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
25
import breezy.bzr.bzrdir
27
from . import lazy_import
28
lazy_import.lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
60
from breezy.branch import Branch
61
from breezy.conflicts import ConflictList
62
from breezy.transport import memory
63
from breezy.revisionspec import RevisionSpec, RevisionInfo
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,
87
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
90
def _get_branch_location(control_dir, possible_transports=None):
91
"""Return location of branch for this control dir."""
93
target = control_dir.get_branch_reference()
94
except errors.NotBranchError:
95
return control_dir.root_transport.base
96
if target is not None:
98
this_branch = control_dir.open_branch(
99
possible_transports=possible_transports)
100
# This may be a heavy checkout, where we want the master branch
101
master_location = this_branch.get_bound_location()
102
if master_location is not None:
103
return master_location
104
# If not, use a local sibling
105
return this_branch.base
108
def _is_colocated(control_dir, possible_transports=None):
109
"""Check if the branch in control_dir is colocated.
111
:param control_dir: Control directory
112
:return: Tuple with boolean indicating whether the branch is colocated
113
and the full URL to the actual branch
115
# This path is meant to be relative to the existing branch
116
this_url = _get_branch_location(control_dir,
117
possible_transports=possible_transports)
118
# Perhaps the target control dir supports colocated branches?
120
root = controldir.ControlDir.open(this_url,
121
possible_transports=possible_transports)
122
except errors.NotBranchError:
123
return (False, this_url)
126
wt = control_dir.open_workingtree()
127
except (errors.NoWorkingTree, errors.NotLocalUrl):
128
return (False, this_url)
131
root._format.colocated_branches and
132
control_dir.control_url == root.control_url,
136
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
137
"""Lookup the location for a new sibling branch.
139
:param control_dir: Control directory to find sibling branches from
140
:param location: Name of the new branch
141
:return: Full location to the new branch
143
location = directory_service.directories.dereference(location)
144
if '/' not in location and '\\' not in location:
145
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
148
return urlutils.join_segment_parameters(this_url,
149
{"branch": urlutils.escape(location)})
151
return urlutils.join(this_url, '..', urlutils.escape(location))
155
def open_sibling_branch(control_dir, location, possible_transports=None):
156
"""Open a branch, possibly a sibling of another.
158
:param control_dir: Control directory relative to which to lookup the
160
:param location: Location to look up
161
:return: branch to open
164
# Perhaps it's a colocated branch?
165
return control_dir.open_branch(location,
166
possible_transports=possible_transports)
167
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
168
this_url = _get_branch_location(control_dir)
171
this_url, '..', urlutils.escape(location)))
174
def open_nearby_branch(near=None, location=None, possible_transports=None):
175
"""Open a nearby branch.
177
:param near: Optional location of container from which to open branch
178
:param location: Location of the branch
179
:return: Branch instance
185
return Branch.open(location,
186
possible_transports=possible_transports)
187
except errors.NotBranchError:
189
cdir = controldir.ControlDir.open(near,
190
possible_transports=possible_transports)
191
return open_sibling_branch(cdir, location,
192
possible_transports=possible_transports)
195
def iter_sibling_branches(control_dir, possible_transports=None):
196
"""Iterate over the siblings of a branch.
198
:param control_dir: Control directory for which to look up the siblings
199
:return: Iterator over tuples with branch name and branch object
203
reference = control_dir.get_branch_reference()
204
except errors.NotBranchError:
205
# There is no active branch, just return the colocated branches.
206
for name, branch in viewitems(control_dir.get_branches()):
209
if reference is not None:
210
ref_branch = Branch.open(reference,
211
possible_transports=possible_transports)
214
if ref_branch is None or ref_branch.name:
215
if ref_branch is not None:
216
control_dir = ref_branch.controldir
217
for name, branch in viewitems(control_dir.get_branches()):
220
repo = ref_branch.controldir.find_repository()
221
for branch in repo.find_branches(using=True):
222
name = urlutils.relative_url(repo.user_url,
223
branch.user_url).rstrip("/")
227
def tree_files_for_add(file_list):
229
Return a tree and list of absolute paths from a file list.
231
Similar to tree_files, but add handles files a bit differently, so it a
232
custom implementation. In particular, MutableTreeTree.smart_add expects
233
absolute paths, which it immediately converts to relative paths.
235
# FIXME Would be nice to just return the relative paths like
236
# internal_tree_files does, but there are a large number of unit tests
237
# that assume the current interface to mutabletree.smart_add
239
tree, relpath = WorkingTree.open_containing(file_list[0])
240
if tree.supports_views():
241
view_files = tree.views.lookup_view()
243
for filename in file_list:
244
if not osutils.is_inside_any(view_files, filename):
245
raise errors.FileOutsideView(filename, view_files)
246
file_list = file_list[:]
247
file_list[0] = tree.abspath(relpath)
249
tree = WorkingTree.open_containing(u'.')[0]
250
if tree.supports_views():
251
view_files = tree.views.lookup_view()
253
file_list = view_files
254
view_str = views.view_display_str(view_files)
255
note(gettext("Ignoring files outside view. View is %s") % view_str)
256
return tree, file_list
259
def _get_one_revision(command_name, revisions):
260
if revisions is None:
262
if len(revisions) != 1:
263
raise errors.BzrCommandError(gettext(
264
'brz %s --revision takes exactly one revision identifier') % (
269
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
270
"""Get a revision tree. Not suitable for commands that change the tree.
272
Specifically, the basis tree in dirstate trees is coupled to the dirstate
273
and doing a commit/uncommit/pull will at best fail due to changing the
276
If tree is passed in, it should be already locked, for lifetime management
277
of the trees internal cached state.
281
if revisions is None:
283
rev_tree = tree.basis_tree()
285
rev_tree = branch.basis_tree()
287
revision = _get_one_revision(command_name, revisions)
288
rev_tree = revision.as_tree(branch)
292
def _get_view_info_for_change_reporter(tree):
293
"""Get the view information from a tree for change reporting."""
296
current_view = tree.views.get_view_info()[0]
297
if current_view is not None:
298
view_info = (current_view, tree.views.lookup_view())
299
except errors.ViewsNotSupported:
304
def _open_directory_or_containing_tree_or_branch(filename, directory):
305
"""Open the tree or branch containing the specified file, unless
306
the --directory option is used to specify a different branch."""
307
if directory is not None:
308
return (None, Branch.open(directory), filename)
309
return controldir.ControlDir.open_containing_tree_or_branch(filename)
312
# TODO: Make sure no commands unconditionally use the working directory as a
313
# branch. If a filename argument is used, the first of them should be used to
314
# specify the branch. (Perhaps this can be factored out into some kind of
315
# Argument class, representing a file in a branch, where the first occurrence
318
class cmd_status(Command):
319
__doc__ = """Display status summary.
321
This reports on versioned and unknown files, reporting them
322
grouped by state. Possible states are:
325
Versioned in the working copy but not in the previous revision.
328
Versioned in the previous revision but removed or deleted
332
Path of this file changed from the previous revision;
333
the text may also have changed. This includes files whose
334
parent directory was renamed.
337
Text has changed since the previous revision.
340
File kind has been changed (e.g. from file to directory).
343
Not versioned and not matching an ignore pattern.
345
Additionally for directories, symlinks and files with a changed
346
executable bit, Bazaar indicates their type using a trailing
347
character: '/', '@' or '*' respectively. These decorations can be
348
disabled using the '--no-classify' option.
350
To see ignored files use 'brz ignored'. For details on the
351
changes to file texts, use 'brz diff'.
353
Note that --short or -S gives status flags for each item, similar
354
to Subversion's status command. To get output similar to svn -q,
357
If no arguments are specified, the status of the entire working
358
directory is shown. Otherwise, only the status of the specified
359
files or directories is reported. If a directory is given, status
360
is reported for everything inside that directory.
362
Before merges are committed, the pending merge tip revisions are
363
shown. To see all pending merge revisions, use the -v option.
364
To skip the display of pending merge information altogether, use
365
the no-pending option or specify a file/directory.
367
To compare the working directory to a specific revision, pass a
368
single revision to the revision argument.
370
To see which files have changed in a specific revision, or between
371
two revisions, pass a revision range to the revision argument.
372
This will produce the same results as calling 'brz diff --summarize'.
375
# TODO: --no-recurse/-N, --recurse options
377
takes_args = ['file*']
378
takes_options = ['show-ids', 'revision', 'change', 'verbose',
379
Option('short', help='Use short status indicators.',
381
Option('versioned', help='Only show versioned files.',
383
Option('no-pending', help='Don\'t show pending merges.',
385
Option('no-classify',
386
help='Do not mark object type using indicator.',
389
aliases = ['st', 'stat']
391
encoding_type = 'replace'
392
_see_also = ['diff', 'revert', 'status-flags']
395
def run(self, show_ids=False, file_list=None, revision=None, short=False,
396
versioned=False, no_pending=False, verbose=False,
398
from .status import show_tree_status
400
if revision and len(revision) > 2:
401
raise errors.BzrCommandError(gettext('brz status --revision takes exactly'
402
' one or two revision specifiers'))
404
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
405
# Avoid asking for specific files when that is not needed.
406
if relfile_list == ['']:
408
# Don't disable pending merges for full trees other than '.'.
409
if file_list == ['.']:
411
# A specific path within a tree was given.
412
elif relfile_list is not None:
414
show_tree_status(tree, show_ids=show_ids,
415
specific_files=relfile_list, revision=revision,
416
to_file=self.outf, short=short, versioned=versioned,
417
show_pending=(not no_pending), verbose=verbose,
418
classify=not no_classify)
421
class cmd_cat_revision(Command):
422
__doc__ = """Write out metadata for a revision.
424
The revision to print can either be specified by a specific
425
revision identifier, or you can use --revision.
429
takes_args = ['revision_id?']
430
takes_options = ['directory', 'revision']
431
# cat-revision is more for frontends so should be exact
434
def print_revision(self, revisions, revid):
435
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
436
record = next(stream)
437
if record.storage_kind == 'absent':
438
raise errors.NoSuchRevision(revisions, revid)
439
revtext = record.get_bytes_as('fulltext')
440
self.outf.write(revtext.decode('utf-8'))
443
def run(self, revision_id=None, revision=None, directory=u'.'):
444
if revision_id is not None and revision is not None:
445
raise errors.BzrCommandError(gettext('You can only supply one of'
446
' revision_id or --revision'))
447
if revision_id is None and revision is None:
448
raise errors.BzrCommandError(gettext('You must supply either'
449
' --revision or a revision_id'))
451
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
453
revisions = b.repository.revisions
454
if revisions is None:
455
raise errors.BzrCommandError(gettext('Repository %r does not support '
456
'access to raw revision texts'))
458
b.repository.lock_read()
460
# TODO: jam 20060112 should cat-revision always output utf-8?
461
if revision_id is not None:
462
revision_id = cache_utf8.encode(revision_id)
464
self.print_revision(revisions, revision_id)
465
except errors.NoSuchRevision:
466
msg = gettext("The repository {0} contains no revision {1}.").format(
467
b.repository.base, revision_id)
468
raise errors.BzrCommandError(msg)
469
elif revision is not None:
472
raise errors.BzrCommandError(
473
gettext('You cannot specify a NULL revision.'))
474
rev_id = rev.as_revision_id(b)
475
self.print_revision(revisions, rev_id)
477
b.repository.unlock()
480
class cmd_dump_btree(Command):
481
__doc__ = """Dump the contents of a btree index file to stdout.
483
PATH is a btree index file, it can be any URL. This includes things like
484
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
486
By default, the tuples stored in the index file will be displayed. With
487
--raw, we will uncompress the pages, but otherwise display the raw bytes
491
# TODO: Do we want to dump the internal nodes as well?
492
# TODO: It would be nice to be able to dump the un-parsed information,
493
# rather than only going through iter_all_entries. However, this is
494
# good enough for a start
496
encoding_type = 'exact'
497
takes_args = ['path']
498
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
499
' rather than the parsed tuples.'),
502
def run(self, path, raw=False):
503
dirname, basename = osutils.split(path)
504
t = transport.get_transport(dirname)
506
self._dump_raw_bytes(t, basename)
508
self._dump_entries(t, basename)
510
def _get_index_and_bytes(self, trans, basename):
511
"""Create a BTreeGraphIndex and raw bytes."""
512
bt = btree_index.BTreeGraphIndex(trans, basename, None)
513
bytes = trans.get_bytes(basename)
514
bt._file = BytesIO(bytes)
515
bt._size = len(bytes)
518
def _dump_raw_bytes(self, trans, basename):
521
# We need to parse at least the root node.
522
# This is because the first page of every row starts with an
523
# uncompressed header.
524
bt, bytes = self._get_index_and_bytes(trans, basename)
525
for page_idx, page_start in enumerate(range(0, len(bytes),
526
btree_index._PAGE_SIZE)):
527
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
528
page_bytes = bytes[page_start:page_end]
530
self.outf.write('Root node:\n')
531
header_end, data = bt._parse_header_from_bytes(page_bytes)
532
self.outf.write(page_bytes[:header_end])
534
self.outf.write('\nPage %d\n' % (page_idx,))
535
if len(page_bytes) == 0:
536
self.outf.write('(empty)\n');
538
decomp_bytes = zlib.decompress(page_bytes)
539
self.outf.write(decomp_bytes)
540
self.outf.write('\n')
542
def _dump_entries(self, trans, basename):
544
st = trans.stat(basename)
545
except errors.TransportNotPossible:
546
# We can't stat, so we'll fake it because we have to do the 'get()'
548
bt, _ = self._get_index_and_bytes(trans, basename)
550
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
551
for node in bt.iter_all_entries():
552
# Node is made up of:
553
# (index, key, value, [references])
557
refs_as_tuples = None
559
refs_as_tuples = static_tuple.as_tuples(refs)
560
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
561
self.outf.write('%s\n' % (as_tuple,))
564
class cmd_remove_tree(Command):
565
__doc__ = """Remove the working tree from a given branch/checkout.
567
Since a lightweight checkout is little more than a working tree
568
this will refuse to run against one.
570
To re-create the working tree, use "brz checkout".
572
_see_also = ['checkout', 'working-trees']
573
takes_args = ['location*']
576
help='Remove the working tree even if it has '
577
'uncommitted or shelved changes.'),
580
def run(self, location_list, force=False):
581
if not location_list:
584
for location in location_list:
585
d = controldir.ControlDir.open(location)
588
working = d.open_workingtree()
589
except errors.NoWorkingTree:
590
raise errors.BzrCommandError(gettext("No working tree to remove"))
591
except errors.NotLocalUrl:
592
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
593
" of a remote path"))
595
if (working.has_changes()):
596
raise errors.UncommittedChanges(working)
597
if working.get_shelf_manager().last_shelf() is not None:
598
raise errors.ShelvedChanges(working)
600
if working.user_url != working.branch.user_url:
601
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
602
" from a lightweight checkout"))
604
d.destroy_workingtree()
607
class cmd_repair_workingtree(Command):
608
__doc__ = """Reset the working tree state file.
610
This is not meant to be used normally, but more as a way to recover from
611
filesystem corruption, etc. This rebuilds the working inventory back to a
612
'known good' state. Any new modifications (adding a file, renaming, etc)
613
will be lost, though modified files will still be detected as such.
615
Most users will want something more like "brz revert" or "brz update"
616
unless the state file has become corrupted.
618
By default this attempts to recover the current state by looking at the
619
headers of the state file. If the state file is too corrupted to even do
620
that, you can supply --revision to force the state of the tree.
623
takes_options = ['revision', 'directory',
625
help='Reset the tree even if it doesn\'t appear to be'
630
def run(self, revision=None, directory='.', force=False):
631
tree, _ = WorkingTree.open_containing(directory)
632
self.add_cleanup(tree.lock_tree_write().unlock)
636
except errors.BzrError:
637
pass # There seems to be a real error here, so we'll reset
640
raise errors.BzrCommandError(gettext(
641
'The tree does not appear to be corrupt. You probably'
642
' want "brz revert" instead. Use "--force" if you are'
643
' sure you want to reset the working tree.'))
647
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
649
tree.reset_state(revision_ids)
650
except errors.BzrError as e:
651
if revision_ids is None:
652
extra = (gettext(', the header appears corrupt, try passing -r -1'
653
' to set the state to the last commit'))
656
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
659
class cmd_revno(Command):
660
__doc__ = """Show current revision number.
662
This is equal to the number of revisions on this branch.
666
takes_args = ['location?']
668
Option('tree', help='Show revno of working tree.'),
673
def run(self, tree=False, location=u'.', revision=None):
674
if revision is not None and tree:
675
raise errors.BzrCommandError(gettext("--tree and --revision can "
676
"not be used together"))
680
wt = WorkingTree.open_containing(location)[0]
681
self.add_cleanup(wt.lock_read().unlock)
682
except (errors.NoWorkingTree, errors.NotLocalUrl):
683
raise errors.NoWorkingTree(location)
685
revid = wt.last_revision()
687
b = Branch.open_containing(location)[0]
688
self.add_cleanup(b.lock_read().unlock)
690
if len(revision) != 1:
691
raise errors.BzrCommandError(gettext(
692
"Revision numbers only make sense for single "
693
"revisions, not ranges"))
694
revid = revision[0].as_revision_id(b)
696
revid = b.last_revision()
698
revno_t = b.revision_id_to_dotted_revno(revid)
699
except errors.NoSuchRevision:
701
revno = ".".join(str(n) for n in revno_t)
703
self.outf.write(revno + '\n')
706
class cmd_revision_info(Command):
707
__doc__ = """Show revision number and revision id for a given revision identifier.
710
takes_args = ['revision_info*']
713
custom_help('directory',
714
help='Branch to examine, '
715
'rather than the one containing the working directory.'),
716
Option('tree', help='Show revno of working tree.'),
720
def run(self, revision=None, directory=u'.', tree=False,
721
revision_info_list=[]):
724
wt = WorkingTree.open_containing(directory)[0]
726
self.add_cleanup(wt.lock_read().unlock)
727
except (errors.NoWorkingTree, errors.NotLocalUrl):
729
b = Branch.open_containing(directory)[0]
730
self.add_cleanup(b.lock_read().unlock)
732
if revision is not None:
733
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
734
if revision_info_list is not None:
735
for rev_str in revision_info_list:
736
rev_spec = RevisionSpec.from_string(rev_str)
737
revision_ids.append(rev_spec.as_revision_id(b))
738
# No arguments supplied, default to the last revision
739
if len(revision_ids) == 0:
742
raise errors.NoWorkingTree(directory)
743
revision_ids.append(wt.last_revision())
745
revision_ids.append(b.last_revision())
749
for revision_id in revision_ids:
751
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
752
revno = '.'.join(str(i) for i in dotted_revno)
753
except errors.NoSuchRevision:
755
maxlen = max(maxlen, len(revno))
756
revinfos.append([revno, revision_id])
760
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
763
class cmd_add(Command):
764
__doc__ = """Add specified files or directories.
766
In non-recursive mode, all the named items are added, regardless
767
of whether they were previously ignored. A warning is given if
768
any of the named files are already versioned.
770
In recursive mode (the default), files are treated the same way
771
but the behaviour for directories is different. Directories that
772
are already versioned do not give a warning. All directories,
773
whether already versioned or not, are searched for files or
774
subdirectories that are neither versioned or ignored, and these
775
are added. This search proceeds recursively into versioned
776
directories. If no names are given '.' is assumed.
778
A warning will be printed when nested trees are encountered,
779
unless they are explicitly ignored.
781
Therefore simply saying 'brz add' will version all files that
782
are currently unknown.
784
Adding a file whose parent directory is not versioned will
785
implicitly add the parent, and so on up to the root. This means
786
you should never need to explicitly add a directory, they'll just
787
get added when you add a file in the directory.
789
--dry-run will show which files would be added, but not actually
792
--file-ids-from will try to use the file ids from the supplied path.
793
It looks up ids trying to find a matching parent directory with the
794
same filename, and then by pure path. This option is rarely needed
795
but can be useful when adding the same logical file into two
796
branches that will be merged later (without showing the two different
797
adds as a conflict). It is also useful when merging another project
798
into a subdirectory of this one.
800
Any files matching patterns in the ignore list will not be added
801
unless they are explicitly mentioned.
803
In recursive mode, files larger than the configuration option
804
add.maximum_file_size will be skipped. Named items are never skipped due
807
takes_args = ['file*']
810
help="Don't recursively add the contents of directories.",
813
help="Show what would be done, but don't actually do anything."),
815
Option('file-ids-from',
817
help='Lookup file ids from this tree.'),
819
encoding_type = 'replace'
820
_see_also = ['remove', 'ignore']
822
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
827
if file_ids_from is not None:
829
base_tree, base_path = WorkingTree.open_containing(
831
except errors.NoWorkingTree:
832
base_branch, base_path = Branch.open_containing(
834
base_tree = base_branch.basis_tree()
836
action = breezy.add.AddFromBaseAction(base_tree, base_path,
837
to_file=self.outf, should_print=(not is_quiet()))
839
action = breezy.add.AddWithSkipLargeAction(to_file=self.outf,
840
should_print=(not is_quiet()))
843
self.add_cleanup(base_tree.lock_read().unlock)
844
tree, file_list = tree_files_for_add(file_list)
845
added, ignored = tree.smart_add(file_list, not
846
no_recurse, action=action, save=not dry_run)
850
for glob in sorted(ignored):
851
for path in ignored[glob]:
853
gettext("ignored {0} matching \"{1}\"\n").format(
857
class cmd_mkdir(Command):
858
__doc__ = """Create a new versioned directory.
860
This is equivalent to creating the directory and then adding it.
863
takes_args = ['dir+']
867
help='No error if existing, make parent directories as needed.',
871
encoding_type = 'replace'
874
def add_file_with_parents(cls, wt, relpath):
875
if wt.path2id(relpath) is not None:
877
cls.add_file_with_parents(wt, osutils.dirname(relpath))
881
def add_file_single(cls, wt, relpath):
884
def run(self, dir_list, parents=False):
886
add_file = self.add_file_with_parents
888
add_file = self.add_file_single
890
wt, relpath = WorkingTree.open_containing(dir)
895
if e.errno != errno.EEXIST:
899
add_file(wt, relpath)
901
self.outf.write(gettext('added %s\n') % dir)
904
class cmd_relpath(Command):
905
__doc__ = """Show path of a file relative to root"""
907
takes_args = ['filename']
911
def run(self, filename):
912
# TODO: jam 20050106 Can relpath return a munged path if
913
# sys.stdout encoding cannot represent it?
914
tree, relpath = WorkingTree.open_containing(filename)
915
self.outf.write(relpath)
916
self.outf.write('\n')
919
class cmd_inventory(Command):
920
__doc__ = """Show inventory of the current working copy or a revision.
922
It is possible to limit the output to a particular entry
923
type using the --kind option. For example: --kind file.
925
It is also possible to restrict the list of files to a specific
926
set. For example: brz inventory --show-ids this/file
935
help='List entries of a particular kind: file, directory, symlink.',
938
takes_args = ['file*']
941
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
942
if kind and kind not in ['file', 'directory', 'symlink']:
943
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
945
revision = _get_one_revision('inventory', revision)
946
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
947
self.add_cleanup(work_tree.lock_read().unlock)
948
if revision is not None:
949
tree = revision.as_tree(work_tree.branch)
951
extra_trees = [work_tree]
952
self.add_cleanup(tree.lock_read().unlock)
957
self.add_cleanup(tree.lock_read().unlock)
958
if file_list is not None:
959
file_ids = tree.paths2ids(file_list, trees=extra_trees,
960
require_versioned=True)
961
# find_ids_across_trees may include some paths that don't
963
entries = tree.iter_entries_by_dir(specific_file_ids=file_ids)
965
entries = tree.iter_entries_by_dir()
967
for path, entry in sorted(entries):
968
if kind and kind != entry.kind:
973
self.outf.write('%-50s %s\n' % (path, entry.file_id))
975
self.outf.write(path)
976
self.outf.write('\n')
979
class cmd_mv(Command):
980
__doc__ = """Move or rename a file.
983
brz mv OLDNAME NEWNAME
985
brz mv SOURCE... DESTINATION
987
If the last argument is a versioned directory, all the other names
988
are moved into it. Otherwise, there must be exactly two arguments
989
and the file is changed to a new name.
991
If OLDNAME does not exist on the filesystem but is versioned and
992
NEWNAME does exist on the filesystem but is not versioned, mv
993
assumes that the file has been manually moved and only updates
994
its internal inventory to reflect that change.
995
The same is valid when moving many SOURCE files to a DESTINATION.
997
Files cannot be moved between branches.
1000
takes_args = ['names*']
1001
takes_options = [Option("after", help="Move only the brz identifier"
1002
" of the file, because the file has already been moved."),
1003
Option('auto', help='Automatically guess renames.'),
1004
Option('dry-run', help='Avoid making changes when guessing renames.'),
1006
aliases = ['move', 'rename']
1007
encoding_type = 'replace'
1009
def run(self, names_list, after=False, auto=False, dry_run=False):
1011
return self.run_auto(names_list, after, dry_run)
1013
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1014
if names_list is None:
1016
if len(names_list) < 2:
1017
raise errors.BzrCommandError(gettext("missing file argument"))
1018
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1019
for file_name in rel_names[0:-1]:
1021
raise errors.BzrCommandError(gettext("can not move root of branch"))
1022
self.add_cleanup(tree.lock_tree_write().unlock)
1023
self._run(tree, names_list, rel_names, after)
1025
def run_auto(self, names_list, after, dry_run):
1026
if names_list is not None and len(names_list) > 1:
1027
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1030
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1032
work_tree, file_list = WorkingTree.open_containing_paths(
1033
names_list, default_directory='.')
1034
self.add_cleanup(work_tree.lock_tree_write().unlock)
1035
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1037
def _run(self, tree, names_list, rel_names, after):
1038
into_existing = osutils.isdir(names_list[-1])
1039
if into_existing and len(names_list) == 2:
1041
# a. case-insensitive filesystem and change case of dir
1042
# b. move directory after the fact (if the source used to be
1043
# a directory, but now doesn't exist in the working tree
1044
# and the target is an existing directory, just rename it)
1045
if (not tree.case_sensitive
1046
and rel_names[0].lower() == rel_names[1].lower()):
1047
into_existing = False
1049
# 'fix' the case of a potential 'from'
1050
from_id = tree.path2id(
1051
tree.get_canonical_inventory_path(rel_names[0]))
1052
if (not osutils.lexists(names_list[0]) and
1053
from_id and tree.stored_kind(from_id) == "directory"):
1054
into_existing = False
1057
# move into existing directory
1058
# All entries reference existing inventory items, so fix them up
1059
# for cicp file-systems.
1060
rel_names = tree.get_canonical_inventory_paths(rel_names)
1061
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1063
self.outf.write("%s => %s\n" % (src, dest))
1065
if len(names_list) != 2:
1066
raise errors.BzrCommandError(gettext('to mv multiple files the'
1067
' destination must be a versioned'
1070
# for cicp file-systems: the src references an existing inventory
1072
src = tree.get_canonical_inventory_path(rel_names[0])
1073
# Find the canonical version of the destination: In all cases, the
1074
# parent of the target must be in the inventory, so we fetch the
1075
# canonical version from there (we do not always *use* the
1076
# canonicalized tail portion - we may be attempting to rename the
1078
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1079
dest_parent = osutils.dirname(canon_dest)
1080
spec_tail = osutils.basename(rel_names[1])
1081
# For a CICP file-system, we need to avoid creating 2 inventory
1082
# entries that differ only by case. So regardless of the case
1083
# we *want* to use (ie, specified by the user or the file-system),
1084
# we must always choose to use the case of any existing inventory
1085
# items. The only exception to this is when we are attempting a
1086
# case-only rename (ie, canonical versions of src and dest are
1088
dest_id = tree.path2id(canon_dest)
1089
if dest_id is None or tree.path2id(src) == dest_id:
1090
# No existing item we care about, so work out what case we
1091
# are actually going to use.
1093
# If 'after' is specified, the tail must refer to a file on disk.
1095
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1097
# pathjoin with an empty tail adds a slash, which breaks
1099
dest_parent_fq = tree.basedir
1101
dest_tail = osutils.canonical_relpath(
1103
osutils.pathjoin(dest_parent_fq, spec_tail))
1105
# not 'after', so case as specified is used
1106
dest_tail = spec_tail
1108
# Use the existing item so 'mv' fails with AlreadyVersioned.
1109
dest_tail = os.path.basename(canon_dest)
1110
dest = osutils.pathjoin(dest_parent, dest_tail)
1111
mutter("attempting to move %s => %s", src, dest)
1112
tree.rename_one(src, dest, after=after)
1114
self.outf.write("%s => %s\n" % (src, dest))
1117
class cmd_pull(Command):
1118
__doc__ = """Turn this branch into a mirror of another branch.
1120
By default, this command only works on branches that have not diverged.
1121
Branches are considered diverged if the destination branch's most recent
1122
commit is one that has not been merged (directly or indirectly) into the
1125
If branches have diverged, you can use 'brz merge' to integrate the changes
1126
from one into the other. Once one branch has merged, the other should
1127
be able to pull it again.
1129
If you want to replace your local changes and just want your branch to
1130
match the remote one, use pull --overwrite. This will work even if the two
1131
branches have diverged.
1133
If there is no default location set, the first pull will set it (use
1134
--no-remember to avoid setting it). After that, you can omit the
1135
location to use the default. To change the default, use --remember. The
1136
value will only be saved if the remote location can be accessed.
1138
The --verbose option will display the revisions pulled using the log_format
1139
configuration option. You can use a different format by overriding it with
1140
-Olog_format=<other_format>.
1142
Note: The location can be specified either in the form of a branch,
1143
or in the form of a path to a file containing a merge directive generated
1147
_see_also = ['push', 'update', 'status-flags', 'send']
1148
takes_options = ['remember', 'overwrite', 'revision',
1149
custom_help('verbose',
1150
help='Show logs of pulled revisions.'),
1151
custom_help('directory',
1152
help='Branch to pull into, '
1153
'rather than the one containing the working directory.'),
1155
help="Perform a local pull in a bound "
1156
"branch. Local pulls are not applied to "
1157
"the master branch."
1160
help="Show base revision text in conflicts."),
1161
Option('overwrite-tags',
1162
help="Overwrite tags only."),
1164
takes_args = ['location?']
1165
encoding_type = 'replace'
1167
def run(self, location=None, remember=None, overwrite=False,
1168
revision=None, verbose=False,
1169
directory=None, local=False,
1170
show_base=False, overwrite_tags=False):
1173
overwrite = ["history", "tags"]
1174
elif overwrite_tags:
1175
overwrite = ["tags"]
1178
# FIXME: too much stuff is in the command class
1181
if directory is None:
1184
tree_to = WorkingTree.open_containing(directory)[0]
1185
branch_to = tree_to.branch
1186
self.add_cleanup(tree_to.lock_write().unlock)
1187
except errors.NoWorkingTree:
1189
branch_to = Branch.open_containing(directory)[0]
1190
self.add_cleanup(branch_to.lock_write().unlock)
1192
warning(gettext("No working tree, ignoring --show-base"))
1194
if local and not branch_to.get_bound_location():
1195
raise errors.LocalRequiresBoundBranch()
1197
possible_transports = []
1198
if location is not None:
1200
mergeable = bundle.read_mergeable_from_url(location,
1201
possible_transports=possible_transports)
1202
except errors.NotABundle:
1205
stored_loc = branch_to.get_parent()
1206
if location is None:
1207
if stored_loc is None:
1208
raise errors.BzrCommandError(gettext("No pull location known or"
1211
display_url = urlutils.unescape_for_display(stored_loc,
1214
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1215
location = stored_loc
1217
revision = _get_one_revision('pull', revision)
1218
if mergeable is not None:
1219
if revision is not None:
1220
raise errors.BzrCommandError(gettext(
1221
'Cannot use -r with merge directives or bundles'))
1222
mergeable.install_revisions(branch_to.repository)
1223
base_revision_id, revision_id, verified = \
1224
mergeable.get_merge_request(branch_to.repository)
1225
branch_from = branch_to
1227
branch_from = Branch.open(location,
1228
possible_transports=possible_transports)
1229
self.add_cleanup(branch_from.lock_read().unlock)
1230
# Remembers if asked explicitly or no previous location is set
1232
or (remember is None and branch_to.get_parent() is None)):
1233
# FIXME: This shouldn't be done before the pull
1234
# succeeds... -- vila 2012-01-02
1235
branch_to.set_parent(branch_from.base)
1237
if revision is not None:
1238
revision_id = revision.as_revision_id(branch_from)
1240
if tree_to is not None:
1241
view_info = _get_view_info_for_change_reporter(tree_to)
1242
change_reporter = delta._ChangeReporter(
1243
unversioned_filter=tree_to.is_ignored,
1244
view_info=view_info)
1245
result = tree_to.pull(
1246
branch_from, overwrite, revision_id, change_reporter,
1247
local=local, show_base=show_base)
1249
result = branch_to.pull(
1250
branch_from, overwrite, revision_id, local=local)
1252
result.report(self.outf)
1253
if verbose and result.old_revid != result.new_revid:
1254
log.show_branch_change(
1255
branch_to, self.outf, result.old_revno,
1257
if getattr(result, 'tag_conflicts', None):
1263
class cmd_push(Command):
1264
__doc__ = """Update a mirror of this branch.
1266
The target branch will not have its working tree populated because this
1267
is both expensive, and is not supported on remote file systems.
1269
Some smart servers or protocols *may* put the working tree in place in
1272
This command only works on branches that have not diverged. Branches are
1273
considered diverged if the destination branch's most recent commit is one
1274
that has not been merged (directly or indirectly) by the source branch.
1276
If branches have diverged, you can use 'brz push --overwrite' to replace
1277
the other branch completely, discarding its unmerged changes.
1279
If you want to ensure you have the different changes in the other branch,
1280
do a merge (see brz help merge) from the other branch, and commit that.
1281
After that you will be able to do a push without '--overwrite'.
1283
If there is no default push location set, the first push will set it (use
1284
--no-remember to avoid setting it). After that, you can omit the
1285
location to use the default. To change the default, use --remember. The
1286
value will only be saved if the remote location can be accessed.
1288
The --verbose option will display the revisions pushed using the log_format
1289
configuration option. You can use a different format by overriding it with
1290
-Olog_format=<other_format>.
1293
_see_also = ['pull', 'update', 'working-trees']
1294
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1295
Option('create-prefix',
1296
help='Create the path leading up to the branch '
1297
'if it does not already exist.'),
1298
custom_help('directory',
1299
help='Branch to push from, '
1300
'rather than the one containing the working directory.'),
1301
Option('use-existing-dir',
1302
help='By default push will fail if the target'
1303
' directory exists, but does not already'
1304
' have a control directory. This flag will'
1305
' allow push to proceed.'),
1307
help='Create a stacked branch that references the public location '
1308
'of the parent branch.'),
1309
Option('stacked-on',
1310
help='Create a stacked branch that refers to another branch '
1311
'for the commit history. Only the work not present in the '
1312
'referenced branch is included in the branch created.',
1315
help='Refuse to push if there are uncommitted changes in'
1316
' the working tree, --no-strict disables the check.'),
1318
help="Don't populate the working tree, even for protocols"
1319
" that support it."),
1320
Option('overwrite-tags',
1321
help="Overwrite tags only."),
1323
takes_args = ['location?']
1324
encoding_type = 'replace'
1326
def run(self, location=None, remember=None, overwrite=False,
1327
create_prefix=False, verbose=False, revision=None,
1328
use_existing_dir=False, directory=None, stacked_on=None,
1329
stacked=False, strict=None, no_tree=False,
1330
overwrite_tags=False):
1331
from .push import _show_push_branch
1334
overwrite = ["history", "tags"]
1335
elif overwrite_tags:
1336
overwrite = ["tags"]
1340
if directory is None:
1342
# Get the source branch
1344
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1345
# Get the tip's revision_id
1346
revision = _get_one_revision('push', revision)
1347
if revision is not None:
1348
revision_id = revision.in_history(br_from).rev_id
1351
if tree is not None and revision_id is None:
1352
tree.check_changed_or_out_of_date(
1353
strict, 'push_strict',
1354
more_error='Use --no-strict to force the push.',
1355
more_warning='Uncommitted changes will not be pushed.')
1356
# Get the stacked_on branch, if any
1357
if stacked_on is not None:
1358
stacked_on = urlutils.normalize_url(stacked_on)
1360
parent_url = br_from.get_parent()
1362
parent = Branch.open(parent_url)
1363
stacked_on = parent.get_public_branch()
1365
# I considered excluding non-http url's here, thus forcing
1366
# 'public' branches only, but that only works for some
1367
# users, so it's best to just depend on the user spotting an
1368
# error by the feedback given to them. RBC 20080227.
1369
stacked_on = parent_url
1371
raise errors.BzrCommandError(gettext(
1372
"Could not determine branch to refer to."))
1374
# Get the destination location
1375
if location is None:
1376
stored_loc = br_from.get_push_location()
1377
if stored_loc is None:
1378
parent_loc = br_from.get_parent()
1380
raise errors.BzrCommandError(gettext(
1381
"No push location known or specified. To push to the "
1382
"parent branch (at %s), use 'brz push :parent'." %
1383
urlutils.unescape_for_display(parent_loc,
1384
self.outf.encoding)))
1386
raise errors.BzrCommandError(gettext(
1387
"No push location known or specified."))
1389
display_url = urlutils.unescape_for_display(stored_loc,
1391
note(gettext("Using saved push location: %s") % display_url)
1392
location = stored_loc
1394
_show_push_branch(br_from, revision_id, location, self.outf,
1395
verbose=verbose, overwrite=overwrite, remember=remember,
1396
stacked_on=stacked_on, create_prefix=create_prefix,
1397
use_existing_dir=use_existing_dir, no_tree=no_tree)
1400
class cmd_branch(Command):
1401
__doc__ = """Create a new branch that is a copy of an existing branch.
1403
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1404
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1405
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1406
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1407
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1410
To retrieve the branch as of a particular revision, supply the --revision
1411
parameter, as in "branch foo/bar -r 5".
1413
The synonyms 'clone' and 'get' for this command are deprecated.
1416
_see_also = ['checkout']
1417
takes_args = ['from_location', 'to_location?']
1418
takes_options = ['revision',
1419
Option('hardlink', help='Hard-link working tree files where possible.'),
1420
Option('files-from', type=str,
1421
help="Get file contents from this tree."),
1423
help="Create a branch without a working-tree."),
1425
help="Switch the checkout in the current directory "
1426
"to the new branch."),
1428
help='Create a stacked branch referring to the source branch. '
1429
'The new branch will depend on the availability of the source '
1430
'branch for all operations.'),
1431
Option('standalone',
1432
help='Do not use a shared repository, even if available.'),
1433
Option('use-existing-dir',
1434
help='By default branch will fail if the target'
1435
' directory exists, but does not already'
1436
' have a control directory. This flag will'
1437
' allow branch to proceed.'),
1439
help="Bind new branch to from location."),
1441
aliases = ['get', 'clone']
1443
def run(self, from_location, to_location=None, revision=None,
1444
hardlink=False, stacked=False, standalone=False, no_tree=False,
1445
use_existing_dir=False, switch=False, bind=False,
1447
from breezy import switch as _mod_switch
1448
if self.invoked_as in ['get', 'clone']:
1449
ui.ui_factory.show_user_warning(
1450
'deprecated_command',
1451
deprecated_name=self.invoked_as,
1452
recommended_name='branch',
1453
deprecated_in_version='2.4')
1454
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1456
if not (hardlink or files_from):
1457
# accelerator_tree is usually slower because you have to read N
1458
# files (no readahead, lots of seeks, etc), but allow the user to
1459
# explicitly request it
1460
accelerator_tree = None
1461
if files_from is not None and files_from != from_location:
1462
accelerator_tree = WorkingTree.open(files_from)
1463
revision = _get_one_revision('branch', revision)
1464
self.add_cleanup(br_from.lock_read().unlock)
1465
if revision is not None:
1466
revision_id = revision.as_revision_id(br_from)
1468
# FIXME - wt.last_revision, fallback to branch, fall back to
1469
# None or perhaps NULL_REVISION to mean copy nothing
1471
revision_id = br_from.last_revision()
1472
if to_location is None:
1473
to_location = getattr(br_from, "name", None)
1475
to_location = urlutils.derive_to_location(from_location)
1476
to_transport = transport.get_transport(to_location)
1478
to_transport.mkdir('.')
1479
except errors.FileExists:
1481
to_dir = controldir.ControlDir.open_from_transport(
1483
except errors.NotBranchError:
1484
if not use_existing_dir:
1485
raise errors.BzrCommandError(gettext('Target directory "%s" '
1486
'already exists.') % to_location)
1491
to_dir.open_branch()
1492
except errors.NotBranchError:
1495
raise errors.AlreadyBranchError(to_location)
1496
except errors.NoSuchFile:
1497
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1503
# preserve whatever source format we have.
1504
to_dir = br_from.controldir.sprout(
1505
to_transport.base, revision_id,
1506
possible_transports=[to_transport],
1507
accelerator_tree=accelerator_tree, hardlink=hardlink,
1508
stacked=stacked, force_new_repo=standalone,
1509
create_tree_if_local=not no_tree, source_branch=br_from)
1510
branch = to_dir.open_branch(
1511
possible_transports=[
1512
br_from.controldir.root_transport, to_transport])
1513
except errors.NoSuchRevision:
1514
to_transport.delete_tree('.')
1515
msg = gettext("The branch {0} has no revision {1}.").format(
1516
from_location, revision)
1517
raise errors.BzrCommandError(msg)
1520
to_repo = to_dir.open_repository()
1521
except errors.NoRepositoryPresent:
1522
to_repo = to_dir.create_repository()
1523
to_repo.fetch(br_from.repository, revision_id=revision_id)
1524
branch = br_from.sprout(to_dir, revision_id=revision_id)
1525
br_from.tags.merge_to(branch.tags)
1527
# If the source branch is stacked, the new branch may
1528
# be stacked whether we asked for that explicitly or not.
1529
# We therefore need a try/except here and not just 'if stacked:'
1531
note(gettext('Created new stacked branch referring to %s.') %
1532
branch.get_stacked_on_url())
1533
except (errors.NotStacked, errors.UnstackableBranchFormat,
1534
errors.UnstackableRepositoryFormat) as e:
1535
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1537
# Bind to the parent
1538
parent_branch = Branch.open(from_location)
1539
branch.bind(parent_branch)
1540
note(gettext('New branch bound to %s') % from_location)
1542
# Switch to the new branch
1543
wt, _ = WorkingTree.open_containing('.')
1544
_mod_switch.switch(wt.controldir, branch)
1545
note(gettext('Switched to branch: %s'),
1546
urlutils.unescape_for_display(branch.base, 'utf-8'))
1549
class cmd_branches(Command):
1550
__doc__ = """List the branches available at the current location.
1552
This command will print the names of all the branches at the current
1556
takes_args = ['location?']
1558
Option('recursive', short_name='R',
1559
help='Recursively scan for branches rather than '
1560
'just looking in the specified location.')]
1562
def run(self, location=".", recursive=False):
1564
t = transport.get_transport(location)
1565
if not t.listable():
1566
raise errors.BzrCommandError(
1567
"Can't scan this type of location.")
1568
for b in controldir.ControlDir.find_branches(t):
1569
self.outf.write("%s\n" % urlutils.unescape_for_display(
1570
urlutils.relative_url(t.base, b.base),
1571
self.outf.encoding).rstrip("/"))
1573
dir = controldir.ControlDir.open_containing(location)[0]
1575
active_branch = dir.open_branch(name="")
1576
except errors.NotBranchError:
1577
active_branch = None
1579
for name, branch in iter_sibling_branches(dir):
1582
active = (active_branch is not None and
1583
active_branch.base == branch.base)
1584
names[name] = active
1585
# Only mention the current branch explicitly if it's not
1586
# one of the colocated branches
1587
if not any(viewvalues(names)) and active_branch is not None:
1588
self.outf.write("* %s\n" % gettext("(default)"))
1589
for name in sorted(names):
1590
active = names[name]
1595
self.outf.write("%s %s\n" % (
1596
prefix, name.encode(self.outf.encoding)))
1599
class cmd_checkout(Command):
1600
__doc__ = """Create a new checkout of an existing branch.
1602
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1603
the branch found in '.'. This is useful if you have removed the working tree
1604
or if it was never created - i.e. if you pushed the branch to its current
1605
location using SFTP.
1607
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1608
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1609
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1610
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1611
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1614
To retrieve the branch as of a particular revision, supply the --revision
1615
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1616
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1620
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1621
takes_args = ['branch_location?', 'to_location?']
1622
takes_options = ['revision',
1623
Option('lightweight',
1624
help="Perform a lightweight checkout. Lightweight "
1625
"checkouts depend on access to the branch for "
1626
"every operation. Normal checkouts can perform "
1627
"common operations like diff and status without "
1628
"such access, and also support local commits."
1630
Option('files-from', type=str,
1631
help="Get file contents from this tree."),
1633
help='Hard-link working tree files where possible.'
1638
def run(self, branch_location=None, to_location=None, revision=None,
1639
lightweight=False, files_from=None, hardlink=False):
1640
if branch_location is None:
1641
branch_location = osutils.getcwd()
1642
to_location = branch_location
1643
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1645
if not (hardlink or files_from):
1646
# accelerator_tree is usually slower because you have to read N
1647
# files (no readahead, lots of seeks, etc), but allow the user to
1648
# explicitly request it
1649
accelerator_tree = None
1650
revision = _get_one_revision('checkout', revision)
1651
if files_from is not None and files_from != branch_location:
1652
accelerator_tree = WorkingTree.open(files_from)
1653
if revision is not None:
1654
revision_id = revision.as_revision_id(source)
1657
if to_location is None:
1658
to_location = urlutils.derive_to_location(branch_location)
1659
# if the source and to_location are the same,
1660
# and there is no working tree,
1661
# then reconstitute a branch
1662
if (osutils.abspath(to_location) ==
1663
osutils.abspath(branch_location)):
1665
source.controldir.open_workingtree()
1666
except errors.NoWorkingTree:
1667
source.controldir.create_workingtree(revision_id)
1669
source.create_checkout(to_location, revision_id, lightweight,
1670
accelerator_tree, hardlink)
1673
class cmd_renames(Command):
1674
__doc__ = """Show list of renamed files.
1676
# TODO: Option to show renames between two historical versions.
1678
# TODO: Only show renames under dir, rather than in the whole branch.
1679
_see_also = ['status']
1680
takes_args = ['dir?']
1683
def run(self, dir=u'.'):
1684
tree = WorkingTree.open_containing(dir)[0]
1685
self.add_cleanup(tree.lock_read().unlock)
1686
old_tree = tree.basis_tree()
1687
self.add_cleanup(old_tree.lock_read().unlock)
1689
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1690
for f, paths, c, v, p, n, k, e in iterator:
1691
if paths[0] == paths[1]:
1695
renames.append(paths)
1697
for old_name, new_name in renames:
1698
self.outf.write("%s => %s\n" % (old_name, new_name))
1701
class cmd_update(Command):
1702
__doc__ = """Update a working tree to a new revision.
1704
This will perform a merge of the destination revision (the tip of the
1705
branch, or the specified revision) into the working tree, and then make
1706
that revision the basis revision for the working tree.
1708
You can use this to visit an older revision, or to update a working tree
1709
that is out of date from its branch.
1711
If there are any uncommitted changes in the tree, they will be carried
1712
across and remain as uncommitted changes after the update. To discard
1713
these changes, use 'brz revert'. The uncommitted changes may conflict
1714
with the changes brought in by the change in basis revision.
1716
If the tree's branch is bound to a master branch, brz will also update
1717
the branch from the master.
1719
You cannot update just a single file or directory, because each Bazaar
1720
working tree has just a single basis revision. If you want to restore a
1721
file that has been removed locally, use 'brz revert' instead of 'brz
1722
update'. If you want to restore a file to its state in a previous
1723
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1724
out the old content of that file to a new location.
1726
The 'dir' argument, if given, must be the location of the root of a
1727
working tree to update. By default, the working tree that contains the
1728
current working directory is used.
1731
_see_also = ['pull', 'working-trees', 'status-flags']
1732
takes_args = ['dir?']
1733
takes_options = ['revision',
1735
help="Show base revision text in conflicts."),
1739
def run(self, dir=None, revision=None, show_base=None):
1740
if revision is not None and len(revision) != 1:
1741
raise errors.brzCommandError(gettext(
1742
"brz update --revision takes exactly one revision"))
1744
tree = WorkingTree.open_containing('.')[0]
1746
tree, relpath = WorkingTree.open_containing(dir)
1749
raise errors.BzrCommandError(gettext(
1750
"brz update can only update a whole tree, "
1751
"not a file or subdirectory"))
1752
branch = tree.branch
1753
possible_transports = []
1754
master = branch.get_master_branch(
1755
possible_transports=possible_transports)
1756
if master is not None:
1757
branch_location = master.base
1760
branch_location = tree.branch.base
1761
tree.lock_tree_write()
1762
self.add_cleanup(tree.unlock)
1763
# get rid of the final '/' and be ready for display
1764
branch_location = urlutils.unescape_for_display(
1765
branch_location.rstrip('/'),
1767
existing_pending_merges = tree.get_parent_ids()[1:]
1771
# may need to fetch data into a heavyweight checkout
1772
# XXX: this may take some time, maybe we should display a
1774
old_tip = branch.update(possible_transports)
1775
if revision is not None:
1776
revision_id = revision[0].as_revision_id(branch)
1778
revision_id = branch.last_revision()
1779
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1780
revno = branch.revision_id_to_dotted_revno(revision_id)
1781
note(gettext("Tree is up to date at revision {0} of branch {1}"
1782
).format('.'.join(map(str, revno)), branch_location))
1784
view_info = _get_view_info_for_change_reporter(tree)
1785
change_reporter = delta._ChangeReporter(
1786
unversioned_filter=tree.is_ignored,
1787
view_info=view_info)
1789
conflicts = tree.update(
1791
possible_transports=possible_transports,
1792
revision=revision_id,
1794
show_base=show_base)
1795
except errors.NoSuchRevision as e:
1796
raise errors.BzrCommandError(gettext(
1797
"branch has no revision %s\n"
1798
"brz update --revision only works"
1799
" for a revision in the branch history")
1801
revno = tree.branch.revision_id_to_dotted_revno(
1802
_mod_revision.ensure_null(tree.last_revision()))
1803
note(gettext('Updated to revision {0} of branch {1}').format(
1804
'.'.join(map(str, revno)), branch_location))
1805
parent_ids = tree.get_parent_ids()
1806
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1807
note(gettext('Your local commits will now show as pending merges with '
1808
"'brz status', and can be committed with 'brz commit'."))
1815
class cmd_info(Command):
1816
__doc__ = """Show information about a working tree, branch or repository.
1818
This command will show all known locations and formats associated to the
1819
tree, branch or repository.
1821
In verbose mode, statistical information is included with each report.
1822
To see extended statistic information, use a verbosity level of 2 or
1823
higher by specifying the verbose option multiple times, e.g. -vv.
1825
Branches and working trees will also report any missing revisions.
1829
Display information on the format and related locations:
1833
Display the above together with extended format information and
1834
basic statistics (like the number of files in the working tree and
1835
number of revisions in the branch and repository):
1839
Display the above together with number of committers to the branch:
1843
_see_also = ['revno', 'working-trees', 'repositories']
1844
takes_args = ['location?']
1845
takes_options = ['verbose']
1846
encoding_type = 'replace'
1849
def run(self, location=None, verbose=False):
1851
noise_level = get_verbosity_level()
1854
from .info import show_bzrdir_info
1855
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1856
verbose=noise_level, outfile=self.outf)
1859
class cmd_remove(Command):
1860
__doc__ = """Remove files or directories.
1862
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1863
delete them if they can easily be recovered using revert otherwise they
1864
will be backed up (adding an extension of the form .~#~). If no options or
1865
parameters are given Bazaar will scan for files that are being tracked by
1866
Bazaar but missing in your tree and stop tracking them for you.
1868
takes_args = ['file*']
1869
takes_options = ['verbose',
1870
Option('new', help='Only remove files that have never been committed.'),
1871
RegistryOption.from_kwargs('file-deletion-strategy',
1872
'The file deletion mode to be used.',
1873
title='Deletion Strategy', value_switches=True, enum_switch=False,
1874
safe='Backup changed files (default).',
1875
keep='Delete from brz but leave the working copy.',
1876
no_backup='Don\'t backup changed files.'),
1878
aliases = ['rm', 'del']
1879
encoding_type = 'replace'
1881
def run(self, file_list, verbose=False, new=False,
1882
file_deletion_strategy='safe'):
1884
tree, file_list = WorkingTree.open_containing_paths(file_list)
1886
if file_list is not None:
1887
file_list = [f for f in file_list]
1889
self.add_cleanup(tree.lock_write().unlock)
1890
# Heuristics should probably all move into tree.remove_smart or
1893
added = tree.changes_from(tree.basis_tree(),
1894
specific_files=file_list).added
1895
file_list = sorted([f[0] for f in added], reverse=True)
1896
if len(file_list) == 0:
1897
raise errors.BzrCommandError(gettext('No matching files.'))
1898
elif file_list is None:
1899
# missing files show up in iter_changes(basis) as
1900
# versioned-with-no-kind.
1902
for change in tree.iter_changes(tree.basis_tree()):
1903
# Find paths in the working tree that have no kind:
1904
if change[1][1] is not None and change[6][1] is None:
1905
missing.append(change[1][1])
1906
file_list = sorted(missing, reverse=True)
1907
file_deletion_strategy = 'keep'
1908
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1909
keep_files=file_deletion_strategy=='keep',
1910
force=(file_deletion_strategy=='no-backup'))
1913
class cmd_file_id(Command):
1914
__doc__ = """Print file_id of a particular file or directory.
1916
The file_id is assigned when the file is first added and remains the
1917
same through all revisions where the file exists, even when it is
1922
_see_also = ['inventory', 'ls']
1923
takes_args = ['filename']
1926
def run(self, filename):
1927
tree, relpath = WorkingTree.open_containing(filename)
1928
i = tree.path2id(relpath)
1930
raise errors.NotVersionedError(filename)
1932
self.outf.write(i + '\n')
1935
class cmd_file_path(Command):
1936
__doc__ = """Print path of file_ids to a file or directory.
1938
This prints one line for each directory down to the target,
1939
starting at the branch root.
1943
takes_args = ['filename']
1946
def run(self, filename):
1947
tree, relpath = WorkingTree.open_containing(filename)
1948
fid = tree.path2id(relpath)
1950
raise errors.NotVersionedError(filename)
1951
segments = osutils.splitpath(relpath)
1952
for pos in range(1, len(segments) + 1):
1953
path = osutils.joinpath(segments[:pos])
1954
self.outf.write("%s\n" % tree.path2id(path))
1957
class cmd_reconcile(Command):
1958
__doc__ = """Reconcile brz metadata in a branch.
1960
This can correct data mismatches that may have been caused by
1961
previous ghost operations or brz upgrades. You should only
1962
need to run this command if 'brz check' or a brz developer
1963
advises you to run it.
1965
If a second branch is provided, cross-branch reconciliation is
1966
also attempted, which will check that data like the tree root
1967
id which was not present in very early brz versions is represented
1968
correctly in both branches.
1970
At the same time it is run it may recompress data resulting in
1971
a potential saving in disk space or performance gain.
1973
The branch *MUST* be on a listable system such as local disk or sftp.
1976
_see_also = ['check']
1977
takes_args = ['branch?']
1979
Option('canonicalize-chks',
1980
help='Make sure CHKs are in canonical form (repairs '
1985
def run(self, branch=".", canonicalize_chks=False):
1986
from .reconcile import reconcile
1987
dir = controldir.ControlDir.open(branch)
1988
reconcile(dir, canonicalize_chks=canonicalize_chks)
1991
class cmd_revision_history(Command):
1992
__doc__ = """Display the list of revision ids on a branch."""
1995
takes_args = ['location?']
2000
def run(self, location="."):
2001
branch = Branch.open_containing(location)[0]
2002
self.add_cleanup(branch.lock_read().unlock)
2003
graph = branch.repository.get_graph()
2004
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
2005
[_mod_revision.NULL_REVISION]))
2006
for revid in reversed(history):
2007
self.outf.write(revid)
2008
self.outf.write('\n')
2011
class cmd_ancestry(Command):
2012
__doc__ = """List all revisions merged into this branch."""
2014
_see_also = ['log', 'revision-history']
2015
takes_args = ['location?']
2020
def run(self, location="."):
2022
wt = WorkingTree.open_containing(location)[0]
2023
except errors.NoWorkingTree:
2024
b = Branch.open(location)
2025
last_revision = b.last_revision()
2028
last_revision = wt.last_revision()
2030
self.add_cleanup(b.repository.lock_read().unlock)
2031
graph = b.repository.get_graph()
2032
revisions = [revid for revid, parents in
2033
graph.iter_ancestry([last_revision])]
2034
for revision_id in reversed(revisions):
2035
if _mod_revision.is_null(revision_id):
2037
self.outf.write(revision_id + '\n')
2040
class cmd_init(Command):
2041
__doc__ = """Make a directory into a versioned branch.
2043
Use this to create an empty branch, or before importing an
2046
If there is a repository in a parent directory of the location, then
2047
the history of the branch will be stored in the repository. Otherwise
2048
init creates a standalone branch which carries its own history
2049
in the .bzr directory.
2051
If there is already a branch at the location but it has no working tree,
2052
the tree can be populated with 'brz checkout'.
2054
Recipe for importing a tree of files::
2060
brz commit -m "imported project"
2063
_see_also = ['init-repository', 'branch', 'checkout']
2064
takes_args = ['location?']
2066
Option('create-prefix',
2067
help='Create the path leading up to the branch '
2068
'if it does not already exist.'),
2069
RegistryOption('format',
2070
help='Specify a format for this branch. '
2071
'See "help formats".',
2072
lazy_registry=('breezy.controldir', 'format_registry'),
2073
converter=lambda name: controldir.format_registry.make_controldir(name),
2074
value_switches=True,
2075
title="Branch format",
2077
Option('append-revisions-only',
2078
help='Never change revnos or the existing log.'
2079
' Append revisions to it only.'),
2081
'Create a branch without a working tree.')
2083
def run(self, location=None, format=None, append_revisions_only=False,
2084
create_prefix=False, no_tree=False):
2086
format = controldir.format_registry.make_controldir('default')
2087
if location is None:
2090
to_transport = transport.get_transport(location)
2092
# The path has to exist to initialize a
2093
# branch inside of it.
2094
# Just using os.mkdir, since I don't
2095
# believe that we want to create a bunch of
2096
# locations if the user supplies an extended path
2098
to_transport.ensure_base()
2099
except errors.NoSuchFile:
2100
if not create_prefix:
2101
raise errors.BzrCommandError(gettext("Parent directory of %s"
2103
"\nYou may supply --create-prefix to create all"
2104
" leading parent directories.")
2106
to_transport.create_prefix()
2109
a_controldir = controldir.ControlDir.open_from_transport(to_transport)
2110
except errors.NotBranchError:
2111
# really a NotBzrDir error...
2112
create_branch = controldir.ControlDir.create_branch_convenience
2114
force_new_tree = False
2116
force_new_tree = None
2117
branch = create_branch(to_transport.base, format=format,
2118
possible_transports=[to_transport],
2119
force_new_tree=force_new_tree)
2120
a_controldir = branch.controldir
2122
from .transport.local import LocalTransport
2123
if a_controldir.has_branch():
2124
if (isinstance(to_transport, LocalTransport)
2125
and not a_controldir.has_workingtree()):
2126
raise errors.BranchExistsWithoutWorkingTree(location)
2127
raise errors.AlreadyBranchError(location)
2128
branch = a_controldir.create_branch()
2129
if not no_tree and not a_controldir.has_workingtree():
2130
a_controldir.create_workingtree()
2131
if append_revisions_only:
2133
branch.set_append_revisions_only(True)
2134
except errors.UpgradeRequired:
2135
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2136
' to append-revisions-only. Try --default.'))
2138
from .info import describe_layout, describe_format
2140
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2141
except (errors.NoWorkingTree, errors.NotLocalUrl):
2143
repository = branch.repository
2144
layout = describe_layout(repository, branch, tree).lower()
2145
format = describe_format(a_controldir, repository, branch, tree)
2146
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2148
if repository.is_shared():
2149
#XXX: maybe this can be refactored into transport.path_or_url()
2150
url = repository.controldir.root_transport.external_url()
2152
url = urlutils.local_path_from_url(url)
2153
except errors.InvalidURL:
2155
self.outf.write(gettext("Using shared repository: %s\n") % url)
2158
class cmd_init_repository(Command):
2159
__doc__ = """Create a shared repository for branches to share storage space.
2161
New branches created under the repository directory will store their
2162
revisions in the repository, not in the branch directory. For branches
2163
with shared history, this reduces the amount of storage needed and
2164
speeds up the creation of new branches.
2166
If the --no-trees option is given then the branches in the repository
2167
will not have working trees by default. They will still exist as
2168
directories on disk, but they will not have separate copies of the
2169
files at a certain revision. This can be useful for repositories that
2170
store branches which are interacted with through checkouts or remote
2171
branches, such as on a server.
2174
Create a shared repository holding just branches::
2176
brz init-repo --no-trees repo
2179
Make a lightweight checkout elsewhere::
2181
brz checkout --lightweight repo/trunk trunk-checkout
2186
_see_also = ['init', 'branch', 'checkout', 'repositories']
2187
takes_args = ["location"]
2188
takes_options = [RegistryOption('format',
2189
help='Specify a format for this repository. See'
2190
' "brz help formats" for details.',
2191
lazy_registry=('breezy.controldir', 'format_registry'),
2192
converter=lambda name: controldir.format_registry.make_controldir(name),
2193
value_switches=True, title='Repository format'),
2195
help='Branches in the repository will default to'
2196
' not having a working tree.'),
2198
aliases = ["init-repo"]
2200
def run(self, location, format=None, no_trees=False):
2202
format = controldir.format_registry.make_controldir('default')
2204
if location is None:
2207
to_transport = transport.get_transport(location)
2209
(repo, newdir, require_stacking, repository_policy) = (
2210
format.initialize_on_transport_ex(to_transport,
2211
create_prefix=True, make_working_trees=not no_trees,
2212
shared_repo=True, force_new_repo=True,
2213
use_existing_dir=True,
2214
repo_format_name=format.repository_format.get_format_string()))
2216
from .info import show_bzrdir_info
2217
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2220
class cmd_diff(Command):
2221
__doc__ = """Show differences in the working tree, between revisions or branches.
2223
If no arguments are given, all changes for the current tree are listed.
2224
If files are given, only the changes in those files are listed.
2225
Remote and multiple branches can be compared by using the --old and
2226
--new options. If not provided, the default for both is derived from
2227
the first argument, if any, or the current tree if no arguments are
2230
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2231
produces patches suitable for "patch -p1".
2233
Note that when using the -r argument with a range of revisions, the
2234
differences are computed between the two specified revisions. That
2235
is, the command does not show the changes introduced by the first
2236
revision in the range. This differs from the interpretation of
2237
revision ranges used by "brz log" which includes the first revision
2242
2 - unrepresentable changes
2247
Shows the difference in the working tree versus the last commit::
2251
Difference between the working tree and revision 1::
2255
Difference between revision 3 and revision 1::
2259
Difference between revision 3 and revision 1 for branch xxx::
2263
The changes introduced by revision 2 (equivalent to -r1..2)::
2267
To see the changes introduced by revision X::
2271
Note that in the case of a merge, the -c option shows the changes
2272
compared to the left hand parent. To see the changes against
2273
another parent, use::
2275
brz diff -r<chosen_parent>..X
2277
The changes between the current revision and the previous revision
2278
(equivalent to -c-1 and -r-2..-1)
2282
Show just the differences for file NEWS::
2286
Show the differences in working tree xxx for file NEWS::
2290
Show the differences from branch xxx to this working tree:
2294
Show the differences between two branches for file NEWS::
2296
brz diff --old xxx --new yyy NEWS
2298
Same as 'brz diff' but prefix paths with old/ and new/::
2300
brz diff --prefix old/:new/
2302
Show the differences using a custom diff program with options::
2304
brz diff --using /usr/bin/diff --diff-options -wu
2306
_see_also = ['status']
2307
takes_args = ['file*']
2309
Option('diff-options', type=str,
2310
help='Pass these options to the external diff program.'),
2311
Option('prefix', type=str,
2313
help='Set prefixes added to old and new filenames, as '
2314
'two values separated by a colon. (eg "old/:new/").'),
2316
help='Branch/tree to compare from.',
2320
help='Branch/tree to compare to.',
2326
help='Use this command to compare files.',
2329
RegistryOption('format',
2331
help='Diff format to use.',
2332
lazy_registry=('breezy.diff', 'format_registry'),
2333
title='Diff format'),
2335
help='How many lines of context to show.',
2339
aliases = ['di', 'dif']
2340
encoding_type = 'exact'
2343
def run(self, revision=None, file_list=None, diff_options=None,
2344
prefix=None, old=None, new=None, using=None, format=None,
2346
from .diff import (get_trees_and_branches_to_diff_locked,
2353
elif prefix == '1' or prefix is None:
2357
old_label, new_label = prefix.split(":")
2359
raise errors.BzrCommandError(gettext(
2360
'--prefix expects two values separated by a colon'
2361
' (eg "old/:new/")'))
2363
if revision and len(revision) > 2:
2364
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2365
' one or two revision specifiers'))
2367
if using is not None and format is not None:
2368
raise errors.BzrCommandError(gettext(
2369
'{0} and {1} are mutually exclusive').format(
2370
'--using', '--format'))
2372
(old_tree, new_tree,
2373
old_branch, new_branch,
2374
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2375
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2376
# GNU diff on Windows uses ANSI encoding for filenames
2377
path_encoding = osutils.get_diff_header_encoding()
2378
return show_diff_trees(old_tree, new_tree, sys.stdout,
2379
specific_files=specific_files,
2380
external_diff_options=diff_options,
2381
old_label=old_label, new_label=new_label,
2382
extra_trees=extra_trees,
2383
path_encoding=path_encoding,
2384
using=using, context=context,
2388
class cmd_deleted(Command):
2389
__doc__ = """List files deleted in the working tree.
2391
# TODO: Show files deleted since a previous revision, or
2392
# between two revisions.
2393
# TODO: Much more efficient way to do this: read in new
2394
# directories with readdir, rather than stating each one. Same
2395
# level of effort but possibly much less IO. (Or possibly not,
2396
# if the directories are very large...)
2397
_see_also = ['status', 'ls']
2398
takes_options = ['directory', 'show-ids']
2401
def run(self, show_ids=False, directory=u'.'):
2402
tree = WorkingTree.open_containing(directory)[0]
2403
self.add_cleanup(tree.lock_read().unlock)
2404
old = tree.basis_tree()
2405
self.add_cleanup(old.lock_read().unlock)
2406
for path, ie in old.iter_entries_by_dir():
2407
if not tree.has_id(ie.file_id):
2408
self.outf.write(path)
2410
self.outf.write(' ')
2411
self.outf.write(ie.file_id)
2412
self.outf.write('\n')
2415
class cmd_modified(Command):
2416
__doc__ = """List files modified in working tree.
2420
_see_also = ['status', 'ls']
2421
takes_options = ['directory', 'null']
2424
def run(self, null=False, directory=u'.'):
2425
tree = WorkingTree.open_containing(directory)[0]
2426
self.add_cleanup(tree.lock_read().unlock)
2427
td = tree.changes_from(tree.basis_tree())
2429
for path, id, kind, text_modified, meta_modified in td.modified:
2431
self.outf.write(path + '\0')
2433
self.outf.write(osutils.quotefn(path) + '\n')
2436
class cmd_added(Command):
2437
__doc__ = """List files added in working tree.
2441
_see_also = ['status', 'ls']
2442
takes_options = ['directory', 'null']
2445
def run(self, null=False, directory=u'.'):
2446
wt = WorkingTree.open_containing(directory)[0]
2447
self.add_cleanup(wt.lock_read().unlock)
2448
basis = wt.basis_tree()
2449
self.add_cleanup(basis.lock_read().unlock)
2450
root_id = wt.get_root_id()
2451
for file_id in wt.all_file_ids():
2452
if basis.has_id(file_id):
2454
if root_id == file_id:
2456
path = wt.id2path(file_id)
2457
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2460
self.outf.write(path + '\0')
2462
self.outf.write(osutils.quotefn(path) + '\n')
2465
class cmd_root(Command):
2466
__doc__ = """Show the tree root directory.
2468
The root is the nearest enclosing directory with a .bzr control
2471
takes_args = ['filename?']
2473
def run(self, filename=None):
2474
"""Print the branch root."""
2475
tree = WorkingTree.open_containing(filename)[0]
2476
self.outf.write(tree.basedir + '\n')
2479
def _parse_limit(limitstring):
2481
return int(limitstring)
2483
msg = gettext("The limit argument must be an integer.")
2484
raise errors.BzrCommandError(msg)
2487
def _parse_levels(s):
2491
msg = gettext("The levels argument must be an integer.")
2492
raise errors.BzrCommandError(msg)
2495
class cmd_log(Command):
2496
__doc__ = """Show historical log for a branch or subset of a branch.
2498
log is brz's default tool for exploring the history of a branch.
2499
The branch to use is taken from the first parameter. If no parameters
2500
are given, the branch containing the working directory is logged.
2501
Here are some simple examples::
2503
brz log log the current branch
2504
brz log foo.py log a file in its branch
2505
brz log http://server/branch log a branch on a server
2507
The filtering, ordering and information shown for each revision can
2508
be controlled as explained below. By default, all revisions are
2509
shown sorted (topologically) so that newer revisions appear before
2510
older ones and descendants always appear before ancestors. If displayed,
2511
merged revisions are shown indented under the revision in which they
2516
The log format controls how information about each revision is
2517
displayed. The standard log formats are called ``long``, ``short``
2518
and ``line``. The default is long. See ``brz help log-formats``
2519
for more details on log formats.
2521
The following options can be used to control what information is
2524
-l N display a maximum of N revisions
2525
-n N display N levels of revisions (0 for all, 1 for collapsed)
2526
-v display a status summary (delta) for each revision
2527
-p display a diff (patch) for each revision
2528
--show-ids display revision-ids (and file-ids), not just revnos
2530
Note that the default number of levels to display is a function of the
2531
log format. If the -n option is not used, the standard log formats show
2532
just the top level (mainline).
2534
Status summaries are shown using status flags like A, M, etc. To see
2535
the changes explained using words like ``added`` and ``modified``
2536
instead, use the -vv option.
2540
To display revisions from oldest to newest, use the --forward option.
2541
In most cases, using this option will have little impact on the total
2542
time taken to produce a log, though --forward does not incrementally
2543
display revisions like --reverse does when it can.
2545
:Revision filtering:
2547
The -r option can be used to specify what revision or range of revisions
2548
to filter against. The various forms are shown below::
2550
-rX display revision X
2551
-rX.. display revision X and later
2552
-r..Y display up to and including revision Y
2553
-rX..Y display from X to Y inclusive
2555
See ``brz help revisionspec`` for details on how to specify X and Y.
2556
Some common examples are given below::
2558
-r-1 show just the tip
2559
-r-10.. show the last 10 mainline revisions
2560
-rsubmit:.. show what's new on this branch
2561
-rancestor:path.. show changes since the common ancestor of this
2562
branch and the one at location path
2563
-rdate:yesterday.. show changes since yesterday
2565
When logging a range of revisions using -rX..Y, log starts at
2566
revision Y and searches back in history through the primary
2567
("left-hand") parents until it finds X. When logging just the
2568
top level (using -n1), an error is reported if X is not found
2569
along the way. If multi-level logging is used (-n0), X may be
2570
a nested merge revision and the log will be truncated accordingly.
2574
If parameters are given and the first one is not a branch, the log
2575
will be filtered to show only those revisions that changed the
2576
nominated files or directories.
2578
Filenames are interpreted within their historical context. To log a
2579
deleted file, specify a revision range so that the file existed at
2580
the end or start of the range.
2582
Historical context is also important when interpreting pathnames of
2583
renamed files/directories. Consider the following example:
2585
* revision 1: add tutorial.txt
2586
* revision 2: modify tutorial.txt
2587
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2591
* ``brz log guide.txt`` will log the file added in revision 1
2593
* ``brz log tutorial.txt`` will log the new file added in revision 3
2595
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2596
the original file in revision 2.
2598
* ``brz log -r2 -p guide.txt`` will display an error message as there
2599
was no file called guide.txt in revision 2.
2601
Renames are always followed by log. By design, there is no need to
2602
explicitly ask for this (and no way to stop logging a file back
2603
until it was last renamed).
2607
The --match option can be used for finding revisions that match a
2608
regular expression in a commit message, committer, author or bug.
2609
Specifying the option several times will match any of the supplied
2610
expressions. --match-author, --match-bugs, --match-committer and
2611
--match-message can be used to only match a specific field.
2615
GUI tools and IDEs are often better at exploring history than command
2616
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2617
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2618
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2619
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2621
You may find it useful to add the aliases below to ``bazaar.conf``::
2625
top = log -l10 --line
2628
``brz tip`` will then show the latest revision while ``brz top``
2629
will show the last 10 mainline revisions. To see the details of a
2630
particular revision X, ``brz show -rX``.
2632
If you are interested in looking deeper into a particular merge X,
2633
use ``brz log -n0 -rX``.
2635
``brz log -v`` on a branch with lots of history is currently
2636
very slow. A fix for this issue is currently under development.
2637
With or without that fix, it is recommended that a revision range
2638
be given when using the -v option.
2640
brz has a generic full-text matching plugin, brz-search, that can be
2641
used to find revisions matching user names, commit messages, etc.
2642
Among other features, this plugin can find all revisions containing
2643
a list of words but not others.
2645
When exploring non-mainline history on large projects with deep
2646
history, the performance of log can be greatly improved by installing
2647
the historycache plugin. This plugin buffers historical information
2648
trading disk space for faster speed.
2650
takes_args = ['file*']
2651
_see_also = ['log-formats', 'revisionspec']
2654
help='Show from oldest to newest.'),
2656
custom_help('verbose',
2657
help='Show files changed in each revision.'),
2661
type=breezy.option._parse_revision_str,
2663
help='Show just the specified revision.'
2664
' See also "help revisionspec".'),
2666
RegistryOption('authors',
2667
'What names to list as authors - first, all or committer.',
2669
lazy_registry=('breezy.log', 'author_list_registry'),
2673
help='Number of levels to display - 0 for all, 1 for flat.',
2675
type=_parse_levels),
2677
help='Show revisions whose message matches this '
2678
'regular expression.',
2683
help='Limit the output to the first N revisions.',
2688
help='Show changes made in each revision as a patch.'),
2689
Option('include-merged',
2690
help='Show merged revisions like --levels 0 does.'),
2691
Option('include-merges', hidden=True,
2692
help='Historical alias for --include-merged.'),
2693
Option('omit-merges',
2694
help='Do not report commits with more than one parent.'),
2695
Option('exclude-common-ancestry',
2696
help='Display only the revisions that are not part'
2697
' of both ancestries (require -rX..Y).'
2699
Option('signatures',
2700
help='Show digital signature validity.'),
2703
help='Show revisions whose properties match this '
2706
ListOption('match-message',
2707
help='Show revisions whose message matches this '
2710
ListOption('match-committer',
2711
help='Show revisions whose committer matches this '
2714
ListOption('match-author',
2715
help='Show revisions whose authors match this '
2718
ListOption('match-bugs',
2719
help='Show revisions whose bugs match this '
2723
encoding_type = 'replace'
2726
def run(self, file_list=None, timezone='original',
2737
include_merged=None,
2739
exclude_common_ancestry=False,
2743
match_committer=None,
2750
make_log_request_dict,
2751
_get_info_for_log_files,
2753
direction = (forward and 'forward') or 'reverse'
2754
if include_merged is None:
2755
include_merged = False
2756
if (exclude_common_ancestry
2757
and (revision is None or len(revision) != 2)):
2758
raise errors.BzrCommandError(gettext(
2759
'--exclude-common-ancestry requires -r with two revisions'))
2764
raise errors.BzrCommandError(gettext(
2765
'{0} and {1} are mutually exclusive').format(
2766
'--levels', '--include-merged'))
2768
if change is not None:
2770
raise errors.RangeInChangeOption()
2771
if revision is not None:
2772
raise errors.BzrCommandError(gettext(
2773
'{0} and {1} are mutually exclusive').format(
2774
'--revision', '--change'))
2779
filter_by_dir = False
2781
# find the file ids to log and check for directory filtering
2782
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2783
revision, file_list, self.add_cleanup)
2784
for relpath, file_id, kind in file_info_list:
2786
raise errors.BzrCommandError(gettext(
2787
"Path unknown at end or start of revision range: %s") %
2789
# If the relpath is the top of the tree, we log everything
2794
file_ids.append(file_id)
2795
filter_by_dir = filter_by_dir or (
2796
kind in ['directory', 'tree-reference'])
2799
# FIXME ? log the current subdir only RBC 20060203
2800
if revision is not None \
2801
and len(revision) > 0 and revision[0].get_branch():
2802
location = revision[0].get_branch()
2805
dir, relpath = controldir.ControlDir.open_containing(location)
2806
b = dir.open_branch()
2807
self.add_cleanup(b.lock_read().unlock)
2808
rev1, rev2 = _get_revision_range(revision, b, self.name())
2810
if b.get_config_stack().get('validate_signatures_in_log'):
2814
if not gpg.GPGStrategy.verify_signatures_available():
2815
raise errors.GpgmeNotInstalled(None)
2817
# Decide on the type of delta & diff filtering to use
2818
# TODO: add an --all-files option to make this configurable & consistent
2826
diff_type = 'partial'
2830
# Build the log formatter
2831
if log_format is None:
2832
log_format = log.log_formatter_registry.get_default(b)
2833
# Make a non-encoding output to include the diffs - bug 328007
2834
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2835
lf = log_format(show_ids=show_ids, to_file=self.outf,
2836
to_exact_file=unencoded_output,
2837
show_timezone=timezone,
2838
delta_format=get_verbosity_level(),
2840
show_advice=levels is None,
2841
author_list_handler=authors)
2843
# Choose the algorithm for doing the logging. It's annoying
2844
# having multiple code paths like this but necessary until
2845
# the underlying repository format is faster at generating
2846
# deltas or can provide everything we need from the indices.
2847
# The default algorithm - match-using-deltas - works for
2848
# multiple files and directories and is faster for small
2849
# amounts of history (200 revisions say). However, it's too
2850
# slow for logging a single file in a repository with deep
2851
# history, i.e. > 10K revisions. In the spirit of "do no
2852
# evil when adding features", we continue to use the
2853
# original algorithm - per-file-graph - for the "single
2854
# file that isn't a directory without showing a delta" case.
2855
partial_history = revision and b.repository._format.supports_chks
2856
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2857
or delta_type or partial_history)
2861
match_dict[''] = match
2863
match_dict['message'] = match_message
2865
match_dict['committer'] = match_committer
2867
match_dict['author'] = match_author
2869
match_dict['bugs'] = match_bugs
2871
# Build the LogRequest and execute it
2872
if len(file_ids) == 0:
2874
rqst = make_log_request_dict(
2875
direction=direction, specific_fileids=file_ids,
2876
start_revision=rev1, end_revision=rev2, limit=limit,
2877
message_search=message, delta_type=delta_type,
2878
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2879
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2880
signature=signatures, omit_merges=omit_merges,
2882
Logger(b, rqst).show(lf)
2885
def _get_revision_range(revisionspec_list, branch, command_name):
2886
"""Take the input of a revision option and turn it into a revision range.
2888
It returns RevisionInfo objects which can be used to obtain the rev_id's
2889
of the desired revisions. It does some user input validations.
2891
if revisionspec_list is None:
2894
elif len(revisionspec_list) == 1:
2895
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2896
elif len(revisionspec_list) == 2:
2897
start_spec = revisionspec_list[0]
2898
end_spec = revisionspec_list[1]
2899
if end_spec.get_branch() != start_spec.get_branch():
2900
# b is taken from revision[0].get_branch(), and
2901
# show_log will use its revision_history. Having
2902
# different branches will lead to weird behaviors.
2903
raise errors.BzrCommandError(gettext(
2904
"brz %s doesn't accept two revisions in different"
2905
" branches.") % command_name)
2906
if start_spec.spec is None:
2907
# Avoid loading all the history.
2908
rev1 = RevisionInfo(branch, None, None)
2910
rev1 = start_spec.in_history(branch)
2911
# Avoid loading all of history when we know a missing
2912
# end of range means the last revision ...
2913
if end_spec.spec is None:
2914
last_revno, last_revision_id = branch.last_revision_info()
2915
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2917
rev2 = end_spec.in_history(branch)
2919
raise errors.BzrCommandError(gettext(
2920
'brz %s --revision takes one or two values.') % command_name)
2924
def _revision_range_to_revid_range(revision_range):
2927
if revision_range[0] is not None:
2928
rev_id1 = revision_range[0].rev_id
2929
if revision_range[1] is not None:
2930
rev_id2 = revision_range[1].rev_id
2931
return rev_id1, rev_id2
2933
def get_log_format(long=False, short=False, line=False, default='long'):
2934
log_format = default
2938
log_format = 'short'
2944
class cmd_touching_revisions(Command):
2945
__doc__ = """Return revision-ids which affected a particular file.
2947
A more user-friendly interface is "brz log FILE".
2951
takes_args = ["filename"]
2954
def run(self, filename):
2955
tree, relpath = WorkingTree.open_containing(filename)
2956
file_id = tree.path2id(relpath)
2958
self.add_cleanup(b.lock_read().unlock)
2959
touching_revs = log.find_touching_revisions(b, file_id)
2960
for revno, revision_id, what in touching_revs:
2961
self.outf.write("%6d %s\n" % (revno, what))
2964
class cmd_ls(Command):
2965
__doc__ = """List files in a tree.
2968
_see_also = ['status', 'cat']
2969
takes_args = ['path?']
2973
Option('recursive', short_name='R',
2974
help='Recurse into subdirectories.'),
2976
help='Print paths relative to the root of the branch.'),
2977
Option('unknown', short_name='u',
2978
help='Print unknown files.'),
2979
Option('versioned', help='Print versioned files.',
2981
Option('ignored', short_name='i',
2982
help='Print ignored files.'),
2983
Option('kind', short_name='k',
2984
help='List entries of a particular kind: file, directory, symlink.',
2991
def run(self, revision=None, verbose=False,
2992
recursive=False, from_root=False,
2993
unknown=False, versioned=False, ignored=False,
2994
null=False, kind=None, show_ids=False, path=None, directory=None):
2996
if kind and kind not in ('file', 'directory', 'symlink'):
2997
raise errors.BzrCommandError(gettext('invalid kind specified'))
2999
if verbose and null:
3000
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
3001
all = not (unknown or versioned or ignored)
3003
selection = {'I':ignored, '?':unknown, 'V':versioned}
3009
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3012
tree, branch, relpath = \
3013
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3015
# Calculate the prefix to use
3019
prefix = relpath + '/'
3020
elif fs_path != '.' and not fs_path.endswith('/'):
3021
prefix = fs_path + '/'
3023
if revision is not None or tree is None:
3024
tree = _get_one_revision_tree('ls', revision, branch=branch)
3027
if isinstance(tree, WorkingTree) and tree.supports_views():
3028
view_files = tree.views.lookup_view()
3031
view_str = views.view_display_str(view_files)
3032
note(gettext("Ignoring files outside view. View is %s") % view_str)
3034
self.add_cleanup(tree.lock_read().unlock)
3035
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3036
from_dir=relpath, recursive=recursive):
3037
# Apply additional masking
3038
if not all and not selection[fc]:
3040
if kind is not None and fkind != kind:
3045
fullpath = osutils.pathjoin(relpath, fp)
3048
views.check_path_in_view(tree, fullpath)
3049
except errors.FileOutsideView:
3054
fp = osutils.pathjoin(prefix, fp)
3055
kindch = entry.kind_character()
3056
outstring = fp + kindch
3057
ui.ui_factory.clear_term()
3059
outstring = '%-8s %s' % (fc, outstring)
3060
if show_ids and fid is not None:
3061
outstring = "%-50s %s" % (outstring, fid)
3062
self.outf.write(outstring + '\n')
3064
self.outf.write(fp + '\0')
3067
self.outf.write(fid)
3068
self.outf.write('\0')
3076
self.outf.write('%-50s %s\n' % (outstring, my_id))
3078
self.outf.write(outstring + '\n')
3081
class cmd_unknowns(Command):
3082
__doc__ = """List unknown files.
3087
takes_options = ['directory']
3090
def run(self, directory=u'.'):
3091
for f in WorkingTree.open_containing(directory)[0].unknowns():
3092
self.outf.write(osutils.quotefn(f) + '\n')
3095
class cmd_ignore(Command):
3096
__doc__ = """Ignore specified files or patterns.
3098
See ``brz help patterns`` for details on the syntax of patterns.
3100
If a .bzrignore file does not exist, the ignore command
3101
will create one and add the specified files or patterns to the newly
3102
created file. The ignore command will also automatically add the
3103
.bzrignore file to be versioned. Creating a .bzrignore file without
3104
the use of the ignore command will require an explicit add command.
3106
To remove patterns from the ignore list, edit the .bzrignore file.
3107
After adding, editing or deleting that file either indirectly by
3108
using this command or directly by using an editor, be sure to commit
3111
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3112
the global ignore file can be found in the application data directory as
3113
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3114
Global ignores are not touched by this command. The global ignore file
3115
can be edited directly using an editor.
3117
Patterns prefixed with '!' are exceptions to ignore patterns and take
3118
precedence over regular ignores. Such exceptions are used to specify
3119
files that should be versioned which would otherwise be ignored.
3121
Patterns prefixed with '!!' act as regular ignore patterns, but have
3122
precedence over the '!' exception patterns.
3126
* Ignore patterns containing shell wildcards must be quoted from
3129
* Ignore patterns starting with "#" act as comments in the ignore file.
3130
To ignore patterns that begin with that character, use the "RE:" prefix.
3133
Ignore the top level Makefile::
3135
brz ignore ./Makefile
3137
Ignore .class files in all directories...::
3139
brz ignore "*.class"
3141
...but do not ignore "special.class"::
3143
brz ignore "!special.class"
3145
Ignore files whose name begins with the "#" character::
3149
Ignore .o files under the lib directory::
3151
brz ignore "lib/**/*.o"
3153
Ignore .o files under the lib directory::
3155
brz ignore "RE:lib/.*\.o"
3157
Ignore everything but the "debian" toplevel directory::
3159
brz ignore "RE:(?!debian/).*"
3161
Ignore everything except the "local" toplevel directory,
3162
but always ignore autosave files ending in ~, even under local/::
3165
brz ignore "!./local"
3169
_see_also = ['status', 'ignored', 'patterns']
3170
takes_args = ['name_pattern*']
3171
takes_options = ['directory',
3172
Option('default-rules',
3173
help='Display the default ignore rules that brz uses.')
3176
def run(self, name_pattern_list=None, default_rules=None,
3178
from breezy import ignores
3179
if default_rules is not None:
3180
# dump the default rules and exit
3181
for pattern in ignores.USER_DEFAULTS:
3182
self.outf.write("%s\n" % pattern)
3184
if not name_pattern_list:
3185
raise errors.BzrCommandError(gettext("ignore requires at least one "
3186
"NAME_PATTERN or --default-rules."))
3187
name_pattern_list = [globbing.normalize_pattern(p)
3188
for p in name_pattern_list]
3190
bad_patterns_count = 0
3191
for p in name_pattern_list:
3192
if not globbing.Globster.is_pattern_valid(p):
3193
bad_patterns_count += 1
3194
bad_patterns += ('\n %s' % p)
3196
msg = (ngettext('Invalid ignore pattern found. %s',
3197
'Invalid ignore patterns found. %s',
3198
bad_patterns_count) % bad_patterns)
3199
ui.ui_factory.show_error(msg)
3200
raise errors.InvalidPattern('')
3201
for name_pattern in name_pattern_list:
3202
if (name_pattern[0] == '/' or
3203
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3204
raise errors.BzrCommandError(gettext(
3205
"NAME_PATTERN should not be an absolute path"))
3206
tree, relpath = WorkingTree.open_containing(directory)
3207
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3208
ignored = globbing.Globster(name_pattern_list)
3210
self.add_cleanup(tree.lock_read().unlock)
3211
for entry in tree.list_files():
3215
if ignored.match(filename):
3216
matches.append(filename)
3217
if len(matches) > 0:
3218
self.outf.write(gettext("Warning: the following files are version "
3219
"controlled and match your ignore pattern:\n%s"
3220
"\nThese files will continue to be version controlled"
3221
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3224
class cmd_ignored(Command):
3225
__doc__ = """List ignored files and the patterns that matched them.
3227
List all the ignored files and the ignore pattern that caused the file to
3230
Alternatively, to list just the files::
3235
encoding_type = 'replace'
3236
_see_also = ['ignore', 'ls']
3237
takes_options = ['directory']
3240
def run(self, directory=u'.'):
3241
tree = WorkingTree.open_containing(directory)[0]
3242
self.add_cleanup(tree.lock_read().unlock)
3243
for path, file_class, kind, file_id, entry in tree.list_files():
3244
if file_class != 'I':
3246
## XXX: Slightly inefficient since this was already calculated
3247
pat = tree.is_ignored(path)
3248
self.outf.write('%-50s %s\n' % (path, pat))
3251
class cmd_lookup_revision(Command):
3252
__doc__ = """Lookup the revision-id from a revision-number
3255
brz lookup-revision 33
3258
takes_args = ['revno']
3259
takes_options = ['directory']
3262
def run(self, revno, directory=u'.'):
3266
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3268
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3269
self.outf.write("%s\n" % revid)
3272
class cmd_export(Command):
3273
__doc__ = """Export current or past revision to a destination directory or archive.
3275
If no revision is specified this exports the last committed revision.
3277
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3278
given, try to find the format with the extension. If no extension
3279
is found exports to a directory (equivalent to --format=dir).
3281
If root is supplied, it will be used as the root directory inside
3282
container formats (tar, zip, etc). If it is not supplied it will default
3283
to the exported filename. The root option has no effect for 'dir' format.
3285
If branch is omitted then the branch containing the current working
3286
directory will be used.
3288
Note: Export of tree with non-ASCII filenames to zip is not supported.
3290
================= =========================
3291
Supported formats Autodetected by extension
3292
================= =========================
3295
tbz2 .tar.bz2, .tbz2
3298
================= =========================
3301
takes_args = ['dest', 'branch_or_subdir?']
3302
takes_options = ['directory',
3304
help="Type of file to export to.",
3307
Option('filters', help='Apply content filters to export the '
3308
'convenient form.'),
3311
help="Name of the root directory inside the exported file."),
3312
Option('per-file-timestamps',
3313
help='Set modification time of files to that of the last '
3314
'revision in which it was changed.'),
3315
Option('uncommitted',
3316
help='Export the working tree contents rather than that of the '
3319
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3320
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3322
from .export import export
3324
if branch_or_subdir is None:
3325
branch_or_subdir = directory
3327
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3329
if tree is not None:
3330
self.add_cleanup(tree.lock_read().unlock)
3334
raise errors.BzrCommandError(
3335
gettext("--uncommitted requires a working tree"))
3338
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3340
export(export_tree, dest, format, root, subdir, filtered=filters,
3341
per_file_timestamps=per_file_timestamps)
3342
except errors.NoSuchExportFormat as e:
3343
raise errors.BzrCommandError(
3344
gettext('Unsupported export format: %s') % e.format)
3347
class cmd_cat(Command):
3348
__doc__ = """Write the contents of a file as of a given revision to standard output.
3350
If no revision is nominated, the last revision is used.
3352
Note: Take care to redirect standard output when using this command on a
3357
takes_options = ['directory',
3358
Option('name-from-revision', help='The path name in the old tree.'),
3359
Option('filters', help='Apply content filters to display the '
3360
'convenience form.'),
3363
takes_args = ['filename']
3364
encoding_type = 'exact'
3367
def run(self, filename, revision=None, name_from_revision=False,
3368
filters=False, directory=None):
3369
if revision is not None and len(revision) != 1:
3370
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3371
" one revision specifier"))
3372
tree, branch, relpath = \
3373
_open_directory_or_containing_tree_or_branch(filename, directory)
3374
self.add_cleanup(branch.lock_read().unlock)
3375
return self._run(tree, branch, relpath, filename, revision,
3376
name_from_revision, filters)
3378
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3381
tree = b.basis_tree()
3382
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3383
self.add_cleanup(rev_tree.lock_read().unlock)
3385
old_file_id = rev_tree.path2id(relpath)
3387
# TODO: Split out this code to something that generically finds the
3388
# best id for a path across one or more trees; it's like
3389
# find_ids_across_trees but restricted to find just one. -- mbp
3391
if name_from_revision:
3392
# Try in revision if requested
3393
if old_file_id is None:
3394
raise errors.BzrCommandError(gettext(
3395
"{0!r} is not present in revision {1}").format(
3396
filename, rev_tree.get_revision_id()))
3398
actual_file_id = old_file_id
3400
cur_file_id = tree.path2id(relpath)
3401
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3402
actual_file_id = cur_file_id
3403
elif old_file_id is not None:
3404
actual_file_id = old_file_id
3406
raise errors.BzrCommandError(gettext(
3407
"{0!r} is not present in revision {1}").format(
3408
filename, rev_tree.get_revision_id()))
3410
from .filter_tree import ContentFilterTree
3411
filter_tree = ContentFilterTree(rev_tree,
3412
rev_tree._content_filter_stack)
3413
content = filter_tree.get_file_text(actual_file_id)
3415
content = rev_tree.get_file_text(actual_file_id)
3417
self.outf.write(content)
3420
class cmd_local_time_offset(Command):
3421
__doc__ = """Show the offset in seconds from GMT to local time."""
3425
self.outf.write("%s\n" % osutils.local_time_offset())
3429
class cmd_commit(Command):
3430
__doc__ = """Commit changes into a new revision.
3432
An explanatory message needs to be given for each commit. This is
3433
often done by using the --message option (getting the message from the
3434
command line) or by using the --file option (getting the message from
3435
a file). If neither of these options is given, an editor is opened for
3436
the user to enter the message. To see the changed files in the
3437
boilerplate text loaded into the editor, use the --show-diff option.
3439
By default, the entire tree is committed and the person doing the
3440
commit is assumed to be the author. These defaults can be overridden
3445
If selected files are specified, only changes to those files are
3446
committed. If a directory is specified then the directory and
3447
everything within it is committed.
3449
When excludes are given, they take precedence over selected files.
3450
For example, to commit only changes within foo, but not changes
3453
brz commit foo -x foo/bar
3455
A selective commit after a merge is not yet supported.
3459
If the author of the change is not the same person as the committer,
3460
you can specify the author's name using the --author option. The
3461
name should be in the same format as a committer-id, e.g.
3462
"John Doe <jdoe@example.com>". If there is more than one author of
3463
the change you can specify the option multiple times, once for each
3468
A common mistake is to forget to add a new file or directory before
3469
running the commit command. The --strict option checks for unknown
3470
files and aborts the commit if any are found. More advanced pre-commit
3471
checks can be implemented by defining hooks. See ``brz help hooks``
3476
If you accidentially commit the wrong changes or make a spelling
3477
mistake in the commit message say, you can use the uncommit command
3478
to undo it. See ``brz help uncommit`` for details.
3480
Hooks can also be configured to run after a commit. This allows you
3481
to trigger updates to external systems like bug trackers. The --fixes
3482
option can be used to record the association between a revision and
3483
one or more bugs. See ``brz help bugs`` for details.
3486
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3487
takes_args = ['selected*']
3489
ListOption('exclude', type=str, short_name='x',
3490
help="Do not consider changes made to a given path."),
3491
Option('message', type=text_type,
3493
help="Description of the new revision."),
3496
help='Commit even if nothing has changed.'),
3497
Option('file', type=str,
3500
help='Take commit message from this file.'),
3502
help="Refuse to commit if there are unknown "
3503
"files in the working tree."),
3504
Option('commit-time', type=str,
3505
help="Manually set a commit time using commit date "
3506
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3507
ListOption('fixes', type=str,
3508
help="Mark a bug as being fixed by this revision "
3509
"(see \"brz help bugs\")."),
3510
ListOption('author', type=text_type,
3511
help="Set the author's name, if it's different "
3512
"from the committer."),
3514
help="Perform a local commit in a bound "
3515
"branch. Local commits are not pushed to "
3516
"the master branch until a normal commit "
3519
Option('show-diff', short_name='p',
3520
help='When no message is supplied, show the diff along'
3521
' with the status summary in the message editor.'),
3523
help='When committing to a foreign version control '
3524
'system do not push data that can not be natively '
3527
aliases = ['ci', 'checkin']
3529
def _iter_bug_fix_urls(self, fixes, branch):
3530
default_bugtracker = None
3531
# Configure the properties for bug fixing attributes.
3532
for fixed_bug in fixes:
3533
tokens = fixed_bug.split(':')
3534
if len(tokens) == 1:
3535
if default_bugtracker is None:
3536
branch_config = branch.get_config_stack()
3537
default_bugtracker = branch_config.get(
3539
if default_bugtracker is None:
3540
raise errors.BzrCommandError(gettext(
3541
"No tracker specified for bug %s. Use the form "
3542
"'tracker:id' or specify a default bug tracker "
3543
"using the `bugtracker` option.\nSee "
3544
"\"brz help bugs\" for more information on this "
3545
"feature. Commit refused.") % fixed_bug)
3546
tag = default_bugtracker
3548
elif len(tokens) != 2:
3549
raise errors.BzrCommandError(gettext(
3550
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3551
"See \"brz help bugs\" for more information on this "
3552
"feature.\nCommit refused.") % fixed_bug)
3554
tag, bug_id = tokens
3556
yield bugtracker.get_bug_url(tag, branch, bug_id)
3557
except errors.UnknownBugTrackerAbbreviation:
3558
raise errors.BzrCommandError(gettext(
3559
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3560
except errors.MalformedBugIdentifier as e:
3561
raise errors.BzrCommandError(gettext(
3562
"%s\nCommit refused.") % (str(e),))
3564
def run(self, message=None, file=None, verbose=False, selected_list=None,
3565
unchanged=False, strict=False, local=False, fixes=None,
3566
author=None, show_diff=False, exclude=None, commit_time=None,
3568
from .errors import (
3573
from .msgeditor import (
3574
edit_commit_message_encoded,
3575
generate_commit_message_template,
3576
make_commit_message_template_encoded,
3580
commit_stamp = offset = None
3581
if commit_time is not None:
3583
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3584
except ValueError as e:
3585
raise errors.BzrCommandError(gettext(
3586
"Could not parse --commit-time: " + str(e)))
3590
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3591
if selected_list == ['']:
3592
# workaround - commit of root of tree should be exactly the same
3593
# as just default commit in that tree, and succeed even though
3594
# selected-file merge commit is not done yet
3599
bug_property = bugtracker.encode_fixes_bug_urls(
3600
self._iter_bug_fix_urls(fixes, tree.branch))
3602
properties['bugs'] = bug_property
3604
if local and not tree.branch.get_bound_location():
3605
raise errors.LocalRequiresBoundBranch()
3607
if message is not None:
3609
file_exists = osutils.lexists(message)
3610
except UnicodeError:
3611
# The commit message contains unicode characters that can't be
3612
# represented in the filesystem encoding, so that can't be a
3617
'The commit message is a file name: "%(f)s".\n'
3618
'(use --file "%(f)s" to take commit message from that file)'
3620
ui.ui_factory.show_warning(warning_msg)
3622
message = message.replace('\r\n', '\n')
3623
message = message.replace('\r', '\n')
3625
raise errors.BzrCommandError(gettext(
3626
"please specify either --message or --file"))
3628
def get_message(commit_obj):
3629
"""Callback to get commit message"""
3633
my_message = f.read().decode(osutils.get_user_encoding())
3636
elif message is not None:
3637
my_message = message
3639
# No message supplied: make one up.
3640
# text is the status of the tree
3641
text = make_commit_message_template_encoded(tree,
3642
selected_list, diff=show_diff,
3643
output_encoding=osutils.get_user_encoding())
3644
# start_message is the template generated from hooks
3645
# XXX: Warning - looks like hooks return unicode,
3646
# make_commit_message_template_encoded returns user encoding.
3647
# We probably want to be using edit_commit_message instead to
3649
my_message = set_commit_message(commit_obj)
3650
if my_message is None:
3651
start_message = generate_commit_message_template(commit_obj)
3652
my_message = edit_commit_message_encoded(text,
3653
start_message=start_message)
3654
if my_message is None:
3655
raise errors.BzrCommandError(gettext("please specify a commit"
3656
" message with either --message or --file"))
3657
if my_message == "":
3658
raise errors.BzrCommandError(gettext("Empty commit message specified."
3659
" Please specify a commit message with either"
3660
" --message or --file or leave a blank message"
3661
" with --message \"\"."))
3664
# The API permits a commit with a filter of [] to mean 'select nothing'
3665
# but the command line should not do that.
3666
if not selected_list:
3667
selected_list = None
3669
tree.commit(message_callback=get_message,
3670
specific_files=selected_list,
3671
allow_pointless=unchanged, strict=strict, local=local,
3672
reporter=None, verbose=verbose, revprops=properties,
3673
authors=author, timestamp=commit_stamp,
3675
exclude=tree.safe_relpath_files(exclude),
3677
except PointlessCommit:
3678
raise errors.BzrCommandError(gettext("No changes to commit."
3679
" Please 'brz add' the files you want to commit, or use"
3680
" --unchanged to force an empty commit."))
3681
except ConflictsInTree:
3682
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3683
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3685
except StrictCommitFailed:
3686
raise errors.BzrCommandError(gettext("Commit refused because there are"
3687
" unknown files in the working tree."))
3688
except errors.BoundBranchOutOfDate as e:
3689
e.extra_help = (gettext("\n"
3690
'To commit to master branch, run update and then commit.\n'
3691
'You can also pass --local to commit to continue working '
3696
class cmd_check(Command):
3697
__doc__ = """Validate working tree structure, branch consistency and repository history.
3699
This command checks various invariants about branch and repository storage
3700
to detect data corruption or brz bugs.
3702
The working tree and branch checks will only give output if a problem is
3703
detected. The output fields of the repository check are:
3706
This is just the number of revisions checked. It doesn't
3710
This is just the number of versionedfiles checked. It
3711
doesn't indicate a problem.
3713
unreferenced ancestors
3714
Texts that are ancestors of other texts, but
3715
are not properly referenced by the revision ancestry. This is a
3716
subtle problem that Bazaar can work around.
3719
This is the total number of unique file contents
3720
seen in the checked revisions. It does not indicate a problem.
3723
This is the total number of repeated texts seen
3724
in the checked revisions. Texts can be repeated when their file
3725
entries are modified, but the file contents are not. It does not
3728
If no restrictions are specified, all Bazaar data that is found at the given
3729
location will be checked.
3733
Check the tree and branch at 'foo'::
3735
brz check --tree --branch foo
3737
Check only the repository at 'bar'::
3739
brz check --repo bar
3741
Check everything at 'baz'::
3746
_see_also = ['reconcile']
3747
takes_args = ['path?']
3748
takes_options = ['verbose',
3749
Option('branch', help="Check the branch related to the"
3750
" current directory."),
3751
Option('repo', help="Check the repository related to the"
3752
" current directory."),
3753
Option('tree', help="Check the working tree related to"
3754
" the current directory.")]
3756
def run(self, path=None, verbose=False, branch=False, repo=False,
3758
from .check import check_dwim
3761
if not branch and not repo and not tree:
3762
branch = repo = tree = True
3763
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3766
class cmd_upgrade(Command):
3767
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3769
When the default format has changed after a major new release of
3770
Bazaar, you may be informed during certain operations that you
3771
should upgrade. Upgrading to a newer format may improve performance
3772
or make new features available. It may however limit interoperability
3773
with older repositories or with older versions of Bazaar.
3775
If you wish to upgrade to a particular format rather than the
3776
current default, that can be specified using the --format option.
3777
As a consequence, you can use the upgrade command this way to
3778
"downgrade" to an earlier format, though some conversions are
3779
a one way process (e.g. changing from the 1.x default to the
3780
2.x default) so downgrading is not always possible.
3782
A backup.bzr.~#~ directory is created at the start of the conversion
3783
process (where # is a number). By default, this is left there on
3784
completion. If the conversion fails, delete the new .bzr directory
3785
and rename this one back in its place. Use the --clean option to ask
3786
for the backup.bzr directory to be removed on successful conversion.
3787
Alternatively, you can delete it by hand if everything looks good
3790
If the location given is a shared repository, dependent branches
3791
are also converted provided the repository converts successfully.
3792
If the conversion of a branch fails, remaining branches are still
3795
For more information on upgrades, see the Bazaar Upgrade Guide,
3796
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3799
_see_also = ['check', 'reconcile', 'formats']
3800
takes_args = ['url?']
3802
RegistryOption('format',
3803
help='Upgrade to a specific format. See "brz help'
3804
' formats" for details.',
3805
lazy_registry=('breezy.controldir', 'format_registry'),
3806
converter=lambda name: controldir.format_registry.make_controldir(name),
3807
value_switches=True, title='Branch format'),
3809
help='Remove the backup.bzr directory if successful.'),
3811
help="Show what would be done, but don't actually do anything."),
3814
def run(self, url='.', format=None, clean=False, dry_run=False):
3815
from .upgrade import upgrade
3816
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3818
if len(exceptions) == 1:
3819
# Compatibility with historical behavior
3825
class cmd_whoami(Command):
3826
__doc__ = """Show or set brz user id.
3829
Show the email of the current user::
3833
Set the current user::
3835
brz whoami "Frank Chu <fchu@example.com>"
3837
takes_options = [ 'directory',
3839
help='Display email address only.'),
3841
help='Set identity for the current branch instead of '
3844
takes_args = ['name?']
3845
encoding_type = 'replace'
3848
def run(self, email=False, branch=False, name=None, directory=None):
3850
if directory is None:
3851
# use branch if we're inside one; otherwise global config
3853
c = Branch.open_containing(u'.')[0].get_config_stack()
3854
except errors.NotBranchError:
3855
c = _mod_config.GlobalStack()
3857
c = Branch.open(directory).get_config_stack()
3858
identity = c.get('email')
3860
self.outf.write(_mod_config.extract_email_address(identity)
3863
self.outf.write(identity + '\n')
3867
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3870
# display a warning if an email address isn't included in the given name.
3872
_mod_config.extract_email_address(name)
3873
except errors.NoEmailInUsername as e:
3874
warning('"%s" does not seem to contain an email address. '
3875
'This is allowed, but not recommended.', name)
3877
# use global config unless --branch given
3879
if directory is None:
3880
c = Branch.open_containing(u'.')[0].get_config_stack()
3882
b = Branch.open(directory)
3883
self.add_cleanup(b.lock_write().unlock)
3884
c = b.get_config_stack()
3886
c = _mod_config.GlobalStack()
3887
c.set('email', name)
3890
class cmd_nick(Command):
3891
__doc__ = """Print or set the branch nickname.
3893
If unset, the colocated branch name is used for colocated branches, and
3894
the branch directory name is used for other branches. To print the
3895
current nickname, execute with no argument.
3897
Bound branches use the nickname of its master branch unless it is set
3901
_see_also = ['info']
3902
takes_args = ['nickname?']
3903
takes_options = ['directory']
3904
def run(self, nickname=None, directory=u'.'):
3905
branch = Branch.open_containing(directory)[0]
3906
if nickname is None:
3907
self.printme(branch)
3909
branch.nick = nickname
3912
def printme(self, branch):
3913
self.outf.write('%s\n' % branch.nick)
3916
class cmd_alias(Command):
3917
__doc__ = """Set/unset and display aliases.
3920
Show the current aliases::
3924
Show the alias specified for 'll'::
3928
Set an alias for 'll'::
3930
brz alias ll="log --line -r-10..-1"
3932
To remove an alias for 'll'::
3934
brz alias --remove ll
3937
takes_args = ['name?']
3939
Option('remove', help='Remove the alias.'),
3942
def run(self, name=None, remove=False):
3944
self.remove_alias(name)
3946
self.print_aliases()
3948
equal_pos = name.find('=')
3950
self.print_alias(name)
3952
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3954
def remove_alias(self, alias_name):
3955
if alias_name is None:
3956
raise errors.BzrCommandError(gettext(
3957
'brz alias --remove expects an alias to remove.'))
3958
# If alias is not found, print something like:
3959
# unalias: foo: not found
3960
c = _mod_config.GlobalConfig()
3961
c.unset_alias(alias_name)
3964
def print_aliases(self):
3965
"""Print out the defined aliases in a similar format to bash."""
3966
aliases = _mod_config.GlobalConfig().get_aliases()
3967
for key, value in sorted(viewitems(aliases)):
3968
self.outf.write('brz alias %s="%s"\n' % (key, value))
3971
def print_alias(self, alias_name):
3972
from .commands import get_alias
3973
alias = get_alias(alias_name)
3975
self.outf.write("brz alias: %s: not found\n" % alias_name)
3978
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3980
def set_alias(self, alias_name, alias_command):
3981
"""Save the alias in the global config."""
3982
c = _mod_config.GlobalConfig()
3983
c.set_alias(alias_name, alias_command)
3986
class cmd_selftest(Command):
3987
__doc__ = """Run internal test suite.
3989
If arguments are given, they are regular expressions that say which tests
3990
should run. Tests matching any expression are run, and other tests are
3993
Alternatively if --first is given, matching tests are run first and then
3994
all other tests are run. This is useful if you have been working in a
3995
particular area, but want to make sure nothing else was broken.
3997
If --exclude is given, tests that match that regular expression are
3998
excluded, regardless of whether they match --first or not.
4000
To help catch accidential dependencies between tests, the --randomize
4001
option is useful. In most cases, the argument used is the word 'now'.
4002
Note that the seed used for the random number generator is displayed
4003
when this option is used. The seed can be explicitly passed as the
4004
argument to this option if required. This enables reproduction of the
4005
actual ordering used if and when an order sensitive problem is encountered.
4007
If --list-only is given, the tests that would be run are listed. This is
4008
useful when combined with --first, --exclude and/or --randomize to
4009
understand their impact. The test harness reports "Listed nn tests in ..."
4010
instead of "Ran nn tests in ..." when list mode is enabled.
4012
If the global option '--no-plugins' is given, plugins are not loaded
4013
before running the selftests. This has two effects: features provided or
4014
modified by plugins will not be tested, and tests provided by plugins will
4017
Tests that need working space on disk use a common temporary directory,
4018
typically inside $TMPDIR or /tmp.
4020
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4021
into a pdb postmortem session.
4023
The --coverage=DIRNAME global option produces a report with covered code
4027
Run only tests relating to 'ignore'::
4031
Disable plugins and list tests as they're run::
4033
brz --no-plugins selftest -v
4035
# NB: this is used from the class without creating an instance, which is
4036
# why it does not have a self parameter.
4037
def get_transport_type(typestring):
4038
"""Parse and return a transport specifier."""
4039
if typestring == "sftp":
4040
from .tests import stub_sftp
4041
return stub_sftp.SFTPAbsoluteServer
4042
elif typestring == "memory":
4043
from .tests import test_server
4044
return memory.MemoryServer
4045
elif typestring == "fakenfs":
4046
from .tests import test_server
4047
return test_server.FakeNFSServer
4048
msg = "No known transport type %s. Supported types are: sftp\n" %\
4050
raise errors.BzrCommandError(msg)
4053
takes_args = ['testspecs*']
4054
takes_options = ['verbose',
4056
help='Stop when one test fails.',
4060
help='Use a different transport by default '
4061
'throughout the test suite.',
4062
type=get_transport_type),
4064
help='Run the benchmarks rather than selftests.',
4066
Option('lsprof-timed',
4067
help='Generate lsprof output for benchmarked'
4068
' sections of code.'),
4069
Option('lsprof-tests',
4070
help='Generate lsprof output for each test.'),
4072
help='Run all tests, but run specified tests first.',
4076
help='List the tests instead of running them.'),
4077
RegistryOption('parallel',
4078
help="Run the test suite in parallel.",
4079
lazy_registry=('breezy.tests', 'parallel_registry'),
4080
value_switches=False,
4082
Option('randomize', type=str, argname="SEED",
4083
help='Randomize the order of tests using the given'
4084
' seed or "now" for the current time.'),
4085
ListOption('exclude', type=str, argname="PATTERN",
4087
help='Exclude tests that match this regular'
4090
help='Output test progress via subunit.'),
4091
Option('strict', help='Fail on missing dependencies or '
4093
Option('load-list', type=str, argname='TESTLISTFILE',
4094
help='Load a test id list from a text file.'),
4095
ListOption('debugflag', type=str, short_name='E',
4096
help='Turn on a selftest debug flag.'),
4097
ListOption('starting-with', type=str, argname='TESTID',
4098
param_name='starting_with', short_name='s',
4100
'Load only the tests starting with TESTID.'),
4102
help="By default we disable fsync and fdatasync"
4103
" while running the test suite.")
4105
encoding_type = 'replace'
4108
Command.__init__(self)
4109
self.additional_selftest_args = {}
4111
def run(self, testspecs_list=None, verbose=False, one=False,
4112
transport=None, benchmark=None,
4114
first=False, list_only=False,
4115
randomize=None, exclude=None, strict=False,
4116
load_list=None, debugflag=None, starting_with=None, subunit=False,
4117
parallel=None, lsprof_tests=False,
4120
# During selftest, disallow proxying, as it can cause severe
4121
# performance penalties and is only needed for thread
4122
# safety. The selftest command is assumed to not use threads
4123
# too heavily. The call should be as early as possible, as
4124
# error reporting for past duplicate imports won't have useful
4126
lazy_import.disallow_proxying()
4130
if testspecs_list is not None:
4131
pattern = '|'.join(testspecs_list)
4136
from .tests import SubUnitBzrRunner
4138
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4139
"needs to be installed to use --subunit."))
4140
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4141
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4142
# stdout, which would corrupt the subunit stream.
4143
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4144
# following code can be deleted when it's sufficiently deployed
4145
# -- vila/mgz 20100514
4146
if (sys.platform == "win32"
4147
and getattr(sys.stdout, 'fileno', None) is not None):
4149
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4151
self.additional_selftest_args.setdefault(
4152
'suite_decorators', []).append(parallel)
4154
raise errors.BzrCommandError(gettext(
4155
"--benchmark is no longer supported from brz 2.2; "
4156
"use bzr-usertest instead"))
4157
test_suite_factory = None
4159
exclude_pattern = None
4161
exclude_pattern = '(' + '|'.join(exclude) + ')'
4163
self._disable_fsync()
4164
selftest_kwargs = {"verbose": verbose,
4166
"stop_on_failure": one,
4167
"transport": transport,
4168
"test_suite_factory": test_suite_factory,
4169
"lsprof_timed": lsprof_timed,
4170
"lsprof_tests": lsprof_tests,
4171
"matching_tests_first": first,
4172
"list_only": list_only,
4173
"random_seed": randomize,
4174
"exclude_pattern": exclude_pattern,
4176
"load_list": load_list,
4177
"debug_flags": debugflag,
4178
"starting_with": starting_with
4180
selftest_kwargs.update(self.additional_selftest_args)
4182
# Make deprecation warnings visible, unless -Werror is set
4183
cleanup = symbol_versioning.activate_deprecation_warnings(
4186
result = tests.selftest(**selftest_kwargs)
4189
return int(not result)
4191
def _disable_fsync(self):
4192
"""Change the 'os' functionality to not synchronize."""
4193
self._orig_fsync = getattr(os, 'fsync', None)
4194
if self._orig_fsync is not None:
4195
os.fsync = lambda filedes: None
4196
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4197
if self._orig_fdatasync is not None:
4198
os.fdatasync = lambda filedes: None
4201
class cmd_version(Command):
4202
__doc__ = """Show version of brz."""
4204
encoding_type = 'replace'
4206
Option("short", help="Print just the version number."),
4210
def run(self, short=False):
4211
from .version import show_version
4213
self.outf.write(breezy.version_string + '\n')
4215
show_version(to_file=self.outf)
4218
class cmd_rocks(Command):
4219
__doc__ = """Statement of optimism."""
4225
self.outf.write(gettext("It sure does!\n"))
4228
class cmd_find_merge_base(Command):
4229
__doc__ = """Find and print a base revision for merging two branches."""
4230
# TODO: Options to specify revisions on either side, as if
4231
# merging only part of the history.
4232
takes_args = ['branch', 'other']
4236
def run(self, branch, other):
4237
from .revision import ensure_null
4239
branch1 = Branch.open_containing(branch)[0]
4240
branch2 = Branch.open_containing(other)[0]
4241
self.add_cleanup(branch1.lock_read().unlock)
4242
self.add_cleanup(branch2.lock_read().unlock)
4243
last1 = ensure_null(branch1.last_revision())
4244
last2 = ensure_null(branch2.last_revision())
4246
graph = branch1.repository.get_graph(branch2.repository)
4247
base_rev_id = graph.find_unique_lca(last1, last2)
4249
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4252
class cmd_merge(Command):
4253
__doc__ = """Perform a three-way merge.
4255
The source of the merge can be specified either in the form of a branch,
4256
or in the form of a path to a file containing a merge directive generated
4257
with brz send. If neither is specified, the default is the upstream branch
4258
or the branch most recently merged using --remember. The source of the
4259
merge may also be specified in the form of a path to a file in another
4260
branch: in this case, only the modifications to that file are merged into
4261
the current working tree.
4263
When merging from a branch, by default brz will try to merge in all new
4264
work from the other branch, automatically determining an appropriate base
4265
revision. If this fails, you may need to give an explicit base.
4267
To pick a different ending revision, pass "--revision OTHER". brz will
4268
try to merge in all new work up to and including revision OTHER.
4270
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4271
through OTHER, excluding BASE but including OTHER, will be merged. If this
4272
causes some revisions to be skipped, i.e. if the destination branch does
4273
not already contain revision BASE, such a merge is commonly referred to as
4274
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4275
cherrypicks. The changes look like a normal commit, and the history of the
4276
changes from the other branch is not stored in the commit.
4278
Revision numbers are always relative to the source branch.
4280
Merge will do its best to combine the changes in two branches, but there
4281
are some kinds of problems only a human can fix. When it encounters those,
4282
it will mark a conflict. A conflict means that you need to fix something,
4283
before you can commit.
4285
Use brz resolve when you have fixed a problem. See also brz conflicts.
4287
If there is no default branch set, the first merge will set it (use
4288
--no-remember to avoid setting it). After that, you can omit the branch
4289
to use the default. To change the default, use --remember. The value will
4290
only be saved if the remote location can be accessed.
4292
The results of the merge are placed into the destination working
4293
directory, where they can be reviewed (with brz diff), tested, and then
4294
committed to record the result of the merge.
4296
merge refuses to run if there are any uncommitted changes, unless
4297
--force is given. If --force is given, then the changes from the source
4298
will be merged with the current working tree, including any uncommitted
4299
changes in the tree. The --force option can also be used to create a
4300
merge revision which has more than two parents.
4302
If one would like to merge changes from the working tree of the other
4303
branch without merging any committed revisions, the --uncommitted option
4306
To select only some changes to merge, use "merge -i", which will prompt
4307
you to apply each diff hunk and file change, similar to "shelve".
4310
To merge all new revisions from brz.dev::
4312
brz merge ../brz.dev
4314
To merge changes up to and including revision 82 from brz.dev::
4316
brz merge -r 82 ../brz.dev
4318
To merge the changes introduced by 82, without previous changes::
4320
brz merge -r 81..82 ../brz.dev
4322
To apply a merge directive contained in /tmp/merge::
4324
brz merge /tmp/merge
4326
To create a merge revision with three parents from two branches
4327
feature1a and feature1b:
4329
brz merge ../feature1a
4330
brz merge ../feature1b --force
4331
brz commit -m 'revision with three parents'
4334
encoding_type = 'exact'
4335
_see_also = ['update', 'remerge', 'status-flags', 'send']
4336
takes_args = ['location?']
4341
help='Merge even if the destination tree has uncommitted changes.'),
4345
Option('show-base', help="Show base revision text in "
4347
Option('uncommitted', help='Apply uncommitted changes'
4348
' from a working copy, instead of branch changes.'),
4349
Option('pull', help='If the destination is already'
4350
' completely merged into the source, pull from the'
4351
' source rather than merging. When this happens,'
4352
' you do not need to commit the result.'),
4353
custom_help('directory',
4354
help='Branch to merge into, '
4355
'rather than the one containing the working directory.'),
4356
Option('preview', help='Instead of merging, show a diff of the'
4358
Option('interactive', help='Select changes interactively.',
4362
def run(self, location=None, revision=None, force=False,
4363
merge_type=None, show_base=False, reprocess=None, remember=None,
4364
uncommitted=False, pull=False,
4369
if merge_type is None:
4370
merge_type = _mod_merge.Merge3Merger
4372
if directory is None: directory = u'.'
4373
possible_transports = []
4375
allow_pending = True
4376
verified = 'inapplicable'
4378
tree = WorkingTree.open_containing(directory)[0]
4379
if tree.branch.revno() == 0:
4380
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4381
'https://bugs.launchpad.net/bzr/+bug/308562'))
4384
basis_tree = tree.revision_tree(tree.last_revision())
4385
except errors.NoSuchRevision:
4386
basis_tree = tree.basis_tree()
4388
# die as quickly as possible if there are uncommitted changes
4390
if tree.has_changes():
4391
raise errors.UncommittedChanges(tree)
4393
view_info = _get_view_info_for_change_reporter(tree)
4394
change_reporter = delta._ChangeReporter(
4395
unversioned_filter=tree.is_ignored, view_info=view_info)
4396
pb = ui.ui_factory.nested_progress_bar()
4397
self.add_cleanup(pb.finished)
4398
self.add_cleanup(tree.lock_write().unlock)
4399
if location is not None:
4401
mergeable = bundle.read_mergeable_from_url(location,
4402
possible_transports=possible_transports)
4403
except errors.NotABundle:
4407
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4408
' with bundles or merge directives.'))
4410
if revision is not None:
4411
raise errors.BzrCommandError(gettext(
4412
'Cannot use -r with merge directives or bundles'))
4413
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4416
if merger is None and uncommitted:
4417
if revision is not None and len(revision) > 0:
4418
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4419
' --revision at the same time.'))
4420
merger = self.get_merger_from_uncommitted(tree, location, None)
4421
allow_pending = False
4424
merger, allow_pending = self._get_merger_from_branch(tree,
4425
location, revision, remember, possible_transports, None)
4427
merger.merge_type = merge_type
4428
merger.reprocess = reprocess
4429
merger.show_base = show_base
4430
self.sanity_check_merger(merger)
4431
if (merger.base_rev_id == merger.other_rev_id and
4432
merger.other_rev_id is not None):
4433
# check if location is a nonexistent file (and not a branch) to
4434
# disambiguate the 'Nothing to do'
4435
if merger.interesting_files:
4436
if not merger.other_tree.has_filename(
4437
merger.interesting_files[0]):
4438
note(gettext("merger: ") + str(merger))
4439
raise errors.PathsDoNotExist([location])
4440
note(gettext('Nothing to do.'))
4442
if pull and not preview:
4443
if merger.interesting_files is not None:
4444
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4445
if (merger.base_rev_id == tree.last_revision()):
4446
result = tree.pull(merger.other_branch, False,
4447
merger.other_rev_id)
4448
result.report(self.outf)
4450
if merger.this_basis is None:
4451
raise errors.BzrCommandError(gettext(
4452
"This branch has no commits."
4453
" (perhaps you would prefer 'brz pull')"))
4455
return self._do_preview(merger)
4457
return self._do_interactive(merger)
4459
return self._do_merge(merger, change_reporter, allow_pending,
4462
def _get_preview(self, merger):
4463
tree_merger = merger.make_merger()
4464
tt = tree_merger.make_preview_transform()
4465
self.add_cleanup(tt.finalize)
4466
result_tree = tt.get_preview_tree()
4469
def _do_preview(self, merger):
4470
from .diff import show_diff_trees
4471
result_tree = self._get_preview(merger)
4472
path_encoding = osutils.get_diff_header_encoding()
4473
show_diff_trees(merger.this_tree, result_tree, self.outf,
4474
old_label='', new_label='',
4475
path_encoding=path_encoding)
4477
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4478
merger.change_reporter = change_reporter
4479
conflict_count = merger.do_merge()
4481
merger.set_pending()
4482
if verified == 'failed':
4483
warning('Preview patch does not match changes')
4484
if conflict_count != 0:
4489
def _do_interactive(self, merger):
4490
"""Perform an interactive merge.
4492
This works by generating a preview tree of the merge, then using
4493
Shelver to selectively remove the differences between the working tree
4494
and the preview tree.
4496
from . import shelf_ui
4497
result_tree = self._get_preview(merger)
4498
writer = breezy.option.diff_writer_registry.get()
4499
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4500
reporter=shelf_ui.ApplyReporter(),
4501
diff_writer=writer(sys.stdout))
4507
def sanity_check_merger(self, merger):
4508
if (merger.show_base and
4509
not merger.merge_type is _mod_merge.Merge3Merger):
4510
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4511
" merge type. %s") % merger.merge_type)
4512
if merger.reprocess is None:
4513
if merger.show_base:
4514
merger.reprocess = False
4516
# Use reprocess if the merger supports it
4517
merger.reprocess = merger.merge_type.supports_reprocess
4518
if merger.reprocess and not merger.merge_type.supports_reprocess:
4519
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4520
" for merge type %s.") %
4522
if merger.reprocess and merger.show_base:
4523
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4526
def _get_merger_from_branch(self, tree, location, revision, remember,
4527
possible_transports, pb):
4528
"""Produce a merger from a location, assuming it refers to a branch."""
4529
# find the branch locations
4530
other_loc, user_location = self._select_branch_location(tree, location,
4532
if revision is not None and len(revision) == 2:
4533
base_loc, _unused = self._select_branch_location(tree,
4534
location, revision, 0)
4536
base_loc = other_loc
4538
other_branch, other_path = Branch.open_containing(other_loc,
4539
possible_transports)
4540
if base_loc == other_loc:
4541
base_branch = other_branch
4543
base_branch, base_path = Branch.open_containing(base_loc,
4544
possible_transports)
4545
# Find the revision ids
4546
other_revision_id = None
4547
base_revision_id = None
4548
if revision is not None:
4549
if len(revision) >= 1:
4550
other_revision_id = revision[-1].as_revision_id(other_branch)
4551
if len(revision) == 2:
4552
base_revision_id = revision[0].as_revision_id(base_branch)
4553
if other_revision_id is None:
4554
other_revision_id = _mod_revision.ensure_null(
4555
other_branch.last_revision())
4556
# Remember where we merge from. We need to remember if:
4557
# - user specify a location (and we don't merge from the parent
4559
# - user ask to remember or there is no previous location set to merge
4560
# from and user didn't ask to *not* remember
4561
if (user_location is not None
4563
or (remember is None
4564
and tree.branch.get_submit_branch() is None)))):
4565
tree.branch.set_submit_branch(other_branch.base)
4566
# Merge tags (but don't set them in the master branch yet, the user
4567
# might revert this merge). Commit will propagate them.
4568
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4569
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4570
other_revision_id, base_revision_id, other_branch, base_branch)
4571
if other_path != '':
4572
allow_pending = False
4573
merger.interesting_files = [other_path]
4575
allow_pending = True
4576
return merger, allow_pending
4578
def get_merger_from_uncommitted(self, tree, location, pb):
4579
"""Get a merger for uncommitted changes.
4581
:param tree: The tree the merger should apply to.
4582
:param location: The location containing uncommitted changes.
4583
:param pb: The progress bar to use for showing progress.
4585
location = self._select_branch_location(tree, location)[0]
4586
other_tree, other_path = WorkingTree.open_containing(location)
4587
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4588
if other_path != '':
4589
merger.interesting_files = [other_path]
4592
def _select_branch_location(self, tree, user_location, revision=None,
4594
"""Select a branch location, according to possible inputs.
4596
If provided, branches from ``revision`` are preferred. (Both
4597
``revision`` and ``index`` must be supplied.)
4599
Otherwise, the ``location`` parameter is used. If it is None, then the
4600
``submit`` or ``parent`` location is used, and a note is printed.
4602
:param tree: The working tree to select a branch for merging into
4603
:param location: The location entered by the user
4604
:param revision: The revision parameter to the command
4605
:param index: The index to use for the revision parameter. Negative
4606
indices are permitted.
4607
:return: (selected_location, user_location). The default location
4608
will be the user-entered location.
4610
if (revision is not None and index is not None
4611
and revision[index] is not None):
4612
branch = revision[index].get_branch()
4613
if branch is not None:
4614
return branch, branch
4615
if user_location is None:
4616
location = self._get_remembered(tree, 'Merging from')
4618
location = user_location
4619
return location, user_location
4621
def _get_remembered(self, tree, verb_string):
4622
"""Use tree.branch's parent if none was supplied.
4624
Report if the remembered location was used.
4626
stored_location = tree.branch.get_submit_branch()
4627
stored_location_type = "submit"
4628
if stored_location is None:
4629
stored_location = tree.branch.get_parent()
4630
stored_location_type = "parent"
4631
mutter("%s", stored_location)
4632
if stored_location is None:
4633
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4634
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4635
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4636
stored_location_type, display_url))
4637
return stored_location
4640
class cmd_remerge(Command):
4641
__doc__ = """Redo a merge.
4643
Use this if you want to try a different merge technique while resolving
4644
conflicts. Some merge techniques are better than others, and remerge
4645
lets you try different ones on different files.
4647
The options for remerge have the same meaning and defaults as the ones for
4648
merge. The difference is that remerge can (only) be run when there is a
4649
pending merge, and it lets you specify particular files.
4652
Re-do the merge of all conflicted files, and show the base text in
4653
conflict regions, in addition to the usual THIS and OTHER texts::
4655
brz remerge --show-base
4657
Re-do the merge of "foobar", using the weave merge algorithm, with
4658
additional processing to reduce the size of conflict regions::
4660
brz remerge --merge-type weave --reprocess foobar
4662
takes_args = ['file*']
4667
help="Show base revision text in conflicts."),
4670
def run(self, file_list=None, merge_type=None, show_base=False,
4672
from .conflicts import restore
4673
if merge_type is None:
4674
merge_type = _mod_merge.Merge3Merger
4675
tree, file_list = WorkingTree.open_containing_paths(file_list)
4676
self.add_cleanup(tree.lock_write().unlock)
4677
parents = tree.get_parent_ids()
4678
if len(parents) != 2:
4679
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4680
" merges. Not cherrypicking or"
4682
repository = tree.branch.repository
4683
interesting_ids = None
4685
conflicts = tree.conflicts()
4686
if file_list is not None:
4687
interesting_ids = set()
4688
for filename in file_list:
4689
file_id = tree.path2id(filename)
4691
raise errors.NotVersionedError(filename)
4692
interesting_ids.add(file_id)
4693
if tree.kind(file_id) != "directory":
4696
# FIXME: Support nested trees
4697
for name, ie in tree.root_inventory.iter_entries(file_id):
4698
interesting_ids.add(ie.file_id)
4699
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4701
# Remerge only supports resolving contents conflicts
4702
allowed_conflicts = ('text conflict', 'contents conflict')
4703
restore_files = [c.path for c in conflicts
4704
if c.typestring in allowed_conflicts]
4705
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4706
tree.set_conflicts(ConflictList(new_conflicts))
4707
if file_list is not None:
4708
restore_files = file_list
4709
for filename in restore_files:
4711
restore(tree.abspath(filename))
4712
except errors.NotConflicted:
4714
# Disable pending merges, because the file texts we are remerging
4715
# have not had those merges performed. If we use the wrong parents
4716
# list, we imply that the working tree text has seen and rejected
4717
# all the changes from the other tree, when in fact those changes
4718
# have not yet been seen.
4719
tree.set_parent_ids(parents[:1])
4721
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4722
merger.interesting_ids = interesting_ids
4723
merger.merge_type = merge_type
4724
merger.show_base = show_base
4725
merger.reprocess = reprocess
4726
conflicts = merger.do_merge()
4728
tree.set_parent_ids(parents)
4735
class cmd_revert(Command):
4737
Set files in the working tree back to the contents of a previous revision.
4739
Giving a list of files will revert only those files. Otherwise, all files
4740
will be reverted. If the revision is not specified with '--revision', the
4741
working tree basis revision is used. A revert operation affects only the
4742
working tree, not any revision history like the branch and repository or
4743
the working tree basis revision.
4745
To remove only some changes, without reverting to a prior version, use
4746
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4747
will remove the changes introduced by the second last commit (-2), without
4748
affecting the changes introduced by the last commit (-1). To remove
4749
certain changes on a hunk-by-hunk basis, see the shelve command.
4750
To update the branch to a specific revision or the latest revision and
4751
update the working tree accordingly while preserving local changes, see the
4754
Uncommitted changes to files that are reverted will be discarded.
4755
Howver, by default, any files that have been manually changed will be
4756
backed up first. (Files changed only by merge are not backed up.) Backup
4757
files have '.~#~' appended to their name, where # is a number.
4759
When you provide files, you can use their current pathname or the pathname
4760
from the target revision. So you can use revert to "undelete" a file by
4761
name. If you name a directory, all the contents of that directory will be
4764
If you have newly added files since the target revision, they will be
4765
removed. If the files to be removed have been changed, backups will be
4766
created as above. Directories containing unknown files will not be
4769
The working tree contains a list of revisions that have been merged but
4770
not yet committed. These revisions will be included as additional parents
4771
of the next commit. Normally, using revert clears that list as well as
4772
reverting the files. If any files are specified, revert leaves the list
4773
of uncommitted merges alone and reverts only the files. Use ``brz revert
4774
.`` in the tree root to revert all files but keep the recorded merges,
4775
and ``brz revert --forget-merges`` to clear the pending merge list without
4776
reverting any files.
4778
Using "brz revert --forget-merges", it is possible to apply all of the
4779
changes from a branch in a single revision. To do this, perform the merge
4780
as desired. Then doing revert with the "--forget-merges" option will keep
4781
the content of the tree as it was, but it will clear the list of pending
4782
merges. The next commit will then contain all of the changes that are
4783
present in the other branch, but without any other parent revisions.
4784
Because this technique forgets where these changes originated, it may
4785
cause additional conflicts on later merges involving the same source and
4789
_see_also = ['cat', 'export', 'merge', 'shelve']
4792
Option('no-backup', "Do not save backups of reverted files."),
4793
Option('forget-merges',
4794
'Remove pending merge marker, without changing any files.'),
4796
takes_args = ['file*']
4798
def run(self, revision=None, no_backup=False, file_list=None,
4799
forget_merges=None):
4800
tree, file_list = WorkingTree.open_containing_paths(file_list)
4801
self.add_cleanup(tree.lock_tree_write().unlock)
4803
tree.set_parent_ids(tree.get_parent_ids()[:1])
4805
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4808
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4809
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4810
tree.revert(file_list, rev_tree, not no_backup, None,
4811
report_changes=True)
4814
class cmd_assert_fail(Command):
4815
__doc__ = """Test reporting of assertion failures"""
4816
# intended just for use in testing
4821
raise AssertionError("always fails")
4824
class cmd_help(Command):
4825
__doc__ = """Show help on a command or other topic.
4828
_see_also = ['topics']
4830
Option('long', 'Show help on all commands.'),
4832
takes_args = ['topic?']
4833
aliases = ['?', '--help', '-?', '-h']
4836
def run(self, topic=None, long=False):
4838
if topic is None and long:
4840
breezy.help.help(topic)
4843
class cmd_shell_complete(Command):
4844
__doc__ = """Show appropriate completions for context.
4846
For a list of all available commands, say 'brz shell-complete'.
4848
takes_args = ['context?']
4853
def run(self, context=None):
4854
from . import shellcomplete
4855
shellcomplete.shellcomplete(context)
4858
class cmd_missing(Command):
4859
__doc__ = """Show unmerged/unpulled revisions between two branches.
4861
OTHER_BRANCH may be local or remote.
4863
To filter on a range of revisions, you can use the command -r begin..end
4864
-r revision requests a specific revision, -r ..end or -r begin.. are
4868
1 - some missing revisions
4869
0 - no missing revisions
4873
Determine the missing revisions between this and the branch at the
4874
remembered pull location::
4878
Determine the missing revisions between this and another branch::
4880
brz missing http://server/branch
4882
Determine the missing revisions up to a specific revision on the other
4885
brz missing -r ..-10
4887
Determine the missing revisions up to a specific revision on this
4890
brz missing --my-revision ..-10
4893
_see_also = ['merge', 'pull']
4894
takes_args = ['other_branch?']
4897
Option('reverse', 'Reverse the order of revisions.'),
4899
'Display changes in the local branch only.'),
4900
Option('this' , 'Same as --mine-only.'),
4901
Option('theirs-only',
4902
'Display changes in the remote branch only.'),
4903
Option('other', 'Same as --theirs-only.'),
4907
custom_help('revision',
4908
help='Filter on other branch revisions (inclusive). '
4909
'See "help revisionspec" for details.'),
4910
Option('my-revision',
4911
type=_parse_revision_str,
4912
help='Filter on local branch revisions (inclusive). '
4913
'See "help revisionspec" for details.'),
4914
Option('include-merged',
4915
'Show all revisions in addition to the mainline ones.'),
4916
Option('include-merges', hidden=True,
4917
help='Historical alias for --include-merged.'),
4919
encoding_type = 'replace'
4922
def run(self, other_branch=None, reverse=False, mine_only=False,
4924
log_format=None, long=False, short=False, line=False,
4925
show_ids=False, verbose=False, this=False, other=False,
4926
include_merged=None, revision=None, my_revision=None,
4928
from breezy.missing import find_unmerged, iter_log_revisions
4933
if include_merged is None:
4934
include_merged = False
4939
# TODO: We should probably check that we don't have mine-only and
4940
# theirs-only set, but it gets complicated because we also have
4941
# this and other which could be used.
4948
local_branch = Branch.open_containing(directory)[0]
4949
self.add_cleanup(local_branch.lock_read().unlock)
4951
parent = local_branch.get_parent()
4952
if other_branch is None:
4953
other_branch = parent
4954
if other_branch is None:
4955
raise errors.BzrCommandError(gettext("No peer location known"
4957
display_url = urlutils.unescape_for_display(parent,
4959
message(gettext("Using saved parent location: {0}\n").format(
4962
remote_branch = Branch.open(other_branch)
4963
if remote_branch.base == local_branch.base:
4964
remote_branch = local_branch
4966
self.add_cleanup(remote_branch.lock_read().unlock)
4968
local_revid_range = _revision_range_to_revid_range(
4969
_get_revision_range(my_revision, local_branch,
4972
remote_revid_range = _revision_range_to_revid_range(
4973
_get_revision_range(revision,
4974
remote_branch, self.name()))
4976
local_extra, remote_extra = find_unmerged(
4977
local_branch, remote_branch, restrict,
4978
backward=not reverse,
4979
include_merged=include_merged,
4980
local_revid_range=local_revid_range,
4981
remote_revid_range=remote_revid_range)
4983
if log_format is None:
4984
registry = log.log_formatter_registry
4985
log_format = registry.get_default(local_branch)
4986
lf = log_format(to_file=self.outf,
4988
show_timezone='original')
4991
if local_extra and not theirs_only:
4992
message(ngettext("You have %d extra revision:\n",
4993
"You have %d extra revisions:\n",
4997
if local_branch.supports_tags():
4998
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
4999
for revision in iter_log_revisions(local_extra,
5000
local_branch.repository,
5003
lf.log_revision(revision)
5004
printed_local = True
5007
printed_local = False
5009
if remote_extra and not mine_only:
5010
if printed_local is True:
5012
message(ngettext("You are missing %d revision:\n",
5013
"You are missing %d revisions:\n",
5014
len(remote_extra)) %
5016
if remote_branch.supports_tags():
5017
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5018
for revision in iter_log_revisions(remote_extra,
5019
remote_branch.repository,
5022
lf.log_revision(revision)
5025
if mine_only and not local_extra:
5026
# We checked local, and found nothing extra
5027
message(gettext('This branch has no new revisions.\n'))
5028
elif theirs_only and not remote_extra:
5029
# We checked remote, and found nothing extra
5030
message(gettext('Other branch has no new revisions.\n'))
5031
elif not (mine_only or theirs_only or local_extra or
5033
# We checked both branches, and neither one had extra
5035
message(gettext("Branches are up to date.\n"))
5037
if not status_code and parent is None and other_branch is not None:
5038
self.add_cleanup(local_branch.lock_write().unlock)
5039
# handle race conditions - a parent might be set while we run.
5040
if local_branch.get_parent() is None:
5041
local_branch.set_parent(remote_branch.base)
5045
class cmd_pack(Command):
5046
__doc__ = """Compress the data within a repository.
5048
This operation compresses the data within a bazaar repository. As
5049
bazaar supports automatic packing of repository, this operation is
5050
normally not required to be done manually.
5052
During the pack operation, bazaar takes a backup of existing repository
5053
data, i.e. pack files. This backup is eventually removed by bazaar
5054
automatically when it is safe to do so. To save disk space by removing
5055
the backed up pack files, the --clean-obsolete-packs option may be
5058
Warning: If you use --clean-obsolete-packs and your machine crashes
5059
during or immediately after repacking, you may be left with a state
5060
where the deletion has been written to disk but the new packs have not
5061
been. In this case the repository may be unusable.
5064
_see_also = ['repositories']
5065
takes_args = ['branch_or_repo?']
5067
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5070
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5071
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5073
branch = dir.open_branch()
5074
repository = branch.repository
5075
except errors.NotBranchError:
5076
repository = dir.open_repository()
5077
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5080
class cmd_plugins(Command):
5081
__doc__ = """List the installed plugins.
5083
This command displays the list of installed plugins including
5084
version of plugin and a short description of each.
5086
--verbose shows the path where each plugin is located.
5088
A plugin is an external component for Bazaar that extends the
5089
revision control system, by adding or replacing code in Bazaar.
5090
Plugins can do a variety of things, including overriding commands,
5091
adding new commands, providing additional network transports and
5092
customizing log output.
5094
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5095
for further information on plugins including where to find them and how to
5096
install them. Instructions are also provided there on how to write new
5097
plugins using the Python programming language.
5099
takes_options = ['verbose']
5102
def run(self, verbose=False):
5103
from . import plugin
5104
# Don't give writelines a generator as some codecs don't like that
5105
self.outf.writelines(
5106
list(plugin.describe_plugins(show_paths=verbose)))
5109
class cmd_testament(Command):
5110
__doc__ = """Show testament (signing-form) of a revision."""
5113
Option('long', help='Produce long-format testament.'),
5115
help='Produce a strict-format testament.')]
5116
takes_args = ['branch?']
5117
encoding_type = 'exact'
5119
def run(self, branch=u'.', revision=None, long=False, strict=False):
5120
from .testament import Testament, StrictTestament
5122
testament_class = StrictTestament
5124
testament_class = Testament
5126
b = Branch.open_containing(branch)[0]
5128
b = Branch.open(branch)
5129
self.add_cleanup(b.lock_read().unlock)
5130
if revision is None:
5131
rev_id = b.last_revision()
5133
rev_id = revision[0].as_revision_id(b)
5134
t = testament_class.from_revision(b.repository, rev_id)
5136
self.outf.writelines(t.as_text_lines())
5138
self.outf.write(t.as_short_text())
5141
class cmd_annotate(Command):
5142
__doc__ = """Show the origin of each line in a file.
5144
This prints out the given file with an annotation on the left side
5145
indicating which revision, author and date introduced the change.
5147
If the origin is the same for a run of consecutive lines, it is
5148
shown only at the top, unless the --all option is given.
5150
# TODO: annotate directories; showing when each file was last changed
5151
# TODO: if the working copy is modified, show annotations on that
5152
# with new uncommitted lines marked
5153
aliases = ['ann', 'blame', 'praise']
5154
takes_args = ['filename']
5155
takes_options = [Option('all', help='Show annotations on all lines.'),
5156
Option('long', help='Show commit date in annotations.'),
5161
encoding_type = 'exact'
5164
def run(self, filename, all=False, long=False, revision=None,
5165
show_ids=False, directory=None):
5166
from .annotate import (
5169
wt, branch, relpath = \
5170
_open_directory_or_containing_tree_or_branch(filename, directory)
5172
self.add_cleanup(wt.lock_read().unlock)
5174
self.add_cleanup(branch.lock_read().unlock)
5175
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5176
self.add_cleanup(tree.lock_read().unlock)
5177
if wt is not None and revision is None:
5178
file_id = wt.path2id(relpath)
5180
file_id = tree.path2id(relpath)
5182
raise errors.NotVersionedError(filename)
5183
if wt is not None and revision is None:
5184
# If there is a tree and we're not annotating historical
5185
# versions, annotate the working tree's content.
5186
annotate_file_tree(wt, file_id, self.outf, long, all,
5189
annotate_file_tree(tree, file_id, self.outf, long, all,
5190
show_ids=show_ids, branch=branch)
5193
class cmd_re_sign(Command):
5194
__doc__ = """Create a digital signature for an existing revision."""
5195
# TODO be able to replace existing ones.
5197
hidden = True # is this right ?
5198
takes_args = ['revision_id*']
5199
takes_options = ['directory', 'revision']
5201
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5202
if revision_id_list is not None and revision is not None:
5203
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5204
if revision_id_list is None and revision is None:
5205
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5206
b = WorkingTree.open_containing(directory)[0].branch
5207
self.add_cleanup(b.lock_write().unlock)
5208
return self._run(b, revision_id_list, revision)
5210
def _run(self, b, revision_id_list, revision):
5212
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5213
if revision_id_list is not None:
5214
b.repository.start_write_group()
5216
for revision_id in revision_id_list:
5217
b.repository.sign_revision(revision_id, gpg_strategy)
5219
b.repository.abort_write_group()
5222
b.repository.commit_write_group()
5223
elif revision is not None:
5224
if len(revision) == 1:
5225
revno, rev_id = revision[0].in_history(b)
5226
b.repository.start_write_group()
5228
b.repository.sign_revision(rev_id, gpg_strategy)
5230
b.repository.abort_write_group()
5233
b.repository.commit_write_group()
5234
elif len(revision) == 2:
5235
# are they both on rh- if so we can walk between them
5236
# might be nice to have a range helper for arbitrary
5237
# revision paths. hmm.
5238
from_revno, from_revid = revision[0].in_history(b)
5239
to_revno, to_revid = revision[1].in_history(b)
5240
if to_revid is None:
5241
to_revno = b.revno()
5242
if from_revno is None or to_revno is None:
5243
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5244
b.repository.start_write_group()
5246
for revno in range(from_revno, to_revno + 1):
5247
b.repository.sign_revision(b.get_rev_id(revno),
5250
b.repository.abort_write_group()
5253
b.repository.commit_write_group()
5255
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5258
class cmd_bind(Command):
5259
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5260
If no branch is supplied, rebind to the last bound location.
5262
Once converted into a checkout, commits must succeed on the master branch
5263
before they will be applied to the local branch.
5265
Bound branches use the nickname of its master branch unless it is set
5266
locally, in which case binding will update the local nickname to be
5270
_see_also = ['checkouts', 'unbind']
5271
takes_args = ['location?']
5272
takes_options = ['directory']
5274
def run(self, location=None, directory=u'.'):
5275
b, relpath = Branch.open_containing(directory)
5276
if location is None:
5278
location = b.get_old_bound_location()
5279
except errors.UpgradeRequired:
5280
raise errors.BzrCommandError(gettext('No location supplied. '
5281
'This format does not remember old locations.'))
5283
if location is None:
5284
if b.get_bound_location() is not None:
5285
raise errors.BzrCommandError(
5286
gettext('Branch is already bound'))
5288
raise errors.BzrCommandError(
5289
gettext('No location supplied'
5290
' and no previous location known'))
5291
b_other = Branch.open(location)
5294
except errors.DivergedBranches:
5295
raise errors.BzrCommandError(gettext('These branches have diverged.'
5296
' Try merging, and then bind again.'))
5297
if b.get_config().has_explicit_nickname():
5298
b.nick = b_other.nick
5301
class cmd_unbind(Command):
5302
__doc__ = """Convert the current checkout into a regular branch.
5304
After unbinding, the local branch is considered independent and subsequent
5305
commits will be local only.
5308
_see_also = ['checkouts', 'bind']
5310
takes_options = ['directory']
5312
def run(self, directory=u'.'):
5313
b, relpath = Branch.open_containing(directory)
5315
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5318
class cmd_uncommit(Command):
5319
__doc__ = """Remove the last committed revision.
5321
--verbose will print out what is being removed.
5322
--dry-run will go through all the motions, but not actually
5325
If --revision is specified, uncommit revisions to leave the branch at the
5326
specified revision. For example, "brz uncommit -r 15" will leave the
5327
branch at revision 15.
5329
Uncommit leaves the working tree ready for a new commit. The only change
5330
it may make is to restore any pending merges that were present before
5334
# TODO: jam 20060108 Add an option to allow uncommit to remove
5335
# unreferenced information in 'branch-as-repository' branches.
5336
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5337
# information in shared branches as well.
5338
_see_also = ['commit']
5339
takes_options = ['verbose', 'revision',
5340
Option('dry-run', help='Don\'t actually make changes.'),
5341
Option('force', help='Say yes to all questions.'),
5343
help='Keep tags that point to removed revisions.'),
5345
help="Only remove the commits from the local branch"
5346
" when in a checkout."
5349
takes_args = ['location?']
5351
encoding_type = 'replace'
5353
def run(self, location=None, dry_run=False, verbose=False,
5354
revision=None, force=False, local=False, keep_tags=False):
5355
if location is None:
5357
control, relpath = controldir.ControlDir.open_containing(location)
5359
tree = control.open_workingtree()
5361
except (errors.NoWorkingTree, errors.NotLocalUrl):
5363
b = control.open_branch()
5365
if tree is not None:
5366
self.add_cleanup(tree.lock_write().unlock)
5368
self.add_cleanup(b.lock_write().unlock)
5369
return self._run(b, tree, dry_run, verbose, revision, force,
5372
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5374
from .log import log_formatter, show_log
5375
from .uncommit import uncommit
5377
last_revno, last_rev_id = b.last_revision_info()
5380
if revision is None:
5382
rev_id = last_rev_id
5384
# 'brz uncommit -r 10' actually means uncommit
5385
# so that the final tree is at revno 10.
5386
# but breezy.uncommit.uncommit() actually uncommits
5387
# the revisions that are supplied.
5388
# So we need to offset it by one
5389
revno = revision[0].in_history(b).revno + 1
5390
if revno <= last_revno:
5391
rev_id = b.get_rev_id(revno)
5393
if rev_id is None or _mod_revision.is_null(rev_id):
5394
self.outf.write(gettext('No revisions to uncommit.\n'))
5397
lf = log_formatter('short',
5399
show_timezone='original')
5404
direction='forward',
5405
start_revision=revno,
5406
end_revision=last_revno)
5409
self.outf.write(gettext('Dry-run, pretending to remove'
5410
' the above revisions.\n'))
5412
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5415
if not ui.ui_factory.confirm_action(
5416
gettext(u'Uncommit these revisions'),
5417
'breezy.builtins.uncommit',
5419
self.outf.write(gettext('Canceled\n'))
5422
mutter('Uncommitting from {%s} to {%s}',
5423
last_rev_id, rev_id)
5424
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5425
revno=revno, local=local, keep_tags=keep_tags)
5426
self.outf.write(gettext('You can restore the old tip by running:\n'
5427
' brz pull . -r revid:%s\n') % last_rev_id)
5430
class cmd_break_lock(Command):
5431
__doc__ = """Break a dead lock.
5433
This command breaks a lock on a repository, branch, working directory or
5436
CAUTION: Locks should only be broken when you are sure that the process
5437
holding the lock has been stopped.
5439
You can get information on what locks are open via the 'brz info
5440
[location]' command.
5444
brz break-lock brz+ssh://example.com/brz/foo
5445
brz break-lock --conf ~/.bazaar
5448
takes_args = ['location?']
5451
help='LOCATION is the directory where the config lock is.'),
5453
help='Do not ask for confirmation before breaking the lock.'),
5456
def run(self, location=None, config=False, force=False):
5457
if location is None:
5460
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5462
{'breezy.lockdir.break': True})
5464
conf = _mod_config.LockableConfig(file_name=location)
5467
control, relpath = controldir.ControlDir.open_containing(location)
5469
control.break_lock()
5470
except NotImplementedError:
5474
class cmd_wait_until_signalled(Command):
5475
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5477
This just prints a line to signal when it is ready, then blocks on stdin.
5483
sys.stdout.write("running\n")
5485
sys.stdin.readline()
5488
class cmd_serve(Command):
5489
__doc__ = """Run the brz server."""
5491
aliases = ['server']
5495
help='Serve on stdin/out for use from inetd or sshd.'),
5496
RegistryOption('protocol',
5497
help="Protocol to serve.",
5498
lazy_registry=('breezy.transport', 'transport_server_registry'),
5499
value_switches=True),
5501
help='Listen for connections on nominated address.', type=str),
5503
help='Listen for connections on nominated port. Passing 0 as '
5504
'the port number will result in a dynamically allocated '
5505
'port. The default port depends on the protocol.',
5507
custom_help('directory',
5508
help='Serve contents of this directory.'),
5509
Option('allow-writes',
5510
help='By default the server is a readonly server. Supplying '
5511
'--allow-writes enables write access to the contents of '
5512
'the served directory and below. Note that ``brz serve`` '
5513
'does not perform authentication, so unless some form of '
5514
'external authentication is arranged supplying this '
5515
'option leads to global uncontrolled write access to your '
5518
Option('client-timeout', type=float,
5519
help='Override the default idle client timeout (5min).'),
5522
def run(self, listen=None, port=None, inet=False, directory=None,
5523
allow_writes=False, protocol=None, client_timeout=None):
5524
from . import transport
5525
if directory is None:
5526
directory = osutils.getcwd()
5527
if protocol is None:
5528
protocol = transport.transport_server_registry.get()
5529
url = transport.location_to_url(directory)
5530
if not allow_writes:
5531
url = 'readonly+' + url
5532
t = transport.get_transport_from_url(url)
5533
protocol(t, listen, port, inet, client_timeout)
5536
class cmd_join(Command):
5537
__doc__ = """Combine a tree into its containing tree.
5539
This command requires the target tree to be in a rich-root format.
5541
The TREE argument should be an independent tree, inside another tree, but
5542
not part of it. (Such trees can be produced by "brz split", but also by
5543
running "brz branch" with the target inside a tree.)
5545
The result is a combined tree, with the subtree no longer an independent
5546
part. This is marked as a merge of the subtree into the containing tree,
5547
and all history is preserved.
5550
_see_also = ['split']
5551
takes_args = ['tree']
5553
Option('reference', help='Join by reference.', hidden=True),
5556
def run(self, tree, reference=False):
5557
sub_tree = WorkingTree.open(tree)
5558
parent_dir = osutils.dirname(sub_tree.basedir)
5559
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5560
repo = containing_tree.branch.repository
5561
if not repo.supports_rich_root():
5562
raise errors.BzrCommandError(gettext(
5563
"Can't join trees because %s doesn't support rich root data.\n"
5564
"You can use brz upgrade on the repository.")
5568
containing_tree.add_reference(sub_tree)
5569
except errors.BadReferenceTarget as e:
5570
# XXX: Would be better to just raise a nicely printable
5571
# exception from the real origin. Also below. mbp 20070306
5572
raise errors.BzrCommandError(
5573
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5576
containing_tree.subsume(sub_tree)
5577
except errors.BadSubsumeSource as e:
5578
raise errors.BzrCommandError(
5579
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5582
class cmd_split(Command):
5583
__doc__ = """Split a subdirectory of a tree into a separate tree.
5585
This command will produce a target tree in a format that supports
5586
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5587
converted into earlier formats like 'dirstate-tags'.
5589
The TREE argument should be a subdirectory of a working tree. That
5590
subdirectory will be converted into an independent tree, with its own
5591
branch. Commits in the top-level tree will not apply to the new subtree.
5594
_see_also = ['join']
5595
takes_args = ['tree']
5597
def run(self, tree):
5598
containing_tree, subdir = WorkingTree.open_containing(tree)
5599
sub_id = containing_tree.path2id(subdir)
5601
raise errors.NotVersionedError(subdir)
5603
containing_tree.extract(sub_id)
5604
except errors.RootNotRich:
5605
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5608
class cmd_merge_directive(Command):
5609
__doc__ = """Generate a merge directive for auto-merge tools.
5611
A directive requests a merge to be performed, and also provides all the
5612
information necessary to do so. This means it must either include a
5613
revision bundle, or the location of a branch containing the desired
5616
A submit branch (the location to merge into) must be supplied the first
5617
time the command is issued. After it has been supplied once, it will
5618
be remembered as the default.
5620
A public branch is optional if a revision bundle is supplied, but required
5621
if --diff or --plain is specified. It will be remembered as the default
5622
after the first use.
5625
takes_args = ['submit_branch?', 'public_branch?']
5629
_see_also = ['send']
5633
RegistryOption.from_kwargs('patch-type',
5634
'The type of patch to include in the directive.',
5636
value_switches=True,
5638
bundle='Bazaar revision bundle (default).',
5639
diff='Normal unified diff.',
5640
plain='No patch, just directive.'),
5641
Option('sign', help='GPG-sign the directive.'), 'revision',
5642
Option('mail-to', type=str,
5643
help='Instead of printing the directive, email to this address.'),
5644
Option('message', type=str, short_name='m',
5645
help='Message to use when committing this merge.')
5648
encoding_type = 'exact'
5650
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5651
sign=False, revision=None, mail_to=None, message=None,
5653
from .revision import ensure_null, NULL_REVISION
5654
include_patch, include_bundle = {
5655
'plain': (False, False),
5656
'diff': (True, False),
5657
'bundle': (True, True),
5659
branch = Branch.open(directory)
5660
stored_submit_branch = branch.get_submit_branch()
5661
if submit_branch is None:
5662
submit_branch = stored_submit_branch
5664
if stored_submit_branch is None:
5665
branch.set_submit_branch(submit_branch)
5666
if submit_branch is None:
5667
submit_branch = branch.get_parent()
5668
if submit_branch is None:
5669
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5671
stored_public_branch = branch.get_public_branch()
5672
if public_branch is None:
5673
public_branch = stored_public_branch
5674
elif stored_public_branch is None:
5675
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5676
branch.set_public_branch(public_branch)
5677
if not include_bundle and public_branch is None:
5678
raise errors.BzrCommandError(gettext('No public branch specified or'
5680
base_revision_id = None
5681
if revision is not None:
5682
if len(revision) > 2:
5683
raise errors.BzrCommandError(gettext('brz merge-directive takes '
5684
'at most two one revision identifiers'))
5685
revision_id = revision[-1].as_revision_id(branch)
5686
if len(revision) == 2:
5687
base_revision_id = revision[0].as_revision_id(branch)
5689
revision_id = branch.last_revision()
5690
revision_id = ensure_null(revision_id)
5691
if revision_id == NULL_REVISION:
5692
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5693
directive = merge_directive.MergeDirective2.from_objects(
5694
branch.repository, revision_id, time.time(),
5695
osutils.local_time_offset(), submit_branch,
5696
public_branch=public_branch, include_patch=include_patch,
5697
include_bundle=include_bundle, message=message,
5698
base_revision_id=base_revision_id)
5701
self.outf.write(directive.to_signed(branch))
5703
self.outf.writelines(directive.to_lines())
5705
message = directive.to_email(mail_to, branch, sign)
5706
s = SMTPConnection(branch.get_config_stack())
5707
s.send_email(message)
5710
class cmd_send(Command):
5711
__doc__ = """Mail or create a merge-directive for submitting changes.
5713
A merge directive provides many things needed for requesting merges:
5715
* A machine-readable description of the merge to perform
5717
* An optional patch that is a preview of the changes requested
5719
* An optional bundle of revision data, so that the changes can be applied
5720
directly from the merge directive, without retrieving data from a
5723
`brz send` creates a compact data set that, when applied using brz
5724
merge, has the same effect as merging from the source branch.
5726
By default the merge directive is self-contained and can be applied to any
5727
branch containing submit_branch in its ancestory without needing access to
5730
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5731
revisions, but only a structured request to merge from the
5732
public_location. In that case the public_branch is needed and it must be
5733
up-to-date and accessible to the recipient. The public_branch is always
5734
included if known, so that people can check it later.
5736
The submit branch defaults to the parent of the source branch, but can be
5737
overridden. Both submit branch and public branch will be remembered in
5738
branch.conf the first time they are used for a particular branch. The
5739
source branch defaults to that containing the working directory, but can
5740
be changed using --from.
5742
Both the submit branch and the public branch follow the usual behavior with
5743
respect to --remember: If there is no default location set, the first send
5744
will set it (use --no-remember to avoid setting it). After that, you can
5745
omit the location to use the default. To change the default, use
5746
--remember. The value will only be saved if the location can be accessed.
5748
In order to calculate those changes, brz must analyse the submit branch.
5749
Therefore it is most efficient for the submit branch to be a local mirror.
5750
If a public location is known for the submit_branch, that location is used
5751
in the merge directive.
5753
The default behaviour is to send the merge directive by mail, unless -o is
5754
given, in which case it is sent to a file.
5756
Mail is sent using your preferred mail program. This should be transparent
5757
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5758
If the preferred client can't be found (or used), your editor will be used.
5760
To use a specific mail program, set the mail_client configuration option.
5761
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5762
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5763
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5764
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5767
If mail is being sent, a to address is required. This can be supplied
5768
either on the commandline, by setting the submit_to configuration
5769
option in the branch itself or the child_submit_to configuration option
5770
in the submit branch.
5772
Two formats are currently supported: "4" uses revision bundle format 4 and
5773
merge directive format 2. It is significantly faster and smaller than
5774
older formats. It is compatible with Bazaar 0.19 and later. It is the
5775
default. "0.9" uses revision bundle format 0.9 and merge directive
5776
format 1. It is compatible with Bazaar 0.12 - 0.18.
5778
The merge directives created by brz send may be applied using brz merge or
5779
brz pull by specifying a file containing a merge directive as the location.
5781
brz send makes extensive use of public locations to map local locations into
5782
URLs that can be used by other people. See `brz help configuration` to
5783
set them, and use `brz info` to display them.
5786
encoding_type = 'exact'
5788
_see_also = ['merge', 'pull']
5790
takes_args = ['submit_branch?', 'public_branch?']
5794
help='Do not include a bundle in the merge directive.'),
5795
Option('no-patch', help='Do not include a preview patch in the merge'
5798
help='Remember submit and public branch.'),
5800
help='Branch to generate the submission from, '
5801
'rather than the one containing the working directory.',
5804
Option('output', short_name='o',
5805
help='Write merge directive to this file or directory; '
5806
'use - for stdout.',
5809
help='Refuse to send if there are uncommitted changes in'
5810
' the working tree, --no-strict disables the check.'),
5811
Option('mail-to', help='Mail the request to this address.',
5815
Option('body', help='Body for the email.', type=text_type),
5816
RegistryOption('format',
5817
help='Use the specified output format.',
5818
lazy_registry=('breezy.send', 'format_registry')),
5821
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5822
no_patch=False, revision=None, remember=None, output=None,
5823
format=None, mail_to=None, message=None, body=None,
5824
strict=None, **kwargs):
5825
from .send import send
5826
return send(submit_branch, revision, public_branch, remember,
5827
format, no_bundle, no_patch, output,
5828
kwargs.get('from', '.'), mail_to, message, body,
5833
class cmd_bundle_revisions(cmd_send):
5834
__doc__ = """Create a merge-directive for submitting changes.
5836
A merge directive provides many things needed for requesting merges:
5838
* A machine-readable description of the merge to perform
5840
* An optional patch that is a preview of the changes requested
5842
* An optional bundle of revision data, so that the changes can be applied
5843
directly from the merge directive, without retrieving data from a
5846
If --no-bundle is specified, then public_branch is needed (and must be
5847
up-to-date), so that the receiver can perform the merge using the
5848
public_branch. The public_branch is always included if known, so that
5849
people can check it later.
5851
The submit branch defaults to the parent, but can be overridden. Both
5852
submit branch and public branch will be remembered if supplied.
5854
If a public_branch is known for the submit_branch, that public submit
5855
branch is used in the merge instructions. This means that a local mirror
5856
can be used as your actual submit branch, once you have set public_branch
5859
Two formats are currently supported: "4" uses revision bundle format 4 and
5860
merge directive format 2. It is significantly faster and smaller than
5861
older formats. It is compatible with Bazaar 0.19 and later. It is the
5862
default. "0.9" uses revision bundle format 0.9 and merge directive
5863
format 1. It is compatible with Bazaar 0.12 - 0.18.
5868
help='Do not include a bundle in the merge directive.'),
5869
Option('no-patch', help='Do not include a preview patch in the merge'
5872
help='Remember submit and public branch.'),
5874
help='Branch to generate the submission from, '
5875
'rather than the one containing the working directory.',
5878
Option('output', short_name='o', help='Write directive to this file.',
5881
help='Refuse to bundle revisions if there are uncommitted'
5882
' changes in the working tree, --no-strict disables the check.'),
5884
RegistryOption('format',
5885
help='Use the specified output format.',
5886
lazy_registry=('breezy.send', 'format_registry')),
5888
aliases = ['bundle']
5890
_see_also = ['send', 'merge']
5894
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5895
no_patch=False, revision=None, remember=False, output=None,
5896
format=None, strict=None, **kwargs):
5899
from .send import send
5900
return send(submit_branch, revision, public_branch, remember,
5901
format, no_bundle, no_patch, output,
5902
kwargs.get('from', '.'), None, None, None,
5903
self.outf, strict=strict)
5906
class cmd_tag(Command):
5907
__doc__ = """Create, remove or modify a tag naming a revision.
5909
Tags give human-meaningful names to revisions. Commands that take a -r
5910
(--revision) option can be given -rtag:X, where X is any previously
5913
Tags are stored in the branch. Tags are copied from one branch to another
5914
along when you branch, push, pull or merge.
5916
It is an error to give a tag name that already exists unless you pass
5917
--force, in which case the tag is moved to point to the new revision.
5919
To rename a tag (change the name but keep it on the same revsion), run ``brz
5920
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
5922
If no tag name is specified it will be determined through the
5923
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5924
upstream releases by reading configure.ac. See ``brz help hooks`` for
5928
_see_also = ['commit', 'tags']
5929
takes_args = ['tag_name?']
5932
help='Delete this tag rather than placing it.',
5934
custom_help('directory',
5935
help='Branch in which to place the tag.'),
5937
help='Replace existing tags.',
5942
def run(self, tag_name=None,
5948
branch, relpath = Branch.open_containing(directory)
5949
self.add_cleanup(branch.lock_write().unlock)
5951
if tag_name is None:
5952
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5953
branch.tags.delete_tag(tag_name)
5954
note(gettext('Deleted tag %s.') % tag_name)
5957
if len(revision) != 1:
5958
raise errors.BzrCommandError(gettext(
5959
"Tags can only be placed on a single revision, "
5961
revision_id = revision[0].as_revision_id(branch)
5963
revision_id = branch.last_revision()
5964
if tag_name is None:
5965
tag_name = branch.automatic_tag_name(revision_id)
5966
if tag_name is None:
5967
raise errors.BzrCommandError(gettext(
5968
"Please specify a tag name."))
5970
existing_target = branch.tags.lookup_tag(tag_name)
5971
except errors.NoSuchTag:
5972
existing_target = None
5973
if not force and existing_target not in (None, revision_id):
5974
raise errors.TagAlreadyExists(tag_name)
5975
if existing_target == revision_id:
5976
note(gettext('Tag %s already exists for that revision.') % tag_name)
5978
branch.tags.set_tag(tag_name, revision_id)
5979
if existing_target is None:
5980
note(gettext('Created tag %s.') % tag_name)
5982
note(gettext('Updated tag %s.') % tag_name)
5985
class cmd_tags(Command):
5986
__doc__ = """List tags.
5988
This command shows a table of tag names and the revisions they reference.
5993
custom_help('directory',
5994
help='Branch whose tags should be displayed.'),
5995
RegistryOption('sort',
5996
'Sort tags by different criteria.', title='Sorting',
5997
lazy_registry=('breezy.tag', 'tag_sort_methods')
6004
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6005
from .tag import tag_sort_methods
6006
branch, relpath = Branch.open_containing(directory)
6008
tags = list(viewitems(branch.tags.get_tag_dict()))
6012
self.add_cleanup(branch.lock_read().unlock)
6014
# Restrict to the specified range
6015
tags = self._tags_for_range(branch, revision)
6017
sort = tag_sort_methods.get()
6020
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6021
for index, (tag, revid) in enumerate(tags):
6023
revno = branch.revision_id_to_dotted_revno(revid)
6024
if isinstance(revno, tuple):
6025
revno = '.'.join(map(str, revno))
6026
except (errors.NoSuchRevision,
6027
errors.GhostRevisionsHaveNoRevno,
6028
errors.UnsupportedOperation):
6029
# Bad tag data/merges can lead to tagged revisions
6030
# which are not in this branch. Fail gracefully ...
6032
tags[index] = (tag, revno)
6034
for tag, revspec in tags:
6035
self.outf.write('%-20s %s\n' % (tag, revspec))
6037
def _tags_for_range(self, branch, revision):
6039
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6040
revid1, revid2 = rev1.rev_id, rev2.rev_id
6041
# _get_revision_range will always set revid2 if it's not specified.
6042
# If revid1 is None, it means we want to start from the branch
6043
# origin which is always a valid ancestor. If revid1 == revid2, the
6044
# ancestry check is useless.
6045
if revid1 and revid1 != revid2:
6046
# FIXME: We really want to use the same graph than
6047
# branch.iter_merge_sorted_revisions below, but this is not
6048
# easily available -- vila 2011-09-23
6049
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6050
# We don't want to output anything in this case...
6052
# only show revisions between revid1 and revid2 (inclusive)
6053
tagged_revids = branch.tags.get_reverse_tag_dict()
6055
for r in branch.iter_merge_sorted_revisions(
6056
start_revision_id=revid2, stop_revision_id=revid1,
6057
stop_rule='include'):
6058
revid_tags = tagged_revids.get(r[0], None)
6060
found.extend([(tag, r[0]) for tag in revid_tags])
6064
class cmd_reconfigure(Command):
6065
__doc__ = """Reconfigure the type of a brz directory.
6067
A target configuration must be specified.
6069
For checkouts, the bind-to location will be auto-detected if not specified.
6070
The order of preference is
6071
1. For a lightweight checkout, the current bound location.
6072
2. For branches that used to be checkouts, the previously-bound location.
6073
3. The push location.
6074
4. The parent location.
6075
If none of these is available, --bind-to must be specified.
6078
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6079
takes_args = ['location?']
6081
RegistryOption.from_kwargs(
6084
help='The relation between branch and tree.',
6085
value_switches=True, enum_switch=False,
6086
branch='Reconfigure to be an unbound branch with no working tree.',
6087
tree='Reconfigure to be an unbound branch with a working tree.',
6088
checkout='Reconfigure to be a bound branch with a working tree.',
6089
lightweight_checkout='Reconfigure to be a lightweight'
6090
' checkout (with no local history).',
6092
RegistryOption.from_kwargs(
6094
title='Repository type',
6095
help='Location fo the repository.',
6096
value_switches=True, enum_switch=False,
6097
standalone='Reconfigure to be a standalone branch '
6098
'(i.e. stop using shared repository).',
6099
use_shared='Reconfigure to use a shared repository.',
6101
RegistryOption.from_kwargs(
6103
title='Trees in Repository',
6104
help='Whether new branches in the repository have trees.',
6105
value_switches=True, enum_switch=False,
6106
with_trees='Reconfigure repository to create '
6107
'working trees on branches by default.',
6108
with_no_trees='Reconfigure repository to not create '
6109
'working trees on branches by default.'
6111
Option('bind-to', help='Branch to bind checkout to.', type=str),
6113
help='Perform reconfiguration even if local changes'
6115
Option('stacked-on',
6116
help='Reconfigure a branch to be stacked on another branch.',
6120
help='Reconfigure a branch to be unstacked. This '
6121
'may require copying substantial data into it.',
6125
def run(self, location=None, bind_to=None, force=False,
6126
tree_type=None, repository_type=None, repository_trees=None,
6127
stacked_on=None, unstacked=None):
6128
directory = controldir.ControlDir.open(location)
6129
if stacked_on and unstacked:
6130
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6131
elif stacked_on is not None:
6132
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6134
reconfigure.ReconfigureUnstacked().apply(directory)
6135
# At the moment you can use --stacked-on and a different
6136
# reconfiguration shape at the same time; there seems no good reason
6138
if (tree_type is None and
6139
repository_type is None and
6140
repository_trees is None):
6141
if stacked_on or unstacked:
6144
raise errors.BzrCommandError(gettext('No target configuration '
6146
reconfiguration = None
6147
if tree_type == 'branch':
6148
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6149
elif tree_type == 'tree':
6150
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6151
elif tree_type == 'checkout':
6152
reconfiguration = reconfigure.Reconfigure.to_checkout(
6154
elif tree_type == 'lightweight-checkout':
6155
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6158
reconfiguration.apply(force)
6159
reconfiguration = None
6160
if repository_type == 'use-shared':
6161
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6162
elif repository_type == 'standalone':
6163
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6165
reconfiguration.apply(force)
6166
reconfiguration = None
6167
if repository_trees == 'with-trees':
6168
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6170
elif repository_trees == 'with-no-trees':
6171
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6174
reconfiguration.apply(force)
6175
reconfiguration = None
6178
class cmd_switch(Command):
6179
__doc__ = """Set the branch of a checkout and update.
6181
For lightweight checkouts, this changes the branch being referenced.
6182
For heavyweight checkouts, this checks that there are no local commits
6183
versus the current bound branch, then it makes the local branch a mirror
6184
of the new location and binds to it.
6186
In both cases, the working tree is updated and uncommitted changes
6187
are merged. The user can commit or revert these as they desire.
6189
Pending merges need to be committed or reverted before using switch.
6191
The path to the branch to switch to can be specified relative to the parent
6192
directory of the current branch. For example, if you are currently in a
6193
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6196
Bound branches use the nickname of its master branch unless it is set
6197
locally, in which case switching will update the local nickname to be
6201
takes_args = ['to_location?']
6202
takes_options = ['directory',
6204
help='Switch even if local commits will be lost.'),
6206
Option('create-branch', short_name='b',
6207
help='Create the target branch from this one before'
6208
' switching to it.'),
6210
help='Store and restore uncommitted changes in the'
6214
def run(self, to_location=None, force=False, create_branch=False,
6215
revision=None, directory=u'.', store=False):
6216
from . import switch
6217
tree_location = directory
6218
revision = _get_one_revision('switch', revision)
6219
possible_transports = []
6220
control_dir = controldir.ControlDir.open_containing(tree_location,
6221
possible_transports=possible_transports)[0]
6222
if to_location is None:
6223
if revision is None:
6224
raise errors.BzrCommandError(gettext('You must supply either a'
6225
' revision or a location'))
6226
to_location = tree_location
6228
branch = control_dir.open_branch(
6229
possible_transports=possible_transports)
6230
had_explicit_nick = branch.get_config().has_explicit_nickname()
6231
except errors.NotBranchError:
6233
had_explicit_nick = False
6236
raise errors.BzrCommandError(
6237
gettext('cannot create branch without source branch'))
6238
to_location = lookup_new_sibling_branch(control_dir, to_location,
6239
possible_transports=possible_transports)
6240
to_branch = branch.controldir.sprout(to_location,
6241
possible_transports=possible_transports,
6242
source_branch=branch).open_branch()
6245
to_branch = Branch.open(to_location,
6246
possible_transports=possible_transports)
6247
except errors.NotBranchError:
6248
to_branch = open_sibling_branch(control_dir, to_location,
6249
possible_transports=possible_transports)
6250
if revision is not None:
6251
revision = revision.as_revision_id(to_branch)
6252
switch.switch(control_dir, to_branch, force, revision_id=revision,
6253
store_uncommitted=store)
6254
if had_explicit_nick:
6255
branch = control_dir.open_branch() #get the new branch!
6256
branch.nick = to_branch.nick
6257
note(gettext('Switched to branch: %s'),
6258
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6262
class cmd_view(Command):
6263
__doc__ = """Manage filtered views.
6265
Views provide a mask over the tree so that users can focus on
6266
a subset of a tree when doing their work. After creating a view,
6267
commands that support a list of files - status, diff, commit, etc -
6268
effectively have that list of files implicitly given each time.
6269
An explicit list of files can still be given but those files
6270
must be within the current view.
6272
In most cases, a view has a short life-span: it is created to make
6273
a selected change and is deleted once that change is committed.
6274
At other times, you may wish to create one or more named views
6275
and switch between them.
6277
To disable the current view without deleting it, you can switch to
6278
the pseudo view called ``off``. This can be useful when you need
6279
to see the whole tree for an operation or two (e.g. merge) but
6280
want to switch back to your view after that.
6283
To define the current view::
6285
brz view file1 dir1 ...
6287
To list the current view::
6291
To delete the current view::
6295
To disable the current view without deleting it::
6297
brz view --switch off
6299
To define a named view and switch to it::
6301
brz view --name view-name file1 dir1 ...
6303
To list a named view::
6305
brz view --name view-name
6307
To delete a named view::
6309
brz view --name view-name --delete
6311
To switch to a named view::
6313
brz view --switch view-name
6315
To list all views defined::
6319
To delete all views::
6321
brz view --delete --all
6325
takes_args = ['file*']
6328
help='Apply list or delete action to all views.',
6331
help='Delete the view.',
6334
help='Name of the view to define, list or delete.',
6338
help='Name of the view to switch to.',
6343
def run(self, file_list,
6349
tree, file_list = WorkingTree.open_containing_paths(file_list,
6351
current_view, view_dict = tree.views.get_view_info()
6356
raise errors.BzrCommandError(gettext(
6357
"Both --delete and a file list specified"))
6359
raise errors.BzrCommandError(gettext(
6360
"Both --delete and --switch specified"))
6362
tree.views.set_view_info(None, {})
6363
self.outf.write(gettext("Deleted all views.\n"))
6365
raise errors.BzrCommandError(gettext("No current view to delete"))
6367
tree.views.delete_view(name)
6368
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6371
raise errors.BzrCommandError(gettext(
6372
"Both --switch and a file list specified"))
6374
raise errors.BzrCommandError(gettext(
6375
"Both --switch and --all specified"))
6376
elif switch == 'off':
6377
if current_view is None:
6378
raise errors.BzrCommandError(gettext("No current view to disable"))
6379
tree.views.set_view_info(None, view_dict)
6380
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6382
tree.views.set_view_info(switch, view_dict)
6383
view_str = views.view_display_str(tree.views.lookup_view())
6384
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6387
self.outf.write(gettext('Views defined:\n'))
6388
for view in sorted(view_dict):
6389
if view == current_view:
6393
view_str = views.view_display_str(view_dict[view])
6394
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6396
self.outf.write(gettext('No views defined.\n'))
6399
# No name given and no current view set
6402
raise errors.BzrCommandError(gettext(
6403
"Cannot change the 'off' pseudo view"))
6404
tree.views.set_view(name, sorted(file_list))
6405
view_str = views.view_display_str(tree.views.lookup_view())
6406
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6410
# No name given and no current view set
6411
self.outf.write(gettext('No current view.\n'))
6413
view_str = views.view_display_str(tree.views.lookup_view(name))
6414
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6417
class cmd_hooks(Command):
6418
__doc__ = """Show hooks."""
6423
for hook_key in sorted(hooks.known_hooks.keys()):
6424
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6425
self.outf.write("%s:\n" % type(some_hooks).__name__)
6426
for hook_name, hook_point in sorted(some_hooks.items()):
6427
self.outf.write(" %s:\n" % (hook_name,))
6428
found_hooks = list(hook_point)
6430
for hook in found_hooks:
6431
self.outf.write(" %s\n" %
6432
(some_hooks.get_hook_name(hook),))
6434
self.outf.write(gettext(" <no hooks installed>\n"))
6437
class cmd_remove_branch(Command):
6438
__doc__ = """Remove a branch.
6440
This will remove the branch from the specified location but
6441
will keep any working tree or repository in place.
6445
Remove the branch at repo/trunk::
6447
brz remove-branch repo/trunk
6451
takes_args = ["location?"]
6453
takes_options = ['directory',
6454
Option('force', help='Remove branch even if it is the active branch.')]
6456
aliases = ["rmbranch"]
6458
def run(self, directory=None, location=None, force=False):
6459
br = open_nearby_branch(near=directory, location=location)
6460
if not force and br.controldir.has_workingtree():
6462
active_branch = br.controldir.open_branch(name="")
6463
except errors.NotBranchError:
6464
active_branch = None
6465
if (active_branch is not None and
6466
br.control_url == active_branch.control_url):
6467
raise errors.BzrCommandError(
6468
gettext("Branch is active. Use --force to remove it."))
6469
br.controldir.destroy_branch(br.name)
6472
class cmd_shelve(Command):
6473
__doc__ = """Temporarily set aside some changes from the current tree.
6475
Shelve allows you to temporarily put changes you've made "on the shelf",
6476
ie. out of the way, until a later time when you can bring them back from
6477
the shelf with the 'unshelve' command. The changes are stored alongside
6478
your working tree, and so they aren't propagated along with your branch nor
6479
will they survive its deletion.
6481
If shelve --list is specified, previously-shelved changes are listed.
6483
Shelve is intended to help separate several sets of changes that have
6484
been inappropriately mingled. If you just want to get rid of all changes
6485
and you don't need to restore them later, use revert. If you want to
6486
shelve all text changes at once, use shelve --all.
6488
If filenames are specified, only the changes to those files will be
6489
shelved. Other files will be left untouched.
6491
If a revision is specified, changes since that revision will be shelved.
6493
You can put multiple items on the shelf, and by default, 'unshelve' will
6494
restore the most recently shelved changes.
6496
For complicated changes, it is possible to edit the changes in a separate
6497
editor program to decide what the file remaining in the working copy
6498
should look like. To do this, add the configuration option
6500
change_editor = PROGRAM @new_path @old_path
6502
where @new_path is replaced with the path of the new version of the
6503
file and @old_path is replaced with the path of the old version of
6504
the file. The PROGRAM should save the new file with the desired
6505
contents of the file in the working tree.
6509
takes_args = ['file*']
6514
Option('all', help='Shelve all changes.'),
6516
RegistryOption('writer', 'Method to use for writing diffs.',
6517
breezy.option.diff_writer_registry,
6518
value_switches=True, enum_switch=False),
6520
Option('list', help='List shelved changes.'),
6522
help='Destroy removed changes instead of shelving them.'),
6524
_see_also = ['unshelve', 'configuration']
6526
def run(self, revision=None, all=False, file_list=None, message=None,
6527
writer=None, list=False, destroy=False, directory=None):
6529
return self.run_for_list(directory=directory)
6530
from .shelf_ui import Shelver
6532
writer = breezy.option.diff_writer_registry.get()
6534
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6535
file_list, message, destroy=destroy, directory=directory)
6540
except errors.UserAbort:
6543
def run_for_list(self, directory=None):
6544
if directory is None:
6546
tree = WorkingTree.open_containing(directory)[0]
6547
self.add_cleanup(tree.lock_read().unlock)
6548
manager = tree.get_shelf_manager()
6549
shelves = manager.active_shelves()
6550
if len(shelves) == 0:
6551
note(gettext('No shelved changes.'))
6553
for shelf_id in reversed(shelves):
6554
message = manager.get_metadata(shelf_id).get('message')
6556
message = '<no message>'
6557
self.outf.write('%3d: %s\n' % (shelf_id, message))
6561
class cmd_unshelve(Command):
6562
__doc__ = """Restore shelved changes.
6564
By default, the most recently shelved changes are restored. However if you
6565
specify a shelf by id those changes will be restored instead. This works
6566
best when the changes don't depend on each other.
6569
takes_args = ['shelf_id?']
6572
RegistryOption.from_kwargs(
6573
'action', help="The action to perform.",
6574
enum_switch=False, value_switches=True,
6575
apply="Apply changes and remove from the shelf.",
6576
dry_run="Show changes, but do not apply or remove them.",
6577
preview="Instead of unshelving the changes, show the diff that "
6578
"would result from unshelving.",
6579
delete_only="Delete changes without applying them.",
6580
keep="Apply changes but don't delete them.",
6583
_see_also = ['shelve']
6585
def run(self, shelf_id=None, action='apply', directory=u'.'):
6586
from .shelf_ui import Unshelver
6587
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6591
unshelver.tree.unlock()
6594
class cmd_clean_tree(Command):
6595
__doc__ = """Remove unwanted files from working tree.
6597
By default, only unknown files, not ignored files, are deleted. Versioned
6598
files are never deleted.
6600
Another class is 'detritus', which includes files emitted by brz during
6601
normal operations and selftests. (The value of these files decreases with
6604
If no options are specified, unknown files are deleted. Otherwise, option
6605
flags are respected, and may be combined.
6607
To check what clean-tree will do, use --dry-run.
6609
takes_options = ['directory',
6610
Option('ignored', help='Delete all ignored files.'),
6611
Option('detritus', help='Delete conflict files, merge and revert'
6612
' backups, and failed selftest dirs.'),
6614
help='Delete files unknown to brz (default).'),
6615
Option('dry-run', help='Show files to delete instead of'
6617
Option('force', help='Do not prompt before deleting.')]
6618
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6619
force=False, directory=u'.'):
6620
from .clean_tree import clean_tree
6621
if not (unknown or ignored or detritus):
6625
clean_tree(directory, unknown=unknown, ignored=ignored,
6626
detritus=detritus, dry_run=dry_run, no_prompt=force)
6629
class cmd_reference(Command):
6630
__doc__ = """list, view and set branch locations for nested trees.
6632
If no arguments are provided, lists the branch locations for nested trees.
6633
If one argument is provided, display the branch location for that tree.
6634
If two arguments are provided, set the branch location for that tree.
6639
takes_args = ['path?', 'location?']
6641
def run(self, path=None, location=None):
6643
if path is not None:
6645
tree, branch, relpath =(
6646
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6647
if path is not None:
6650
tree = branch.basis_tree()
6652
info = viewitems(branch._get_all_reference_info())
6653
self._display_reference_info(tree, branch, info)
6655
file_id = tree.path2id(path)
6657
raise errors.NotVersionedError(path)
6658
if location is None:
6659
info = [(file_id, branch.get_reference_info(file_id))]
6660
self._display_reference_info(tree, branch, info)
6662
branch.set_reference_info(file_id, path, location)
6664
def _display_reference_info(self, tree, branch, info):
6666
for file_id, (path, location) in info:
6668
path = tree.id2path(file_id)
6669
except errors.NoSuchId:
6671
ref_list.append((path, location))
6672
for path, location in sorted(ref_list):
6673
self.outf.write('%s %s\n' % (path, location))
6676
class cmd_export_pot(Command):
6677
__doc__ = """Export command helps and error messages in po format."""
6680
takes_options = [Option('plugin',
6681
help='Export help text from named command '\
6682
'(defaults to all built in commands).',
6684
Option('include-duplicates',
6685
help='Output multiple copies of the same msgid '
6686
'string if it appears more than once.'),
6689
def run(self, plugin=None, include_duplicates=False):
6690
from .export_pot import export_pot
6691
export_pot(self.outf, plugin, include_duplicates)
6694
class cmd_import(Command):
6695
__doc__ = """Import sources from a directory, tarball or zip file
6697
This command will import a directory, tarball or zip file into a bzr
6698
tree, replacing any versioned files already present. If a directory is
6699
specified, it is used as the target. If the directory does not exist, or
6700
is not versioned, it is created.
6702
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6704
If the tarball or zip has a single root directory, that directory is
6705
stripped when extracting the tarball. This is not done for directories.
6708
takes_args = ['source', 'tree?']
6710
def run(self, source, tree=None):
6711
from .upstream_import import do_import
6712
do_import(source, tree)
6715
class cmd_fetch_ghosts(Command):
6716
__doc__ = """Attempt to retrieve ghosts from another branch.
6718
If the other branch is not supplied, the last-pulled branch is used.
6722
aliases = ['fetch-missing']
6723
takes_args = ['branch?']
6724
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6726
def run(self, branch=None, no_fix=False):
6727
from .fetch_ghosts import GhostFetcher
6728
installed, failed = GhostFetcher.from_cmdline(branch).run()
6729
if len(installed) > 0:
6730
self.outf.write("Installed:\n")
6731
for rev in installed:
6732
self.outf.write(rev + "\n")
6734
self.outf.write("Still missing:\n")
6736
self.outf.write(rev + "\n")
6737
if not no_fix and len(installed) > 0:
6738
cmd_reconcile().run(".")
6741
def _register_lazy_builtins():
6742
# register lazy builtins from other modules; called at startup and should
6743
# be only called once.
6744
for (name, aliases, module_name) in [
6745
('cmd_bisect', [], 'breezy.bisect'),
6746
('cmd_bundle_info', [], 'breezy.bundle.commands'),
6747
('cmd_config', [], 'breezy.config'),
6748
('cmd_dpush', [], 'breezy.foreign'),
6749
('cmd_version_info', [], 'breezy.cmd_version_info'),
6750
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
6751
('cmd_conflicts', [], 'breezy.conflicts'),
6752
('cmd_ping', [], 'breezy.smart.ping'),
6753
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
6754
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
6755
('cmd_test_script', [], 'breezy.cmd_test_script'),
6757
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
