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
27
from . import lazy_import
28
lazy_import.lazy_import(globals(), """
33
branch as _mod_branch,
40
config as _mod_config,
52
revision as _mod_revision,
61
from breezy.branch import Branch
62
from breezy.conflicts import ConflictList
63
from breezy.transport import memory
64
from breezy.smtp_connection import SMTPConnection
65
from breezy.workingtree import WorkingTree
66
from breezy.i18n import gettext, ngettext
69
from .commands import (
71
builtin_command_registry,
81
from .revisionspec import (
91
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
94
def _get_branch_location(control_dir, possible_transports=None):
95
"""Return location of branch for this control dir."""
97
target = control_dir.get_branch_reference()
98
except errors.NotBranchError:
99
return control_dir.root_transport.base
100
if target is not None:
102
this_branch = control_dir.open_branch(
103
possible_transports=possible_transports)
104
# This may be a heavy checkout, where we want the master branch
105
master_location = this_branch.get_bound_location()
106
if master_location is not None:
107
return master_location
108
# If not, use a local sibling
109
return this_branch.base
112
def _is_colocated(control_dir, possible_transports=None):
113
"""Check if the branch in control_dir is colocated.
115
:param control_dir: Control directory
116
:return: Tuple with boolean indicating whether the branch is colocated
117
and the full URL to the actual branch
119
# This path is meant to be relative to the existing branch
120
this_url = _get_branch_location(control_dir,
121
possible_transports=possible_transports)
122
# Perhaps the target control dir supports colocated branches?
124
root = controldir.ControlDir.open(this_url,
125
possible_transports=possible_transports)
126
except errors.NotBranchError:
127
return (False, this_url)
130
wt = control_dir.open_workingtree()
131
except (errors.NoWorkingTree, errors.NotLocalUrl):
132
return (False, this_url)
135
root._format.colocated_branches and
136
control_dir.control_url == root.control_url,
140
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
141
"""Lookup the location for a new sibling branch.
143
:param control_dir: Control directory to find sibling branches from
144
:param location: Name of the new branch
145
:return: Full location to the new branch
147
location = directory_service.directories.dereference(location)
148
if '/' not in location and '\\' not in location:
149
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
152
return urlutils.join_segment_parameters(this_url,
153
{"branch": urlutils.escape(location)})
155
return urlutils.join(this_url, '..', urlutils.escape(location))
159
def open_sibling_branch(control_dir, location, possible_transports=None):
160
"""Open a branch, possibly a sibling of another.
162
:param control_dir: Control directory relative to which to lookup the
164
:param location: Location to look up
165
:return: branch to open
168
# Perhaps it's a colocated branch?
169
return control_dir.open_branch(location,
170
possible_transports=possible_transports)
171
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
172
this_url = _get_branch_location(control_dir)
175
this_url, '..', urlutils.escape(location)))
178
def open_nearby_branch(near=None, location=None, possible_transports=None):
179
"""Open a nearby branch.
181
:param near: Optional location of container from which to open branch
182
:param location: Location of the branch
183
:return: Branch instance
189
return Branch.open(location,
190
possible_transports=possible_transports)
191
except errors.NotBranchError:
193
cdir = controldir.ControlDir.open(near,
194
possible_transports=possible_transports)
195
return open_sibling_branch(cdir, location,
196
possible_transports=possible_transports)
199
def iter_sibling_branches(control_dir, possible_transports=None):
200
"""Iterate over the siblings of a branch.
202
:param control_dir: Control directory for which to look up the siblings
203
:return: Iterator over tuples with branch name and branch object
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(reference,
215
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(repo.user_url,
227
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") % view_str)
260
return tree, file_list
263
def _get_one_revision(command_name, revisions):
264
if revisions is None:
266
if len(revisions) != 1:
267
raise errors.BzrCommandError(gettext(
268
'brz %s --revision takes exactly one revision identifier') % (
273
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
274
"""Get a revision tree. Not suitable for commands that change the tree.
276
Specifically, the basis tree in dirstate trees is coupled to the dirstate
277
and doing a commit/uncommit/pull will at best fail due to changing the
280
If tree is passed in, it should be already locked, for lifetime management
281
of the trees internal cached state.
285
if revisions is None:
287
rev_tree = tree.basis_tree()
289
rev_tree = branch.basis_tree()
291
revision = _get_one_revision(command_name, revisions)
292
rev_tree = revision.as_tree(branch)
296
def _get_view_info_for_change_reporter(tree):
297
"""Get the view information from a tree for change reporting."""
300
current_view = tree.views.get_view_info()[0]
301
if current_view is not None:
302
view_info = (current_view, tree.views.lookup_view())
303
except views.ViewsNotSupported:
308
def _open_directory_or_containing_tree_or_branch(filename, directory):
309
"""Open the tree or branch containing the specified file, unless
310
the --directory option is used to specify a different branch."""
311
if directory is not None:
312
return (None, Branch.open(directory), filename)
313
return controldir.ControlDir.open_containing_tree_or_branch(filename)
316
# TODO: Make sure no commands unconditionally use the working directory as a
317
# branch. If a filename argument is used, the first of them should be used to
318
# specify the branch. (Perhaps this can be factored out into some kind of
319
# Argument class, representing a file in a branch, where the first occurrence
322
class cmd_status(Command):
323
__doc__ = """Display status summary.
325
This reports on versioned and unknown files, reporting them
326
grouped by state. Possible states are:
329
Versioned in the working copy but not in the previous revision.
332
Versioned in the previous revision but removed or deleted
336
Path of this file changed from the previous revision;
337
the text may also have changed. This includes files whose
338
parent directory was renamed.
341
Text has changed since the previous revision.
344
File kind has been changed (e.g. from file to directory).
347
Not versioned and not matching an ignore pattern.
349
Additionally for directories, symlinks and files with a changed
350
executable bit, Bazaar indicates their type using a trailing
351
character: '/', '@' or '*' respectively. These decorations can be
352
disabled using the '--no-classify' option.
354
To see ignored files use 'brz ignored'. For details on the
355
changes to file texts, use 'brz diff'.
357
Note that --short or -S gives status flags for each item, similar
358
to Subversion's status command. To get output similar to svn -q,
361
If no arguments are specified, the status of the entire working
362
directory is shown. Otherwise, only the status of the specified
363
files or directories is reported. If a directory is given, status
364
is reported for everything inside that directory.
366
Before merges are committed, the pending merge tip revisions are
367
shown. To see all pending merge revisions, use the -v option.
368
To skip the display of pending merge information altogether, use
369
the no-pending option or specify a file/directory.
371
To compare the working directory to a specific revision, pass a
372
single revision to the revision argument.
374
To see which files have changed in a specific revision, or between
375
two revisions, pass a revision range to the revision argument.
376
This will produce the same results as calling 'brz diff --summarize'.
379
# TODO: --no-recurse/-N, --recurse options
381
takes_args = ['file*']
382
takes_options = ['show-ids', 'revision', 'change', 'verbose',
383
Option('short', help='Use short status indicators.',
385
Option('versioned', help='Only show versioned files.',
387
Option('no-pending', help='Don\'t show pending merges.',
389
Option('no-classify',
390
help='Do not mark object type using indicator.',
393
aliases = ['st', 'stat']
395
encoding_type = 'replace'
396
_see_also = ['diff', 'revert', 'status-flags']
399
def run(self, show_ids=False, file_list=None, revision=None, short=False,
400
versioned=False, no_pending=False, verbose=False,
402
from .status import show_tree_status
404
if revision and len(revision) > 2:
405
raise errors.BzrCommandError(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(gettext('You must supply either'
453
' --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(gettext('Repository %r does not support '
460
'access to raw revision texts'))
462
with b.repository.lock_read():
463
# TODO: jam 20060112 should cat-revision always output utf-8?
464
if revision_id is not None:
465
revision_id = cache_utf8.encode(revision_id)
467
self.print_revision(revisions, revision_id)
468
except errors.NoSuchRevision:
469
msg = gettext("The repository {0} contains no revision {1}.").format(
470
b.repository.base, revision_id)
471
raise errors.BzrCommandError(msg)
472
elif revision is not None:
475
raise errors.BzrCommandError(
476
gettext('You cannot specify a NULL revision.'))
477
rev_id = rev.as_revision_id(b)
478
self.print_revision(revisions, rev_id)
481
class cmd_remove_tree(Command):
482
__doc__ = """Remove the working tree from a given branch/checkout.
484
Since a lightweight checkout is little more than a working tree
485
this will refuse to run against one.
487
To re-create the working tree, use "brz checkout".
489
_see_also = ['checkout', 'working-trees']
490
takes_args = ['location*']
493
help='Remove the working tree even if it has '
494
'uncommitted or shelved changes.'),
497
def run(self, location_list, force=False):
498
if not location_list:
501
for location in location_list:
502
d = controldir.ControlDir.open(location)
505
working = d.open_workingtree()
506
except errors.NoWorkingTree:
507
raise errors.BzrCommandError(gettext("No working tree to remove"))
508
except errors.NotLocalUrl:
509
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
510
" of a remote path"))
512
if (working.has_changes()):
513
raise errors.UncommittedChanges(working)
514
if working.get_shelf_manager().last_shelf() is not None:
515
raise errors.ShelvedChanges(working)
517
if working.user_url != working.branch.user_url:
518
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
519
" from a lightweight checkout"))
521
d.destroy_workingtree()
524
class cmd_repair_workingtree(Command):
525
__doc__ = """Reset the working tree state file.
527
This is not meant to be used normally, but more as a way to recover from
528
filesystem corruption, etc. This rebuilds the working inventory back to a
529
'known good' state. Any new modifications (adding a file, renaming, etc)
530
will be lost, though modified files will still be detected as such.
532
Most users will want something more like "brz revert" or "brz update"
533
unless the state file has become corrupted.
535
By default this attempts to recover the current state by looking at the
536
headers of the state file. If the state file is too corrupted to even do
537
that, you can supply --revision to force the state of the tree.
540
takes_options = ['revision', 'directory',
542
help='Reset the tree even if it doesn\'t appear to be'
547
def run(self, revision=None, directory='.', force=False):
548
tree, _ = WorkingTree.open_containing(directory)
549
self.add_cleanup(tree.lock_tree_write().unlock)
553
except errors.BzrError:
554
pass # There seems to be a real error here, so we'll reset
557
raise errors.BzrCommandError(gettext(
558
'The tree does not appear to be corrupt. You probably'
559
' want "brz revert" instead. Use "--force" if you are'
560
' sure you want to reset the working tree.'))
564
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
566
tree.reset_state(revision_ids)
567
except errors.BzrError as e:
568
if revision_ids is None:
569
extra = (gettext(', the header appears corrupt, try passing -r -1'
570
' to set the state to the last commit'))
573
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
576
class cmd_revno(Command):
577
__doc__ = """Show current revision number.
579
This is equal to the number of revisions on this branch.
583
takes_args = ['location?']
585
Option('tree', help='Show revno of working tree.'),
590
def run(self, tree=False, location=u'.', revision=None):
591
if revision is not None and tree:
592
raise errors.BzrCommandError(gettext("--tree and --revision can "
593
"not be used together"))
597
wt = WorkingTree.open_containing(location)[0]
598
self.add_cleanup(wt.lock_read().unlock)
599
except (errors.NoWorkingTree, errors.NotLocalUrl):
600
raise errors.NoWorkingTree(location)
602
revid = wt.last_revision()
604
b = Branch.open_containing(location)[0]
605
self.add_cleanup(b.lock_read().unlock)
607
if len(revision) != 1:
608
raise errors.BzrCommandError(gettext(
609
"Revision numbers only make sense for single "
610
"revisions, not ranges"))
611
revid = revision[0].as_revision_id(b)
613
revid = b.last_revision()
615
revno_t = b.revision_id_to_dotted_revno(revid)
616
except errors.NoSuchRevision:
618
revno = ".".join(str(n) for n in revno_t)
620
self.outf.write(revno + '\n')
623
class cmd_revision_info(Command):
624
__doc__ = """Show revision number and revision id for a given revision identifier.
627
takes_args = ['revision_info*']
630
custom_help('directory',
631
help='Branch to examine, '
632
'rather than the one containing the working directory.'),
633
Option('tree', help='Show revno of working tree.'),
637
def run(self, revision=None, directory=u'.', tree=False,
638
revision_info_list=[]):
641
wt = WorkingTree.open_containing(directory)[0]
643
self.add_cleanup(wt.lock_read().unlock)
644
except (errors.NoWorkingTree, errors.NotLocalUrl):
646
b = Branch.open_containing(directory)[0]
647
self.add_cleanup(b.lock_read().unlock)
649
if revision is not None:
650
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
651
if revision_info_list is not None:
652
for rev_str in revision_info_list:
653
rev_spec = RevisionSpec.from_string(rev_str)
654
revision_ids.append(rev_spec.as_revision_id(b))
655
# No arguments supplied, default to the last revision
656
if len(revision_ids) == 0:
659
raise errors.NoWorkingTree(directory)
660
revision_ids.append(wt.last_revision())
662
revision_ids.append(b.last_revision())
666
for revision_id in revision_ids:
668
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
669
revno = '.'.join(str(i) for i in dotted_revno)
670
except errors.NoSuchRevision:
672
maxlen = max(maxlen, len(revno))
673
revinfos.append([revno, revision_id])
677
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
680
class cmd_add(Command):
681
__doc__ = """Add specified files or directories.
683
In non-recursive mode, all the named items are added, regardless
684
of whether they were previously ignored. A warning is given if
685
any of the named files are already versioned.
687
In recursive mode (the default), files are treated the same way
688
but the behaviour for directories is different. Directories that
689
are already versioned do not give a warning. All directories,
690
whether already versioned or not, are searched for files or
691
subdirectories that are neither versioned or ignored, and these
692
are added. This search proceeds recursively into versioned
693
directories. If no names are given '.' is assumed.
695
A warning will be printed when nested trees are encountered,
696
unless they are explicitly ignored.
698
Therefore simply saying 'brz add' will version all files that
699
are currently unknown.
701
Adding a file whose parent directory is not versioned will
702
implicitly add the parent, and so on up to the root. This means
703
you should never need to explicitly add a directory, they'll just
704
get added when you add a file in the directory.
706
--dry-run will show which files would be added, but not actually
709
--file-ids-from will try to use the file ids from the supplied path.
710
It looks up ids trying to find a matching parent directory with the
711
same filename, and then by pure path. This option is rarely needed
712
but can be useful when adding the same logical file into two
713
branches that will be merged later (without showing the two different
714
adds as a conflict). It is also useful when merging another project
715
into a subdirectory of this one.
717
Any files matching patterns in the ignore list will not be added
718
unless they are explicitly mentioned.
720
In recursive mode, files larger than the configuration option
721
add.maximum_file_size will be skipped. Named items are never skipped due
724
takes_args = ['file*']
727
help="Don't recursively add the contents of directories.",
730
help="Show what would be done, but don't actually do anything."),
732
Option('file-ids-from',
734
help='Lookup file ids from this tree.'),
736
encoding_type = 'replace'
737
_see_also = ['remove', 'ignore']
739
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
744
if file_ids_from is not None:
746
base_tree, base_path = WorkingTree.open_containing(
748
except errors.NoWorkingTree:
749
base_branch, base_path = Branch.open_containing(
751
base_tree = base_branch.basis_tree()
753
action = breezy.add.AddFromBaseAction(base_tree, base_path,
754
to_file=self.outf, should_print=(not is_quiet()))
756
action = breezy.add.AddWithSkipLargeAction(to_file=self.outf,
757
should_print=(not is_quiet()))
760
self.add_cleanup(base_tree.lock_read().unlock)
761
tree, file_list = tree_files_for_add(file_list)
762
added, ignored = tree.smart_add(file_list, not
763
no_recurse, action=action, save=not dry_run)
767
for glob in sorted(ignored):
768
for path in ignored[glob]:
770
gettext("ignored {0} matching \"{1}\"\n").format(
774
class cmd_mkdir(Command):
775
__doc__ = """Create a new versioned directory.
777
This is equivalent to creating the directory and then adding it.
780
takes_args = ['dir+']
784
help='No error if existing, make parent directories as needed.',
788
encoding_type = 'replace'
791
def add_file_with_parents(cls, wt, relpath):
792
if wt.is_versioned(relpath):
794
cls.add_file_with_parents(wt, osutils.dirname(relpath))
798
def add_file_single(cls, wt, relpath):
801
def run(self, dir_list, parents=False):
803
add_file = self.add_file_with_parents
805
add_file = self.add_file_single
807
wt, relpath = WorkingTree.open_containing(dir)
812
if e.errno != errno.EEXIST:
816
add_file(wt, relpath)
818
self.outf.write(gettext('added %s\n') % dir)
821
class cmd_relpath(Command):
822
__doc__ = """Show path of a file relative to root"""
824
takes_args = ['filename']
828
def run(self, filename):
829
# TODO: jam 20050106 Can relpath return a munged path if
830
# sys.stdout encoding cannot represent it?
831
tree, relpath = WorkingTree.open_containing(filename)
832
self.outf.write(relpath)
833
self.outf.write('\n')
836
class cmd_inventory(Command):
837
__doc__ = """Show inventory of the current working copy or a revision.
839
It is possible to limit the output to a particular entry
840
type using the --kind option. For example: --kind file.
842
It is also possible to restrict the list of files to a specific
843
set. For example: brz inventory --show-ids this/file
852
help='List entries of a particular kind: file, directory, symlink.',
855
takes_args = ['file*']
858
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
859
if kind and kind not in ['file', 'directory', 'symlink']:
860
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
862
revision = _get_one_revision('inventory', revision)
863
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
864
self.add_cleanup(work_tree.lock_read().unlock)
865
if revision is not None:
866
tree = revision.as_tree(work_tree.branch)
868
extra_trees = [work_tree]
869
self.add_cleanup(tree.lock_read().unlock)
874
self.add_cleanup(tree.lock_read().unlock)
875
if file_list is not None:
876
paths = tree.find_related_paths_across_trees(
877
file_list, extra_trees, require_versioned=True)
878
# find_ids_across_trees may include some paths that don't
880
entries = tree.iter_entries_by_dir(specific_files=paths)
882
entries = tree.iter_entries_by_dir()
884
for path, entry in sorted(entries):
885
if kind and kind != entry.kind:
890
self.outf.write('%-50s %s\n' % (path, entry.file_id))
892
self.outf.write(path)
893
self.outf.write('\n')
896
class cmd_cp(Command):
897
__doc__ = """Copy a file.
900
brz cp OLDNAME NEWNAME
902
brz cp SOURCE... DESTINATION
904
If the last argument is a versioned directory, all the other names
905
are copied into it. Otherwise, there must be exactly two arguments
906
and the file is copied to a new name.
908
Files cannot be copied between branches. Only files can be copied
912
takes_args = ['names*']
915
encoding_type = 'replace'
917
def run(self, names_list):
919
if names_list is None:
921
if len(names_list) < 2:
922
raise errors.BzrCommandError(gettext("missing file argument"))
923
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
924
for file_name in rel_names[0:-1]:
926
raise errors.BzrCommandError(gettext("can not copy root of branch"))
927
self.add_cleanup(tree.lock_tree_write().unlock)
928
into_existing = osutils.isdir(names_list[-1])
929
if not into_existing:
931
(src, dst) = rel_names
933
raise errors.BzrCommandError(gettext('to copy multiple files the'
934
' destination must be a versioned'
938
pairs = [(n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
939
for n in rel_names[:-1]]
941
for src, dst in pairs:
943
src_kind = tree.stored_kind(src)
944
except errors.NoSuchFile:
945
raise errors.BzrCommandError(
946
gettext('Could not copy %s => %s: %s is not versioned.')
949
raise errors.BzrCommandError(
950
gettext('Could not copy %s => %s . %s is not versioned\.'
952
if src_kind == 'directory':
953
raise errors.BzrCommandError(
954
gettext('Could not copy %s => %s . %s is a directory.'
956
dst_parent = osutils.split(dst)[0]
959
dst_parent_kind = tree.stored_kind(dst_parent)
960
except errors.NoSuchFile:
961
raise errors.BzrCommandError(
962
gettext('Could not copy %s => %s: %s is not versioned.')
963
% (src, dst, dst_parent))
964
if dst_parent_kind != 'directory':
965
raise errors.BzrCommandError(
966
gettext('Could not copy to %s: %s is not a directory.')
967
% (dst_parent, dst_parent))
969
tree.copy_one(src, dst)
972
class cmd_mv(Command):
973
__doc__ = """Move or rename a file.
976
brz mv OLDNAME NEWNAME
978
brz mv SOURCE... DESTINATION
980
If the last argument is a versioned directory, all the other names
981
are moved into it. Otherwise, there must be exactly two arguments
982
and the file is changed to a new name.
984
If OLDNAME does not exist on the filesystem but is versioned and
985
NEWNAME does exist on the filesystem but is not versioned, mv
986
assumes that the file has been manually moved and only updates
987
its internal inventory to reflect that change.
988
The same is valid when moving many SOURCE files to a DESTINATION.
990
Files cannot be moved between branches.
993
takes_args = ['names*']
994
takes_options = [Option("after", help="Move only the brz identifier"
995
" of the file, because the file has already been moved."),
996
Option('auto', help='Automatically guess renames.'),
997
Option('dry-run', help='Avoid making changes when guessing renames.'),
999
aliases = ['move', 'rename']
1000
encoding_type = 'replace'
1002
def run(self, names_list, after=False, auto=False, dry_run=False):
1004
return self.run_auto(names_list, after, dry_run)
1006
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1007
if names_list is None:
1009
if len(names_list) < 2:
1010
raise errors.BzrCommandError(gettext("missing file argument"))
1011
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1012
for file_name in rel_names[0:-1]:
1014
raise errors.BzrCommandError(gettext("can not move root of branch"))
1015
self.add_cleanup(tree.lock_tree_write().unlock)
1016
self._run(tree, names_list, rel_names, after)
1018
def run_auto(self, names_list, after, dry_run):
1019
if names_list is not None and len(names_list) > 1:
1020
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1023
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1025
work_tree, file_list = WorkingTree.open_containing_paths(
1026
names_list, default_directory='.')
1027
self.add_cleanup(work_tree.lock_tree_write().unlock)
1028
rename_map.RenameMap.guess_renames(
1029
work_tree.basis_tree(), work_tree, dry_run)
1031
def _run(self, tree, names_list, rel_names, after):
1032
into_existing = osutils.isdir(names_list[-1])
1033
if into_existing and len(names_list) == 2:
1035
# a. case-insensitive filesystem and change case of dir
1036
# b. move directory after the fact (if the source used to be
1037
# a directory, but now doesn't exist in the working tree
1038
# and the target is an existing directory, just rename it)
1039
if (not tree.case_sensitive
1040
and rel_names[0].lower() == rel_names[1].lower()):
1041
into_existing = False
1043
# 'fix' the case of a potential 'from'
1044
from_path = tree.get_canonical_inventory_path(rel_names[0])
1045
if (not osutils.lexists(names_list[0]) and
1046
tree.is_versioned(from_path) and
1047
tree.stored_kind(from_path) == "directory"):
1048
into_existing = False
1051
# move into existing directory
1052
# All entries reference existing inventory items, so fix them up
1053
# for cicp file-systems.
1054
rel_names = tree.get_canonical_inventory_paths(rel_names)
1055
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1057
self.outf.write("%s => %s\n" % (src, dest))
1059
if len(names_list) != 2:
1060
raise errors.BzrCommandError(gettext('to mv multiple files the'
1061
' destination must be a versioned'
1064
# for cicp file-systems: the src references an existing inventory
1066
src = tree.get_canonical_inventory_path(rel_names[0])
1067
# Find the canonical version of the destination: In all cases, the
1068
# parent of the target must be in the inventory, so we fetch the
1069
# canonical version from there (we do not always *use* the
1070
# canonicalized tail portion - we may be attempting to rename the
1072
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1073
dest_parent = osutils.dirname(canon_dest)
1074
spec_tail = osutils.basename(rel_names[1])
1075
# For a CICP file-system, we need to avoid creating 2 inventory
1076
# entries that differ only by case. So regardless of the case
1077
# we *want* to use (ie, specified by the user or the file-system),
1078
# we must always choose to use the case of any existing inventory
1079
# items. The only exception to this is when we are attempting a
1080
# case-only rename (ie, canonical versions of src and dest are
1082
dest_id = tree.path2id(canon_dest)
1083
if dest_id is None or tree.path2id(src) == dest_id:
1084
# No existing item we care about, so work out what case we
1085
# are actually going to use.
1087
# If 'after' is specified, the tail must refer to a file on disk.
1089
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1091
# pathjoin with an empty tail adds a slash, which breaks
1093
dest_parent_fq = tree.basedir
1095
dest_tail = osutils.canonical_relpath(
1097
osutils.pathjoin(dest_parent_fq, spec_tail))
1099
# not 'after', so case as specified is used
1100
dest_tail = spec_tail
1102
# Use the existing item so 'mv' fails with AlreadyVersioned.
1103
dest_tail = os.path.basename(canon_dest)
1104
dest = osutils.pathjoin(dest_parent, dest_tail)
1105
mutter("attempting to move %s => %s", src, dest)
1106
tree.rename_one(src, dest, after=after)
1108
self.outf.write("%s => %s\n" % (src, dest))
1111
class cmd_pull(Command):
1112
__doc__ = """Turn this branch into a mirror of another branch.
1114
By default, this command only works on branches that have not diverged.
1115
Branches are considered diverged if the destination branch's most recent
1116
commit is one that has not been merged (directly or indirectly) into the
1119
If branches have diverged, you can use 'brz merge' to integrate the changes
1120
from one into the other. Once one branch has merged, the other should
1121
be able to pull it again.
1123
If you want to replace your local changes and just want your branch to
1124
match the remote one, use pull --overwrite. This will work even if the two
1125
branches have diverged.
1127
If there is no default location set, the first pull will set it (use
1128
--no-remember to avoid setting it). After that, you can omit the
1129
location to use the default. To change the default, use --remember. The
1130
value will only be saved if the remote location can be accessed.
1132
The --verbose option will display the revisions pulled using the log_format
1133
configuration option. You can use a different format by overriding it with
1134
-Olog_format=<other_format>.
1136
Note: The location can be specified either in the form of a branch,
1137
or in the form of a path to a file containing a merge directive generated
1141
_see_also = ['push', 'update', 'status-flags', 'send']
1142
takes_options = ['remember', 'overwrite', 'revision',
1143
custom_help('verbose',
1144
help='Show logs of pulled revisions.'),
1145
custom_help('directory',
1146
help='Branch to pull into, '
1147
'rather than the one containing the working directory.'),
1149
help="Perform a local pull in a bound "
1150
"branch. Local pulls are not applied to "
1151
"the master branch."
1154
help="Show base revision text in conflicts."),
1155
Option('overwrite-tags',
1156
help="Overwrite tags only."),
1158
takes_args = ['location?']
1159
encoding_type = 'replace'
1161
def run(self, location=None, remember=None, overwrite=False,
1162
revision=None, verbose=False,
1163
directory=None, local=False,
1164
show_base=False, overwrite_tags=False):
1167
overwrite = ["history", "tags"]
1168
elif overwrite_tags:
1169
overwrite = ["tags"]
1172
# FIXME: too much stuff is in the command class
1175
if directory is None:
1178
tree_to = WorkingTree.open_containing(directory)[0]
1179
branch_to = tree_to.branch
1180
self.add_cleanup(tree_to.lock_write().unlock)
1181
except errors.NoWorkingTree:
1183
branch_to = Branch.open_containing(directory)[0]
1184
self.add_cleanup(branch_to.lock_write().unlock)
1186
warning(gettext("No working tree, ignoring --show-base"))
1188
if local and not branch_to.get_bound_location():
1189
raise errors.LocalRequiresBoundBranch()
1191
possible_transports = []
1192
if location is not None:
1194
mergeable = bundle.read_mergeable_from_url(location,
1195
possible_transports=possible_transports)
1196
except errors.NotABundle:
1199
stored_loc = branch_to.get_parent()
1200
if location is None:
1201
if stored_loc is None:
1202
raise errors.BzrCommandError(gettext("No pull location known or"
1205
display_url = urlutils.unescape_for_display(stored_loc,
1208
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1209
location = stored_loc
1211
revision = _get_one_revision('pull', revision)
1212
if mergeable is not None:
1213
if revision is not None:
1214
raise errors.BzrCommandError(gettext(
1215
'Cannot use -r with merge directives or bundles'))
1216
mergeable.install_revisions(branch_to.repository)
1217
base_revision_id, revision_id, verified = \
1218
mergeable.get_merge_request(branch_to.repository)
1219
branch_from = branch_to
1221
branch_from = Branch.open(location,
1222
possible_transports=possible_transports)
1223
self.add_cleanup(branch_from.lock_read().unlock)
1224
# Remembers if asked explicitly or no previous location is set
1226
or (remember is None and branch_to.get_parent() is None)):
1227
# FIXME: This shouldn't be done before the pull
1228
# succeeds... -- vila 2012-01-02
1229
branch_to.set_parent(branch_from.base)
1231
if revision is not None:
1232
revision_id = revision.as_revision_id(branch_from)
1234
if tree_to is not None:
1235
view_info = _get_view_info_for_change_reporter(tree_to)
1236
change_reporter = delta._ChangeReporter(
1237
unversioned_filter=tree_to.is_ignored,
1238
view_info=view_info)
1239
result = tree_to.pull(
1240
branch_from, overwrite, revision_id, change_reporter,
1241
local=local, show_base=show_base)
1243
result = branch_to.pull(
1244
branch_from, overwrite, revision_id, local=local)
1246
result.report(self.outf)
1247
if verbose and result.old_revid != result.new_revid:
1248
log.show_branch_change(
1249
branch_to, self.outf, result.old_revno,
1251
if getattr(result, 'tag_conflicts', None):
1257
class cmd_push(Command):
1258
__doc__ = """Update a mirror of this branch.
1260
The target branch will not have its working tree populated because this
1261
is both expensive, and is not supported on remote file systems.
1263
Some smart servers or protocols *may* put the working tree in place in
1266
This command only works on branches that have not diverged. Branches are
1267
considered diverged if the destination branch's most recent commit is one
1268
that has not been merged (directly or indirectly) by the source branch.
1270
If branches have diverged, you can use 'brz push --overwrite' to replace
1271
the other branch completely, discarding its unmerged changes.
1273
If you want to ensure you have the different changes in the other branch,
1274
do a merge (see brz help merge) from the other branch, and commit that.
1275
After that you will be able to do a push without '--overwrite'.
1277
If there is no default push location set, the first push will set it (use
1278
--no-remember to avoid setting it). After that, you can omit the
1279
location to use the default. To change the default, use --remember. The
1280
value will only be saved if the remote location can be accessed.
1282
The --verbose option will display the revisions pushed using the log_format
1283
configuration option. You can use a different format by overriding it with
1284
-Olog_format=<other_format>.
1287
_see_also = ['pull', 'update', 'working-trees']
1288
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1289
Option('create-prefix',
1290
help='Create the path leading up to the branch '
1291
'if it does not already exist.'),
1292
custom_help('directory',
1293
help='Branch to push from, '
1294
'rather than the one containing the working directory.'),
1295
Option('use-existing-dir',
1296
help='By default push will fail if the target'
1297
' directory exists, but does not already'
1298
' have a control directory. This flag will'
1299
' allow push to proceed.'),
1301
help='Create a stacked branch that references the public location '
1302
'of the parent branch.'),
1303
Option('stacked-on',
1304
help='Create a stacked branch that refers to another branch '
1305
'for the commit history. Only the work not present in the '
1306
'referenced branch is included in the branch created.',
1309
help='Refuse to push if there are uncommitted changes in'
1310
' the working tree, --no-strict disables the check.'),
1312
help="Don't populate the working tree, even for protocols"
1313
" that support it."),
1314
Option('overwrite-tags',
1315
help="Overwrite tags only."),
1316
Option('lossy', help="Allow lossy push, i.e. dropping metadata "
1317
"that can't be represented in the target.")
1319
takes_args = ['location?']
1320
encoding_type = 'replace'
1322
def run(self, location=None, remember=None, overwrite=False,
1323
create_prefix=False, verbose=False, revision=None,
1324
use_existing_dir=False, directory=None, stacked_on=None,
1325
stacked=False, strict=None, no_tree=False,
1326
overwrite_tags=False, lossy=False):
1327
from .push import _show_push_branch
1330
overwrite = ["history", "tags"]
1331
elif overwrite_tags:
1332
overwrite = ["tags"]
1336
if directory is None:
1338
# Get the source branch
1340
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1341
# Get the tip's revision_id
1342
revision = _get_one_revision('push', revision)
1343
if revision is not None:
1344
revision_id = revision.in_history(br_from).rev_id
1347
if tree is not None and revision_id is None:
1348
tree.check_changed_or_out_of_date(
1349
strict, 'push_strict',
1350
more_error='Use --no-strict to force the push.',
1351
more_warning='Uncommitted changes will not be pushed.')
1352
# Get the stacked_on branch, if any
1353
if stacked_on is not None:
1354
stacked_on = urlutils.normalize_url(stacked_on)
1356
parent_url = br_from.get_parent()
1358
parent = Branch.open(parent_url)
1359
stacked_on = parent.get_public_branch()
1361
# I considered excluding non-http url's here, thus forcing
1362
# 'public' branches only, but that only works for some
1363
# users, so it's best to just depend on the user spotting an
1364
# error by the feedback given to them. RBC 20080227.
1365
stacked_on = parent_url
1367
raise errors.BzrCommandError(gettext(
1368
"Could not determine branch to refer to."))
1370
# Get the destination location
1371
if location is None:
1372
stored_loc = br_from.get_push_location()
1373
if stored_loc is None:
1374
parent_loc = br_from.get_parent()
1376
raise errors.BzrCommandError(gettext(
1377
"No push location known or specified. To push to the "
1378
"parent branch (at %s), use 'brz push :parent'." %
1379
urlutils.unescape_for_display(parent_loc,
1380
self.outf.encoding)))
1382
raise errors.BzrCommandError(gettext(
1383
"No push location known or specified."))
1385
display_url = urlutils.unescape_for_display(stored_loc,
1387
note(gettext("Using saved push location: %s") % display_url)
1388
location = stored_loc
1390
_show_push_branch(br_from, revision_id, location, self.outf,
1391
verbose=verbose, overwrite=overwrite, remember=remember,
1392
stacked_on=stacked_on, create_prefix=create_prefix,
1393
use_existing_dir=use_existing_dir, no_tree=no_tree,
1397
class cmd_branch(Command):
1398
__doc__ = """Create a new branch that is a copy of an existing branch.
1400
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1401
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1402
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1403
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1404
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1407
To retrieve the branch as of a particular revision, supply the --revision
1408
parameter, as in "branch foo/bar -r 5".
1411
_see_also = ['checkout']
1412
takes_args = ['from_location', 'to_location?']
1413
takes_options = ['revision',
1414
Option('hardlink', help='Hard-link working tree files where possible.'),
1415
Option('files-from', type=text_type,
1416
help="Get file contents from this tree."),
1418
help="Create a branch without a working-tree."),
1420
help="Switch the checkout in the current directory "
1421
"to the new branch."),
1423
help='Create a stacked branch referring to the source branch. '
1424
'The new branch will depend on the availability of the source '
1425
'branch for all operations.'),
1426
Option('standalone',
1427
help='Do not use a shared repository, even if available.'),
1428
Option('use-existing-dir',
1429
help='By default branch will fail if the target'
1430
' directory exists, but does not already'
1431
' have a control directory. This flag will'
1432
' allow branch to proceed.'),
1434
help="Bind new branch to from location."),
1437
def run(self, from_location, to_location=None, revision=None,
1438
hardlink=False, stacked=False, standalone=False, no_tree=False,
1439
use_existing_dir=False, switch=False, bind=False,
1441
from breezy import switch as _mod_switch
1442
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1444
if not (hardlink or files_from):
1445
# accelerator_tree is usually slower because you have to read N
1446
# files (no readahead, lots of seeks, etc), but allow the user to
1447
# explicitly request it
1448
accelerator_tree = None
1449
if files_from is not None and files_from != from_location:
1450
accelerator_tree = WorkingTree.open(files_from)
1451
revision = _get_one_revision('branch', revision)
1452
self.add_cleanup(br_from.lock_read().unlock)
1453
if revision is not None:
1454
revision_id = revision.as_revision_id(br_from)
1456
# FIXME - wt.last_revision, fallback to branch, fall back to
1457
# None or perhaps NULL_REVISION to mean copy nothing
1459
revision_id = br_from.last_revision()
1460
if to_location is None:
1461
to_location = getattr(br_from, "name", None)
1463
to_location = urlutils.derive_to_location(from_location)
1464
to_transport = transport.get_transport(to_location)
1466
to_transport.mkdir('.')
1467
except errors.FileExists:
1469
to_dir = controldir.ControlDir.open_from_transport(
1471
except errors.NotBranchError:
1472
if not use_existing_dir:
1473
raise errors.BzrCommandError(gettext('Target directory "%s" '
1474
'already exists.') % to_location)
1479
to_dir.open_branch()
1480
except errors.NotBranchError:
1483
raise errors.AlreadyBranchError(to_location)
1484
except errors.NoSuchFile:
1485
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1491
# preserve whatever source format we have.
1492
to_dir = br_from.controldir.sprout(
1493
to_transport.base, revision_id,
1494
possible_transports=[to_transport],
1495
accelerator_tree=accelerator_tree, hardlink=hardlink,
1496
stacked=stacked, force_new_repo=standalone,
1497
create_tree_if_local=not no_tree, source_branch=br_from)
1498
branch = to_dir.open_branch(
1499
possible_transports=[
1500
br_from.controldir.root_transport, to_transport])
1501
except errors.NoSuchRevision:
1502
to_transport.delete_tree('.')
1503
msg = gettext("The branch {0} has no revision {1}.").format(
1504
from_location, revision)
1505
raise errors.BzrCommandError(msg)
1508
to_repo = to_dir.open_repository()
1509
except errors.NoRepositoryPresent:
1510
to_repo = to_dir.create_repository()
1511
to_repo.fetch(br_from.repository, revision_id=revision_id)
1512
branch = br_from.sprout(to_dir, revision_id=revision_id)
1513
br_from.tags.merge_to(branch.tags)
1515
# If the source branch is stacked, the new branch may
1516
# be stacked whether we asked for that explicitly or not.
1517
# We therefore need a try/except here and not just 'if stacked:'
1519
note(gettext('Created new stacked branch referring to %s.') %
1520
branch.get_stacked_on_url())
1521
except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
1522
errors.UnstackableRepositoryFormat) as e:
1523
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1525
# Bind to the parent
1526
parent_branch = Branch.open(from_location)
1527
branch.bind(parent_branch)
1528
note(gettext('New branch bound to %s') % from_location)
1530
# Switch to the new branch
1531
wt, _ = WorkingTree.open_containing('.')
1532
_mod_switch.switch(wt.controldir, branch)
1533
note(gettext('Switched to branch: %s'),
1534
urlutils.unescape_for_display(branch.base, 'utf-8'))
1537
class cmd_branches(Command):
1538
__doc__ = """List the branches available at the current location.
1540
This command will print the names of all the branches at the current
1544
takes_args = ['location?']
1546
Option('recursive', short_name='R',
1547
help='Recursively scan for branches rather than '
1548
'just looking in the specified location.')]
1550
def run(self, location=".", recursive=False):
1552
t = transport.get_transport(location)
1553
if not t.listable():
1554
raise errors.BzrCommandError(
1555
"Can't scan this type of location.")
1556
for b in controldir.ControlDir.find_branches(t):
1557
self.outf.write("%s\n" % urlutils.unescape_for_display(
1558
urlutils.relative_url(t.base, b.base),
1559
self.outf.encoding).rstrip("/"))
1561
dir = controldir.ControlDir.open_containing(location)[0]
1563
active_branch = dir.open_branch(name="")
1564
except errors.NotBranchError:
1565
active_branch = None
1567
for name, branch in iter_sibling_branches(dir):
1570
active = (active_branch is not None and
1571
active_branch.user_url == branch.user_url)
1572
names[name] = active
1573
# Only mention the current branch explicitly if it's not
1574
# one of the colocated branches
1575
if not any(viewvalues(names)) and active_branch is not None:
1576
self.outf.write("* %s\n" % gettext("(default)"))
1577
for name in sorted(names):
1578
active = names[name]
1583
self.outf.write("%s %s\n" % (
1584
prefix, name.encode(self.outf.encoding)))
1587
class cmd_checkout(Command):
1588
__doc__ = """Create a new checkout of an existing branch.
1590
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1591
the branch found in '.'. This is useful if you have removed the working tree
1592
or if it was never created - i.e. if you pushed the branch to its current
1593
location using SFTP.
1595
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1596
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1597
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1598
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1599
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1602
To retrieve the branch as of a particular revision, supply the --revision
1603
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1604
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1608
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1609
takes_args = ['branch_location?', 'to_location?']
1610
takes_options = ['revision',
1611
Option('lightweight',
1612
help="Perform a lightweight checkout. Lightweight "
1613
"checkouts depend on access to the branch for "
1614
"every operation. Normal checkouts can perform "
1615
"common operations like diff and status without "
1616
"such access, and also support local commits."
1618
Option('files-from', type=text_type,
1619
help="Get file contents from this tree."),
1621
help='Hard-link working tree files where possible.'
1626
def run(self, branch_location=None, to_location=None, revision=None,
1627
lightweight=False, files_from=None, hardlink=False):
1628
if branch_location is None:
1629
branch_location = osutils.getcwd()
1630
to_location = branch_location
1631
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1633
if not (hardlink or files_from):
1634
# accelerator_tree is usually slower because you have to read N
1635
# files (no readahead, lots of seeks, etc), but allow the user to
1636
# explicitly request it
1637
accelerator_tree = None
1638
revision = _get_one_revision('checkout', revision)
1639
if files_from is not None and files_from != branch_location:
1640
accelerator_tree = WorkingTree.open(files_from)
1641
if revision is not None:
1642
revision_id = revision.as_revision_id(source)
1645
if to_location is None:
1646
to_location = urlutils.derive_to_location(branch_location)
1647
# if the source and to_location are the same,
1648
# and there is no working tree,
1649
# then reconstitute a branch
1650
if (osutils.abspath(to_location) ==
1651
osutils.abspath(branch_location)):
1653
source.controldir.open_workingtree()
1654
except errors.NoWorkingTree:
1655
source.controldir.create_workingtree(revision_id)
1657
source.create_checkout(to_location, revision_id, lightweight,
1658
accelerator_tree, hardlink)
1661
class cmd_renames(Command):
1662
__doc__ = """Show list of renamed files.
1664
# TODO: Option to show renames between two historical versions.
1666
# TODO: Only show renames under dir, rather than in the whole branch.
1667
_see_also = ['status']
1668
takes_args = ['dir?']
1671
def run(self, dir=u'.'):
1672
tree = WorkingTree.open_containing(dir)[0]
1673
self.add_cleanup(tree.lock_read().unlock)
1674
old_tree = tree.basis_tree()
1675
self.add_cleanup(old_tree.lock_read().unlock)
1677
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1678
for f, paths, c, v, p, n, k, e in iterator:
1679
if paths[0] == paths[1]:
1683
renames.append(paths)
1685
for old_name, new_name in renames:
1686
self.outf.write("%s => %s\n" % (old_name, new_name))
1689
class cmd_update(Command):
1690
__doc__ = """Update a working tree to a new revision.
1692
This will perform a merge of the destination revision (the tip of the
1693
branch, or the specified revision) into the working tree, and then make
1694
that revision the basis revision for the working tree.
1696
You can use this to visit an older revision, or to update a working tree
1697
that is out of date from its branch.
1699
If there are any uncommitted changes in the tree, they will be carried
1700
across and remain as uncommitted changes after the update. To discard
1701
these changes, use 'brz revert'. The uncommitted changes may conflict
1702
with the changes brought in by the change in basis revision.
1704
If the tree's branch is bound to a master branch, brz will also update
1705
the branch from the master.
1707
You cannot update just a single file or directory, because each Bazaar
1708
working tree has just a single basis revision. If you want to restore a
1709
file that has been removed locally, use 'brz revert' instead of 'brz
1710
update'. If you want to restore a file to its state in a previous
1711
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1712
out the old content of that file to a new location.
1714
The 'dir' argument, if given, must be the location of the root of a
1715
working tree to update. By default, the working tree that contains the
1716
current working directory is used.
1719
_see_also = ['pull', 'working-trees', 'status-flags']
1720
takes_args = ['dir?']
1721
takes_options = ['revision',
1723
help="Show base revision text in conflicts."),
1727
def run(self, dir=None, revision=None, show_base=None):
1728
if revision is not None and len(revision) != 1:
1729
raise errors.BzrCommandError(gettext(
1730
"brz update --revision takes exactly one revision"))
1732
tree = WorkingTree.open_containing('.')[0]
1734
tree, relpath = WorkingTree.open_containing(dir)
1737
raise errors.BzrCommandError(gettext(
1738
"brz update can only update a whole tree, "
1739
"not a file or subdirectory"))
1740
branch = tree.branch
1741
possible_transports = []
1742
master = branch.get_master_branch(
1743
possible_transports=possible_transports)
1744
if master is not None:
1745
branch_location = master.base
1748
branch_location = tree.branch.base
1749
tree.lock_tree_write()
1750
self.add_cleanup(tree.unlock)
1751
# get rid of the final '/' and be ready for display
1752
branch_location = urlutils.unescape_for_display(
1753
branch_location.rstrip('/'),
1755
existing_pending_merges = tree.get_parent_ids()[1:]
1759
# may need to fetch data into a heavyweight checkout
1760
# XXX: this may take some time, maybe we should display a
1762
old_tip = branch.update(possible_transports)
1763
if revision is not None:
1764
revision_id = revision[0].as_revision_id(branch)
1766
revision_id = branch.last_revision()
1767
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1768
revno = branch.revision_id_to_dotted_revno(revision_id)
1769
note(gettext("Tree is up to date at revision {0} of branch {1}"
1770
).format('.'.join(map(str, revno)), branch_location))
1772
view_info = _get_view_info_for_change_reporter(tree)
1773
change_reporter = delta._ChangeReporter(
1774
unversioned_filter=tree.is_ignored,
1775
view_info=view_info)
1777
conflicts = tree.update(
1779
possible_transports=possible_transports,
1780
revision=revision_id,
1782
show_base=show_base)
1783
except errors.NoSuchRevision as e:
1784
raise errors.BzrCommandError(gettext(
1785
"branch has no revision %s\n"
1786
"brz update --revision only works"
1787
" for a revision in the branch history")
1789
revno = tree.branch.revision_id_to_dotted_revno(
1790
_mod_revision.ensure_null(tree.last_revision()))
1791
note(gettext('Updated to revision {0} of branch {1}').format(
1792
'.'.join(map(str, revno)), branch_location))
1793
parent_ids = tree.get_parent_ids()
1794
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1795
note(gettext('Your local commits will now show as pending merges with '
1796
"'brz status', and can be committed with 'brz commit'."))
1803
class cmd_info(Command):
1804
__doc__ = """Show information about a working tree, branch or repository.
1806
This command will show all known locations and formats associated to the
1807
tree, branch or repository.
1809
In verbose mode, statistical information is included with each report.
1810
To see extended statistic information, use a verbosity level of 2 or
1811
higher by specifying the verbose option multiple times, e.g. -vv.
1813
Branches and working trees will also report any missing revisions.
1817
Display information on the format and related locations:
1821
Display the above together with extended format information and
1822
basic statistics (like the number of files in the working tree and
1823
number of revisions in the branch and repository):
1827
Display the above together with number of committers to the branch:
1831
_see_also = ['revno', 'working-trees', 'repositories']
1832
takes_args = ['location?']
1833
takes_options = ['verbose']
1834
encoding_type = 'replace'
1837
def run(self, location=None, verbose=False):
1839
noise_level = get_verbosity_level()
1842
from .info import show_bzrdir_info
1843
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1844
verbose=noise_level, outfile=self.outf)
1847
class cmd_remove(Command):
1848
__doc__ = """Remove files or directories.
1850
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1851
delete them if they can easily be recovered using revert otherwise they
1852
will be backed up (adding an extension of the form .~#~). If no options or
1853
parameters are given Bazaar will scan for files that are being tracked by
1854
Bazaar but missing in your tree and stop tracking them for you.
1856
takes_args = ['file*']
1857
takes_options = ['verbose',
1858
Option('new', help='Only remove files that have never been committed.'),
1859
RegistryOption.from_kwargs('file-deletion-strategy',
1860
'The file deletion mode to be used.',
1861
title='Deletion Strategy', value_switches=True, enum_switch=False,
1862
safe='Backup changed files (default).',
1863
keep='Delete from brz but leave the working copy.',
1864
no_backup='Don\'t backup changed files.'),
1866
aliases = ['rm', 'del']
1867
encoding_type = 'replace'
1869
def run(self, file_list, verbose=False, new=False,
1870
file_deletion_strategy='safe'):
1872
tree, file_list = WorkingTree.open_containing_paths(file_list)
1874
if file_list is not None:
1875
file_list = [f for f in file_list]
1877
self.add_cleanup(tree.lock_write().unlock)
1878
# Heuristics should probably all move into tree.remove_smart or
1881
added = tree.changes_from(tree.basis_tree(),
1882
specific_files=file_list).added
1883
file_list = sorted([f[0] for f in added], reverse=True)
1884
if len(file_list) == 0:
1885
raise errors.BzrCommandError(gettext('No matching files.'))
1886
elif file_list is None:
1887
# missing files show up in iter_changes(basis) as
1888
# versioned-with-no-kind.
1890
for change in tree.iter_changes(tree.basis_tree()):
1891
# Find paths in the working tree that have no kind:
1892
if change[1][1] is not None and change[6][1] is None:
1893
missing.append(change[1][1])
1894
file_list = sorted(missing, reverse=True)
1895
file_deletion_strategy = 'keep'
1896
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1897
keep_files=file_deletion_strategy=='keep',
1898
force=(file_deletion_strategy=='no-backup'))
1901
class cmd_file_id(Command):
1902
__doc__ = """Print file_id of a particular file or directory.
1904
The file_id is assigned when the file is first added and remains the
1905
same through all revisions where the file exists, even when it is
1910
_see_also = ['inventory', 'ls']
1911
takes_args = ['filename']
1914
def run(self, filename):
1915
tree, relpath = WorkingTree.open_containing(filename)
1916
i = tree.path2id(relpath)
1918
raise errors.NotVersionedError(filename)
1920
self.outf.write(i + '\n')
1923
class cmd_file_path(Command):
1924
__doc__ = """Print path of file_ids to a file or directory.
1926
This prints one line for each directory down to the target,
1927
starting at the branch root.
1931
takes_args = ['filename']
1934
def run(self, filename):
1935
tree, relpath = WorkingTree.open_containing(filename)
1936
fid = tree.path2id(relpath)
1938
raise errors.NotVersionedError(filename)
1939
segments = osutils.splitpath(relpath)
1940
for pos in range(1, len(segments) + 1):
1941
path = osutils.joinpath(segments[:pos])
1942
self.outf.write("%s\n" % tree.path2id(path))
1945
class cmd_reconcile(Command):
1946
__doc__ = """Reconcile brz metadata in a branch.
1948
This can correct data mismatches that may have been caused by
1949
previous ghost operations or brz upgrades. You should only
1950
need to run this command if 'brz check' or a brz developer
1951
advises you to run it.
1953
If a second branch is provided, cross-branch reconciliation is
1954
also attempted, which will check that data like the tree root
1955
id which was not present in very early brz versions is represented
1956
correctly in both branches.
1958
At the same time it is run it may recompress data resulting in
1959
a potential saving in disk space or performance gain.
1961
The branch *MUST* be on a listable system such as local disk or sftp.
1964
_see_also = ['check']
1965
takes_args = ['branch?']
1967
Option('canonicalize-chks',
1968
help='Make sure CHKs are in canonical form (repairs '
1973
def run(self, branch=".", canonicalize_chks=False):
1974
from .reconcile import reconcile
1975
dir = controldir.ControlDir.open(branch)
1976
reconcile(dir, canonicalize_chks=canonicalize_chks)
1979
class cmd_revision_history(Command):
1980
__doc__ = """Display the list of revision ids on a branch."""
1983
takes_args = ['location?']
1988
def run(self, location="."):
1989
branch = Branch.open_containing(location)[0]
1990
self.add_cleanup(branch.lock_read().unlock)
1991
graph = branch.repository.get_graph()
1992
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1993
[_mod_revision.NULL_REVISION]))
1994
for revid in reversed(history):
1995
self.outf.write(revid)
1996
self.outf.write('\n')
1999
class cmd_ancestry(Command):
2000
__doc__ = """List all revisions merged into this branch."""
2002
_see_also = ['log', 'revision-history']
2003
takes_args = ['location?']
2008
def run(self, location="."):
2010
wt = WorkingTree.open_containing(location)[0]
2011
except errors.NoWorkingTree:
2012
b = Branch.open(location)
2013
last_revision = b.last_revision()
2016
last_revision = wt.last_revision()
2018
self.add_cleanup(b.repository.lock_read().unlock)
2019
graph = b.repository.get_graph()
2020
revisions = [revid for revid, parents in
2021
graph.iter_ancestry([last_revision])]
2022
for revision_id in reversed(revisions):
2023
if _mod_revision.is_null(revision_id):
2025
self.outf.write(revision_id + '\n')
2028
class cmd_init(Command):
2029
__doc__ = """Make a directory into a versioned branch.
2031
Use this to create an empty branch, or before importing an
2034
If there is a repository in a parent directory of the location, then
2035
the history of the branch will be stored in the repository. Otherwise
2036
init creates a standalone branch which carries its own history
2037
in the .bzr directory.
2039
If there is already a branch at the location but it has no working tree,
2040
the tree can be populated with 'brz checkout'.
2042
Recipe for importing a tree of files::
2048
brz commit -m "imported project"
2051
_see_also = ['init-repository', 'branch', 'checkout']
2052
takes_args = ['location?']
2054
Option('create-prefix',
2055
help='Create the path leading up to the branch '
2056
'if it does not already exist.'),
2057
RegistryOption('format',
2058
help='Specify a format for this branch. '
2059
'See "help formats" for a full list.',
2060
lazy_registry=('breezy.controldir', 'format_registry'),
2061
converter=lambda name: controldir.format_registry.make_controldir(name),
2062
value_switches=True,
2063
title="Branch format",
2065
Option('append-revisions-only',
2066
help='Never change revnos or the existing log.'
2067
' Append revisions to it only.'),
2069
'Create a branch without a working tree.')
2071
def run(self, location=None, format=None, append_revisions_only=False,
2072
create_prefix=False, no_tree=False):
2074
format = controldir.format_registry.make_controldir('default')
2075
if location is None:
2078
to_transport = transport.get_transport(location)
2080
# The path has to exist to initialize a
2081
# branch inside of it.
2082
# Just using os.mkdir, since I don't
2083
# believe that we want to create a bunch of
2084
# locations if the user supplies an extended path
2086
to_transport.ensure_base()
2087
except errors.NoSuchFile:
2088
if not create_prefix:
2089
raise errors.BzrCommandError(gettext("Parent directory of %s"
2091
"\nYou may supply --create-prefix to create all"
2092
" leading parent directories.")
2094
to_transport.create_prefix()
2097
a_controldir = controldir.ControlDir.open_from_transport(to_transport)
2098
except errors.NotBranchError:
2099
# really a NotBzrDir error...
2100
create_branch = controldir.ControlDir.create_branch_convenience
2102
force_new_tree = False
2104
force_new_tree = None
2105
branch = create_branch(to_transport.base, format=format,
2106
possible_transports=[to_transport],
2107
force_new_tree=force_new_tree)
2108
a_controldir = branch.controldir
2110
from .transport.local import LocalTransport
2111
if a_controldir.has_branch():
2112
if (isinstance(to_transport, LocalTransport)
2113
and not a_controldir.has_workingtree()):
2114
raise errors.BranchExistsWithoutWorkingTree(location)
2115
raise errors.AlreadyBranchError(location)
2116
branch = a_controldir.create_branch()
2117
if not no_tree and not a_controldir.has_workingtree():
2118
a_controldir.create_workingtree()
2119
if append_revisions_only:
2121
branch.set_append_revisions_only(True)
2122
except errors.UpgradeRequired:
2123
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2124
' to append-revisions-only. Try --default.'))
2126
from .info import describe_layout, describe_format
2128
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2129
except (errors.NoWorkingTree, errors.NotLocalUrl):
2131
repository = branch.repository
2132
layout = describe_layout(repository, branch, tree).lower()
2133
format = describe_format(a_controldir, repository, branch, tree)
2134
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2136
if repository.is_shared():
2137
#XXX: maybe this can be refactored into transport.path_or_url()
2138
url = repository.controldir.root_transport.external_url()
2140
url = urlutils.local_path_from_url(url)
2141
except urlutils.InvalidURL:
2143
self.outf.write(gettext("Using shared repository: %s\n") % url)
2146
class cmd_init_repository(Command):
2147
__doc__ = """Create a shared repository for branches to share storage space.
2149
New branches created under the repository directory will store their
2150
revisions in the repository, not in the branch directory. For branches
2151
with shared history, this reduces the amount of storage needed and
2152
speeds up the creation of new branches.
2154
If the --no-trees option is given then the branches in the repository
2155
will not have working trees by default. They will still exist as
2156
directories on disk, but they will not have separate copies of the
2157
files at a certain revision. This can be useful for repositories that
2158
store branches which are interacted with through checkouts or remote
2159
branches, such as on a server.
2162
Create a shared repository holding just branches::
2164
brz init-repo --no-trees repo
2167
Make a lightweight checkout elsewhere::
2169
brz checkout --lightweight repo/trunk trunk-checkout
2174
_see_also = ['init', 'branch', 'checkout', 'repositories']
2175
takes_args = ["location"]
2176
takes_options = [RegistryOption('format',
2177
help='Specify a format for this repository. See'
2178
' "brz help formats" for details.',
2179
lazy_registry=('breezy.controldir', 'format_registry'),
2180
converter=lambda name: controldir.format_registry.make_controldir(name),
2181
value_switches=True, title='Repository format'),
2183
help='Branches in the repository will default to'
2184
' not having a working tree.'),
2186
aliases = ["init-repo"]
2188
def run(self, location, format=None, no_trees=False):
2190
format = controldir.format_registry.make_controldir('default')
2192
if location is None:
2195
to_transport = transport.get_transport(location)
2197
if format.fixed_components:
2198
repo_format_name = None
2200
repo_format_name = format.repository_format.get_format_string()
2202
(repo, newdir, require_stacking, repository_policy) = (
2203
format.initialize_on_transport_ex(to_transport,
2204
create_prefix=True, make_working_trees=not no_trees,
2205
shared_repo=True, force_new_repo=True,
2206
use_existing_dir=True,
2207
repo_format_name=repo_format_name))
2209
from .info import show_bzrdir_info
2210
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2213
class cmd_diff(Command):
2214
__doc__ = """Show differences in the working tree, between revisions or branches.
2216
If no arguments are given, all changes for the current tree are listed.
2217
If files are given, only the changes in those files are listed.
2218
Remote and multiple branches can be compared by using the --old and
2219
--new options. If not provided, the default for both is derived from
2220
the first argument, if any, or the current tree if no arguments are
2223
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2224
produces patches suitable for "patch -p1".
2226
Note that when using the -r argument with a range of revisions, the
2227
differences are computed between the two specified revisions. That
2228
is, the command does not show the changes introduced by the first
2229
revision in the range. This differs from the interpretation of
2230
revision ranges used by "brz log" which includes the first revision
2235
2 - unrepresentable changes
2240
Shows the difference in the working tree versus the last commit::
2244
Difference between the working tree and revision 1::
2248
Difference between revision 3 and revision 1::
2252
Difference between revision 3 and revision 1 for branch xxx::
2256
The changes introduced by revision 2 (equivalent to -r1..2)::
2260
To see the changes introduced by revision X::
2264
Note that in the case of a merge, the -c option shows the changes
2265
compared to the left hand parent. To see the changes against
2266
another parent, use::
2268
brz diff -r<chosen_parent>..X
2270
The changes between the current revision and the previous revision
2271
(equivalent to -c-1 and -r-2..-1)
2275
Show just the differences for file NEWS::
2279
Show the differences in working tree xxx for file NEWS::
2283
Show the differences from branch xxx to this working tree:
2287
Show the differences between two branches for file NEWS::
2289
brz diff --old xxx --new yyy NEWS
2291
Same as 'brz diff' but prefix paths with old/ and new/::
2293
brz diff --prefix old/:new/
2295
Show the differences using a custom diff program with options::
2297
brz diff --using /usr/bin/diff --diff-options -wu
2299
_see_also = ['status']
2300
takes_args = ['file*']
2302
Option('diff-options', type=text_type,
2303
help='Pass these options to the external diff program.'),
2304
Option('prefix', type=text_type,
2306
help='Set prefixes added to old and new filenames, as '
2307
'two values separated by a colon. (eg "old/:new/").'),
2309
help='Branch/tree to compare from.',
2313
help='Branch/tree to compare to.',
2319
help='Use this command to compare files.',
2322
RegistryOption('format',
2324
help='Diff format to use.',
2325
lazy_registry=('breezy.diff', 'format_registry'),
2326
title='Diff format'),
2328
help='How many lines of context to show.',
2332
aliases = ['di', 'dif']
2333
encoding_type = 'exact'
2336
def run(self, revision=None, file_list=None, diff_options=None,
2337
prefix=None, old=None, new=None, using=None, format=None,
2339
from .diff import (get_trees_and_branches_to_diff_locked,
2346
elif prefix == u'1' or prefix is None:
2349
elif u':' in prefix:
2350
old_label, new_label = prefix.split(u":")
2352
raise errors.BzrCommandError(gettext(
2353
'--prefix expects two values separated by a colon'
2354
' (eg "old/:new/")'))
2356
if revision and len(revision) > 2:
2357
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2358
' one or two revision specifiers'))
2360
if using is not None and format is not None:
2361
raise errors.BzrCommandError(gettext(
2362
'{0} and {1} are mutually exclusive').format(
2363
'--using', '--format'))
2365
(old_tree, new_tree,
2366
old_branch, new_branch,
2367
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2368
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2369
# GNU diff on Windows uses ANSI encoding for filenames
2370
path_encoding = osutils.get_diff_header_encoding()
2371
return show_diff_trees(old_tree, new_tree, self.outf,
2372
specific_files=specific_files,
2373
external_diff_options=diff_options,
2374
old_label=old_label, new_label=new_label,
2375
extra_trees=extra_trees,
2376
path_encoding=path_encoding,
2377
using=using, context=context,
2381
class cmd_deleted(Command):
2382
__doc__ = """List files deleted in the working tree.
2384
# TODO: Show files deleted since a previous revision, or
2385
# between two revisions.
2386
# TODO: Much more efficient way to do this: read in new
2387
# directories with readdir, rather than stating each one. Same
2388
# level of effort but possibly much less IO. (Or possibly not,
2389
# if the directories are very large...)
2390
_see_also = ['status', 'ls']
2391
takes_options = ['directory', 'show-ids']
2394
def run(self, show_ids=False, directory=u'.'):
2395
tree = WorkingTree.open_containing(directory)[0]
2396
self.add_cleanup(tree.lock_read().unlock)
2397
old = tree.basis_tree()
2398
self.add_cleanup(old.lock_read().unlock)
2399
for path, ie in old.iter_entries_by_dir():
2400
if not tree.has_id(ie.file_id):
2401
self.outf.write(path)
2403
self.outf.write(' ')
2404
self.outf.write(ie.file_id)
2405
self.outf.write('\n')
2408
class cmd_modified(Command):
2409
__doc__ = """List files modified in working tree.
2413
_see_also = ['status', 'ls']
2414
takes_options = ['directory', 'null']
2417
def run(self, null=False, directory=u'.'):
2418
tree = WorkingTree.open_containing(directory)[0]
2419
self.add_cleanup(tree.lock_read().unlock)
2420
td = tree.changes_from(tree.basis_tree())
2422
for path, id, kind, text_modified, meta_modified in td.modified:
2424
self.outf.write(path + '\0')
2426
self.outf.write(osutils.quotefn(path) + '\n')
2429
class cmd_added(Command):
2430
__doc__ = """List files added in working tree.
2434
_see_also = ['status', 'ls']
2435
takes_options = ['directory', 'null']
2438
def run(self, null=False, directory=u'.'):
2439
wt = WorkingTree.open_containing(directory)[0]
2440
self.add_cleanup(wt.lock_read().unlock)
2441
basis = wt.basis_tree()
2442
self.add_cleanup(basis.lock_read().unlock)
2443
root_id = wt.get_root_id()
2444
for path in wt.all_versioned_paths():
2445
if basis.has_filename(path):
2449
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2452
self.outf.write(path + '\0')
2454
self.outf.write(osutils.quotefn(path) + '\n')
2457
class cmd_root(Command):
2458
__doc__ = """Show the tree root directory.
2460
The root is the nearest enclosing directory with a .bzr control
2463
takes_args = ['filename?']
2465
def run(self, filename=None):
2466
"""Print the branch root."""
2467
tree = WorkingTree.open_containing(filename)[0]
2468
self.outf.write(tree.basedir + '\n')
2471
def _parse_limit(limitstring):
2473
return int(limitstring)
2475
msg = gettext("The limit argument must be an integer.")
2476
raise errors.BzrCommandError(msg)
2479
def _parse_levels(s):
2483
msg = gettext("The levels argument must be an integer.")
2484
raise errors.BzrCommandError(msg)
2487
class cmd_log(Command):
2488
__doc__ = """Show historical log for a branch or subset of a branch.
2490
log is brz's default tool for exploring the history of a branch.
2491
The branch to use is taken from the first parameter. If no parameters
2492
are given, the branch containing the working directory is logged.
2493
Here are some simple examples::
2495
brz log log the current branch
2496
brz log foo.py log a file in its branch
2497
brz log http://server/branch log a branch on a server
2499
The filtering, ordering and information shown for each revision can
2500
be controlled as explained below. By default, all revisions are
2501
shown sorted (topologically) so that newer revisions appear before
2502
older ones and descendants always appear before ancestors. If displayed,
2503
merged revisions are shown indented under the revision in which they
2508
The log format controls how information about each revision is
2509
displayed. The standard log formats are called ``long``, ``short``
2510
and ``line``. The default is long. See ``brz help log-formats``
2511
for more details on log formats.
2513
The following options can be used to control what information is
2516
-l N display a maximum of N revisions
2517
-n N display N levels of revisions (0 for all, 1 for collapsed)
2518
-v display a status summary (delta) for each revision
2519
-p display a diff (patch) for each revision
2520
--show-ids display revision-ids (and file-ids), not just revnos
2522
Note that the default number of levels to display is a function of the
2523
log format. If the -n option is not used, the standard log formats show
2524
just the top level (mainline).
2526
Status summaries are shown using status flags like A, M, etc. To see
2527
the changes explained using words like ``added`` and ``modified``
2528
instead, use the -vv option.
2532
To display revisions from oldest to newest, use the --forward option.
2533
In most cases, using this option will have little impact on the total
2534
time taken to produce a log, though --forward does not incrementally
2535
display revisions like --reverse does when it can.
2537
:Revision filtering:
2539
The -r option can be used to specify what revision or range of revisions
2540
to filter against. The various forms are shown below::
2542
-rX display revision X
2543
-rX.. display revision X and later
2544
-r..Y display up to and including revision Y
2545
-rX..Y display from X to Y inclusive
2547
See ``brz help revisionspec`` for details on how to specify X and Y.
2548
Some common examples are given below::
2550
-r-1 show just the tip
2551
-r-10.. show the last 10 mainline revisions
2552
-rsubmit:.. show what's new on this branch
2553
-rancestor:path.. show changes since the common ancestor of this
2554
branch and the one at location path
2555
-rdate:yesterday.. show changes since yesterday
2557
When logging a range of revisions using -rX..Y, log starts at
2558
revision Y and searches back in history through the primary
2559
("left-hand") parents until it finds X. When logging just the
2560
top level (using -n1), an error is reported if X is not found
2561
along the way. If multi-level logging is used (-n0), X may be
2562
a nested merge revision and the log will be truncated accordingly.
2566
If parameters are given and the first one is not a branch, the log
2567
will be filtered to show only those revisions that changed the
2568
nominated files or directories.
2570
Filenames are interpreted within their historical context. To log a
2571
deleted file, specify a revision range so that the file existed at
2572
the end or start of the range.
2574
Historical context is also important when interpreting pathnames of
2575
renamed files/directories. Consider the following example:
2577
* revision 1: add tutorial.txt
2578
* revision 2: modify tutorial.txt
2579
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2583
* ``brz log guide.txt`` will log the file added in revision 1
2585
* ``brz log tutorial.txt`` will log the new file added in revision 3
2587
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2588
the original file in revision 2.
2590
* ``brz log -r2 -p guide.txt`` will display an error message as there
2591
was no file called guide.txt in revision 2.
2593
Renames are always followed by log. By design, there is no need to
2594
explicitly ask for this (and no way to stop logging a file back
2595
until it was last renamed).
2599
The --match option can be used for finding revisions that match a
2600
regular expression in a commit message, committer, author or bug.
2601
Specifying the option several times will match any of the supplied
2602
expressions. --match-author, --match-bugs, --match-committer and
2603
--match-message can be used to only match a specific field.
2607
GUI tools and IDEs are often better at exploring history than command
2608
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2609
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2610
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2611
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2613
You may find it useful to add the aliases below to ``breezy.conf``::
2617
top = log -l10 --line
2620
``brz tip`` will then show the latest revision while ``brz top``
2621
will show the last 10 mainline revisions. To see the details of a
2622
particular revision X, ``brz show -rX``.
2624
If you are interested in looking deeper into a particular merge X,
2625
use ``brz log -n0 -rX``.
2627
``brz log -v`` on a branch with lots of history is currently
2628
very slow. A fix for this issue is currently under development.
2629
With or without that fix, it is recommended that a revision range
2630
be given when using the -v option.
2632
brz has a generic full-text matching plugin, brz-search, that can be
2633
used to find revisions matching user names, commit messages, etc.
2634
Among other features, this plugin can find all revisions containing
2635
a list of words but not others.
2637
When exploring non-mainline history on large projects with deep
2638
history, the performance of log can be greatly improved by installing
2639
the historycache plugin. This plugin buffers historical information
2640
trading disk space for faster speed.
2642
takes_args = ['file*']
2643
_see_also = ['log-formats', 'revisionspec']
2646
help='Show from oldest to newest.'),
2648
custom_help('verbose',
2649
help='Show files changed in each revision.'),
2653
type=breezy.option._parse_revision_str,
2655
help='Show just the specified revision.'
2656
' See also "help revisionspec".'),
2658
RegistryOption('authors',
2659
'What names to list as authors - first, all or committer.',
2661
lazy_registry=('breezy.log', 'author_list_registry'),
2665
help='Number of levels to display - 0 for all, 1 for flat.',
2667
type=_parse_levels),
2669
help='Show revisions whose message matches this '
2670
'regular expression.',
2675
help='Limit the output to the first N revisions.',
2680
help='Show changes made in each revision as a patch.'),
2681
Option('include-merged',
2682
help='Show merged revisions like --levels 0 does.'),
2683
Option('include-merges', hidden=True,
2684
help='Historical alias for --include-merged.'),
2685
Option('omit-merges',
2686
help='Do not report commits with more than one parent.'),
2687
Option('exclude-common-ancestry',
2688
help='Display only the revisions that are not part'
2689
' of both ancestries (require -rX..Y).'
2691
Option('signatures',
2692
help='Show digital signature validity.'),
2695
help='Show revisions whose properties match this '
2698
ListOption('match-message',
2699
help='Show revisions whose message matches this '
2702
ListOption('match-committer',
2703
help='Show revisions whose committer matches this '
2706
ListOption('match-author',
2707
help='Show revisions whose authors match this '
2710
ListOption('match-bugs',
2711
help='Show revisions whose bugs match this '
2715
encoding_type = 'replace'
2718
def run(self, file_list=None, timezone='original',
2729
include_merged=None,
2731
exclude_common_ancestry=False,
2735
match_committer=None,
2742
make_log_request_dict,
2743
_get_info_for_log_files,
2745
direction = (forward and 'forward') or 'reverse'
2746
if include_merged is None:
2747
include_merged = False
2748
if (exclude_common_ancestry
2749
and (revision is None or len(revision) != 2)):
2750
raise errors.BzrCommandError(gettext(
2751
'--exclude-common-ancestry requires -r with two revisions'))
2756
raise errors.BzrCommandError(gettext(
2757
'{0} and {1} are mutually exclusive').format(
2758
'--levels', '--include-merged'))
2760
if change is not None:
2762
raise errors.RangeInChangeOption()
2763
if revision is not None:
2764
raise errors.BzrCommandError(gettext(
2765
'{0} and {1} are mutually exclusive').format(
2766
'--revision', '--change'))
2771
filter_by_dir = False
2773
# find the file ids to log and check for directory filtering
2774
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2775
revision, file_list, self.add_cleanup)
2776
for relpath, file_id, kind in file_info_list:
2778
raise errors.BzrCommandError(gettext(
2779
"Path unknown at end or start of revision range: %s") %
2781
# If the relpath is the top of the tree, we log everything
2786
file_ids.append(file_id)
2787
filter_by_dir = filter_by_dir or (
2788
kind in ['directory', 'tree-reference'])
2791
# FIXME ? log the current subdir only RBC 20060203
2792
if revision is not None \
2793
and len(revision) > 0 and revision[0].get_branch():
2794
location = revision[0].get_branch()
2797
dir, relpath = controldir.ControlDir.open_containing(location)
2798
b = dir.open_branch()
2799
self.add_cleanup(b.lock_read().unlock)
2800
rev1, rev2 = _get_revision_range(revision, b, self.name())
2802
if b.get_config_stack().get('validate_signatures_in_log'):
2806
if not gpg.GPGStrategy.verify_signatures_available():
2807
raise errors.GpgmeNotInstalled(None)
2809
# Decide on the type of delta & diff filtering to use
2810
# TODO: add an --all-files option to make this configurable & consistent
2818
diff_type = 'partial'
2822
# Build the log formatter
2823
if log_format is None:
2824
log_format = log.log_formatter_registry.get_default(b)
2825
# Make a non-encoding output to include the diffs - bug 328007
2826
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2827
lf = log_format(show_ids=show_ids, to_file=self.outf,
2828
to_exact_file=unencoded_output,
2829
show_timezone=timezone,
2830
delta_format=get_verbosity_level(),
2832
show_advice=levels is None,
2833
author_list_handler=authors)
2835
# Choose the algorithm for doing the logging. It's annoying
2836
# having multiple code paths like this but necessary until
2837
# the underlying repository format is faster at generating
2838
# deltas or can provide everything we need from the indices.
2839
# The default algorithm - match-using-deltas - works for
2840
# multiple files and directories and is faster for small
2841
# amounts of history (200 revisions say). However, it's too
2842
# slow for logging a single file in a repository with deep
2843
# history, i.e. > 10K revisions. In the spirit of "do no
2844
# evil when adding features", we continue to use the
2845
# original algorithm - per-file-graph - for the "single
2846
# file that isn't a directory without showing a delta" case.
2847
partial_history = revision and b.repository._format.supports_chks
2848
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2849
or delta_type or partial_history)
2853
match_dict[''] = match
2855
match_dict['message'] = match_message
2857
match_dict['committer'] = match_committer
2859
match_dict['author'] = match_author
2861
match_dict['bugs'] = match_bugs
2863
# Build the LogRequest and execute it
2864
if len(file_ids) == 0:
2866
rqst = make_log_request_dict(
2867
direction=direction, specific_fileids=file_ids,
2868
start_revision=rev1, end_revision=rev2, limit=limit,
2869
message_search=message, delta_type=delta_type,
2870
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2871
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2872
signature=signatures, omit_merges=omit_merges,
2874
Logger(b, rqst).show(lf)
2877
def _get_revision_range(revisionspec_list, branch, command_name):
2878
"""Take the input of a revision option and turn it into a revision range.
2880
It returns RevisionInfo objects which can be used to obtain the rev_id's
2881
of the desired revisions. It does some user input validations.
2883
if revisionspec_list is None:
2886
elif len(revisionspec_list) == 1:
2887
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2888
elif len(revisionspec_list) == 2:
2889
start_spec = revisionspec_list[0]
2890
end_spec = revisionspec_list[1]
2891
if end_spec.get_branch() != start_spec.get_branch():
2892
# b is taken from revision[0].get_branch(), and
2893
# show_log will use its revision_history. Having
2894
# different branches will lead to weird behaviors.
2895
raise errors.BzrCommandError(gettext(
2896
"brz %s doesn't accept two revisions in different"
2897
" branches.") % command_name)
2898
if start_spec.spec is None:
2899
# Avoid loading all the history.
2900
rev1 = RevisionInfo(branch, None, None)
2902
rev1 = start_spec.in_history(branch)
2903
# Avoid loading all of history when we know a missing
2904
# end of range means the last revision ...
2905
if end_spec.spec is None:
2906
last_revno, last_revision_id = branch.last_revision_info()
2907
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2909
rev2 = end_spec.in_history(branch)
2911
raise errors.BzrCommandError(gettext(
2912
'brz %s --revision takes one or two values.') % command_name)
2916
def _revision_range_to_revid_range(revision_range):
2919
if revision_range[0] is not None:
2920
rev_id1 = revision_range[0].rev_id
2921
if revision_range[1] is not None:
2922
rev_id2 = revision_range[1].rev_id
2923
return rev_id1, rev_id2
2925
def get_log_format(long=False, short=False, line=False, default='long'):
2926
log_format = default
2930
log_format = 'short'
2936
class cmd_touching_revisions(Command):
2937
__doc__ = """Return revision-ids which affected a particular file.
2939
A more user-friendly interface is "brz log FILE".
2943
takes_args = ["filename"]
2946
def run(self, filename):
2947
tree, relpath = WorkingTree.open_containing(filename)
2948
with tree.lock_read():
2949
touching_revs = log.find_touching_revisions(
2950
tree.branch.repository, tree.branch.last_revision(), tree, relpath)
2951
for revno, revision_id, what in reversed(list(touching_revs)):
2952
self.outf.write("%6d %s\n" % (revno, what))
2955
class cmd_ls(Command):
2956
__doc__ = """List files in a tree.
2959
_see_also = ['status', 'cat']
2960
takes_args = ['path?']
2964
Option('recursive', short_name='R',
2965
help='Recurse into subdirectories.'),
2967
help='Print paths relative to the root of the branch.'),
2968
Option('unknown', short_name='u',
2969
help='Print unknown files.'),
2970
Option('versioned', help='Print versioned files.',
2972
Option('ignored', short_name='i',
2973
help='Print ignored files.'),
2974
Option('kind', short_name='k',
2975
help='List entries of a particular kind: file, directory, symlink.',
2982
def run(self, revision=None, verbose=False,
2983
recursive=False, from_root=False,
2984
unknown=False, versioned=False, ignored=False,
2985
null=False, kind=None, show_ids=False, path=None, directory=None):
2987
if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
2988
raise errors.BzrCommandError(gettext('invalid kind specified'))
2990
if verbose and null:
2991
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2992
all = not (unknown or versioned or ignored)
2994
selection = {'I':ignored, '?':unknown, 'V':versioned}
3000
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3003
tree, branch, relpath = \
3004
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3006
# Calculate the prefix to use
3010
prefix = relpath + '/'
3011
elif fs_path != '.' and not fs_path.endswith('/'):
3012
prefix = fs_path + '/'
3014
if revision is not None or tree is None:
3015
tree = _get_one_revision_tree('ls', revision, branch=branch)
3018
if isinstance(tree, WorkingTree) and tree.supports_views():
3019
view_files = tree.views.lookup_view()
3022
view_str = views.view_display_str(view_files)
3023
note(gettext("Ignoring files outside view. View is %s") % view_str)
3025
self.add_cleanup(tree.lock_read().unlock)
3026
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3027
from_dir=relpath, recursive=recursive):
3028
# Apply additional masking
3029
if not all and not selection[fc]:
3031
if kind is not None and fkind != kind:
3036
fullpath = osutils.pathjoin(relpath, fp)
3039
views.check_path_in_view(tree, fullpath)
3040
except views.FileOutsideView:
3045
fp = osutils.pathjoin(prefix, fp)
3046
kindch = entry.kind_character()
3047
outstring = fp + kindch
3048
ui.ui_factory.clear_term()
3050
outstring = '%-8s %s' % (fc, outstring)
3051
if show_ids and fid is not None:
3052
outstring = "%-50s %s" % (outstring, fid)
3053
self.outf.write(outstring + '\n')
3055
self.outf.write(fp + '\0')
3058
self.outf.write(fid)
3059
self.outf.write('\0')
3067
self.outf.write('%-50s %s\n' % (outstring, my_id))
3069
self.outf.write(outstring + '\n')
3072
class cmd_unknowns(Command):
3073
__doc__ = """List unknown files.
3078
takes_options = ['directory']
3081
def run(self, directory=u'.'):
3082
for f in WorkingTree.open_containing(directory)[0].unknowns():
3083
self.outf.write(osutils.quotefn(f) + '\n')
3086
class cmd_ignore(Command):
3087
__doc__ = """Ignore specified files or patterns.
3089
See ``brz help patterns`` for details on the syntax of patterns.
3091
If a .bzrignore file does not exist, the ignore command
3092
will create one and add the specified files or patterns to the newly
3093
created file. The ignore command will also automatically add the
3094
.bzrignore file to be versioned. Creating a .bzrignore file without
3095
the use of the ignore command will require an explicit add command.
3097
To remove patterns from the ignore list, edit the .bzrignore file.
3098
After adding, editing or deleting that file either indirectly by
3099
using this command or directly by using an editor, be sure to commit
3102
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3103
the global ignore file can be found in the application data directory as
3104
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3105
Global ignores are not touched by this command. The global ignore file
3106
can be edited directly using an editor.
3108
Patterns prefixed with '!' are exceptions to ignore patterns and take
3109
precedence over regular ignores. Such exceptions are used to specify
3110
files that should be versioned which would otherwise be ignored.
3112
Patterns prefixed with '!!' act as regular ignore patterns, but have
3113
precedence over the '!' exception patterns.
3117
* Ignore patterns containing shell wildcards must be quoted from
3120
* Ignore patterns starting with "#" act as comments in the ignore file.
3121
To ignore patterns that begin with that character, use the "RE:" prefix.
3124
Ignore the top level Makefile::
3126
brz ignore ./Makefile
3128
Ignore .class files in all directories...::
3130
brz ignore "*.class"
3132
...but do not ignore "special.class"::
3134
brz ignore "!special.class"
3136
Ignore files whose name begins with the "#" character::
3140
Ignore .o files under the lib directory::
3142
brz ignore "lib/**/*.o"
3144
Ignore .o files under the lib directory::
3146
brz ignore "RE:lib/.*\\.o"
3148
Ignore everything but the "debian" toplevel directory::
3150
brz ignore "RE:(?!debian/).*"
3152
Ignore everything except the "local" toplevel directory,
3153
but always ignore autosave files ending in ~, even under local/::
3156
brz ignore "!./local"
3160
_see_also = ['status', 'ignored', 'patterns']
3161
takes_args = ['name_pattern*']
3162
takes_options = ['directory',
3163
Option('default-rules',
3164
help='Display the default ignore rules that brz uses.')
3167
def run(self, name_pattern_list=None, default_rules=None,
3169
from breezy import ignores
3170
if default_rules is not None:
3171
# dump the default rules and exit
3172
for pattern in ignores.USER_DEFAULTS:
3173
self.outf.write("%s\n" % pattern)
3175
if not name_pattern_list:
3176
raise errors.BzrCommandError(gettext("ignore requires at least one "
3177
"NAME_PATTERN or --default-rules."))
3178
name_pattern_list = [globbing.normalize_pattern(p)
3179
for p in name_pattern_list]
3181
bad_patterns_count = 0
3182
for p in name_pattern_list:
3183
if not globbing.Globster.is_pattern_valid(p):
3184
bad_patterns_count += 1
3185
bad_patterns += ('\n %s' % p)
3187
msg = (ngettext('Invalid ignore pattern found. %s',
3188
'Invalid ignore patterns found. %s',
3189
bad_patterns_count) % bad_patterns)
3190
ui.ui_factory.show_error(msg)
3191
raise lazy_regex.InvalidPattern('')
3192
for name_pattern in name_pattern_list:
3193
if (name_pattern[0] == '/' or
3194
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3195
raise errors.BzrCommandError(gettext(
3196
"NAME_PATTERN should not be an absolute path"))
3197
tree, relpath = WorkingTree.open_containing(directory)
3198
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3199
ignored = globbing.Globster(name_pattern_list)
3201
self.add_cleanup(tree.lock_read().unlock)
3202
for entry in tree.list_files():
3206
if ignored.match(filename):
3207
matches.append(filename)
3208
if len(matches) > 0:
3209
self.outf.write(gettext("Warning: the following files are version "
3210
"controlled and match your ignore pattern:\n%s"
3211
"\nThese files will continue to be version controlled"
3212
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3215
class cmd_ignored(Command):
3216
__doc__ = """List ignored files and the patterns that matched them.
3218
List all the ignored files and the ignore pattern that caused the file to
3221
Alternatively, to list just the files::
3226
encoding_type = 'replace'
3227
_see_also = ['ignore', 'ls']
3228
takes_options = ['directory']
3231
def run(self, directory=u'.'):
3232
tree = WorkingTree.open_containing(directory)[0]
3233
self.add_cleanup(tree.lock_read().unlock)
3234
for path, file_class, kind, file_id, entry in tree.list_files():
3235
if file_class != 'I':
3237
## XXX: Slightly inefficient since this was already calculated
3238
pat = tree.is_ignored(path)
3239
self.outf.write('%-50s %s\n' % (path, pat))
3242
class cmd_lookup_revision(Command):
3243
__doc__ = """Lookup the revision-id from a revision-number
3246
brz lookup-revision 33
3249
takes_args = ['revno']
3250
takes_options = ['directory']
3253
def run(self, revno, directory=u'.'):
3257
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3259
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3260
self.outf.write("%s\n" % revid)
3263
class cmd_export(Command):
3264
__doc__ = """Export current or past revision to a destination directory or archive.
3266
If no revision is specified this exports the last committed revision.
3268
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3269
given, try to find the format with the extension. If no extension
3270
is found exports to a directory (equivalent to --format=dir).
3272
If root is supplied, it will be used as the root directory inside
3273
container formats (tar, zip, etc). If it is not supplied it will default
3274
to the exported filename. The root option has no effect for 'dir' format.
3276
If branch is omitted then the branch containing the current working
3277
directory will be used.
3279
Note: Export of tree with non-ASCII filenames to zip is not supported.
3281
================= =========================
3282
Supported formats Autodetected by extension
3283
================= =========================
3286
tbz2 .tar.bz2, .tbz2
3289
================= =========================
3292
encoding_type = 'exact'
3293
takes_args = ['dest', 'branch_or_subdir?']
3294
takes_options = ['directory',
3296
help="Type of file to export to.",
3299
Option('filters', help='Apply content filters to export the '
3300
'convenient form.'),
3303
help="Name of the root directory inside the exported file."),
3304
Option('per-file-timestamps',
3305
help='Set modification time of files to that of the last '
3306
'revision in which it was changed.'),
3307
Option('uncommitted',
3308
help='Export the working tree contents rather than that of the '
3311
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3312
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3314
from .export import export
3316
if branch_or_subdir is None:
3317
branch_or_subdir = directory
3319
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3321
if tree is not None:
3322
self.add_cleanup(tree.lock_read().unlock)
3326
raise errors.BzrCommandError(
3327
gettext("--uncommitted requires a working tree"))
3330
export_tree = _get_one_revision_tree(
3331
'export', revision, branch=b,
3335
from breezy.filter_tree import ContentFilterTree
3336
export_tree = ContentFilterTree(
3337
export_tree, export_tree._content_filter_stack)
3339
# Try asking the tree first..
3340
if not per_file_timestamps:
3341
chunks = export_tree.archive(
3342
dest, format, root=root, subdir=subdir)
3345
self.outf.writelines(chunks)
3348
with tempfile.NamedTemporaryFile(delete=False) as temp:
3349
temp.writelines(chunks)
3350
os.rename(temp.name, dest)
3351
except errors.NoSuchExportFormat:
3356
export(export_tree, dest, format, root, subdir,
3357
per_file_timestamps=per_file_timestamps)
3358
except errors.NoSuchExportFormat as e:
3359
raise errors.BzrCommandError(
3360
gettext('Unsupported export format: %s') % e.format)
3363
class cmd_cat(Command):
3364
__doc__ = """Write the contents of a file as of a given revision to standard output.
3366
If no revision is nominated, the last revision is used.
3368
Note: Take care to redirect standard output when using this command on a
3373
takes_options = ['directory',
3374
Option('name-from-revision', help='The path name in the old tree.'),
3375
Option('filters', help='Apply content filters to display the '
3376
'convenience form.'),
3379
takes_args = ['filename']
3380
encoding_type = 'exact'
3383
def run(self, filename, revision=None, name_from_revision=False,
3384
filters=False, directory=None):
3385
if revision is not None and len(revision) != 1:
3386
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3387
" one revision specifier"))
3388
tree, branch, relpath = \
3389
_open_directory_or_containing_tree_or_branch(filename, directory)
3390
self.add_cleanup(branch.lock_read().unlock)
3391
return self._run(tree, branch, relpath, filename, revision,
3392
name_from_revision, filters)
3394
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3397
tree = b.basis_tree()
3398
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3399
self.add_cleanup(rev_tree.lock_read().unlock)
3401
old_file_id = rev_tree.path2id(relpath)
3403
# TODO: Split out this code to something that generically finds the
3404
# best id for a path across one or more trees; it's like
3405
# find_ids_across_trees but restricted to find just one. -- mbp
3407
if name_from_revision:
3408
# Try in revision if requested
3409
if old_file_id is None:
3410
raise errors.BzrCommandError(gettext(
3411
"{0!r} is not present in revision {1}").format(
3412
filename, rev_tree.get_revision_id()))
3414
actual_file_id = old_file_id
3416
cur_file_id = tree.path2id(relpath)
3417
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3418
actual_file_id = cur_file_id
3419
elif old_file_id is not None:
3420
actual_file_id = old_file_id
3422
raise errors.BzrCommandError(gettext(
3423
"{0!r} is not present in revision {1}").format(
3424
filename, rev_tree.get_revision_id()))
3425
relpath = rev_tree.id2path(actual_file_id)
3427
from .filter_tree import ContentFilterTree
3428
filter_tree = ContentFilterTree(rev_tree,
3429
rev_tree._content_filter_stack)
3430
content = filter_tree.get_file_text(relpath, actual_file_id)
3432
content = rev_tree.get_file_text(relpath, actual_file_id)
3434
self.outf.write(content)
3437
class cmd_local_time_offset(Command):
3438
__doc__ = """Show the offset in seconds from GMT to local time."""
3442
self.outf.write("%s\n" % osutils.local_time_offset())
3446
class cmd_commit(Command):
3447
__doc__ = """Commit changes into a new revision.
3449
An explanatory message needs to be given for each commit. This is
3450
often done by using the --message option (getting the message from the
3451
command line) or by using the --file option (getting the message from
3452
a file). If neither of these options is given, an editor is opened for
3453
the user to enter the message. To see the changed files in the
3454
boilerplate text loaded into the editor, use the --show-diff option.
3456
By default, the entire tree is committed and the person doing the
3457
commit is assumed to be the author. These defaults can be overridden
3462
If selected files are specified, only changes to those files are
3463
committed. If a directory is specified then the directory and
3464
everything within it is committed.
3466
When excludes are given, they take precedence over selected files.
3467
For example, to commit only changes within foo, but not changes
3470
brz commit foo -x foo/bar
3472
A selective commit after a merge is not yet supported.
3476
If the author of the change is not the same person as the committer,
3477
you can specify the author's name using the --author option. The
3478
name should be in the same format as a committer-id, e.g.
3479
"John Doe <jdoe@example.com>". If there is more than one author of
3480
the change you can specify the option multiple times, once for each
3485
A common mistake is to forget to add a new file or directory before
3486
running the commit command. The --strict option checks for unknown
3487
files and aborts the commit if any are found. More advanced pre-commit
3488
checks can be implemented by defining hooks. See ``brz help hooks``
3493
If you accidentially commit the wrong changes or make a spelling
3494
mistake in the commit message say, you can use the uncommit command
3495
to undo it. See ``brz help uncommit`` for details.
3497
Hooks can also be configured to run after a commit. This allows you
3498
to trigger updates to external systems like bug trackers. The --fixes
3499
option can be used to record the association between a revision and
3500
one or more bugs. See ``brz help bugs`` for details.
3503
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3504
takes_args = ['selected*']
3506
ListOption('exclude', type=text_type, short_name='x',
3507
help="Do not consider changes made to a given path."),
3508
Option('message', type=text_type,
3510
help="Description of the new revision."),
3513
help='Commit even if nothing has changed.'),
3514
Option('file', type=text_type,
3517
help='Take commit message from this file.'),
3519
help="Refuse to commit if there are unknown "
3520
"files in the working tree."),
3521
Option('commit-time', type=text_type,
3522
help="Manually set a commit time using commit date "
3523
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3524
ListOption('fixes', type=text_type,
3525
help="Mark a bug as being fixed by this revision "
3526
"(see \"brz help bugs\")."),
3527
ListOption('author', type=text_type,
3528
help="Set the author's name, if it's different "
3529
"from the committer."),
3531
help="Perform a local commit in a bound "
3532
"branch. Local commits are not pushed to "
3533
"the master branch until a normal commit "
3536
Option('show-diff', short_name='p',
3537
help='When no message is supplied, show the diff along'
3538
' with the status summary in the message editor.'),
3540
help='When committing to a foreign version control '
3541
'system do not push data that can not be natively '
3544
aliases = ['ci', 'checkin']
3546
def _iter_bug_fix_urls(self, fixes, branch):
3547
default_bugtracker = None
3548
# Configure the properties for bug fixing attributes.
3549
for fixed_bug in fixes:
3550
tokens = fixed_bug.split(':')
3551
if len(tokens) == 1:
3552
if default_bugtracker is None:
3553
branch_config = branch.get_config_stack()
3554
default_bugtracker = branch_config.get(
3556
if default_bugtracker is None:
3557
raise errors.BzrCommandError(gettext(
3558
"No tracker specified for bug %s. Use the form "
3559
"'tracker:id' or specify a default bug tracker "
3560
"using the `bugtracker` option.\nSee "
3561
"\"brz help bugs\" for more information on this "
3562
"feature. Commit refused.") % fixed_bug)
3563
tag = default_bugtracker
3565
elif len(tokens) != 2:
3566
raise errors.BzrCommandError(gettext(
3567
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3568
"See \"brz help bugs\" for more information on this "
3569
"feature.\nCommit refused.") % fixed_bug)
3571
tag, bug_id = tokens
3573
yield bugtracker.get_bug_url(tag, branch, bug_id)
3574
except bugtracker.UnknownBugTrackerAbbreviation:
3575
raise errors.BzrCommandError(gettext(
3576
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3577
except bugtracker.MalformedBugIdentifier as e:
3578
raise errors.BzrCommandError(gettext(
3579
u"%s\nCommit refused.") % (e,))
3581
def run(self, message=None, file=None, verbose=False, selected_list=None,
3582
unchanged=False, strict=False, local=False, fixes=None,
3583
author=None, show_diff=False, exclude=None, commit_time=None,
3585
from .commit import (
3588
from .errors import (
3592
from .msgeditor import (
3593
edit_commit_message_encoded,
3594
generate_commit_message_template,
3595
make_commit_message_template_encoded,
3599
commit_stamp = offset = None
3600
if commit_time is not None:
3602
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3603
except ValueError as e:
3604
raise errors.BzrCommandError(gettext(
3605
"Could not parse --commit-time: " + str(e)))
3609
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3610
if selected_list == ['']:
3611
# workaround - commit of root of tree should be exactly the same
3612
# as just default commit in that tree, and succeed even though
3613
# selected-file merge commit is not done yet
3618
bug_property = bugtracker.encode_fixes_bug_urls(
3619
self._iter_bug_fix_urls(fixes, tree.branch))
3621
properties['bugs'] = bug_property
3623
if local and not tree.branch.get_bound_location():
3624
raise errors.LocalRequiresBoundBranch()
3626
if message is not None:
3628
file_exists = osutils.lexists(message)
3629
except UnicodeError:
3630
# The commit message contains unicode characters that can't be
3631
# represented in the filesystem encoding, so that can't be a
3636
'The commit message is a file name: "%(f)s".\n'
3637
'(use --file "%(f)s" to take commit message from that file)'
3639
ui.ui_factory.show_warning(warning_msg)
3641
message = message.replace('\r\n', '\n')
3642
message = message.replace('\r', '\n')
3644
raise errors.BzrCommandError(gettext(
3645
"please specify either --message or --file"))
3647
def get_message(commit_obj):
3648
"""Callback to get commit message"""
3650
with open(file) as f:
3651
my_message = f.read().decode(osutils.get_user_encoding())
3652
elif message is not None:
3653
my_message = message
3655
# No message supplied: make one up.
3656
# text is the status of the tree
3657
text = make_commit_message_template_encoded(tree,
3658
selected_list, diff=show_diff,
3659
output_encoding=osutils.get_user_encoding())
3660
# start_message is the template generated from hooks
3661
# XXX: Warning - looks like hooks return unicode,
3662
# make_commit_message_template_encoded returns user encoding.
3663
# We probably want to be using edit_commit_message instead to
3665
my_message = set_commit_message(commit_obj)
3666
if my_message is None:
3667
start_message = generate_commit_message_template(commit_obj)
3668
my_message = edit_commit_message_encoded(text,
3669
start_message=start_message)
3670
if my_message is None:
3671
raise errors.BzrCommandError(gettext("please specify a commit"
3672
" message with either --message or --file"))
3673
if my_message == "":
3674
raise errors.BzrCommandError(gettext("Empty commit message specified."
3675
" Please specify a commit message with either"
3676
" --message or --file or leave a blank message"
3677
" with --message \"\"."))
3680
# The API permits a commit with a filter of [] to mean 'select nothing'
3681
# but the command line should not do that.
3682
if not selected_list:
3683
selected_list = None
3685
tree.commit(message_callback=get_message,
3686
specific_files=selected_list,
3687
allow_pointless=unchanged, strict=strict, local=local,
3688
reporter=None, verbose=verbose, revprops=properties,
3689
authors=author, timestamp=commit_stamp,
3691
exclude=tree.safe_relpath_files(exclude),
3693
except PointlessCommit:
3694
raise errors.BzrCommandError(gettext("No changes to commit."
3695
" Please 'brz add' the files you want to commit, or use"
3696
" --unchanged to force an empty commit."))
3697
except ConflictsInTree:
3698
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3699
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3701
except StrictCommitFailed:
3702
raise errors.BzrCommandError(gettext("Commit refused because there are"
3703
" unknown files in the working tree."))
3704
except errors.BoundBranchOutOfDate as e:
3705
e.extra_help = (gettext("\n"
3706
'To commit to master branch, run update and then commit.\n'
3707
'You can also pass --local to commit to continue working '
3712
class cmd_check(Command):
3713
__doc__ = """Validate working tree structure, branch consistency and repository history.
3715
This command checks various invariants about branch and repository storage
3716
to detect data corruption or brz bugs.
3718
The working tree and branch checks will only give output if a problem is
3719
detected. The output fields of the repository check are:
3722
This is just the number of revisions checked. It doesn't
3726
This is just the number of versionedfiles checked. It
3727
doesn't indicate a problem.
3729
unreferenced ancestors
3730
Texts that are ancestors of other texts, but
3731
are not properly referenced by the revision ancestry. This is a
3732
subtle problem that Bazaar can work around.
3735
This is the total number of unique file contents
3736
seen in the checked revisions. It does not indicate a problem.
3739
This is the total number of repeated texts seen
3740
in the checked revisions. Texts can be repeated when their file
3741
entries are modified, but the file contents are not. It does not
3744
If no restrictions are specified, all Bazaar data that is found at the given
3745
location will be checked.
3749
Check the tree and branch at 'foo'::
3751
brz check --tree --branch foo
3753
Check only the repository at 'bar'::
3755
brz check --repo bar
3757
Check everything at 'baz'::
3762
_see_also = ['reconcile']
3763
takes_args = ['path?']
3764
takes_options = ['verbose',
3765
Option('branch', help="Check the branch related to the"
3766
" current directory."),
3767
Option('repo', help="Check the repository related to the"
3768
" current directory."),
3769
Option('tree', help="Check the working tree related to"
3770
" the current directory.")]
3772
def run(self, path=None, verbose=False, branch=False, repo=False,
3774
from .check import check_dwim
3777
if not branch and not repo and not tree:
3778
branch = repo = tree = True
3779
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3782
class cmd_upgrade(Command):
3783
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3785
When the default format has changed after a major new release of
3786
Bazaar, you may be informed during certain operations that you
3787
should upgrade. Upgrading to a newer format may improve performance
3788
or make new features available. It may however limit interoperability
3789
with older repositories or with older versions of Bazaar.
3791
If you wish to upgrade to a particular format rather than the
3792
current default, that can be specified using the --format option.
3793
As a consequence, you can use the upgrade command this way to
3794
"downgrade" to an earlier format, though some conversions are
3795
a one way process (e.g. changing from the 1.x default to the
3796
2.x default) so downgrading is not always possible.
3798
A backup.bzr.~#~ directory is created at the start of the conversion
3799
process (where # is a number). By default, this is left there on
3800
completion. If the conversion fails, delete the new .bzr directory
3801
and rename this one back in its place. Use the --clean option to ask
3802
for the backup.bzr directory to be removed on successful conversion.
3803
Alternatively, you can delete it by hand if everything looks good
3806
If the location given is a shared repository, dependent branches
3807
are also converted provided the repository converts successfully.
3808
If the conversion of a branch fails, remaining branches are still
3811
For more information on upgrades, see the Bazaar Upgrade Guide,
3812
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3815
_see_also = ['check', 'reconcile', 'formats']
3816
takes_args = ['url?']
3818
RegistryOption('format',
3819
help='Upgrade to a specific format. See "brz help'
3820
' formats" for details.',
3821
lazy_registry=('breezy.controldir', 'format_registry'),
3822
converter=lambda name: controldir.format_registry.make_controldir(name),
3823
value_switches=True, title='Branch format'),
3825
help='Remove the backup.bzr directory if successful.'),
3827
help="Show what would be done, but don't actually do anything."),
3830
def run(self, url='.', format=None, clean=False, dry_run=False):
3831
from .upgrade import upgrade
3832
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3834
if len(exceptions) == 1:
3835
# Compatibility with historical behavior
3841
class cmd_whoami(Command):
3842
__doc__ = """Show or set brz user id.
3845
Show the email of the current user::
3849
Set the current user::
3851
brz whoami "Frank Chu <fchu@example.com>"
3853
takes_options = [ 'directory',
3855
help='Display email address only.'),
3857
help='Set identity for the current branch instead of '
3860
takes_args = ['name?']
3861
encoding_type = 'replace'
3864
def run(self, email=False, branch=False, name=None, directory=None):
3866
if directory is None:
3867
# use branch if we're inside one; otherwise global config
3869
c = Branch.open_containing(u'.')[0].get_config_stack()
3870
except errors.NotBranchError:
3871
c = _mod_config.GlobalStack()
3873
c = Branch.open(directory).get_config_stack()
3874
identity = c.get('email')
3876
self.outf.write(_mod_config.extract_email_address(identity)
3879
self.outf.write(identity + '\n')
3883
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3886
# display a warning if an email address isn't included in the given name.
3888
_mod_config.extract_email_address(name)
3889
except _mod_config.NoEmailInUsername as e:
3890
warning('"%s" does not seem to contain an email address. '
3891
'This is allowed, but not recommended.', name)
3893
# use global config unless --branch given
3895
if directory is None:
3896
c = Branch.open_containing(u'.')[0].get_config_stack()
3898
b = Branch.open(directory)
3899
self.add_cleanup(b.lock_write().unlock)
3900
c = b.get_config_stack()
3902
c = _mod_config.GlobalStack()
3903
c.set('email', name)
3906
class cmd_nick(Command):
3907
__doc__ = """Print or set the branch nickname.
3909
If unset, the colocated branch name is used for colocated branches, and
3910
the branch directory name is used for other branches. To print the
3911
current nickname, execute with no argument.
3913
Bound branches use the nickname of its master branch unless it is set
3917
_see_also = ['info']
3918
takes_args = ['nickname?']
3919
takes_options = ['directory']
3920
def run(self, nickname=None, directory=u'.'):
3921
branch = Branch.open_containing(directory)[0]
3922
if nickname is None:
3923
self.printme(branch)
3925
branch.nick = nickname
3928
def printme(self, branch):
3929
self.outf.write('%s\n' % branch.nick)
3932
class cmd_alias(Command):
3933
__doc__ = """Set/unset and display aliases.
3936
Show the current aliases::
3940
Show the alias specified for 'll'::
3944
Set an alias for 'll'::
3946
brz alias ll="log --line -r-10..-1"
3948
To remove an alias for 'll'::
3950
brz alias --remove ll
3953
takes_args = ['name?']
3955
Option('remove', help='Remove the alias.'),
3958
def run(self, name=None, remove=False):
3960
self.remove_alias(name)
3962
self.print_aliases()
3964
equal_pos = name.find('=')
3966
self.print_alias(name)
3968
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3970
def remove_alias(self, alias_name):
3971
if alias_name is None:
3972
raise errors.BzrCommandError(gettext(
3973
'brz alias --remove expects an alias to remove.'))
3974
# If alias is not found, print something like:
3975
# unalias: foo: not found
3976
c = _mod_config.GlobalConfig()
3977
c.unset_alias(alias_name)
3980
def print_aliases(self):
3981
"""Print out the defined aliases in a similar format to bash."""
3982
aliases = _mod_config.GlobalConfig().get_aliases()
3983
for key, value in sorted(viewitems(aliases)):
3984
self.outf.write('brz alias %s="%s"\n' % (key, value))
3987
def print_alias(self, alias_name):
3988
from .commands import get_alias
3989
alias = get_alias(alias_name)
3991
self.outf.write("brz alias: %s: not found\n" % alias_name)
3994
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3996
def set_alias(self, alias_name, alias_command):
3997
"""Save the alias in the global config."""
3998
c = _mod_config.GlobalConfig()
3999
c.set_alias(alias_name, alias_command)
4002
class cmd_selftest(Command):
4003
__doc__ = """Run internal test suite.
4005
If arguments are given, they are regular expressions that say which tests
4006
should run. Tests matching any expression are run, and other tests are
4009
Alternatively if --first is given, matching tests are run first and then
4010
all other tests are run. This is useful if you have been working in a
4011
particular area, but want to make sure nothing else was broken.
4013
If --exclude is given, tests that match that regular expression are
4014
excluded, regardless of whether they match --first or not.
4016
To help catch accidential dependencies between tests, the --randomize
4017
option is useful. In most cases, the argument used is the word 'now'.
4018
Note that the seed used for the random number generator is displayed
4019
when this option is used. The seed can be explicitly passed as the
4020
argument to this option if required. This enables reproduction of the
4021
actual ordering used if and when an order sensitive problem is encountered.
4023
If --list-only is given, the tests that would be run are listed. This is
4024
useful when combined with --first, --exclude and/or --randomize to
4025
understand their impact. The test harness reports "Listed nn tests in ..."
4026
instead of "Ran nn tests in ..." when list mode is enabled.
4028
If the global option '--no-plugins' is given, plugins are not loaded
4029
before running the selftests. This has two effects: features provided or
4030
modified by plugins will not be tested, and tests provided by plugins will
4033
Tests that need working space on disk use a common temporary directory,
4034
typically inside $TMPDIR or /tmp.
4036
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4037
into a pdb postmortem session.
4039
The --coverage=DIRNAME global option produces a report with covered code
4043
Run only tests relating to 'ignore'::
4047
Disable plugins and list tests as they're run::
4049
brz --no-plugins selftest -v
4051
# NB: this is used from the class without creating an instance, which is
4052
# why it does not have a self parameter.
4053
def get_transport_type(typestring):
4054
"""Parse and return a transport specifier."""
4055
if typestring == "sftp":
4056
from .tests import stub_sftp
4057
return stub_sftp.SFTPAbsoluteServer
4058
elif typestring == "memory":
4059
from .tests import test_server
4060
return memory.MemoryServer
4061
elif typestring == "fakenfs":
4062
from .tests import test_server
4063
return test_server.FakeNFSServer
4064
msg = "No known transport type %s. Supported types are: sftp\n" %\
4066
raise errors.BzrCommandError(msg)
4069
takes_args = ['testspecs*']
4070
takes_options = ['verbose',
4072
help='Stop when one test fails.',
4076
help='Use a different transport by default '
4077
'throughout the test suite.',
4078
type=get_transport_type),
4080
help='Run the benchmarks rather than selftests.',
4082
Option('lsprof-timed',
4083
help='Generate lsprof output for benchmarked'
4084
' sections of code.'),
4085
Option('lsprof-tests',
4086
help='Generate lsprof output for each test.'),
4088
help='Run all tests, but run specified tests first.',
4092
help='List the tests instead of running them.'),
4093
RegistryOption('parallel',
4094
help="Run the test suite in parallel.",
4095
lazy_registry=('breezy.tests', 'parallel_registry'),
4096
value_switches=False,
4098
Option('randomize', type=text_type, argname="SEED",
4099
help='Randomize the order of tests using the given'
4100
' seed or "now" for the current time.'),
4101
ListOption('exclude', type=text_type, argname="PATTERN",
4103
help='Exclude tests that match this regular'
4106
help='Output test progress via subunit v1.'),
4108
help='Output test progress via subunit v2.'),
4109
Option('strict', help='Fail on missing dependencies or '
4111
Option('load-list', type=text_type, argname='TESTLISTFILE',
4112
help='Load a test id list from a text file.'),
4113
ListOption('debugflag', type=text_type, short_name='E',
4114
help='Turn on a selftest debug flag.'),
4115
ListOption('starting-with', type=text_type, argname='TESTID',
4116
param_name='starting_with', short_name='s',
4118
'Load only the tests starting with TESTID.'),
4120
help="By default we disable fsync and fdatasync"
4121
" while running the test suite.")
4123
encoding_type = 'replace'
4126
Command.__init__(self)
4127
self.additional_selftest_args = {}
4129
def run(self, testspecs_list=None, verbose=False, one=False,
4130
transport=None, benchmark=None,
4132
first=False, list_only=False,
4133
randomize=None, exclude=None, strict=False,
4134
load_list=None, debugflag=None, starting_with=None, subunit1=False,
4135
subunit2=False, parallel=None, lsprof_tests=False, sync=False):
4137
# During selftest, disallow proxying, as it can cause severe
4138
# performance penalties and is only needed for thread
4139
# safety. The selftest command is assumed to not use threads
4140
# too heavily. The call should be as early as possible, as
4141
# error reporting for past duplicate imports won't have useful
4143
if sys.version_info[0] < 3:
4144
# TODO(pad.lv/1696545): Allow proxying on Python 3, since
4145
# disallowing it currently leads to failures in many places.
4146
lazy_import.disallow_proxying()
4151
raise errors.BzrCommandError("tests not available. Install the "
4152
"breezy tests to run the breezy testsuite.")
4154
if testspecs_list is not None:
4155
pattern = '|'.join(testspecs_list)
4160
from .tests import SubUnitBzrRunnerv1
4162
raise errors.BzrCommandError(gettext(
4163
"subunit not available. subunit needs to be installed "
4164
"to use --subunit."))
4165
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
4166
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4167
# stdout, which would corrupt the subunit stream.
4168
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4169
# following code can be deleted when it's sufficiently deployed
4170
# -- vila/mgz 20100514
4171
if (sys.platform == "win32"
4172
and getattr(sys.stdout, 'fileno', None) is not None):
4174
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4177
from .tests import SubUnitBzrRunnerv2
4179
raise errors.BzrCommandError(gettext(
4180
"subunit not available. subunit "
4181
"needs to be installed to use --subunit2."))
4182
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
4185
self.additional_selftest_args.setdefault(
4186
'suite_decorators', []).append(parallel)
4188
raise errors.BzrCommandError(gettext(
4189
"--benchmark is no longer supported from brz 2.2; "
4190
"use bzr-usertest instead"))
4191
test_suite_factory = None
4193
exclude_pattern = None
4195
exclude_pattern = '(' + '|'.join(exclude) + ')'
4197
self._disable_fsync()
4198
selftest_kwargs = {"verbose": verbose,
4200
"stop_on_failure": one,
4201
"transport": transport,
4202
"test_suite_factory": test_suite_factory,
4203
"lsprof_timed": lsprof_timed,
4204
"lsprof_tests": lsprof_tests,
4205
"matching_tests_first": first,
4206
"list_only": list_only,
4207
"random_seed": randomize,
4208
"exclude_pattern": exclude_pattern,
4210
"load_list": load_list,
4211
"debug_flags": debugflag,
4212
"starting_with": starting_with
4214
selftest_kwargs.update(self.additional_selftest_args)
4216
# Make deprecation warnings visible, unless -Werror is set
4217
cleanup = symbol_versioning.activate_deprecation_warnings(
4220
result = tests.selftest(**selftest_kwargs)
4223
return int(not result)
4225
def _disable_fsync(self):
4226
"""Change the 'os' functionality to not synchronize."""
4227
self._orig_fsync = getattr(os, 'fsync', None)
4228
if self._orig_fsync is not None:
4229
os.fsync = lambda filedes: None
4230
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4231
if self._orig_fdatasync is not None:
4232
os.fdatasync = lambda filedes: None
4235
class cmd_version(Command):
4236
__doc__ = """Show version of brz."""
4238
encoding_type = 'replace'
4240
Option("short", help="Print just the version number."),
4244
def run(self, short=False):
4245
from .version import show_version
4247
self.outf.write(breezy.version_string + '\n')
4249
show_version(to_file=self.outf)
4252
class cmd_rocks(Command):
4253
__doc__ = """Statement of optimism."""
4259
self.outf.write(gettext("It sure does!\n"))
4262
class cmd_find_merge_base(Command):
4263
__doc__ = """Find and print a base revision for merging two branches."""
4264
# TODO: Options to specify revisions on either side, as if
4265
# merging only part of the history.
4266
takes_args = ['branch', 'other']
4270
def run(self, branch, other):
4271
from .revision import ensure_null
4273
branch1 = Branch.open_containing(branch)[0]
4274
branch2 = Branch.open_containing(other)[0]
4275
self.add_cleanup(branch1.lock_read().unlock)
4276
self.add_cleanup(branch2.lock_read().unlock)
4277
last1 = ensure_null(branch1.last_revision())
4278
last2 = ensure_null(branch2.last_revision())
4280
graph = branch1.repository.get_graph(branch2.repository)
4281
base_rev_id = graph.find_unique_lca(last1, last2)
4283
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4286
class cmd_merge(Command):
4287
__doc__ = """Perform a three-way merge.
4289
The source of the merge can be specified either in the form of a branch,
4290
or in the form of a path to a file containing a merge directive generated
4291
with brz send. If neither is specified, the default is the upstream branch
4292
or the branch most recently merged using --remember. The source of the
4293
merge may also be specified in the form of a path to a file in another
4294
branch: in this case, only the modifications to that file are merged into
4295
the current working tree.
4297
When merging from a branch, by default brz will try to merge in all new
4298
work from the other branch, automatically determining an appropriate base
4299
revision. If this fails, you may need to give an explicit base.
4301
To pick a different ending revision, pass "--revision OTHER". brz will
4302
try to merge in all new work up to and including revision OTHER.
4304
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4305
through OTHER, excluding BASE but including OTHER, will be merged. If this
4306
causes some revisions to be skipped, i.e. if the destination branch does
4307
not already contain revision BASE, such a merge is commonly referred to as
4308
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4309
cherrypicks. The changes look like a normal commit, and the history of the
4310
changes from the other branch is not stored in the commit.
4312
Revision numbers are always relative to the source branch.
4314
Merge will do its best to combine the changes in two branches, but there
4315
are some kinds of problems only a human can fix. When it encounters those,
4316
it will mark a conflict. A conflict means that you need to fix something,
4317
before you can commit.
4319
Use brz resolve when you have fixed a problem. See also brz conflicts.
4321
If there is no default branch set, the first merge will set it (use
4322
--no-remember to avoid setting it). After that, you can omit the branch
4323
to use the default. To change the default, use --remember. The value will
4324
only be saved if the remote location can be accessed.
4326
The results of the merge are placed into the destination working
4327
directory, where they can be reviewed (with brz diff), tested, and then
4328
committed to record the result of the merge.
4330
merge refuses to run if there are any uncommitted changes, unless
4331
--force is given. If --force is given, then the changes from the source
4332
will be merged with the current working tree, including any uncommitted
4333
changes in the tree. The --force option can also be used to create a
4334
merge revision which has more than two parents.
4336
If one would like to merge changes from the working tree of the other
4337
branch without merging any committed revisions, the --uncommitted option
4340
To select only some changes to merge, use "merge -i", which will prompt
4341
you to apply each diff hunk and file change, similar to "shelve".
4344
To merge all new revisions from brz.dev::
4346
brz merge ../brz.dev
4348
To merge changes up to and including revision 82 from brz.dev::
4350
brz merge -r 82 ../brz.dev
4352
To merge the changes introduced by 82, without previous changes::
4354
brz merge -r 81..82 ../brz.dev
4356
To apply a merge directive contained in /tmp/merge::
4358
brz merge /tmp/merge
4360
To create a merge revision with three parents from two branches
4361
feature1a and feature1b:
4363
brz merge ../feature1a
4364
brz merge ../feature1b --force
4365
brz commit -m 'revision with three parents'
4368
encoding_type = 'exact'
4369
_see_also = ['update', 'remerge', 'status-flags', 'send']
4370
takes_args = ['location?']
4375
help='Merge even if the destination tree has uncommitted changes.'),
4379
Option('show-base', help="Show base revision text in "
4381
Option('uncommitted', help='Apply uncommitted changes'
4382
' from a working copy, instead of branch changes.'),
4383
Option('pull', help='If the destination is already'
4384
' completely merged into the source, pull from the'
4385
' source rather than merging. When this happens,'
4386
' you do not need to commit the result.'),
4387
custom_help('directory',
4388
help='Branch to merge into, '
4389
'rather than the one containing the working directory.'),
4390
Option('preview', help='Instead of merging, show a diff of the'
4392
Option('interactive', help='Select changes interactively.',
4396
def run(self, location=None, revision=None, force=False,
4397
merge_type=None, show_base=False, reprocess=None, remember=None,
4398
uncommitted=False, pull=False,
4403
if merge_type is None:
4404
merge_type = _mod_merge.Merge3Merger
4406
if directory is None: directory = u'.'
4407
possible_transports = []
4409
allow_pending = True
4410
verified = 'inapplicable'
4412
tree = WorkingTree.open_containing(directory)[0]
4413
if tree.branch.revno() == 0:
4414
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4415
'https://bugs.launchpad.net/bzr/+bug/308562'))
4418
basis_tree = tree.revision_tree(tree.last_revision())
4419
except errors.NoSuchRevision:
4420
basis_tree = tree.basis_tree()
4422
# die as quickly as possible if there are uncommitted changes
4424
if tree.has_changes():
4425
raise errors.UncommittedChanges(tree)
4427
view_info = _get_view_info_for_change_reporter(tree)
4428
change_reporter = delta._ChangeReporter(
4429
unversioned_filter=tree.is_ignored, view_info=view_info)
4430
pb = ui.ui_factory.nested_progress_bar()
4431
self.add_cleanup(pb.finished)
4432
self.add_cleanup(tree.lock_write().unlock)
4433
if location is not None:
4435
mergeable = bundle.read_mergeable_from_url(location,
4436
possible_transports=possible_transports)
4437
except errors.NotABundle:
4441
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4442
' with bundles or merge directives.'))
4444
if revision is not None:
4445
raise errors.BzrCommandError(gettext(
4446
'Cannot use -r with merge directives or bundles'))
4447
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4450
if merger is None and uncommitted:
4451
if revision is not None and len(revision) > 0:
4452
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4453
' --revision at the same time.'))
4454
merger = self.get_merger_from_uncommitted(tree, location, None)
4455
allow_pending = False
4458
merger, allow_pending = self._get_merger_from_branch(tree,
4459
location, revision, remember, possible_transports, None)
4461
merger.merge_type = merge_type
4462
merger.reprocess = reprocess
4463
merger.show_base = show_base
4464
self.sanity_check_merger(merger)
4465
if (merger.base_rev_id == merger.other_rev_id and
4466
merger.other_rev_id is not None):
4467
# check if location is a nonexistent file (and not a branch) to
4468
# disambiguate the 'Nothing to do'
4469
if merger.interesting_files:
4470
if not merger.other_tree.has_filename(
4471
merger.interesting_files[0]):
4472
note(gettext("merger: ") + str(merger))
4473
raise errors.PathsDoNotExist([location])
4474
note(gettext('Nothing to do.'))
4476
if pull and not preview:
4477
if merger.interesting_files is not None:
4478
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4479
if (merger.base_rev_id == tree.last_revision()):
4480
result = tree.pull(merger.other_branch, False,
4481
merger.other_rev_id)
4482
result.report(self.outf)
4484
if merger.this_basis is None:
4485
raise errors.BzrCommandError(gettext(
4486
"This branch has no commits."
4487
" (perhaps you would prefer 'brz pull')"))
4489
return self._do_preview(merger)
4491
return self._do_interactive(merger)
4493
return self._do_merge(merger, change_reporter, allow_pending,
4496
def _get_preview(self, merger):
4497
tree_merger = merger.make_merger()
4498
tt = tree_merger.make_preview_transform()
4499
self.add_cleanup(tt.finalize)
4500
result_tree = tt.get_preview_tree()
4503
def _do_preview(self, merger):
4504
from .diff import show_diff_trees
4505
result_tree = self._get_preview(merger)
4506
path_encoding = osutils.get_diff_header_encoding()
4507
show_diff_trees(merger.this_tree, result_tree, self.outf,
4508
old_label='', new_label='',
4509
path_encoding=path_encoding)
4511
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4512
merger.change_reporter = change_reporter
4513
conflict_count = merger.do_merge()
4515
merger.set_pending()
4516
if verified == 'failed':
4517
warning('Preview patch does not match changes')
4518
if conflict_count != 0:
4523
def _do_interactive(self, merger):
4524
"""Perform an interactive merge.
4526
This works by generating a preview tree of the merge, then using
4527
Shelver to selectively remove the differences between the working tree
4528
and the preview tree.
4530
from . import shelf_ui
4531
result_tree = self._get_preview(merger)
4532
writer = breezy.option.diff_writer_registry.get()
4533
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4534
reporter=shelf_ui.ApplyReporter(),
4535
diff_writer=writer(self.outf))
4541
def sanity_check_merger(self, merger):
4542
if (merger.show_base and
4543
not merger.merge_type is _mod_merge.Merge3Merger):
4544
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4545
" merge type. %s") % merger.merge_type)
4546
if merger.reprocess is None:
4547
if merger.show_base:
4548
merger.reprocess = False
4550
# Use reprocess if the merger supports it
4551
merger.reprocess = merger.merge_type.supports_reprocess
4552
if merger.reprocess and not merger.merge_type.supports_reprocess:
4553
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4554
" for merge type %s.") %
4556
if merger.reprocess and merger.show_base:
4557
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4560
if (merger.merge_type.requires_file_merge_plan and
4561
(not getattr(merger.this_tree, 'plan_file_merge', None) or
4562
not getattr(merger.other_tree, 'plan_file_merge', None) or
4563
(merger.base_tree is not None and
4564
not getattr(merger.base_tree, 'plan_file_merge', None)))):
4565
raise errors.BzrCommandError(
4566
gettext('Plan file merge unsupported: '
4567
'Merge type incompatible with tree formats.'))
4569
def _get_merger_from_branch(self, tree, location, revision, remember,
4570
possible_transports, pb):
4571
"""Produce a merger from a location, assuming it refers to a branch."""
4572
# find the branch locations
4573
other_loc, user_location = self._select_branch_location(tree, location,
4575
if revision is not None and len(revision) == 2:
4576
base_loc, _unused = self._select_branch_location(tree,
4577
location, revision, 0)
4579
base_loc = other_loc
4581
other_branch, other_path = Branch.open_containing(other_loc,
4582
possible_transports)
4583
if base_loc == other_loc:
4584
base_branch = other_branch
4586
base_branch, base_path = Branch.open_containing(base_loc,
4587
possible_transports)
4588
# Find the revision ids
4589
other_revision_id = None
4590
base_revision_id = None
4591
if revision is not None:
4592
if len(revision) >= 1:
4593
other_revision_id = revision[-1].as_revision_id(other_branch)
4594
if len(revision) == 2:
4595
base_revision_id = revision[0].as_revision_id(base_branch)
4596
if other_revision_id is None:
4597
other_revision_id = _mod_revision.ensure_null(
4598
other_branch.last_revision())
4599
# Remember where we merge from. We need to remember if:
4600
# - user specify a location (and we don't merge from the parent
4602
# - user ask to remember or there is no previous location set to merge
4603
# from and user didn't ask to *not* remember
4604
if (user_location is not None
4606
or (remember is None
4607
and tree.branch.get_submit_branch() is None)))):
4608
tree.branch.set_submit_branch(other_branch.base)
4609
# Merge tags (but don't set them in the master branch yet, the user
4610
# might revert this merge). Commit will propagate them.
4611
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4612
merger = _mod_merge.Merger.from_revision_ids(tree,
4613
other_revision_id, base_revision_id, other_branch, base_branch)
4614
if other_path != '':
4615
allow_pending = False
4616
merger.interesting_files = [other_path]
4618
allow_pending = True
4619
return merger, allow_pending
4621
def get_merger_from_uncommitted(self, tree, location, pb):
4622
"""Get a merger for uncommitted changes.
4624
:param tree: The tree the merger should apply to.
4625
:param location: The location containing uncommitted changes.
4626
:param pb: The progress bar to use for showing progress.
4628
location = self._select_branch_location(tree, location)[0]
4629
other_tree, other_path = WorkingTree.open_containing(location)
4630
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4631
if other_path != '':
4632
merger.interesting_files = [other_path]
4635
def _select_branch_location(self, tree, user_location, revision=None,
4637
"""Select a branch location, according to possible inputs.
4639
If provided, branches from ``revision`` are preferred. (Both
4640
``revision`` and ``index`` must be supplied.)
4642
Otherwise, the ``location`` parameter is used. If it is None, then the
4643
``submit`` or ``parent`` location is used, and a note is printed.
4645
:param tree: The working tree to select a branch for merging into
4646
:param location: The location entered by the user
4647
:param revision: The revision parameter to the command
4648
:param index: The index to use for the revision parameter. Negative
4649
indices are permitted.
4650
:return: (selected_location, user_location). The default location
4651
will be the user-entered location.
4653
if (revision is not None and index is not None
4654
and revision[index] is not None):
4655
branch = revision[index].get_branch()
4656
if branch is not None:
4657
return branch, branch
4658
if user_location is None:
4659
location = self._get_remembered(tree, 'Merging from')
4661
location = user_location
4662
return location, user_location
4664
def _get_remembered(self, tree, verb_string):
4665
"""Use tree.branch's parent if none was supplied.
4667
Report if the remembered location was used.
4669
stored_location = tree.branch.get_submit_branch()
4670
stored_location_type = "submit"
4671
if stored_location is None:
4672
stored_location = tree.branch.get_parent()
4673
stored_location_type = "parent"
4674
mutter("%s", stored_location)
4675
if stored_location is None:
4676
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4677
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4678
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4679
stored_location_type, display_url))
4680
return stored_location
4683
class cmd_remerge(Command):
4684
__doc__ = """Redo a merge.
4686
Use this if you want to try a different merge technique while resolving
4687
conflicts. Some merge techniques are better than others, and remerge
4688
lets you try different ones on different files.
4690
The options for remerge have the same meaning and defaults as the ones for
4691
merge. The difference is that remerge can (only) be run when there is a
4692
pending merge, and it lets you specify particular files.
4695
Re-do the merge of all conflicted files, and show the base text in
4696
conflict regions, in addition to the usual THIS and OTHER texts::
4698
brz remerge --show-base
4700
Re-do the merge of "foobar", using the weave merge algorithm, with
4701
additional processing to reduce the size of conflict regions::
4703
brz remerge --merge-type weave --reprocess foobar
4705
takes_args = ['file*']
4710
help="Show base revision text in conflicts."),
4713
def run(self, file_list=None, merge_type=None, show_base=False,
4715
from .conflicts import restore
4716
if merge_type is None:
4717
merge_type = _mod_merge.Merge3Merger
4718
tree, file_list = WorkingTree.open_containing_paths(file_list)
4719
self.add_cleanup(tree.lock_write().unlock)
4720
parents = tree.get_parent_ids()
4721
if len(parents) != 2:
4722
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4723
" merges. Not cherrypicking or"
4725
repository = tree.branch.repository
4726
interesting_files = None
4728
conflicts = tree.conflicts()
4729
if file_list is not None:
4730
interesting_files = set()
4731
for filename in file_list:
4732
if not tree.is_versioned(filename):
4733
raise errors.NotVersionedError(filename)
4734
interesting_files.add(filename)
4735
if tree.kind(filename) != "directory":
4738
for path, ie in tree.iter_entries_by_dir(specific_files=[filename]):
4739
interesting_files.add(path)
4740
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4742
# Remerge only supports resolving contents conflicts
4743
allowed_conflicts = ('text conflict', 'contents conflict')
4744
restore_files = [c.path for c in conflicts
4745
if c.typestring in allowed_conflicts]
4746
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
4747
tree.set_conflicts(ConflictList(new_conflicts))
4748
if file_list is not None:
4749
restore_files = file_list
4750
for filename in restore_files:
4752
restore(tree.abspath(filename))
4753
except errors.NotConflicted:
4755
# Disable pending merges, because the file texts we are remerging
4756
# have not had those merges performed. If we use the wrong parents
4757
# list, we imply that the working tree text has seen and rejected
4758
# all the changes from the other tree, when in fact those changes
4759
# have not yet been seen.
4760
tree.set_parent_ids(parents[:1])
4762
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4763
merger.interesting_files = interesting_files
4764
merger.merge_type = merge_type
4765
merger.show_base = show_base
4766
merger.reprocess = reprocess
4767
conflicts = merger.do_merge()
4769
tree.set_parent_ids(parents)
4776
class cmd_revert(Command):
4778
Set files in the working tree back to the contents of a previous revision.
4780
Giving a list of files will revert only those files. Otherwise, all files
4781
will be reverted. If the revision is not specified with '--revision', the
4782
working tree basis revision is used. A revert operation affects only the
4783
working tree, not any revision history like the branch and repository or
4784
the working tree basis revision.
4786
To remove only some changes, without reverting to a prior version, use
4787
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4788
will remove the changes introduced by the second last commit (-2), without
4789
affecting the changes introduced by the last commit (-1). To remove
4790
certain changes on a hunk-by-hunk basis, see the shelve command.
4791
To update the branch to a specific revision or the latest revision and
4792
update the working tree accordingly while preserving local changes, see the
4795
Uncommitted changes to files that are reverted will be discarded.
4796
Howver, by default, any files that have been manually changed will be
4797
backed up first. (Files changed only by merge are not backed up.) Backup
4798
files have '.~#~' appended to their name, where # is a number.
4800
When you provide files, you can use their current pathname or the pathname
4801
from the target revision. So you can use revert to "undelete" a file by
4802
name. If you name a directory, all the contents of that directory will be
4805
If you have newly added files since the target revision, they will be
4806
removed. If the files to be removed have been changed, backups will be
4807
created as above. Directories containing unknown files will not be
4810
The working tree contains a list of revisions that have been merged but
4811
not yet committed. These revisions will be included as additional parents
4812
of the next commit. Normally, using revert clears that list as well as
4813
reverting the files. If any files are specified, revert leaves the list
4814
of uncommitted merges alone and reverts only the files. Use ``brz revert
4815
.`` in the tree root to revert all files but keep the recorded merges,
4816
and ``brz revert --forget-merges`` to clear the pending merge list without
4817
reverting any files.
4819
Using "brz revert --forget-merges", it is possible to apply all of the
4820
changes from a branch in a single revision. To do this, perform the merge
4821
as desired. Then doing revert with the "--forget-merges" option will keep
4822
the content of the tree as it was, but it will clear the list of pending
4823
merges. The next commit will then contain all of the changes that are
4824
present in the other branch, but without any other parent revisions.
4825
Because this technique forgets where these changes originated, it may
4826
cause additional conflicts on later merges involving the same source and
4830
_see_also = ['cat', 'export', 'merge', 'shelve']
4833
Option('no-backup', "Do not save backups of reverted files."),
4834
Option('forget-merges',
4835
'Remove pending merge marker, without changing any files.'),
4837
takes_args = ['file*']
4839
def run(self, revision=None, no_backup=False, file_list=None,
4840
forget_merges=None):
4841
tree, file_list = WorkingTree.open_containing_paths(file_list)
4842
self.add_cleanup(tree.lock_tree_write().unlock)
4844
tree.set_parent_ids(tree.get_parent_ids()[:1])
4846
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4849
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4850
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4851
tree.revert(file_list, rev_tree, not no_backup, None,
4852
report_changes=True)
4855
class cmd_assert_fail(Command):
4856
__doc__ = """Test reporting of assertion failures"""
4857
# intended just for use in testing
4862
raise AssertionError("always fails")
4865
class cmd_help(Command):
4866
__doc__ = """Show help on a command or other topic.
4869
_see_also = ['topics']
4871
Option('long', 'Show help on all commands.'),
4873
takes_args = ['topic?']
4874
aliases = ['?', '--help', '-?', '-h']
4877
def run(self, topic=None, long=False):
4879
if topic is None and long:
4881
breezy.help.help(topic)
4884
class cmd_shell_complete(Command):
4885
__doc__ = """Show appropriate completions for context.
4887
For a list of all available commands, say 'brz shell-complete'.
4889
takes_args = ['context?']
4894
def run(self, context=None):
4895
from . import shellcomplete
4896
shellcomplete.shellcomplete(context)
4899
class cmd_missing(Command):
4900
__doc__ = """Show unmerged/unpulled revisions between two branches.
4902
OTHER_BRANCH may be local or remote.
4904
To filter on a range of revisions, you can use the command -r begin..end
4905
-r revision requests a specific revision, -r ..end or -r begin.. are
4909
1 - some missing revisions
4910
0 - no missing revisions
4914
Determine the missing revisions between this and the branch at the
4915
remembered pull location::
4919
Determine the missing revisions between this and another branch::
4921
brz missing http://server/branch
4923
Determine the missing revisions up to a specific revision on the other
4926
brz missing -r ..-10
4928
Determine the missing revisions up to a specific revision on this
4931
brz missing --my-revision ..-10
4934
_see_also = ['merge', 'pull']
4935
takes_args = ['other_branch?']
4938
Option('reverse', 'Reverse the order of revisions.'),
4940
'Display changes in the local branch only.'),
4941
Option('this', 'Same as --mine-only.'),
4942
Option('theirs-only',
4943
'Display changes in the remote branch only.'),
4944
Option('other', 'Same as --theirs-only.'),
4948
custom_help('revision',
4949
help='Filter on other branch revisions (inclusive). '
4950
'See "help revisionspec" for details.'),
4951
Option('my-revision',
4952
type=_parse_revision_str,
4953
help='Filter on local branch revisions (inclusive). '
4954
'See "help revisionspec" for details.'),
4955
Option('include-merged',
4956
'Show all revisions in addition to the mainline ones.'),
4957
Option('include-merges', hidden=True,
4958
help='Historical alias for --include-merged.'),
4960
encoding_type = 'replace'
4963
def run(self, other_branch=None, reverse=False, mine_only=False,
4965
log_format=None, long=False, short=False, line=False,
4966
show_ids=False, verbose=False, this=False, other=False,
4967
include_merged=None, revision=None, my_revision=None,
4969
from breezy.missing import find_unmerged, iter_log_revisions
4974
if include_merged is None:
4975
include_merged = False
4980
# TODO: We should probably check that we don't have mine-only and
4981
# theirs-only set, but it gets complicated because we also have
4982
# this and other which could be used.
4989
local_branch = Branch.open_containing(directory)[0]
4990
self.add_cleanup(local_branch.lock_read().unlock)
4992
parent = local_branch.get_parent()
4993
if other_branch is None:
4994
other_branch = parent
4995
if other_branch is None:
4996
raise errors.BzrCommandError(gettext("No peer location known"
4998
display_url = urlutils.unescape_for_display(parent,
5000
message(gettext("Using saved parent location: {0}\n").format(
5003
remote_branch = Branch.open(other_branch)
5004
if remote_branch.base == local_branch.base:
5005
remote_branch = local_branch
5007
self.add_cleanup(remote_branch.lock_read().unlock)
5009
local_revid_range = _revision_range_to_revid_range(
5010
_get_revision_range(my_revision, local_branch,
5013
remote_revid_range = _revision_range_to_revid_range(
5014
_get_revision_range(revision,
5015
remote_branch, self.name()))
5017
local_extra, remote_extra = find_unmerged(
5018
local_branch, remote_branch, restrict,
5019
backward=not reverse,
5020
include_merged=include_merged,
5021
local_revid_range=local_revid_range,
5022
remote_revid_range=remote_revid_range)
5024
if log_format is None:
5025
registry = log.log_formatter_registry
5026
log_format = registry.get_default(local_branch)
5027
lf = log_format(to_file=self.outf,
5029
show_timezone='original')
5032
if local_extra and not theirs_only:
5033
message(ngettext("You have %d extra revision:\n",
5034
"You have %d extra revisions:\n",
5038
if local_branch.supports_tags():
5039
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5040
for revision in iter_log_revisions(local_extra,
5041
local_branch.repository,
5044
lf.log_revision(revision)
5045
printed_local = True
5048
printed_local = False
5050
if remote_extra and not mine_only:
5051
if printed_local is True:
5053
message(ngettext("You are missing %d revision:\n",
5054
"You are missing %d revisions:\n",
5055
len(remote_extra)) %
5057
if remote_branch.supports_tags():
5058
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5059
for revision in iter_log_revisions(remote_extra,
5060
remote_branch.repository,
5063
lf.log_revision(revision)
5066
if mine_only and not local_extra:
5067
# We checked local, and found nothing extra
5068
message(gettext('This branch has no new revisions.\n'))
5069
elif theirs_only and not remote_extra:
5070
# We checked remote, and found nothing extra
5071
message(gettext('Other branch has no new revisions.\n'))
5072
elif not (mine_only or theirs_only or local_extra or
5074
# We checked both branches, and neither one had extra
5076
message(gettext("Branches are up to date.\n"))
5078
if not status_code and parent is None and other_branch is not None:
5079
self.add_cleanup(local_branch.lock_write().unlock)
5080
# handle race conditions - a parent might be set while we run.
5081
if local_branch.get_parent() is None:
5082
local_branch.set_parent(remote_branch.base)
5086
class cmd_pack(Command):
5087
__doc__ = """Compress the data within a repository.
5089
This operation compresses the data within a bazaar repository. As
5090
bazaar supports automatic packing of repository, this operation is
5091
normally not required to be done manually.
5093
During the pack operation, bazaar takes a backup of existing repository
5094
data, i.e. pack files. This backup is eventually removed by bazaar
5095
automatically when it is safe to do so. To save disk space by removing
5096
the backed up pack files, the --clean-obsolete-packs option may be
5099
Warning: If you use --clean-obsolete-packs and your machine crashes
5100
during or immediately after repacking, you may be left with a state
5101
where the deletion has been written to disk but the new packs have not
5102
been. In this case the repository may be unusable.
5105
_see_also = ['repositories']
5106
takes_args = ['branch_or_repo?']
5108
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5111
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5112
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5114
branch = dir.open_branch()
5115
repository = branch.repository
5116
except errors.NotBranchError:
5117
repository = dir.open_repository()
5118
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5121
class cmd_plugins(Command):
5122
__doc__ = """List the installed plugins.
5124
This command displays the list of installed plugins including
5125
version of plugin and a short description of each.
5127
--verbose shows the path where each plugin is located.
5129
A plugin is an external component for Bazaar that extends the
5130
revision control system, by adding or replacing code in Bazaar.
5131
Plugins can do a variety of things, including overriding commands,
5132
adding new commands, providing additional network transports and
5133
customizing log output.
5135
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5136
for further information on plugins including where to find them and how to
5137
install them. Instructions are also provided there on how to write new
5138
plugins using the Python programming language.
5140
takes_options = ['verbose']
5143
def run(self, verbose=False):
5144
from . import plugin
5145
# Don't give writelines a generator as some codecs don't like that
5146
self.outf.writelines(
5147
list(plugin.describe_plugins(show_paths=verbose)))
5150
class cmd_testament(Command):
5151
__doc__ = """Show testament (signing-form) of a revision."""
5154
Option('long', help='Produce long-format testament.'),
5156
help='Produce a strict-format testament.')]
5157
takes_args = ['branch?']
5158
encoding_type = 'exact'
5160
def run(self, branch=u'.', revision=None, long=False, strict=False):
5161
from .testament import Testament, StrictTestament
5163
testament_class = StrictTestament
5165
testament_class = Testament
5167
b = Branch.open_containing(branch)[0]
5169
b = Branch.open(branch)
5170
self.add_cleanup(b.lock_read().unlock)
5171
if revision is None:
5172
rev_id = b.last_revision()
5174
rev_id = revision[0].as_revision_id(b)
5175
t = testament_class.from_revision(b.repository, rev_id)
5177
self.outf.writelines(t.as_text_lines())
5179
self.outf.write(t.as_short_text())
5182
class cmd_annotate(Command):
5183
__doc__ = """Show the origin of each line in a file.
5185
This prints out the given file with an annotation on the left side
5186
indicating which revision, author and date introduced the change.
5188
If the origin is the same for a run of consecutive lines, it is
5189
shown only at the top, unless the --all option is given.
5191
# TODO: annotate directories; showing when each file was last changed
5192
# TODO: if the working copy is modified, show annotations on that
5193
# with new uncommitted lines marked
5194
aliases = ['ann', 'blame', 'praise']
5195
takes_args = ['filename']
5196
takes_options = [Option('all', help='Show annotations on all lines.'),
5197
Option('long', help='Show commit date in annotations.'),
5202
encoding_type = 'exact'
5205
def run(self, filename, all=False, long=False, revision=None,
5206
show_ids=False, directory=None):
5207
from .annotate import (
5210
wt, branch, relpath = \
5211
_open_directory_or_containing_tree_or_branch(filename, directory)
5213
self.add_cleanup(wt.lock_read().unlock)
5215
self.add_cleanup(branch.lock_read().unlock)
5216
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5217
self.add_cleanup(tree.lock_read().unlock)
5218
if wt is not None and revision is None:
5219
file_id = wt.path2id(relpath)
5221
file_id = tree.path2id(relpath)
5223
raise errors.NotVersionedError(filename)
5224
if wt is not None and revision is None:
5225
# If there is a tree and we're not annotating historical
5226
# versions, annotate the working tree's content.
5227
annotate_file_tree(wt, relpath, self.outf, long, all,
5228
show_ids=show_ids, file_id=file_id)
5230
annotate_file_tree(tree, relpath, self.outf, long, all,
5231
show_ids=show_ids, branch=branch, file_id=file_id)
5234
class cmd_re_sign(Command):
5235
__doc__ = """Create a digital signature for an existing revision."""
5236
# TODO be able to replace existing ones.
5238
hidden = True # is this right ?
5239
takes_args = ['revision_id*']
5240
takes_options = ['directory', 'revision']
5242
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5243
if revision_id_list is not None and revision is not None:
5244
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5245
if revision_id_list is None and revision is None:
5246
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5247
b = WorkingTree.open_containing(directory)[0].branch
5248
self.add_cleanup(b.lock_write().unlock)
5249
return self._run(b, revision_id_list, revision)
5251
def _run(self, b, revision_id_list, revision):
5252
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5253
if revision_id_list is not None:
5254
b.repository.start_write_group()
5256
for revision_id in revision_id_list:
5257
revision_id = cache_utf8.encode(revision_id)
5258
b.repository.sign_revision(revision_id, gpg_strategy)
5260
b.repository.abort_write_group()
5263
b.repository.commit_write_group()
5264
elif revision is not None:
5265
if len(revision) == 1:
5266
revno, rev_id = revision[0].in_history(b)
5267
b.repository.start_write_group()
5269
b.repository.sign_revision(rev_id, gpg_strategy)
5271
b.repository.abort_write_group()
5274
b.repository.commit_write_group()
5275
elif len(revision) == 2:
5276
# are they both on rh- if so we can walk between them
5277
# might be nice to have a range helper for arbitrary
5278
# revision paths. hmm.
5279
from_revno, from_revid = revision[0].in_history(b)
5280
to_revno, to_revid = revision[1].in_history(b)
5281
if to_revid is None:
5282
to_revno = b.revno()
5283
if from_revno is None or to_revno is None:
5284
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5285
b.repository.start_write_group()
5287
for revno in range(from_revno, to_revno + 1):
5288
b.repository.sign_revision(b.get_rev_id(revno),
5291
b.repository.abort_write_group()
5294
b.repository.commit_write_group()
5296
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5299
class cmd_bind(Command):
5300
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5301
If no branch is supplied, rebind to the last bound location.
5303
Once converted into a checkout, commits must succeed on the master branch
5304
before they will be applied to the local branch.
5306
Bound branches use the nickname of its master branch unless it is set
5307
locally, in which case binding will update the local nickname to be
5311
_see_also = ['checkouts', 'unbind']
5312
takes_args = ['location?']
5313
takes_options = ['directory']
5315
def run(self, location=None, directory=u'.'):
5316
b, relpath = Branch.open_containing(directory)
5317
if location is None:
5319
location = b.get_old_bound_location()
5320
except errors.UpgradeRequired:
5321
raise errors.BzrCommandError(gettext('No location supplied. '
5322
'This format does not remember old locations.'))
5324
if location is None:
5325
if b.get_bound_location() is not None:
5326
raise errors.BzrCommandError(
5327
gettext('Branch is already bound'))
5329
raise errors.BzrCommandError(
5330
gettext('No location supplied'
5331
' and no previous location known'))
5332
b_other = Branch.open(location)
5335
except errors.DivergedBranches:
5336
raise errors.BzrCommandError(gettext('These branches have diverged.'
5337
' Try merging, and then bind again.'))
5338
if b.get_config().has_explicit_nickname():
5339
b.nick = b_other.nick
5342
class cmd_unbind(Command):
5343
__doc__ = """Convert the current checkout into a regular branch.
5345
After unbinding, the local branch is considered independent and subsequent
5346
commits will be local only.
5349
_see_also = ['checkouts', 'bind']
5351
takes_options = ['directory']
5353
def run(self, directory=u'.'):
5354
b, relpath = Branch.open_containing(directory)
5356
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5359
class cmd_uncommit(Command):
5360
__doc__ = """Remove the last committed revision.
5362
--verbose will print out what is being removed.
5363
--dry-run will go through all the motions, but not actually
5366
If --revision is specified, uncommit revisions to leave the branch at the
5367
specified revision. For example, "brz uncommit -r 15" will leave the
5368
branch at revision 15.
5370
Uncommit leaves the working tree ready for a new commit. The only change
5371
it may make is to restore any pending merges that were present before
5375
# TODO: jam 20060108 Add an option to allow uncommit to remove
5376
# unreferenced information in 'branch-as-repository' branches.
5377
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5378
# information in shared branches as well.
5379
_see_also = ['commit']
5380
takes_options = ['verbose', 'revision',
5381
Option('dry-run', help='Don\'t actually make changes.'),
5382
Option('force', help='Say yes to all questions.'),
5384
help='Keep tags that point to removed revisions.'),
5386
help="Only remove the commits from the local branch"
5387
" when in a checkout."
5390
takes_args = ['location?']
5392
encoding_type = 'replace'
5394
def run(self, location=None, dry_run=False, verbose=False,
5395
revision=None, force=False, local=False, keep_tags=False):
5396
if location is None:
5398
control, relpath = controldir.ControlDir.open_containing(location)
5400
tree = control.open_workingtree()
5402
except (errors.NoWorkingTree, errors.NotLocalUrl):
5404
b = control.open_branch()
5406
if tree is not None:
5407
self.add_cleanup(tree.lock_write().unlock)
5409
self.add_cleanup(b.lock_write().unlock)
5410
return self._run(b, tree, dry_run, verbose, revision, force,
5413
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5415
from .log import log_formatter, show_log
5416
from .uncommit import uncommit
5418
last_revno, last_rev_id = b.last_revision_info()
5421
if revision is None:
5423
rev_id = last_rev_id
5425
# 'brz uncommit -r 10' actually means uncommit
5426
# so that the final tree is at revno 10.
5427
# but breezy.uncommit.uncommit() actually uncommits
5428
# the revisions that are supplied.
5429
# So we need to offset it by one
5430
revno = revision[0].in_history(b).revno + 1
5431
if revno <= last_revno:
5432
rev_id = b.get_rev_id(revno)
5434
if rev_id is None or _mod_revision.is_null(rev_id):
5435
self.outf.write(gettext('No revisions to uncommit.\n'))
5438
lf = log_formatter('short',
5440
show_timezone='original')
5445
direction='forward',
5446
start_revision=revno,
5447
end_revision=last_revno)
5450
self.outf.write(gettext('Dry-run, pretending to remove'
5451
' the above revisions.\n'))
5453
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5456
if not ui.ui_factory.confirm_action(
5457
gettext(u'Uncommit these revisions'),
5458
'breezy.builtins.uncommit',
5460
self.outf.write(gettext('Canceled\n'))
5463
mutter('Uncommitting from {%s} to {%s}',
5464
last_rev_id, rev_id)
5465
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5466
revno=revno, local=local, keep_tags=keep_tags)
5467
self.outf.write(gettext('You can restore the old tip by running:\n'
5468
' brz pull . -r revid:%s\n') % last_rev_id)
5471
class cmd_break_lock(Command):
5472
__doc__ = """Break a dead lock.
5474
This command breaks a lock on a repository, branch, working directory or
5477
CAUTION: Locks should only be broken when you are sure that the process
5478
holding the lock has been stopped.
5480
You can get information on what locks are open via the 'brz info
5481
[location]' command.
5485
brz break-lock brz+ssh://example.com/brz/foo
5486
brz break-lock --conf ~/.bazaar
5489
takes_args = ['location?']
5492
help='LOCATION is the directory where the config lock is.'),
5494
help='Do not ask for confirmation before breaking the lock.'),
5497
def run(self, location=None, config=False, force=False):
5498
if location is None:
5501
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5503
{'breezy.lockdir.break': True})
5505
conf = _mod_config.LockableConfig(file_name=location)
5508
control, relpath = controldir.ControlDir.open_containing(location)
5510
control.break_lock()
5511
except NotImplementedError:
5515
class cmd_wait_until_signalled(Command):
5516
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5518
This just prints a line to signal when it is ready, then blocks on stdin.
5524
self.outf.write("running\n")
5526
sys.stdin.readline()
5529
class cmd_serve(Command):
5530
__doc__ = """Run the brz server."""
5532
aliases = ['server']
5536
help='Serve on stdin/out for use from inetd or sshd.'),
5537
RegistryOption('protocol',
5538
help="Protocol to serve.",
5539
lazy_registry=('breezy.transport', 'transport_server_registry'),
5540
value_switches=True),
5542
help='Listen for connections on nominated address.', type=text_type),
5544
help='Listen for connections on nominated port. Passing 0 as '
5545
'the port number will result in a dynamically allocated '
5546
'port. The default port depends on the protocol.',
5548
custom_help('directory',
5549
help='Serve contents of this directory.'),
5550
Option('allow-writes',
5551
help='By default the server is a readonly server. Supplying '
5552
'--allow-writes enables write access to the contents of '
5553
'the served directory and below. Note that ``brz serve`` '
5554
'does not perform authentication, so unless some form of '
5555
'external authentication is arranged supplying this '
5556
'option leads to global uncontrolled write access to your '
5559
Option('client-timeout', type=float,
5560
help='Override the default idle client timeout (5min).'),
5563
def run(self, listen=None, port=None, inet=False, directory=None,
5564
allow_writes=False, protocol=None, client_timeout=None):
5565
from . import transport
5566
if directory is None:
5567
directory = osutils.getcwd()
5568
if protocol is None:
5569
protocol = transport.transport_server_registry.get()
5570
url = transport.location_to_url(directory)
5571
if not allow_writes:
5572
url = 'readonly+' + url
5573
t = transport.get_transport_from_url(url)
5574
protocol(t, listen, port, inet, client_timeout)
5577
class cmd_join(Command):
5578
__doc__ = """Combine a tree into its containing tree.
5580
This command requires the target tree to be in a rich-root format.
5582
The TREE argument should be an independent tree, inside another tree, but
5583
not part of it. (Such trees can be produced by "brz split", but also by
5584
running "brz branch" with the target inside a tree.)
5586
The result is a combined tree, with the subtree no longer an independent
5587
part. This is marked as a merge of the subtree into the containing tree,
5588
and all history is preserved.
5591
_see_also = ['split']
5592
takes_args = ['tree']
5594
Option('reference', help='Join by reference.', hidden=True),
5597
def run(self, tree, reference=False):
5598
from breezy.mutabletree import BadReferenceTarget
5599
sub_tree = WorkingTree.open(tree)
5600
parent_dir = osutils.dirname(sub_tree.basedir)
5601
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5602
repo = containing_tree.branch.repository
5603
if not repo.supports_rich_root():
5604
raise errors.BzrCommandError(gettext(
5605
"Can't join trees because %s doesn't support rich root data.\n"
5606
"You can use brz upgrade on the repository.")
5610
containing_tree.add_reference(sub_tree)
5611
except BadReferenceTarget as e:
5612
# XXX: Would be better to just raise a nicely printable
5613
# exception from the real origin. Also below. mbp 20070306
5614
raise errors.BzrCommandError(
5615
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5618
containing_tree.subsume(sub_tree)
5619
except errors.BadSubsumeSource as e:
5620
raise errors.BzrCommandError(
5621
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5624
class cmd_split(Command):
5625
__doc__ = """Split a subdirectory of a tree into a separate tree.
5627
This command will produce a target tree in a format that supports
5628
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5629
converted into earlier formats like 'dirstate-tags'.
5631
The TREE argument should be a subdirectory of a working tree. That
5632
subdirectory will be converted into an independent tree, with its own
5633
branch. Commits in the top-level tree will not apply to the new subtree.
5636
_see_also = ['join']
5637
takes_args = ['tree']
5639
def run(self, tree):
5640
containing_tree, subdir = WorkingTree.open_containing(tree)
5641
sub_id = containing_tree.path2id(subdir)
5643
raise errors.NotVersionedError(subdir)
5645
containing_tree.extract(subdir, sub_id)
5646
except errors.RootNotRich:
5647
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5650
class cmd_merge_directive(Command):
5651
__doc__ = """Generate a merge directive for auto-merge tools.
5653
A directive requests a merge to be performed, and also provides all the
5654
information necessary to do so. This means it must either include a
5655
revision bundle, or the location of a branch containing the desired
5658
A submit branch (the location to merge into) must be supplied the first
5659
time the command is issued. After it has been supplied once, it will
5660
be remembered as the default.
5662
A public branch is optional if a revision bundle is supplied, but required
5663
if --diff or --plain is specified. It will be remembered as the default
5664
after the first use.
5667
takes_args = ['submit_branch?', 'public_branch?']
5671
_see_also = ['send']
5675
RegistryOption.from_kwargs('patch-type',
5676
'The type of patch to include in the directive.',
5678
value_switches=True,
5680
bundle='Bazaar revision bundle (default).',
5681
diff='Normal unified diff.',
5682
plain='No patch, just directive.'),
5683
Option('sign', help='GPG-sign the directive.'), 'revision',
5684
Option('mail-to', type=text_type,
5685
help='Instead of printing the directive, email to this address.'),
5686
Option('message', type=text_type, short_name='m',
5687
help='Message to use when committing this merge.')
5690
encoding_type = 'exact'
5692
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5693
sign=False, revision=None, mail_to=None, message=None,
5695
from .revision import ensure_null, NULL_REVISION
5696
include_patch, include_bundle = {
5697
'plain': (False, False),
5698
'diff': (True, False),
5699
'bundle': (True, True),
5701
branch = Branch.open(directory)
5702
stored_submit_branch = branch.get_submit_branch()
5703
if submit_branch is None:
5704
submit_branch = stored_submit_branch
5706
if stored_submit_branch is None:
5707
branch.set_submit_branch(submit_branch)
5708
if submit_branch is None:
5709
submit_branch = branch.get_parent()
5710
if submit_branch is None:
5711
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5713
stored_public_branch = branch.get_public_branch()
5714
if public_branch is None:
5715
public_branch = stored_public_branch
5716
elif stored_public_branch is None:
5717
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5718
branch.set_public_branch(public_branch)
5719
if not include_bundle and public_branch is None:
5720
raise errors.BzrCommandError(gettext('No public branch specified or'
5722
base_revision_id = None
5723
if revision is not None:
5724
if len(revision) > 2:
5725
raise errors.BzrCommandError(gettext('brz merge-directive takes '
5726
'at most two one revision identifiers'))
5727
revision_id = revision[-1].as_revision_id(branch)
5728
if len(revision) == 2:
5729
base_revision_id = revision[0].as_revision_id(branch)
5731
revision_id = branch.last_revision()
5732
revision_id = ensure_null(revision_id)
5733
if revision_id == NULL_REVISION:
5734
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5735
directive = merge_directive.MergeDirective2.from_objects(
5736
branch.repository, revision_id, time.time(),
5737
osutils.local_time_offset(), submit_branch,
5738
public_branch=public_branch, include_patch=include_patch,
5739
include_bundle=include_bundle, message=message,
5740
base_revision_id=base_revision_id)
5743
self.outf.write(directive.to_signed(branch))
5745
self.outf.writelines(directive.to_lines())
5747
message = directive.to_email(mail_to, branch, sign)
5748
s = SMTPConnection(branch.get_config_stack())
5749
s.send_email(message)
5752
class cmd_send(Command):
5753
__doc__ = """Mail or create a merge-directive for submitting changes.
5755
A merge directive provides many things needed for requesting merges:
5757
* A machine-readable description of the merge to perform
5759
* An optional patch that is a preview of the changes requested
5761
* An optional bundle of revision data, so that the changes can be applied
5762
directly from the merge directive, without retrieving data from a
5765
`brz send` creates a compact data set that, when applied using brz
5766
merge, has the same effect as merging from the source branch.
5768
By default the merge directive is self-contained and can be applied to any
5769
branch containing submit_branch in its ancestory without needing access to
5772
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5773
revisions, but only a structured request to merge from the
5774
public_location. In that case the public_branch is needed and it must be
5775
up-to-date and accessible to the recipient. The public_branch is always
5776
included if known, so that people can check it later.
5778
The submit branch defaults to the parent of the source branch, but can be
5779
overridden. Both submit branch and public branch will be remembered in
5780
branch.conf the first time they are used for a particular branch. The
5781
source branch defaults to that containing the working directory, but can
5782
be changed using --from.
5784
Both the submit branch and the public branch follow the usual behavior with
5785
respect to --remember: If there is no default location set, the first send
5786
will set it (use --no-remember to avoid setting it). After that, you can
5787
omit the location to use the default. To change the default, use
5788
--remember. The value will only be saved if the location can be accessed.
5790
In order to calculate those changes, brz must analyse the submit branch.
5791
Therefore it is most efficient for the submit branch to be a local mirror.
5792
If a public location is known for the submit_branch, that location is used
5793
in the merge directive.
5795
The default behaviour is to send the merge directive by mail, unless -o is
5796
given, in which case it is sent to a file.
5798
Mail is sent using your preferred mail program. This should be transparent
5799
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5800
If the preferred client can't be found (or used), your editor will be used.
5802
To use a specific mail program, set the mail_client configuration option.
5803
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5804
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5805
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5806
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5809
If mail is being sent, a to address is required. This can be supplied
5810
either on the commandline, by setting the submit_to configuration
5811
option in the branch itself or the child_submit_to configuration option
5812
in the submit branch.
5814
Two formats are currently supported: "4" uses revision bundle format 4 and
5815
merge directive format 2. It is significantly faster and smaller than
5816
older formats. It is compatible with Bazaar 0.19 and later. It is the
5817
default. "0.9" uses revision bundle format 0.9 and merge directive
5818
format 1. It is compatible with Bazaar 0.12 - 0.18.
5820
The merge directives created by brz send may be applied using brz merge or
5821
brz pull by specifying a file containing a merge directive as the location.
5823
brz send makes extensive use of public locations to map local locations into
5824
URLs that can be used by other people. See `brz help configuration` to
5825
set them, and use `brz info` to display them.
5828
encoding_type = 'exact'
5830
_see_also = ['merge', 'pull']
5832
takes_args = ['submit_branch?', 'public_branch?']
5836
help='Do not include a bundle in the merge directive.'),
5837
Option('no-patch', help='Do not include a preview patch in the merge'
5840
help='Remember submit and public branch.'),
5842
help='Branch to generate the submission from, '
5843
'rather than the one containing the working directory.',
5846
Option('output', short_name='o',
5847
help='Write merge directive to this file or directory; '
5848
'use - for stdout.',
5851
help='Refuse to send if there are uncommitted changes in'
5852
' the working tree, --no-strict disables the check.'),
5853
Option('mail-to', help='Mail the request to this address.',
5857
Option('body', help='Body for the email.', type=text_type),
5858
RegistryOption('format',
5859
help='Use the specified output format.',
5860
lazy_registry=('breezy.send', 'format_registry')),
5863
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5864
no_patch=False, revision=None, remember=None, output=None,
5865
format=None, mail_to=None, message=None, body=None,
5866
strict=None, **kwargs):
5867
from .send import send
5868
return send(submit_branch, revision, public_branch, remember,
5869
format, no_bundle, no_patch, output,
5870
kwargs.get('from', '.'), mail_to, message, body,
5875
class cmd_bundle_revisions(cmd_send):
5876
__doc__ = """Create a merge-directive for submitting changes.
5878
A merge directive provides many things needed for requesting merges:
5880
* A machine-readable description of the merge to perform
5882
* An optional patch that is a preview of the changes requested
5884
* An optional bundle of revision data, so that the changes can be applied
5885
directly from the merge directive, without retrieving data from a
5888
If --no-bundle is specified, then public_branch is needed (and must be
5889
up-to-date), so that the receiver can perform the merge using the
5890
public_branch. The public_branch is always included if known, so that
5891
people can check it later.
5893
The submit branch defaults to the parent, but can be overridden. Both
5894
submit branch and public branch will be remembered if supplied.
5896
If a public_branch is known for the submit_branch, that public submit
5897
branch is used in the merge instructions. This means that a local mirror
5898
can be used as your actual submit branch, once you have set public_branch
5901
Two formats are currently supported: "4" uses revision bundle format 4 and
5902
merge directive format 2. It is significantly faster and smaller than
5903
older formats. It is compatible with Bazaar 0.19 and later. It is the
5904
default. "0.9" uses revision bundle format 0.9 and merge directive
5905
format 1. It is compatible with Bazaar 0.12 - 0.18.
5910
help='Do not include a bundle in the merge directive.'),
5911
Option('no-patch', help='Do not include a preview patch in the merge'
5914
help='Remember submit and public branch.'),
5916
help='Branch to generate the submission from, '
5917
'rather than the one containing the working directory.',
5920
Option('output', short_name='o', help='Write directive to this file.',
5923
help='Refuse to bundle revisions if there are uncommitted'
5924
' changes in the working tree, --no-strict disables the check.'),
5926
RegistryOption('format',
5927
help='Use the specified output format.',
5928
lazy_registry=('breezy.send', 'format_registry')),
5930
aliases = ['bundle']
5932
_see_also = ['send', 'merge']
5936
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5937
no_patch=False, revision=None, remember=False, output=None,
5938
format=None, strict=None, **kwargs):
5941
from .send import send
5942
return send(submit_branch, revision, public_branch, remember,
5943
format, no_bundle, no_patch, output,
5944
kwargs.get('from', '.'), None, None, None,
5945
self.outf, strict=strict)
5948
class cmd_tag(Command):
5949
__doc__ = """Create, remove or modify a tag naming a revision.
5951
Tags give human-meaningful names to revisions. Commands that take a -r
5952
(--revision) option can be given -rtag:X, where X is any previously
5955
Tags are stored in the branch. Tags are copied from one branch to another
5956
along when you branch, push, pull or merge.
5958
It is an error to give a tag name that already exists unless you pass
5959
--force, in which case the tag is moved to point to the new revision.
5961
To rename a tag (change the name but keep it on the same revsion), run ``brz
5962
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
5964
If no tag name is specified it will be determined through the
5965
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5966
upstream releases by reading configure.ac. See ``brz help hooks`` for
5970
_see_also = ['commit', 'tags']
5971
takes_args = ['tag_name?']
5974
help='Delete this tag rather than placing it.',
5976
custom_help('directory',
5977
help='Branch in which to place the tag.'),
5979
help='Replace existing tags.',
5984
def run(self, tag_name=None,
5990
branch, relpath = Branch.open_containing(directory)
5991
self.add_cleanup(branch.lock_write().unlock)
5993
if tag_name is None:
5994
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5995
branch.tags.delete_tag(tag_name)
5996
note(gettext('Deleted tag %s.') % tag_name)
5999
if len(revision) != 1:
6000
raise errors.BzrCommandError(gettext(
6001
"Tags can only be placed on a single revision, "
6003
revision_id = revision[0].as_revision_id(branch)
6005
revision_id = branch.last_revision()
6006
if tag_name is None:
6007
tag_name = branch.automatic_tag_name(revision_id)
6008
if tag_name is None:
6009
raise errors.BzrCommandError(gettext(
6010
"Please specify a tag name."))
6012
existing_target = branch.tags.lookup_tag(tag_name)
6013
except errors.NoSuchTag:
6014
existing_target = None
6015
if not force and existing_target not in (None, revision_id):
6016
raise errors.TagAlreadyExists(tag_name)
6017
if existing_target == revision_id:
6018
note(gettext('Tag %s already exists for that revision.') % tag_name)
6020
branch.tags.set_tag(tag_name, revision_id)
6021
if existing_target is None:
6022
note(gettext('Created tag %s.') % tag_name)
6024
note(gettext('Updated tag %s.') % tag_name)
6027
class cmd_tags(Command):
6028
__doc__ = """List tags.
6030
This command shows a table of tag names and the revisions they reference.
6035
custom_help('directory',
6036
help='Branch whose tags should be displayed.'),
6037
RegistryOption('sort',
6038
'Sort tags by different criteria.', title='Sorting',
6039
lazy_registry=('breezy.tag', 'tag_sort_methods')
6046
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6047
from .tag import tag_sort_methods
6048
branch, relpath = Branch.open_containing(directory)
6050
tags = list(viewitems(branch.tags.get_tag_dict()))
6054
self.add_cleanup(branch.lock_read().unlock)
6056
# Restrict to the specified range
6057
tags = self._tags_for_range(branch, revision)
6059
sort = tag_sort_methods.get()
6062
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6063
for index, (tag, revid) in enumerate(tags):
6065
revno = branch.revision_id_to_dotted_revno(revid)
6066
if isinstance(revno, tuple):
6067
revno = '.'.join(map(str, revno))
6068
except (errors.NoSuchRevision,
6069
errors.GhostRevisionsHaveNoRevno,
6070
errors.UnsupportedOperation):
6071
# Bad tag data/merges can lead to tagged revisions
6072
# which are not in this branch. Fail gracefully ...
6074
tags[index] = (tag, revno)
6076
for tag, revspec in tags:
6077
self.outf.write('%-20s %s\n' % (tag, revspec))
6079
def _tags_for_range(self, branch, revision):
6081
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6082
revid1, revid2 = rev1.rev_id, rev2.rev_id
6083
# _get_revision_range will always set revid2 if it's not specified.
6084
# If revid1 is None, it means we want to start from the branch
6085
# origin which is always a valid ancestor. If revid1 == revid2, the
6086
# ancestry check is useless.
6087
if revid1 and revid1 != revid2:
6088
# FIXME: We really want to use the same graph than
6089
# branch.iter_merge_sorted_revisions below, but this is not
6090
# easily available -- vila 2011-09-23
6091
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6092
# We don't want to output anything in this case...
6094
# only show revisions between revid1 and revid2 (inclusive)
6095
tagged_revids = branch.tags.get_reverse_tag_dict()
6097
for r in branch.iter_merge_sorted_revisions(
6098
start_revision_id=revid2, stop_revision_id=revid1,
6099
stop_rule='include'):
6100
revid_tags = tagged_revids.get(r[0], None)
6102
found.extend([(tag, r[0]) for tag in revid_tags])
6106
class cmd_reconfigure(Command):
6107
__doc__ = """Reconfigure the type of a brz directory.
6109
A target configuration must be specified.
6111
For checkouts, the bind-to location will be auto-detected if not specified.
6112
The order of preference is
6113
1. For a lightweight checkout, the current bound location.
6114
2. For branches that used to be checkouts, the previously-bound location.
6115
3. The push location.
6116
4. The parent location.
6117
If none of these is available, --bind-to must be specified.
6120
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6121
takes_args = ['location?']
6123
RegistryOption.from_kwargs(
6126
help='The relation between branch and tree.',
6127
value_switches=True, enum_switch=False,
6128
branch='Reconfigure to be an unbound branch with no working tree.',
6129
tree='Reconfigure to be an unbound branch with a working tree.',
6130
checkout='Reconfigure to be a bound branch with a working tree.',
6131
lightweight_checkout='Reconfigure to be a lightweight'
6132
' checkout (with no local history).',
6134
RegistryOption.from_kwargs(
6136
title='Repository type',
6137
help='Location fo the repository.',
6138
value_switches=True, enum_switch=False,
6139
standalone='Reconfigure to be a standalone branch '
6140
'(i.e. stop using shared repository).',
6141
use_shared='Reconfigure to use a shared repository.',
6143
RegistryOption.from_kwargs(
6145
title='Trees in Repository',
6146
help='Whether new branches in the repository have trees.',
6147
value_switches=True, enum_switch=False,
6148
with_trees='Reconfigure repository to create '
6149
'working trees on branches by default.',
6150
with_no_trees='Reconfigure repository to not create '
6151
'working trees on branches by default.'
6153
Option('bind-to', help='Branch to bind checkout to.', type=text_type),
6155
help='Perform reconfiguration even if local changes'
6157
Option('stacked-on',
6158
help='Reconfigure a branch to be stacked on another branch.',
6162
help='Reconfigure a branch to be unstacked. This '
6163
'may require copying substantial data into it.',
6167
def run(self, location=None, bind_to=None, force=False,
6168
tree_type=None, repository_type=None, repository_trees=None,
6169
stacked_on=None, unstacked=None):
6170
directory = controldir.ControlDir.open(location)
6171
if stacked_on and unstacked:
6172
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6173
elif stacked_on is not None:
6174
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6176
reconfigure.ReconfigureUnstacked().apply(directory)
6177
# At the moment you can use --stacked-on and a different
6178
# reconfiguration shape at the same time; there seems no good reason
6180
if (tree_type is None and
6181
repository_type is None and
6182
repository_trees is None):
6183
if stacked_on or unstacked:
6186
raise errors.BzrCommandError(gettext('No target configuration '
6188
reconfiguration = None
6189
if tree_type == 'branch':
6190
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6191
elif tree_type == 'tree':
6192
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6193
elif tree_type == 'checkout':
6194
reconfiguration = reconfigure.Reconfigure.to_checkout(
6196
elif tree_type == 'lightweight-checkout':
6197
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6200
reconfiguration.apply(force)
6201
reconfiguration = None
6202
if repository_type == 'use-shared':
6203
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6204
elif repository_type == 'standalone':
6205
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6207
reconfiguration.apply(force)
6208
reconfiguration = None
6209
if repository_trees == 'with-trees':
6210
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6212
elif repository_trees == 'with-no-trees':
6213
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6216
reconfiguration.apply(force)
6217
reconfiguration = None
6220
class cmd_switch(Command):
6221
__doc__ = """Set the branch of a checkout and update.
6223
For lightweight checkouts, this changes the branch being referenced.
6224
For heavyweight checkouts, this checks that there are no local commits
6225
versus the current bound branch, then it makes the local branch a mirror
6226
of the new location and binds to it.
6228
In both cases, the working tree is updated and uncommitted changes
6229
are merged. The user can commit or revert these as they desire.
6231
Pending merges need to be committed or reverted before using switch.
6233
The path to the branch to switch to can be specified relative to the parent
6234
directory of the current branch. For example, if you are currently in a
6235
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6238
Bound branches use the nickname of its master branch unless it is set
6239
locally, in which case switching will update the local nickname to be
6243
takes_args = ['to_location?']
6244
takes_options = ['directory',
6246
help='Switch even if local commits will be lost.'),
6248
Option('create-branch', short_name='b',
6249
help='Create the target branch from this one before'
6250
' switching to it.'),
6252
help='Store and restore uncommitted changes in the'
6256
def run(self, to_location=None, force=False, create_branch=False,
6257
revision=None, directory=u'.', store=False):
6258
from . import switch
6259
tree_location = directory
6260
revision = _get_one_revision('switch', revision)
6261
possible_transports = []
6262
control_dir = controldir.ControlDir.open_containing(tree_location,
6263
possible_transports=possible_transports)[0]
6264
if to_location is None:
6265
if revision is None:
6266
raise errors.BzrCommandError(gettext('You must supply either a'
6267
' revision or a location'))
6268
to_location = tree_location
6270
branch = control_dir.open_branch(
6271
possible_transports=possible_transports)
6272
had_explicit_nick = branch.get_config().has_explicit_nickname()
6273
except errors.NotBranchError:
6275
had_explicit_nick = False
6278
raise errors.BzrCommandError(
6279
gettext('cannot create branch without source branch'))
6280
to_location = lookup_new_sibling_branch(control_dir, to_location,
6281
possible_transports=possible_transports)
6282
to_branch = branch.controldir.sprout(to_location,
6283
possible_transports=possible_transports,
6284
source_branch=branch).open_branch()
6287
to_branch = Branch.open(to_location,
6288
possible_transports=possible_transports)
6289
except errors.NotBranchError:
6290
to_branch = open_sibling_branch(control_dir, to_location,
6291
possible_transports=possible_transports)
6292
if revision is not None:
6293
revision = revision.as_revision_id(to_branch)
6295
switch.switch(control_dir, to_branch, force, revision_id=revision,
6296
store_uncommitted=store)
6297
except controldir.BranchReferenceLoop:
6298
raise errors.BzrCommandError(
6299
gettext('switching would create a branch reference loop. '
6300
'Use the "bzr up" command to switch to a '
6301
'different revision.'))
6302
if had_explicit_nick:
6303
branch = control_dir.open_branch() #get the new branch!
6304
branch.nick = to_branch.nick
6305
note(gettext('Switched to branch: %s'),
6306
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6310
class cmd_view(Command):
6311
__doc__ = """Manage filtered views.
6313
Views provide a mask over the tree so that users can focus on
6314
a subset of a tree when doing their work. After creating a view,
6315
commands that support a list of files - status, diff, commit, etc -
6316
effectively have that list of files implicitly given each time.
6317
An explicit list of files can still be given but those files
6318
must be within the current view.
6320
In most cases, a view has a short life-span: it is created to make
6321
a selected change and is deleted once that change is committed.
6322
At other times, you may wish to create one or more named views
6323
and switch between them.
6325
To disable the current view without deleting it, you can switch to
6326
the pseudo view called ``off``. This can be useful when you need
6327
to see the whole tree for an operation or two (e.g. merge) but
6328
want to switch back to your view after that.
6331
To define the current view::
6333
brz view file1 dir1 ...
6335
To list the current view::
6339
To delete the current view::
6343
To disable the current view without deleting it::
6345
brz view --switch off
6347
To define a named view and switch to it::
6349
brz view --name view-name file1 dir1 ...
6351
To list a named view::
6353
brz view --name view-name
6355
To delete a named view::
6357
brz view --name view-name --delete
6359
To switch to a named view::
6361
brz view --switch view-name
6363
To list all views defined::
6367
To delete all views::
6369
brz view --delete --all
6373
takes_args = ['file*']
6376
help='Apply list or delete action to all views.',
6379
help='Delete the view.',
6382
help='Name of the view to define, list or delete.',
6386
help='Name of the view to switch to.',
6391
def run(self, file_list,
6397
tree, file_list = WorkingTree.open_containing_paths(file_list,
6399
current_view, view_dict = tree.views.get_view_info()
6404
raise errors.BzrCommandError(gettext(
6405
"Both --delete and a file list specified"))
6407
raise errors.BzrCommandError(gettext(
6408
"Both --delete and --switch specified"))
6410
tree.views.set_view_info(None, {})
6411
self.outf.write(gettext("Deleted all views.\n"))
6413
raise errors.BzrCommandError(gettext("No current view to delete"))
6415
tree.views.delete_view(name)
6416
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6419
raise errors.BzrCommandError(gettext(
6420
"Both --switch and a file list specified"))
6422
raise errors.BzrCommandError(gettext(
6423
"Both --switch and --all specified"))
6424
elif switch == 'off':
6425
if current_view is None:
6426
raise errors.BzrCommandError(gettext("No current view to disable"))
6427
tree.views.set_view_info(None, view_dict)
6428
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6430
tree.views.set_view_info(switch, view_dict)
6431
view_str = views.view_display_str(tree.views.lookup_view())
6432
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6435
self.outf.write(gettext('Views defined:\n'))
6436
for view in sorted(view_dict):
6437
if view == current_view:
6441
view_str = views.view_display_str(view_dict[view])
6442
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6444
self.outf.write(gettext('No views defined.\n'))
6447
# No name given and no current view set
6450
raise errors.BzrCommandError(gettext(
6451
"Cannot change the 'off' pseudo view"))
6452
tree.views.set_view(name, sorted(file_list))
6453
view_str = views.view_display_str(tree.views.lookup_view())
6454
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6458
# No name given and no current view set
6459
self.outf.write(gettext('No current view.\n'))
6461
view_str = views.view_display_str(tree.views.lookup_view(name))
6462
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6465
class cmd_hooks(Command):
6466
__doc__ = """Show hooks."""
6471
for hook_key in sorted(hooks.known_hooks.keys()):
6472
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6473
self.outf.write("%s:\n" % type(some_hooks).__name__)
6474
for hook_name, hook_point in sorted(some_hooks.items()):
6475
self.outf.write(" %s:\n" % (hook_name,))
6476
found_hooks = list(hook_point)
6478
for hook in found_hooks:
6479
self.outf.write(" %s\n" %
6480
(some_hooks.get_hook_name(hook),))
6482
self.outf.write(gettext(" <no hooks installed>\n"))
6485
class cmd_remove_branch(Command):
6486
__doc__ = """Remove a branch.
6488
This will remove the branch from the specified location but
6489
will keep any working tree or repository in place.
6493
Remove the branch at repo/trunk::
6495
brz remove-branch repo/trunk
6499
takes_args = ["location?"]
6501
takes_options = ['directory',
6502
Option('force', help='Remove branch even if it is the active branch.')]
6504
aliases = ["rmbranch"]
6506
def run(self, directory=None, location=None, force=False):
6507
br = open_nearby_branch(near=directory, location=location)
6508
if not force and br.controldir.has_workingtree():
6510
active_branch = br.controldir.open_branch(name="")
6511
except errors.NotBranchError:
6512
active_branch = None
6513
if (active_branch is not None and
6514
br.control_url == active_branch.control_url):
6515
raise errors.BzrCommandError(
6516
gettext("Branch is active. Use --force to remove it."))
6517
br.controldir.destroy_branch(br.name)
6520
class cmd_shelve(Command):
6521
__doc__ = """Temporarily set aside some changes from the current tree.
6523
Shelve allows you to temporarily put changes you've made "on the shelf",
6524
ie. out of the way, until a later time when you can bring them back from
6525
the shelf with the 'unshelve' command. The changes are stored alongside
6526
your working tree, and so they aren't propagated along with your branch nor
6527
will they survive its deletion.
6529
If shelve --list is specified, previously-shelved changes are listed.
6531
Shelve is intended to help separate several sets of changes that have
6532
been inappropriately mingled. If you just want to get rid of all changes
6533
and you don't need to restore them later, use revert. If you want to
6534
shelve all text changes at once, use shelve --all.
6536
If filenames are specified, only the changes to those files will be
6537
shelved. Other files will be left untouched.
6539
If a revision is specified, changes since that revision will be shelved.
6541
You can put multiple items on the shelf, and by default, 'unshelve' will
6542
restore the most recently shelved changes.
6544
For complicated changes, it is possible to edit the changes in a separate
6545
editor program to decide what the file remaining in the working copy
6546
should look like. To do this, add the configuration option
6548
change_editor = PROGRAM @new_path @old_path
6550
where @new_path is replaced with the path of the new version of the
6551
file and @old_path is replaced with the path of the old version of
6552
the file. The PROGRAM should save the new file with the desired
6553
contents of the file in the working tree.
6557
takes_args = ['file*']
6562
Option('all', help='Shelve all changes.'),
6564
RegistryOption('writer', 'Method to use for writing diffs.',
6565
breezy.option.diff_writer_registry,
6566
value_switches=True, enum_switch=False),
6568
Option('list', help='List shelved changes.'),
6570
help='Destroy removed changes instead of shelving them.'),
6572
_see_also = ['unshelve', 'configuration']
6574
def run(self, revision=None, all=False, file_list=None, message=None,
6575
writer=None, list=False, destroy=False, directory=None):
6577
return self.run_for_list(directory=directory)
6578
from .shelf_ui import Shelver
6580
writer = breezy.option.diff_writer_registry.get()
6582
shelver = Shelver.from_args(writer(self.outf), revision, all,
6583
file_list, message, destroy=destroy, directory=directory)
6588
except errors.UserAbort:
6591
def run_for_list(self, directory=None):
6592
if directory is None:
6594
tree = WorkingTree.open_containing(directory)[0]
6595
self.add_cleanup(tree.lock_read().unlock)
6596
manager = tree.get_shelf_manager()
6597
shelves = manager.active_shelves()
6598
if len(shelves) == 0:
6599
note(gettext('No shelved changes.'))
6601
for shelf_id in reversed(shelves):
6602
message = manager.get_metadata(shelf_id).get('message')
6604
message = '<no message>'
6605
self.outf.write('%3d: %s\n' % (shelf_id, message))
6609
class cmd_unshelve(Command):
6610
__doc__ = """Restore shelved changes.
6612
By default, the most recently shelved changes are restored. However if you
6613
specify a shelf by id those changes will be restored instead. This works
6614
best when the changes don't depend on each other.
6617
takes_args = ['shelf_id?']
6620
RegistryOption.from_kwargs(
6621
'action', help="The action to perform.",
6622
enum_switch=False, value_switches=True,
6623
apply="Apply changes and remove from the shelf.",
6624
dry_run="Show changes, but do not apply or remove them.",
6625
preview="Instead of unshelving the changes, show the diff that "
6626
"would result from unshelving.",
6627
delete_only="Delete changes without applying them.",
6628
keep="Apply changes but don't delete them.",
6631
_see_also = ['shelve']
6633
def run(self, shelf_id=None, action='apply', directory=u'.'):
6634
from .shelf_ui import Unshelver
6635
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6639
unshelver.tree.unlock()
6642
class cmd_clean_tree(Command):
6643
__doc__ = """Remove unwanted files from working tree.
6645
By default, only unknown files, not ignored files, are deleted. Versioned
6646
files are never deleted.
6648
Another class is 'detritus', which includes files emitted by brz during
6649
normal operations and selftests. (The value of these files decreases with
6652
If no options are specified, unknown files are deleted. Otherwise, option
6653
flags are respected, and may be combined.
6655
To check what clean-tree will do, use --dry-run.
6657
takes_options = ['directory',
6658
Option('ignored', help='Delete all ignored files.'),
6659
Option('detritus', help='Delete conflict files, merge and revert'
6660
' backups, and failed selftest dirs.'),
6662
help='Delete files unknown to brz (default).'),
6663
Option('dry-run', help='Show files to delete instead of'
6665
Option('force', help='Do not prompt before deleting.')]
6666
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6667
force=False, directory=u'.'):
6668
from .clean_tree import clean_tree
6669
if not (unknown or ignored or detritus):
6673
clean_tree(directory, unknown=unknown, ignored=ignored,
6674
detritus=detritus, dry_run=dry_run, no_prompt=force)
6677
class cmd_reference(Command):
6678
__doc__ = """list, view and set branch locations for nested trees.
6680
If no arguments are provided, lists the branch locations for nested trees.
6681
If one argument is provided, display the branch location for that tree.
6682
If two arguments are provided, set the branch location for that tree.
6687
takes_args = ['path?', 'location?']
6689
def run(self, path=None, location=None):
6691
if path is not None:
6693
tree, branch, relpath =(
6694
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6695
if path is not None:
6698
tree = branch.basis_tree()
6700
info = viewitems(branch._get_all_reference_info())
6701
self._display_reference_info(tree, branch, info)
6703
if not tree.is_versioned(path):
6704
raise errors.NotVersionedError(path)
6705
if location is None:
6706
info = [(path, branch.get_reference_info(path))]
6707
self._display_reference_info(tree, branch, info)
6709
branch.set_reference_info(
6710
path, location, file_id=tree.path2id(path))
6712
def _display_reference_info(self, tree, branch, info):
6714
for path, (location, file_id) in info:
6715
ref_list.append((path, location))
6716
for path, location in sorted(ref_list):
6717
self.outf.write('%s %s\n' % (path, location))
6720
class cmd_export_pot(Command):
6721
__doc__ = """Export command helps and error messages in po format."""
6724
takes_options = [Option('plugin',
6725
help='Export help text from named command '\
6726
'(defaults to all built in commands).',
6728
Option('include-duplicates',
6729
help='Output multiple copies of the same msgid '
6730
'string if it appears more than once.'),
6733
def run(self, plugin=None, include_duplicates=False):
6734
from .export_pot import export_pot
6735
export_pot(self.outf, plugin, include_duplicates)
6738
class cmd_import(Command):
6739
__doc__ = """Import sources from a directory, tarball or zip file
6741
This command will import a directory, tarball or zip file into a bzr
6742
tree, replacing any versioned files already present. If a directory is
6743
specified, it is used as the target. If the directory does not exist, or
6744
is not versioned, it is created.
6746
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6748
If the tarball or zip has a single root directory, that directory is
6749
stripped when extracting the tarball. This is not done for directories.
6752
takes_args = ['source', 'tree?']
6754
def run(self, source, tree=None):
6755
from .upstream_import import do_import
6756
do_import(source, tree)
6759
class cmd_link_tree(Command):
6760
__doc__ = """Hardlink matching files to another tree.
6762
Only files with identical content and execute bit will be linked.
6765
takes_args = ['location']
6767
def run(self, location):
6768
from .transform import link_tree
6769
target_tree = WorkingTree.open_containing(".")[0]
6770
source_tree = WorkingTree.open(location)
6771
target_tree.lock_write()
6773
source_tree.lock_read()
6775
link_tree(target_tree, source_tree)
6777
source_tree.unlock()
6779
target_tree.unlock()
6782
class cmd_fetch_ghosts(Command):
6783
__doc__ = """Attempt to retrieve ghosts from another branch.
6785
If the other branch is not supplied, the last-pulled branch is used.
6789
aliases = ['fetch-missing']
6790
takes_args = ['branch?']
6791
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6793
def run(self, branch=None, no_fix=False):
6794
from .fetch_ghosts import GhostFetcher
6795
installed, failed = GhostFetcher.from_cmdline(branch).run()
6796
if len(installed) > 0:
6797
self.outf.write("Installed:\n")
6798
for rev in installed:
6799
self.outf.write(rev + "\n")
6801
self.outf.write("Still missing:\n")
6803
self.outf.write(rev + "\n")
6804
if not no_fix and len(installed) > 0:
6805
cmd_reconcile().run(".")
6808
def _register_lazy_builtins():
6809
# register lazy builtins from other modules; called at startup and should
6810
# be only called once.
6811
for (name, aliases, module_name) in [
6812
('cmd_bisect', [], 'breezy.bisect'),
6813
('cmd_bundle_info', [], 'breezy.bundle.commands'),
6814
('cmd_config', [], 'breezy.config'),
6815
('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
6816
('cmd_version_info', [], 'breezy.cmd_version_info'),
6817
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
6818
('cmd_conflicts', [], 'breezy.conflicts'),
6819
('cmd_ping', [], 'breezy.bzr.smart.ping'),
6820
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
6821
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
6822
('cmd_test_script', [], 'breezy.cmd_test_script'),
6824
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
