1
# Copyright (C) 2005-2012 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin brz commands"""
19
from __future__ import absolute_import
27
from . import lazy_import
28
lazy_import.lazy_import(globals(), """
39
config as _mod_config,
50
revision as _mod_revision,
60
from breezy.bzr import (
63
from breezy.branch import Branch
64
from breezy.conflicts import ConflictList
65
from breezy.transport import memory
66
from breezy.revisionspec import RevisionSpec, RevisionInfo
67
from breezy.smtp_connection import SMTPConnection
68
from breezy.workingtree import WorkingTree
69
from breezy.i18n import gettext, ngettext
72
from .commands import (
74
builtin_command_registry,
90
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
93
def _get_branch_location(control_dir, possible_transports=None):
94
"""Return location of branch for this control dir."""
96
target = control_dir.get_branch_reference()
97
except errors.NotBranchError:
98
return control_dir.root_transport.base
99
if target is not None:
101
this_branch = control_dir.open_branch(
102
possible_transports=possible_transports)
103
# This may be a heavy checkout, where we want the master branch
104
master_location = this_branch.get_bound_location()
105
if master_location is not None:
106
return master_location
107
# If not, use a local sibling
108
return this_branch.base
111
def _is_colocated(control_dir, possible_transports=None):
112
"""Check if the branch in control_dir is colocated.
114
:param control_dir: Control directory
115
:return: Tuple with boolean indicating whether the branch is colocated
116
and the full URL to the actual branch
118
# This path is meant to be relative to the existing branch
119
this_url = _get_branch_location(control_dir,
120
possible_transports=possible_transports)
121
# Perhaps the target control dir supports colocated branches?
123
root = controldir.ControlDir.open(this_url,
124
possible_transports=possible_transports)
125
except errors.NotBranchError:
126
return (False, this_url)
129
wt = control_dir.open_workingtree()
130
except (errors.NoWorkingTree, errors.NotLocalUrl):
131
return (False, this_url)
134
root._format.colocated_branches and
135
control_dir.control_url == root.control_url,
139
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
140
"""Lookup the location for a new sibling branch.
142
:param control_dir: Control directory to find sibling branches from
143
:param location: Name of the new branch
144
:return: Full location to the new branch
146
location = directory_service.directories.dereference(location)
147
if '/' not in location and '\\' not in location:
148
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
151
return urlutils.join_segment_parameters(this_url,
152
{"branch": urlutils.escape(location)})
154
return urlutils.join(this_url, '..', urlutils.escape(location))
158
def open_sibling_branch(control_dir, location, possible_transports=None):
159
"""Open a branch, possibly a sibling of another.
161
:param control_dir: Control directory relative to which to lookup the
163
:param location: Location to look up
164
:return: branch to open
167
# Perhaps it's a colocated branch?
168
return control_dir.open_branch(location,
169
possible_transports=possible_transports)
170
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
171
this_url = _get_branch_location(control_dir)
174
this_url, '..', urlutils.escape(location)))
177
def open_nearby_branch(near=None, location=None, possible_transports=None):
178
"""Open a nearby branch.
180
:param near: Optional location of container from which to open branch
181
:param location: Location of the branch
182
:return: Branch instance
188
return Branch.open(location,
189
possible_transports=possible_transports)
190
except errors.NotBranchError:
192
cdir = controldir.ControlDir.open(near,
193
possible_transports=possible_transports)
194
return open_sibling_branch(cdir, location,
195
possible_transports=possible_transports)
198
def iter_sibling_branches(control_dir, possible_transports=None):
199
"""Iterate over the siblings of a branch.
201
:param control_dir: Control directory for which to look up the siblings
202
:return: Iterator over tuples with branch name and branch object
206
reference = control_dir.get_branch_reference()
207
except errors.NotBranchError:
208
# There is no active branch, just return the colocated branches.
209
for name, branch in viewitems(control_dir.get_branches()):
212
if reference is not None:
213
ref_branch = Branch.open(reference,
214
possible_transports=possible_transports)
217
if ref_branch is None or ref_branch.name:
218
if ref_branch is not None:
219
control_dir = ref_branch.controldir
220
for name, branch in viewitems(control_dir.get_branches()):
223
repo = ref_branch.controldir.find_repository()
224
for branch in repo.find_branches(using=True):
225
name = urlutils.relative_url(repo.user_url,
226
branch.user_url).rstrip("/")
230
def tree_files_for_add(file_list):
232
Return a tree and list of absolute paths from a file list.
234
Similar to tree_files, but add handles files a bit differently, so it a
235
custom implementation. In particular, MutableTreeTree.smart_add expects
236
absolute paths, which it immediately converts to relative paths.
238
# FIXME Would be nice to just return the relative paths like
239
# internal_tree_files does, but there are a large number of unit tests
240
# that assume the current interface to mutabletree.smart_add
242
tree, relpath = WorkingTree.open_containing(file_list[0])
243
if tree.supports_views():
244
view_files = tree.views.lookup_view()
246
for filename in file_list:
247
if not osutils.is_inside_any(view_files, filename):
248
raise views.FileOutsideView(filename, view_files)
249
file_list = file_list[:]
250
file_list[0] = tree.abspath(relpath)
252
tree = WorkingTree.open_containing(u'.')[0]
253
if tree.supports_views():
254
view_files = tree.views.lookup_view()
256
file_list = view_files
257
view_str = views.view_display_str(view_files)
258
note(gettext("Ignoring files outside view. View is %s") % view_str)
259
return tree, file_list
262
def _get_one_revision(command_name, revisions):
263
if revisions is None:
265
if len(revisions) != 1:
266
raise errors.BzrCommandError(gettext(
267
'brz %s --revision takes exactly one revision identifier') % (
272
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
273
"""Get a revision tree. Not suitable for commands that change the tree.
275
Specifically, the basis tree in dirstate trees is coupled to the dirstate
276
and doing a commit/uncommit/pull will at best fail due to changing the
279
If tree is passed in, it should be already locked, for lifetime management
280
of the trees internal cached state.
284
if revisions is None:
286
rev_tree = tree.basis_tree()
288
rev_tree = branch.basis_tree()
290
revision = _get_one_revision(command_name, revisions)
291
rev_tree = revision.as_tree(branch)
295
def _get_view_info_for_change_reporter(tree):
296
"""Get the view information from a tree for change reporting."""
299
current_view = tree.views.get_view_info()[0]
300
if current_view is not None:
301
view_info = (current_view, tree.views.lookup_view())
302
except views.ViewsNotSupported:
307
def _open_directory_or_containing_tree_or_branch(filename, directory):
308
"""Open the tree or branch containing the specified file, unless
309
the --directory option is used to specify a different branch."""
310
if directory is not None:
311
return (None, Branch.open(directory), filename)
312
return controldir.ControlDir.open_containing_tree_or_branch(filename)
315
# TODO: Make sure no commands unconditionally use the working directory as a
316
# branch. If a filename argument is used, the first of them should be used to
317
# specify the branch. (Perhaps this can be factored out into some kind of
318
# Argument class, representing a file in a branch, where the first occurrence
321
class cmd_status(Command):
322
__doc__ = """Display status summary.
324
This reports on versioned and unknown files, reporting them
325
grouped by state. Possible states are:
328
Versioned in the working copy but not in the previous revision.
331
Versioned in the previous revision but removed or deleted
335
Path of this file changed from the previous revision;
336
the text may also have changed. This includes files whose
337
parent directory was renamed.
340
Text has changed since the previous revision.
343
File kind has been changed (e.g. from file to directory).
346
Not versioned and not matching an ignore pattern.
348
Additionally for directories, symlinks and files with a changed
349
executable bit, Bazaar indicates their type using a trailing
350
character: '/', '@' or '*' respectively. These decorations can be
351
disabled using the '--no-classify' option.
353
To see ignored files use 'brz ignored'. For details on the
354
changes to file texts, use 'brz diff'.
356
Note that --short or -S gives status flags for each item, similar
357
to Subversion's status command. To get output similar to svn -q,
360
If no arguments are specified, the status of the entire working
361
directory is shown. Otherwise, only the status of the specified
362
files or directories is reported. If a directory is given, status
363
is reported for everything inside that directory.
365
Before merges are committed, the pending merge tip revisions are
366
shown. To see all pending merge revisions, use the -v option.
367
To skip the display of pending merge information altogether, use
368
the no-pending option or specify a file/directory.
370
To compare the working directory to a specific revision, pass a
371
single revision to the revision argument.
373
To see which files have changed in a specific revision, or between
374
two revisions, pass a revision range to the revision argument.
375
This will produce the same results as calling 'brz diff --summarize'.
378
# TODO: --no-recurse/-N, --recurse options
380
takes_args = ['file*']
381
takes_options = ['show-ids', 'revision', 'change', 'verbose',
382
Option('short', help='Use short status indicators.',
384
Option('versioned', help='Only show versioned files.',
386
Option('no-pending', help='Don\'t show pending merges.',
388
Option('no-classify',
389
help='Do not mark object type using indicator.',
392
aliases = ['st', 'stat']
394
encoding_type = 'replace'
395
_see_also = ['diff', 'revert', 'status-flags']
398
def run(self, show_ids=False, file_list=None, revision=None, short=False,
399
versioned=False, no_pending=False, verbose=False,
401
from .status import show_tree_status
403
if revision and len(revision) > 2:
404
raise errors.BzrCommandError(gettext('brz status --revision takes exactly'
405
' one or two revision specifiers'))
407
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
408
# Avoid asking for specific files when that is not needed.
409
if relfile_list == ['']:
411
# Don't disable pending merges for full trees other than '.'.
412
if file_list == ['.']:
414
# A specific path within a tree was given.
415
elif relfile_list is not None:
417
show_tree_status(tree, show_ids=show_ids,
418
specific_files=relfile_list, revision=revision,
419
to_file=self.outf, short=short, versioned=versioned,
420
show_pending=(not no_pending), verbose=verbose,
421
classify=not no_classify)
424
class cmd_cat_revision(Command):
425
__doc__ = """Write out metadata for a revision.
427
The revision to print can either be specified by a specific
428
revision identifier, or you can use --revision.
432
takes_args = ['revision_id?']
433
takes_options = ['directory', 'revision']
434
# cat-revision is more for frontends so should be exact
437
def print_revision(self, revisions, revid):
438
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
439
record = next(stream)
440
if record.storage_kind == 'absent':
441
raise errors.NoSuchRevision(revisions, revid)
442
revtext = record.get_bytes_as('fulltext')
443
self.outf.write(revtext.decode('utf-8'))
446
def run(self, revision_id=None, revision=None, directory=u'.'):
447
if revision_id is not None and revision is not None:
448
raise errors.BzrCommandError(gettext('You can only supply one of'
449
' revision_id or --revision'))
450
if revision_id is None and revision is None:
451
raise errors.BzrCommandError(gettext('You must supply either'
452
' --revision or a revision_id'))
454
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
456
revisions = b.repository.revisions
457
if revisions is None:
458
raise errors.BzrCommandError(gettext('Repository %r does not support '
459
'access to raw revision texts'))
461
b.repository.lock_read()
463
# TODO: jam 20060112 should cat-revision always output utf-8?
464
if revision_id is not None:
465
revision_id = cache_utf8.encode(revision_id)
467
self.print_revision(revisions, revision_id)
468
except errors.NoSuchRevision:
469
msg = gettext("The repository {0} contains no revision {1}.").format(
470
b.repository.base, revision_id)
471
raise errors.BzrCommandError(msg)
472
elif revision is not None:
475
raise errors.BzrCommandError(
476
gettext('You cannot specify a NULL revision.'))
477
rev_id = rev.as_revision_id(b)
478
self.print_revision(revisions, rev_id)
480
b.repository.unlock()
483
class cmd_dump_btree(Command):
484
__doc__ = """Dump the contents of a btree index file to stdout.
486
PATH is a btree index file, it can be any URL. This includes things like
487
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
489
By default, the tuples stored in the index file will be displayed. With
490
--raw, we will uncompress the pages, but otherwise display the raw bytes
494
# TODO: Do we want to dump the internal nodes as well?
495
# TODO: It would be nice to be able to dump the un-parsed information,
496
# rather than only going through iter_all_entries. However, this is
497
# good enough for a start
499
encoding_type = 'exact'
500
takes_args = ['path']
501
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
502
' rather than the parsed tuples.'),
505
def run(self, path, raw=False):
506
dirname, basename = osutils.split(path)
507
t = transport.get_transport(dirname)
509
self._dump_raw_bytes(t, basename)
511
self._dump_entries(t, basename)
513
def _get_index_and_bytes(self, trans, basename):
514
"""Create a BTreeGraphIndex and raw bytes."""
515
bt = btree_index.BTreeGraphIndex(trans, basename, None)
516
bytes = trans.get_bytes(basename)
517
bt._file = BytesIO(bytes)
518
bt._size = len(bytes)
521
def _dump_raw_bytes(self, trans, basename):
524
# We need to parse at least the root node.
525
# This is because the first page of every row starts with an
526
# uncompressed header.
527
bt, bytes = self._get_index_and_bytes(trans, basename)
528
for page_idx, page_start in enumerate(range(0, len(bytes),
529
btree_index._PAGE_SIZE)):
530
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
531
page_bytes = bytes[page_start:page_end]
533
self.outf.write('Root node:\n')
534
header_end, data = bt._parse_header_from_bytes(page_bytes)
535
self.outf.write(page_bytes[:header_end])
537
self.outf.write('\nPage %d\n' % (page_idx,))
538
if len(page_bytes) == 0:
539
self.outf.write('(empty)\n');
541
decomp_bytes = zlib.decompress(page_bytes)
542
self.outf.write(decomp_bytes)
543
self.outf.write('\n')
545
def _dump_entries(self, trans, basename):
547
st = trans.stat(basename)
548
except errors.TransportNotPossible:
549
# We can't stat, so we'll fake it because we have to do the 'get()'
551
bt, _ = self._get_index_and_bytes(trans, basename)
553
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
554
for node in bt.iter_all_entries():
555
# Node is made up of:
556
# (index, key, value, [references])
560
refs_as_tuples = None
562
refs_as_tuples = static_tuple.as_tuples(refs)
563
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
564
self.outf.write('%s\n' % (as_tuple,))
567
class cmd_remove_tree(Command):
568
__doc__ = """Remove the working tree from a given branch/checkout.
570
Since a lightweight checkout is little more than a working tree
571
this will refuse to run against one.
573
To re-create the working tree, use "brz checkout".
575
_see_also = ['checkout', 'working-trees']
576
takes_args = ['location*']
579
help='Remove the working tree even if it has '
580
'uncommitted or shelved changes.'),
583
def run(self, location_list, force=False):
584
if not location_list:
587
for location in location_list:
588
d = controldir.ControlDir.open(location)
591
working = d.open_workingtree()
592
except errors.NoWorkingTree:
593
raise errors.BzrCommandError(gettext("No working tree to remove"))
594
except errors.NotLocalUrl:
595
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
596
" of a remote path"))
598
if (working.has_changes()):
599
raise errors.UncommittedChanges(working)
600
if working.get_shelf_manager().last_shelf() is not None:
601
raise errors.ShelvedChanges(working)
603
if working.user_url != working.branch.user_url:
604
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
605
" from a lightweight checkout"))
607
d.destroy_workingtree()
610
class cmd_repair_workingtree(Command):
611
__doc__ = """Reset the working tree state file.
613
This is not meant to be used normally, but more as a way to recover from
614
filesystem corruption, etc. This rebuilds the working inventory back to a
615
'known good' state. Any new modifications (adding a file, renaming, etc)
616
will be lost, though modified files will still be detected as such.
618
Most users will want something more like "brz revert" or "brz update"
619
unless the state file has become corrupted.
621
By default this attempts to recover the current state by looking at the
622
headers of the state file. If the state file is too corrupted to even do
623
that, you can supply --revision to force the state of the tree.
626
takes_options = ['revision', 'directory',
628
help='Reset the tree even if it doesn\'t appear to be'
633
def run(self, revision=None, directory='.', force=False):
634
tree, _ = WorkingTree.open_containing(directory)
635
self.add_cleanup(tree.lock_tree_write().unlock)
639
except errors.BzrError:
640
pass # There seems to be a real error here, so we'll reset
643
raise errors.BzrCommandError(gettext(
644
'The tree does not appear to be corrupt. You probably'
645
' want "brz revert" instead. Use "--force" if you are'
646
' sure you want to reset the working tree.'))
650
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
652
tree.reset_state(revision_ids)
653
except errors.BzrError as e:
654
if revision_ids is None:
655
extra = (gettext(', the header appears corrupt, try passing -r -1'
656
' to set the state to the last commit'))
659
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
662
class cmd_revno(Command):
663
__doc__ = """Show current revision number.
665
This is equal to the number of revisions on this branch.
669
takes_args = ['location?']
671
Option('tree', help='Show revno of working tree.'),
676
def run(self, tree=False, location=u'.', revision=None):
677
if revision is not None and tree:
678
raise errors.BzrCommandError(gettext("--tree and --revision can "
679
"not be used together"))
683
wt = WorkingTree.open_containing(location)[0]
684
self.add_cleanup(wt.lock_read().unlock)
685
except (errors.NoWorkingTree, errors.NotLocalUrl):
686
raise errors.NoWorkingTree(location)
688
revid = wt.last_revision()
690
b = Branch.open_containing(location)[0]
691
self.add_cleanup(b.lock_read().unlock)
693
if len(revision) != 1:
694
raise errors.BzrCommandError(gettext(
695
"Revision numbers only make sense for single "
696
"revisions, not ranges"))
697
revid = revision[0].as_revision_id(b)
699
revid = b.last_revision()
701
revno_t = b.revision_id_to_dotted_revno(revid)
702
except errors.NoSuchRevision:
704
revno = ".".join(str(n) for n in revno_t)
706
self.outf.write(revno + '\n')
709
class cmd_revision_info(Command):
710
__doc__ = """Show revision number and revision id for a given revision identifier.
713
takes_args = ['revision_info*']
716
custom_help('directory',
717
help='Branch to examine, '
718
'rather than the one containing the working directory.'),
719
Option('tree', help='Show revno of working tree.'),
723
def run(self, revision=None, directory=u'.', tree=False,
724
revision_info_list=[]):
727
wt = WorkingTree.open_containing(directory)[0]
729
self.add_cleanup(wt.lock_read().unlock)
730
except (errors.NoWorkingTree, errors.NotLocalUrl):
732
b = Branch.open_containing(directory)[0]
733
self.add_cleanup(b.lock_read().unlock)
735
if revision is not None:
736
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
737
if revision_info_list is not None:
738
for rev_str in revision_info_list:
739
rev_spec = RevisionSpec.from_string(rev_str)
740
revision_ids.append(rev_spec.as_revision_id(b))
741
# No arguments supplied, default to the last revision
742
if len(revision_ids) == 0:
745
raise errors.NoWorkingTree(directory)
746
revision_ids.append(wt.last_revision())
748
revision_ids.append(b.last_revision())
752
for revision_id in revision_ids:
754
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
755
revno = '.'.join(str(i) for i in dotted_revno)
756
except errors.NoSuchRevision:
758
maxlen = max(maxlen, len(revno))
759
revinfos.append([revno, revision_id])
763
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
766
class cmd_add(Command):
767
__doc__ = """Add specified files or directories.
769
In non-recursive mode, all the named items are added, regardless
770
of whether they were previously ignored. A warning is given if
771
any of the named files are already versioned.
773
In recursive mode (the default), files are treated the same way
774
but the behaviour for directories is different. Directories that
775
are already versioned do not give a warning. All directories,
776
whether already versioned or not, are searched for files or
777
subdirectories that are neither versioned or ignored, and these
778
are added. This search proceeds recursively into versioned
779
directories. If no names are given '.' is assumed.
781
A warning will be printed when nested trees are encountered,
782
unless they are explicitly ignored.
784
Therefore simply saying 'brz add' will version all files that
785
are currently unknown.
787
Adding a file whose parent directory is not versioned will
788
implicitly add the parent, and so on up to the root. This means
789
you should never need to explicitly add a directory, they'll just
790
get added when you add a file in the directory.
792
--dry-run will show which files would be added, but not actually
795
--file-ids-from will try to use the file ids from the supplied path.
796
It looks up ids trying to find a matching parent directory with the
797
same filename, and then by pure path. This option is rarely needed
798
but can be useful when adding the same logical file into two
799
branches that will be merged later (without showing the two different
800
adds as a conflict). It is also useful when merging another project
801
into a subdirectory of this one.
803
Any files matching patterns in the ignore list will not be added
804
unless they are explicitly mentioned.
806
In recursive mode, files larger than the configuration option
807
add.maximum_file_size will be skipped. Named items are never skipped due
810
takes_args = ['file*']
813
help="Don't recursively add the contents of directories.",
816
help="Show what would be done, but don't actually do anything."),
818
Option('file-ids-from',
820
help='Lookup file ids from this tree.'),
822
encoding_type = 'replace'
823
_see_also = ['remove', 'ignore']
825
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
830
if file_ids_from is not None:
832
base_tree, base_path = WorkingTree.open_containing(
834
except errors.NoWorkingTree:
835
base_branch, base_path = Branch.open_containing(
837
base_tree = base_branch.basis_tree()
839
action = breezy.add.AddFromBaseAction(base_tree, base_path,
840
to_file=self.outf, should_print=(not is_quiet()))
842
action = breezy.add.AddWithSkipLargeAction(to_file=self.outf,
843
should_print=(not is_quiet()))
846
self.add_cleanup(base_tree.lock_read().unlock)
847
tree, file_list = tree_files_for_add(file_list)
848
added, ignored = tree.smart_add(file_list, not
849
no_recurse, action=action, save=not dry_run)
853
for glob in sorted(ignored):
854
for path in ignored[glob]:
856
gettext("ignored {0} matching \"{1}\"\n").format(
860
class cmd_mkdir(Command):
861
__doc__ = """Create a new versioned directory.
863
This is equivalent to creating the directory and then adding it.
866
takes_args = ['dir+']
870
help='No error if existing, make parent directories as needed.',
874
encoding_type = 'replace'
877
def add_file_with_parents(cls, wt, relpath):
878
if wt.path2id(relpath) is not None:
880
cls.add_file_with_parents(wt, osutils.dirname(relpath))
884
def add_file_single(cls, wt, relpath):
887
def run(self, dir_list, parents=False):
889
add_file = self.add_file_with_parents
891
add_file = self.add_file_single
893
wt, relpath = WorkingTree.open_containing(dir)
898
if e.errno != errno.EEXIST:
902
add_file(wt, relpath)
904
self.outf.write(gettext('added %s\n') % dir)
907
class cmd_relpath(Command):
908
__doc__ = """Show path of a file relative to root"""
910
takes_args = ['filename']
914
def run(self, filename):
915
# TODO: jam 20050106 Can relpath return a munged path if
916
# sys.stdout encoding cannot represent it?
917
tree, relpath = WorkingTree.open_containing(filename)
918
self.outf.write(relpath)
919
self.outf.write('\n')
922
class cmd_inventory(Command):
923
__doc__ = """Show inventory of the current working copy or a revision.
925
It is possible to limit the output to a particular entry
926
type using the --kind option. For example: --kind file.
928
It is also possible to restrict the list of files to a specific
929
set. For example: brz inventory --show-ids this/file
938
help='List entries of a particular kind: file, directory, symlink.',
941
takes_args = ['file*']
944
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
945
if kind and kind not in ['file', 'directory', 'symlink']:
946
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
948
revision = _get_one_revision('inventory', revision)
949
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
950
self.add_cleanup(work_tree.lock_read().unlock)
951
if revision is not None:
952
tree = revision.as_tree(work_tree.branch)
954
extra_trees = [work_tree]
955
self.add_cleanup(tree.lock_read().unlock)
960
self.add_cleanup(tree.lock_read().unlock)
961
if file_list is not None:
962
file_ids = tree.paths2ids(file_list, trees=extra_trees,
963
require_versioned=True)
964
# find_ids_across_trees may include some paths that don't
966
entries = tree.iter_entries_by_dir(specific_file_ids=file_ids)
968
entries = tree.iter_entries_by_dir()
970
for path, entry in sorted(entries):
971
if kind and kind != entry.kind:
976
self.outf.write('%-50s %s\n' % (path, entry.file_id))
978
self.outf.write(path)
979
self.outf.write('\n')
982
class cmd_mv(Command):
983
__doc__ = """Move or rename a file.
986
brz mv OLDNAME NEWNAME
988
brz mv SOURCE... DESTINATION
990
If the last argument is a versioned directory, all the other names
991
are moved into it. Otherwise, there must be exactly two arguments
992
and the file is changed to a new name.
994
If OLDNAME does not exist on the filesystem but is versioned and
995
NEWNAME does exist on the filesystem but is not versioned, mv
996
assumes that the file has been manually moved and only updates
997
its internal inventory to reflect that change.
998
The same is valid when moving many SOURCE files to a DESTINATION.
1000
Files cannot be moved between branches.
1003
takes_args = ['names*']
1004
takes_options = [Option("after", help="Move only the brz identifier"
1005
" of the file, because the file has already been moved."),
1006
Option('auto', help='Automatically guess renames.'),
1007
Option('dry-run', help='Avoid making changes when guessing renames.'),
1009
aliases = ['move', 'rename']
1010
encoding_type = 'replace'
1012
def run(self, names_list, after=False, auto=False, dry_run=False):
1014
return self.run_auto(names_list, after, dry_run)
1016
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1017
if names_list is None:
1019
if len(names_list) < 2:
1020
raise errors.BzrCommandError(gettext("missing file argument"))
1021
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1022
for file_name in rel_names[0:-1]:
1024
raise errors.BzrCommandError(gettext("can not move root of branch"))
1025
self.add_cleanup(tree.lock_tree_write().unlock)
1026
self._run(tree, names_list, rel_names, after)
1028
def run_auto(self, names_list, after, dry_run):
1029
if names_list is not None and len(names_list) > 1:
1030
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1033
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1035
work_tree, file_list = WorkingTree.open_containing_paths(
1036
names_list, default_directory='.')
1037
self.add_cleanup(work_tree.lock_tree_write().unlock)
1038
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1040
def _run(self, tree, names_list, rel_names, after):
1041
into_existing = osutils.isdir(names_list[-1])
1042
if into_existing and len(names_list) == 2:
1044
# a. case-insensitive filesystem and change case of dir
1045
# b. move directory after the fact (if the source used to be
1046
# a directory, but now doesn't exist in the working tree
1047
# and the target is an existing directory, just rename it)
1048
if (not tree.case_sensitive
1049
and rel_names[0].lower() == rel_names[1].lower()):
1050
into_existing = False
1052
# 'fix' the case of a potential 'from'
1053
from_id = tree.path2id(
1054
tree.get_canonical_inventory_path(rel_names[0]))
1055
if (not osutils.lexists(names_list[0]) and
1056
from_id and tree.stored_kind(from_id) == "directory"):
1057
into_existing = False
1060
# move into existing directory
1061
# All entries reference existing inventory items, so fix them up
1062
# for cicp file-systems.
1063
rel_names = tree.get_canonical_inventory_paths(rel_names)
1064
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1066
self.outf.write("%s => %s\n" % (src, dest))
1068
if len(names_list) != 2:
1069
raise errors.BzrCommandError(gettext('to mv multiple files the'
1070
' destination must be a versioned'
1073
# for cicp file-systems: the src references an existing inventory
1075
src = tree.get_canonical_inventory_path(rel_names[0])
1076
# Find the canonical version of the destination: In all cases, the
1077
# parent of the target must be in the inventory, so we fetch the
1078
# canonical version from there (we do not always *use* the
1079
# canonicalized tail portion - we may be attempting to rename the
1081
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1082
dest_parent = osutils.dirname(canon_dest)
1083
spec_tail = osutils.basename(rel_names[1])
1084
# For a CICP file-system, we need to avoid creating 2 inventory
1085
# entries that differ only by case. So regardless of the case
1086
# we *want* to use (ie, specified by the user or the file-system),
1087
# we must always choose to use the case of any existing inventory
1088
# items. The only exception to this is when we are attempting a
1089
# case-only rename (ie, canonical versions of src and dest are
1091
dest_id = tree.path2id(canon_dest)
1092
if dest_id is None or tree.path2id(src) == dest_id:
1093
# No existing item we care about, so work out what case we
1094
# are actually going to use.
1096
# If 'after' is specified, the tail must refer to a file on disk.
1098
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1100
# pathjoin with an empty tail adds a slash, which breaks
1102
dest_parent_fq = tree.basedir
1104
dest_tail = osutils.canonical_relpath(
1106
osutils.pathjoin(dest_parent_fq, spec_tail))
1108
# not 'after', so case as specified is used
1109
dest_tail = spec_tail
1111
# Use the existing item so 'mv' fails with AlreadyVersioned.
1112
dest_tail = os.path.basename(canon_dest)
1113
dest = osutils.pathjoin(dest_parent, dest_tail)
1114
mutter("attempting to move %s => %s", src, dest)
1115
tree.rename_one(src, dest, after=after)
1117
self.outf.write("%s => %s\n" % (src, dest))
1120
class cmd_pull(Command):
1121
__doc__ = """Turn this branch into a mirror of another branch.
1123
By default, this command only works on branches that have not diverged.
1124
Branches are considered diverged if the destination branch's most recent
1125
commit is one that has not been merged (directly or indirectly) into the
1128
If branches have diverged, you can use 'brz merge' to integrate the changes
1129
from one into the other. Once one branch has merged, the other should
1130
be able to pull it again.
1132
If you want to replace your local changes and just want your branch to
1133
match the remote one, use pull --overwrite. This will work even if the two
1134
branches have diverged.
1136
If there is no default location set, the first pull will set it (use
1137
--no-remember to avoid setting it). After that, you can omit the
1138
location to use the default. To change the default, use --remember. The
1139
value will only be saved if the remote location can be accessed.
1141
The --verbose option will display the revisions pulled using the log_format
1142
configuration option. You can use a different format by overriding it with
1143
-Olog_format=<other_format>.
1145
Note: The location can be specified either in the form of a branch,
1146
or in the form of a path to a file containing a merge directive generated
1150
_see_also = ['push', 'update', 'status-flags', 'send']
1151
takes_options = ['remember', 'overwrite', 'revision',
1152
custom_help('verbose',
1153
help='Show logs of pulled revisions.'),
1154
custom_help('directory',
1155
help='Branch to pull into, '
1156
'rather than the one containing the working directory.'),
1158
help="Perform a local pull in a bound "
1159
"branch. Local pulls are not applied to "
1160
"the master branch."
1163
help="Show base revision text in conflicts."),
1164
Option('overwrite-tags',
1165
help="Overwrite tags only."),
1167
takes_args = ['location?']
1168
encoding_type = 'replace'
1170
def run(self, location=None, remember=None, overwrite=False,
1171
revision=None, verbose=False,
1172
directory=None, local=False,
1173
show_base=False, overwrite_tags=False):
1176
overwrite = ["history", "tags"]
1177
elif overwrite_tags:
1178
overwrite = ["tags"]
1181
# FIXME: too much stuff is in the command class
1184
if directory is None:
1187
tree_to = WorkingTree.open_containing(directory)[0]
1188
branch_to = tree_to.branch
1189
self.add_cleanup(tree_to.lock_write().unlock)
1190
except errors.NoWorkingTree:
1192
branch_to = Branch.open_containing(directory)[0]
1193
self.add_cleanup(branch_to.lock_write().unlock)
1195
warning(gettext("No working tree, ignoring --show-base"))
1197
if local and not branch_to.get_bound_location():
1198
raise errors.LocalRequiresBoundBranch()
1200
possible_transports = []
1201
if location is not None:
1203
mergeable = bundle.read_mergeable_from_url(location,
1204
possible_transports=possible_transports)
1205
except errors.NotABundle:
1208
stored_loc = branch_to.get_parent()
1209
if location is None:
1210
if stored_loc is None:
1211
raise errors.BzrCommandError(gettext("No pull location known or"
1214
display_url = urlutils.unescape_for_display(stored_loc,
1217
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1218
location = stored_loc
1220
revision = _get_one_revision('pull', revision)
1221
if mergeable is not None:
1222
if revision is not None:
1223
raise errors.BzrCommandError(gettext(
1224
'Cannot use -r with merge directives or bundles'))
1225
mergeable.install_revisions(branch_to.repository)
1226
base_revision_id, revision_id, verified = \
1227
mergeable.get_merge_request(branch_to.repository)
1228
branch_from = branch_to
1230
branch_from = Branch.open(location,
1231
possible_transports=possible_transports)
1232
self.add_cleanup(branch_from.lock_read().unlock)
1233
# Remembers if asked explicitly or no previous location is set
1235
or (remember is None and branch_to.get_parent() is None)):
1236
# FIXME: This shouldn't be done before the pull
1237
# succeeds... -- vila 2012-01-02
1238
branch_to.set_parent(branch_from.base)
1240
if revision is not None:
1241
revision_id = revision.as_revision_id(branch_from)
1243
if tree_to is not None:
1244
view_info = _get_view_info_for_change_reporter(tree_to)
1245
change_reporter = delta._ChangeReporter(
1246
unversioned_filter=tree_to.is_ignored,
1247
view_info=view_info)
1248
result = tree_to.pull(
1249
branch_from, overwrite, revision_id, change_reporter,
1250
local=local, show_base=show_base)
1252
result = branch_to.pull(
1253
branch_from, overwrite, revision_id, local=local)
1255
result.report(self.outf)
1256
if verbose and result.old_revid != result.new_revid:
1257
log.show_branch_change(
1258
branch_to, self.outf, result.old_revno,
1260
if getattr(result, 'tag_conflicts', None):
1266
class cmd_push(Command):
1267
__doc__ = """Update a mirror of this branch.
1269
The target branch will not have its working tree populated because this
1270
is both expensive, and is not supported on remote file systems.
1272
Some smart servers or protocols *may* put the working tree in place in
1275
This command only works on branches that have not diverged. Branches are
1276
considered diverged if the destination branch's most recent commit is one
1277
that has not been merged (directly or indirectly) by the source branch.
1279
If branches have diverged, you can use 'brz push --overwrite' to replace
1280
the other branch completely, discarding its unmerged changes.
1282
If you want to ensure you have the different changes in the other branch,
1283
do a merge (see brz help merge) from the other branch, and commit that.
1284
After that you will be able to do a push without '--overwrite'.
1286
If there is no default push location set, the first push will set it (use
1287
--no-remember to avoid setting it). After that, you can omit the
1288
location to use the default. To change the default, use --remember. The
1289
value will only be saved if the remote location can be accessed.
1291
The --verbose option will display the revisions pushed using the log_format
1292
configuration option. You can use a different format by overriding it with
1293
-Olog_format=<other_format>.
1296
_see_also = ['pull', 'update', 'working-trees']
1297
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1298
Option('create-prefix',
1299
help='Create the path leading up to the branch '
1300
'if it does not already exist.'),
1301
custom_help('directory',
1302
help='Branch to push from, '
1303
'rather than the one containing the working directory.'),
1304
Option('use-existing-dir',
1305
help='By default push will fail if the target'
1306
' directory exists, but does not already'
1307
' have a control directory. This flag will'
1308
' allow push to proceed.'),
1310
help='Create a stacked branch that references the public location '
1311
'of the parent branch.'),
1312
Option('stacked-on',
1313
help='Create a stacked branch that refers to another branch '
1314
'for the commit history. Only the work not present in the '
1315
'referenced branch is included in the branch created.',
1318
help='Refuse to push if there are uncommitted changes in'
1319
' the working tree, --no-strict disables the check.'),
1321
help="Don't populate the working tree, even for protocols"
1322
" that support it."),
1323
Option('overwrite-tags',
1324
help="Overwrite tags only."),
1326
takes_args = ['location?']
1327
encoding_type = 'replace'
1329
def run(self, location=None, remember=None, overwrite=False,
1330
create_prefix=False, verbose=False, revision=None,
1331
use_existing_dir=False, directory=None, stacked_on=None,
1332
stacked=False, strict=None, no_tree=False,
1333
overwrite_tags=False):
1334
from .push import _show_push_branch
1337
overwrite = ["history", "tags"]
1338
elif overwrite_tags:
1339
overwrite = ["tags"]
1343
if directory is None:
1345
# Get the source branch
1347
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1348
# Get the tip's revision_id
1349
revision = _get_one_revision('push', revision)
1350
if revision is not None:
1351
revision_id = revision.in_history(br_from).rev_id
1354
if tree is not None and revision_id is None:
1355
tree.check_changed_or_out_of_date(
1356
strict, 'push_strict',
1357
more_error='Use --no-strict to force the push.',
1358
more_warning='Uncommitted changes will not be pushed.')
1359
# Get the stacked_on branch, if any
1360
if stacked_on is not None:
1361
stacked_on = urlutils.normalize_url(stacked_on)
1363
parent_url = br_from.get_parent()
1365
parent = Branch.open(parent_url)
1366
stacked_on = parent.get_public_branch()
1368
# I considered excluding non-http url's here, thus forcing
1369
# 'public' branches only, but that only works for some
1370
# users, so it's best to just depend on the user spotting an
1371
# error by the feedback given to them. RBC 20080227.
1372
stacked_on = parent_url
1374
raise errors.BzrCommandError(gettext(
1375
"Could not determine branch to refer to."))
1377
# Get the destination location
1378
if location is None:
1379
stored_loc = br_from.get_push_location()
1380
if stored_loc is None:
1381
parent_loc = br_from.get_parent()
1383
raise errors.BzrCommandError(gettext(
1384
"No push location known or specified. To push to the "
1385
"parent branch (at %s), use 'brz push :parent'." %
1386
urlutils.unescape_for_display(parent_loc,
1387
self.outf.encoding)))
1389
raise errors.BzrCommandError(gettext(
1390
"No push location known or specified."))
1392
display_url = urlutils.unescape_for_display(stored_loc,
1394
note(gettext("Using saved push location: %s") % display_url)
1395
location = stored_loc
1397
_show_push_branch(br_from, revision_id, location, self.outf,
1398
verbose=verbose, overwrite=overwrite, remember=remember,
1399
stacked_on=stacked_on, create_prefix=create_prefix,
1400
use_existing_dir=use_existing_dir, no_tree=no_tree)
1403
class cmd_branch(Command):
1404
__doc__ = """Create a new branch that is a copy of an existing branch.
1406
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1407
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1408
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1409
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1410
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1413
To retrieve the branch as of a particular revision, supply the --revision
1414
parameter, as in "branch foo/bar -r 5".
1417
_see_also = ['checkout']
1418
takes_args = ['from_location', 'to_location?']
1419
takes_options = ['revision',
1420
Option('hardlink', help='Hard-link working tree files where possible.'),
1421
Option('files-from', type=str,
1422
help="Get file contents from this tree."),
1424
help="Create a branch without a working-tree."),
1426
help="Switch the checkout in the current directory "
1427
"to the new branch."),
1429
help='Create a stacked branch referring to the source branch. '
1430
'The new branch will depend on the availability of the source '
1431
'branch for all operations.'),
1432
Option('standalone',
1433
help='Do not use a shared repository, even if available.'),
1434
Option('use-existing-dir',
1435
help='By default branch will fail if the target'
1436
' directory exists, but does not already'
1437
' have a control directory. This flag will'
1438
' allow branch to proceed.'),
1440
help="Bind new branch to from location."),
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
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1450
if not (hardlink or files_from):
1451
# accelerator_tree is usually slower because you have to read N
1452
# files (no readahead, lots of seeks, etc), but allow the user to
1453
# explicitly request it
1454
accelerator_tree = None
1455
if files_from is not None and files_from != from_location:
1456
accelerator_tree = WorkingTree.open(files_from)
1457
revision = _get_one_revision('branch', revision)
1458
self.add_cleanup(br_from.lock_read().unlock)
1459
if revision is not None:
1460
revision_id = revision.as_revision_id(br_from)
1462
# FIXME - wt.last_revision, fallback to branch, fall back to
1463
# None or perhaps NULL_REVISION to mean copy nothing
1465
revision_id = br_from.last_revision()
1466
if to_location is None:
1467
to_location = getattr(br_from, "name", None)
1469
to_location = urlutils.derive_to_location(from_location)
1470
to_transport = transport.get_transport(to_location)
1472
to_transport.mkdir('.')
1473
except errors.FileExists:
1475
to_dir = controldir.ControlDir.open_from_transport(
1477
except errors.NotBranchError:
1478
if not use_existing_dir:
1479
raise errors.BzrCommandError(gettext('Target directory "%s" '
1480
'already exists.') % to_location)
1485
to_dir.open_branch()
1486
except errors.NotBranchError:
1489
raise errors.AlreadyBranchError(to_location)
1490
except errors.NoSuchFile:
1491
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1497
# preserve whatever source format we have.
1498
to_dir = br_from.controldir.sprout(
1499
to_transport.base, revision_id,
1500
possible_transports=[to_transport],
1501
accelerator_tree=accelerator_tree, hardlink=hardlink,
1502
stacked=stacked, force_new_repo=standalone,
1503
create_tree_if_local=not no_tree, source_branch=br_from)
1504
branch = to_dir.open_branch(
1505
possible_transports=[
1506
br_from.controldir.root_transport, to_transport])
1507
except errors.NoSuchRevision:
1508
to_transport.delete_tree('.')
1509
msg = gettext("The branch {0} has no revision {1}.").format(
1510
from_location, revision)
1511
raise errors.BzrCommandError(msg)
1514
to_repo = to_dir.open_repository()
1515
except errors.NoRepositoryPresent:
1516
to_repo = to_dir.create_repository()
1517
to_repo.fetch(br_from.repository, revision_id=revision_id)
1518
branch = br_from.sprout(to_dir, revision_id=revision_id)
1519
br_from.tags.merge_to(branch.tags)
1521
# If the source branch is stacked, the new branch may
1522
# be stacked whether we asked for that explicitly or not.
1523
# We therefore need a try/except here and not just 'if stacked:'
1525
note(gettext('Created new stacked branch referring to %s.') %
1526
branch.get_stacked_on_url())
1527
except (errors.NotStacked, errors.UnstackableBranchFormat,
1528
errors.UnstackableRepositoryFormat) as e:
1529
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1531
# Bind to the parent
1532
parent_branch = Branch.open(from_location)
1533
branch.bind(parent_branch)
1534
note(gettext('New branch bound to %s') % from_location)
1536
# Switch to the new branch
1537
wt, _ = WorkingTree.open_containing('.')
1538
_mod_switch.switch(wt.controldir, branch)
1539
note(gettext('Switched to branch: %s'),
1540
urlutils.unescape_for_display(branch.base, 'utf-8'))
1543
class cmd_branches(Command):
1544
__doc__ = """List the branches available at the current location.
1546
This command will print the names of all the branches at the current
1550
takes_args = ['location?']
1552
Option('recursive', short_name='R',
1553
help='Recursively scan for branches rather than '
1554
'just looking in the specified location.')]
1556
def run(self, location=".", recursive=False):
1558
t = transport.get_transport(location)
1559
if not t.listable():
1560
raise errors.BzrCommandError(
1561
"Can't scan this type of location.")
1562
for b in controldir.ControlDir.find_branches(t):
1563
self.outf.write("%s\n" % urlutils.unescape_for_display(
1564
urlutils.relative_url(t.base, b.base),
1565
self.outf.encoding).rstrip("/"))
1567
dir = controldir.ControlDir.open_containing(location)[0]
1569
active_branch = dir.open_branch(name="")
1570
except errors.NotBranchError:
1571
active_branch = None
1573
for name, branch in iter_sibling_branches(dir):
1576
active = (active_branch is not None and
1577
active_branch.base == branch.base)
1578
names[name] = active
1579
# Only mention the current branch explicitly if it's not
1580
# one of the colocated branches
1581
if not any(viewvalues(names)) and active_branch is not None:
1582
self.outf.write("* %s\n" % gettext("(default)"))
1583
for name in sorted(names):
1584
active = names[name]
1589
self.outf.write("%s %s\n" % (
1590
prefix, name.encode(self.outf.encoding)))
1593
class cmd_checkout(Command):
1594
__doc__ = """Create a new checkout of an existing branch.
1596
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1597
the branch found in '.'. This is useful if you have removed the working tree
1598
or if it was never created - i.e. if you pushed the branch to its current
1599
location using SFTP.
1601
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1602
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1603
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1604
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1605
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1608
To retrieve the branch as of a particular revision, supply the --revision
1609
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1610
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1614
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1615
takes_args = ['branch_location?', 'to_location?']
1616
takes_options = ['revision',
1617
Option('lightweight',
1618
help="Perform a lightweight checkout. Lightweight "
1619
"checkouts depend on access to the branch for "
1620
"every operation. Normal checkouts can perform "
1621
"common operations like diff and status without "
1622
"such access, and also support local commits."
1624
Option('files-from', type=str,
1625
help="Get file contents from this tree."),
1627
help='Hard-link working tree files where possible.'
1632
def run(self, branch_location=None, to_location=None, revision=None,
1633
lightweight=False, files_from=None, hardlink=False):
1634
if branch_location is None:
1635
branch_location = osutils.getcwd()
1636
to_location = branch_location
1637
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1639
if not (hardlink or files_from):
1640
# accelerator_tree is usually slower because you have to read N
1641
# files (no readahead, lots of seeks, etc), but allow the user to
1642
# explicitly request it
1643
accelerator_tree = None
1644
revision = _get_one_revision('checkout', revision)
1645
if files_from is not None and files_from != branch_location:
1646
accelerator_tree = WorkingTree.open(files_from)
1647
if revision is not None:
1648
revision_id = revision.as_revision_id(source)
1651
if to_location is None:
1652
to_location = urlutils.derive_to_location(branch_location)
1653
# if the source and to_location are the same,
1654
# and there is no working tree,
1655
# then reconstitute a branch
1656
if (osutils.abspath(to_location) ==
1657
osutils.abspath(branch_location)):
1659
source.controldir.open_workingtree()
1660
except errors.NoWorkingTree:
1661
source.controldir.create_workingtree(revision_id)
1663
source.create_checkout(to_location, revision_id, lightweight,
1664
accelerator_tree, hardlink)
1667
class cmd_renames(Command):
1668
__doc__ = """Show list of renamed files.
1670
# TODO: Option to show renames between two historical versions.
1672
# TODO: Only show renames under dir, rather than in the whole branch.
1673
_see_also = ['status']
1674
takes_args = ['dir?']
1677
def run(self, dir=u'.'):
1678
tree = WorkingTree.open_containing(dir)[0]
1679
self.add_cleanup(tree.lock_read().unlock)
1680
old_tree = tree.basis_tree()
1681
self.add_cleanup(old_tree.lock_read().unlock)
1683
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1684
for f, paths, c, v, p, n, k, e in iterator:
1685
if paths[0] == paths[1]:
1689
renames.append(paths)
1691
for old_name, new_name in renames:
1692
self.outf.write("%s => %s\n" % (old_name, new_name))
1695
class cmd_update(Command):
1696
__doc__ = """Update a working tree to a new revision.
1698
This will perform a merge of the destination revision (the tip of the
1699
branch, or the specified revision) into the working tree, and then make
1700
that revision the basis revision for the working tree.
1702
You can use this to visit an older revision, or to update a working tree
1703
that is out of date from its branch.
1705
If there are any uncommitted changes in the tree, they will be carried
1706
across and remain as uncommitted changes after the update. To discard
1707
these changes, use 'brz revert'. The uncommitted changes may conflict
1708
with the changes brought in by the change in basis revision.
1710
If the tree's branch is bound to a master branch, brz will also update
1711
the branch from the master.
1713
You cannot update just a single file or directory, because each Bazaar
1714
working tree has just a single basis revision. If you want to restore a
1715
file that has been removed locally, use 'brz revert' instead of 'brz
1716
update'. If you want to restore a file to its state in a previous
1717
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1718
out the old content of that file to a new location.
1720
The 'dir' argument, if given, must be the location of the root of a
1721
working tree to update. By default, the working tree that contains the
1722
current working directory is used.
1725
_see_also = ['pull', 'working-trees', 'status-flags']
1726
takes_args = ['dir?']
1727
takes_options = ['revision',
1729
help="Show base revision text in conflicts."),
1733
def run(self, dir=None, revision=None, show_base=None):
1734
if revision is not None and len(revision) != 1:
1735
raise errors.brzCommandError(gettext(
1736
"brz update --revision takes exactly one revision"))
1738
tree = WorkingTree.open_containing('.')[0]
1740
tree, relpath = WorkingTree.open_containing(dir)
1743
raise errors.BzrCommandError(gettext(
1744
"brz update can only update a whole tree, "
1745
"not a file or subdirectory"))
1746
branch = tree.branch
1747
possible_transports = []
1748
master = branch.get_master_branch(
1749
possible_transports=possible_transports)
1750
if master is not None:
1751
branch_location = master.base
1754
branch_location = tree.branch.base
1755
tree.lock_tree_write()
1756
self.add_cleanup(tree.unlock)
1757
# get rid of the final '/' and be ready for display
1758
branch_location = urlutils.unescape_for_display(
1759
branch_location.rstrip('/'),
1761
existing_pending_merges = tree.get_parent_ids()[1:]
1765
# may need to fetch data into a heavyweight checkout
1766
# XXX: this may take some time, maybe we should display a
1768
old_tip = branch.update(possible_transports)
1769
if revision is not None:
1770
revision_id = revision[0].as_revision_id(branch)
1772
revision_id = branch.last_revision()
1773
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1774
revno = branch.revision_id_to_dotted_revno(revision_id)
1775
note(gettext("Tree is up to date at revision {0} of branch {1}"
1776
).format('.'.join(map(str, revno)), branch_location))
1778
view_info = _get_view_info_for_change_reporter(tree)
1779
change_reporter = delta._ChangeReporter(
1780
unversioned_filter=tree.is_ignored,
1781
view_info=view_info)
1783
conflicts = tree.update(
1785
possible_transports=possible_transports,
1786
revision=revision_id,
1788
show_base=show_base)
1789
except errors.NoSuchRevision as e:
1790
raise errors.BzrCommandError(gettext(
1791
"branch has no revision %s\n"
1792
"brz update --revision only works"
1793
" for a revision in the branch history")
1795
revno = tree.branch.revision_id_to_dotted_revno(
1796
_mod_revision.ensure_null(tree.last_revision()))
1797
note(gettext('Updated to revision {0} of branch {1}').format(
1798
'.'.join(map(str, revno)), branch_location))
1799
parent_ids = tree.get_parent_ids()
1800
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1801
note(gettext('Your local commits will now show as pending merges with '
1802
"'brz status', and can be committed with 'brz commit'."))
1809
class cmd_info(Command):
1810
__doc__ = """Show information about a working tree, branch or repository.
1812
This command will show all known locations and formats associated to the
1813
tree, branch or repository.
1815
In verbose mode, statistical information is included with each report.
1816
To see extended statistic information, use a verbosity level of 2 or
1817
higher by specifying the verbose option multiple times, e.g. -vv.
1819
Branches and working trees will also report any missing revisions.
1823
Display information on the format and related locations:
1827
Display the above together with extended format information and
1828
basic statistics (like the number of files in the working tree and
1829
number of revisions in the branch and repository):
1833
Display the above together with number of committers to the branch:
1837
_see_also = ['revno', 'working-trees', 'repositories']
1838
takes_args = ['location?']
1839
takes_options = ['verbose']
1840
encoding_type = 'replace'
1843
def run(self, location=None, verbose=False):
1845
noise_level = get_verbosity_level()
1848
from .info import show_bzrdir_info
1849
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1850
verbose=noise_level, outfile=self.outf)
1853
class cmd_remove(Command):
1854
__doc__ = """Remove files or directories.
1856
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1857
delete them if they can easily be recovered using revert otherwise they
1858
will be backed up (adding an extension of the form .~#~). If no options or
1859
parameters are given Bazaar will scan for files that are being tracked by
1860
Bazaar but missing in your tree and stop tracking them for you.
1862
takes_args = ['file*']
1863
takes_options = ['verbose',
1864
Option('new', help='Only remove files that have never been committed.'),
1865
RegistryOption.from_kwargs('file-deletion-strategy',
1866
'The file deletion mode to be used.',
1867
title='Deletion Strategy', value_switches=True, enum_switch=False,
1868
safe='Backup changed files (default).',
1869
keep='Delete from brz but leave the working copy.',
1870
no_backup='Don\'t backup changed files.'),
1872
aliases = ['rm', 'del']
1873
encoding_type = 'replace'
1875
def run(self, file_list, verbose=False, new=False,
1876
file_deletion_strategy='safe'):
1878
tree, file_list = WorkingTree.open_containing_paths(file_list)
1880
if file_list is not None:
1881
file_list = [f for f in file_list]
1883
self.add_cleanup(tree.lock_write().unlock)
1884
# Heuristics should probably all move into tree.remove_smart or
1887
added = tree.changes_from(tree.basis_tree(),
1888
specific_files=file_list).added
1889
file_list = sorted([f[0] for f in added], reverse=True)
1890
if len(file_list) == 0:
1891
raise errors.BzrCommandError(gettext('No matching files.'))
1892
elif file_list is None:
1893
# missing files show up in iter_changes(basis) as
1894
# versioned-with-no-kind.
1896
for change in tree.iter_changes(tree.basis_tree()):
1897
# Find paths in the working tree that have no kind:
1898
if change[1][1] is not None and change[6][1] is None:
1899
missing.append(change[1][1])
1900
file_list = sorted(missing, reverse=True)
1901
file_deletion_strategy = 'keep'
1902
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1903
keep_files=file_deletion_strategy=='keep',
1904
force=(file_deletion_strategy=='no-backup'))
1907
class cmd_file_id(Command):
1908
__doc__ = """Print file_id of a particular file or directory.
1910
The file_id is assigned when the file is first added and remains the
1911
same through all revisions where the file exists, even when it is
1916
_see_also = ['inventory', 'ls']
1917
takes_args = ['filename']
1920
def run(self, filename):
1921
tree, relpath = WorkingTree.open_containing(filename)
1922
i = tree.path2id(relpath)
1924
raise errors.NotVersionedError(filename)
1926
self.outf.write(i + '\n')
1929
class cmd_file_path(Command):
1930
__doc__ = """Print path of file_ids to a file or directory.
1932
This prints one line for each directory down to the target,
1933
starting at the branch root.
1937
takes_args = ['filename']
1940
def run(self, filename):
1941
tree, relpath = WorkingTree.open_containing(filename)
1942
fid = tree.path2id(relpath)
1944
raise errors.NotVersionedError(filename)
1945
segments = osutils.splitpath(relpath)
1946
for pos in range(1, len(segments) + 1):
1947
path = osutils.joinpath(segments[:pos])
1948
self.outf.write("%s\n" % tree.path2id(path))
1951
class cmd_reconcile(Command):
1952
__doc__ = """Reconcile brz metadata in a branch.
1954
This can correct data mismatches that may have been caused by
1955
previous ghost operations or brz upgrades. You should only
1956
need to run this command if 'brz check' or a brz developer
1957
advises you to run it.
1959
If a second branch is provided, cross-branch reconciliation is
1960
also attempted, which will check that data like the tree root
1961
id which was not present in very early brz versions is represented
1962
correctly in both branches.
1964
At the same time it is run it may recompress data resulting in
1965
a potential saving in disk space or performance gain.
1967
The branch *MUST* be on a listable system such as local disk or sftp.
1970
_see_also = ['check']
1971
takes_args = ['branch?']
1973
Option('canonicalize-chks',
1974
help='Make sure CHKs are in canonical form (repairs '
1979
def run(self, branch=".", canonicalize_chks=False):
1980
from .reconcile import reconcile
1981
dir = controldir.ControlDir.open(branch)
1982
reconcile(dir, canonicalize_chks=canonicalize_chks)
1985
class cmd_revision_history(Command):
1986
__doc__ = """Display the list of revision ids on a branch."""
1989
takes_args = ['location?']
1994
def run(self, location="."):
1995
branch = Branch.open_containing(location)[0]
1996
self.add_cleanup(branch.lock_read().unlock)
1997
graph = branch.repository.get_graph()
1998
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1999
[_mod_revision.NULL_REVISION]))
2000
for revid in reversed(history):
2001
self.outf.write(revid)
2002
self.outf.write('\n')
2005
class cmd_ancestry(Command):
2006
__doc__ = """List all revisions merged into this branch."""
2008
_see_also = ['log', 'revision-history']
2009
takes_args = ['location?']
2014
def run(self, location="."):
2016
wt = WorkingTree.open_containing(location)[0]
2017
except errors.NoWorkingTree:
2018
b = Branch.open(location)
2019
last_revision = b.last_revision()
2022
last_revision = wt.last_revision()
2024
self.add_cleanup(b.repository.lock_read().unlock)
2025
graph = b.repository.get_graph()
2026
revisions = [revid for revid, parents in
2027
graph.iter_ancestry([last_revision])]
2028
for revision_id in reversed(revisions):
2029
if _mod_revision.is_null(revision_id):
2031
self.outf.write(revision_id + '\n')
2034
class cmd_init(Command):
2035
__doc__ = """Make a directory into a versioned branch.
2037
Use this to create an empty branch, or before importing an
2040
If there is a repository in a parent directory of the location, then
2041
the history of the branch will be stored in the repository. Otherwise
2042
init creates a standalone branch which carries its own history
2043
in the .bzr directory.
2045
If there is already a branch at the location but it has no working tree,
2046
the tree can be populated with 'brz checkout'.
2048
Recipe for importing a tree of files::
2054
brz commit -m "imported project"
2057
_see_also = ['init-repository', 'branch', 'checkout']
2058
takes_args = ['location?']
2060
Option('create-prefix',
2061
help='Create the path leading up to the branch '
2062
'if it does not already exist.'),
2063
RegistryOption('format',
2064
help='Specify a format for this branch. '
2065
'See "help formats".',
2066
lazy_registry=('breezy.controldir', 'format_registry'),
2067
converter=lambda name: controldir.format_registry.make_controldir(name),
2068
value_switches=False,
2069
title="Branch format",
2071
Option('append-revisions-only',
2072
help='Never change revnos or the existing log.'
2073
' Append revisions to it only.'),
2075
'Create a branch without a working tree.')
2077
def run(self, location=None, format=None, append_revisions_only=False,
2078
create_prefix=False, no_tree=False):
2080
format = controldir.format_registry.make_controldir('default')
2081
if location is None:
2084
to_transport = transport.get_transport(location)
2086
# The path has to exist to initialize a
2087
# branch inside of it.
2088
# Just using os.mkdir, since I don't
2089
# believe that we want to create a bunch of
2090
# locations if the user supplies an extended path
2092
to_transport.ensure_base()
2093
except errors.NoSuchFile:
2094
if not create_prefix:
2095
raise errors.BzrCommandError(gettext("Parent directory of %s"
2097
"\nYou may supply --create-prefix to create all"
2098
" leading parent directories.")
2100
to_transport.create_prefix()
2103
a_controldir = controldir.ControlDir.open_from_transport(to_transport)
2104
except errors.NotBranchError:
2105
# really a NotBzrDir error...
2106
create_branch = controldir.ControlDir.create_branch_convenience
2108
force_new_tree = False
2110
force_new_tree = None
2111
branch = create_branch(to_transport.base, format=format,
2112
possible_transports=[to_transport],
2113
force_new_tree=force_new_tree)
2114
a_controldir = branch.controldir
2116
from .transport.local import LocalTransport
2117
if a_controldir.has_branch():
2118
if (isinstance(to_transport, LocalTransport)
2119
and not a_controldir.has_workingtree()):
2120
raise errors.BranchExistsWithoutWorkingTree(location)
2121
raise errors.AlreadyBranchError(location)
2122
branch = a_controldir.create_branch()
2123
if not no_tree and not a_controldir.has_workingtree():
2124
a_controldir.create_workingtree()
2125
if append_revisions_only:
2127
branch.set_append_revisions_only(True)
2128
except errors.UpgradeRequired:
2129
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2130
' to append-revisions-only. Try --default.'))
2132
from .info import describe_layout, describe_format
2134
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2135
except (errors.NoWorkingTree, errors.NotLocalUrl):
2137
repository = branch.repository
2138
layout = describe_layout(repository, branch, tree).lower()
2139
format = describe_format(a_controldir, repository, branch, tree)
2140
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2142
if repository.is_shared():
2143
#XXX: maybe this can be refactored into transport.path_or_url()
2144
url = repository.controldir.root_transport.external_url()
2146
url = urlutils.local_path_from_url(url)
2147
except errors.InvalidURL:
2149
self.outf.write(gettext("Using shared repository: %s\n") % url)
2152
class cmd_init_repository(Command):
2153
__doc__ = """Create a shared repository for branches to share storage space.
2155
New branches created under the repository directory will store their
2156
revisions in the repository, not in the branch directory. For branches
2157
with shared history, this reduces the amount of storage needed and
2158
speeds up the creation of new branches.
2160
If the --no-trees option is given then the branches in the repository
2161
will not have working trees by default. They will still exist as
2162
directories on disk, but they will not have separate copies of the
2163
files at a certain revision. This can be useful for repositories that
2164
store branches which are interacted with through checkouts or remote
2165
branches, such as on a server.
2168
Create a shared repository holding just branches::
2170
brz init-repo --no-trees repo
2173
Make a lightweight checkout elsewhere::
2175
brz checkout --lightweight repo/trunk trunk-checkout
2180
_see_also = ['init', 'branch', 'checkout', 'repositories']
2181
takes_args = ["location"]
2182
takes_options = [RegistryOption('format',
2183
help='Specify a format for this repository. See'
2184
' "brz help formats" for details.',
2185
lazy_registry=('breezy.controldir', 'format_registry'),
2186
converter=lambda name: controldir.format_registry.make_controldir(name),
2187
value_switches=False, title='Repository format'),
2189
help='Branches in the repository will default to'
2190
' not having a working tree.'),
2192
aliases = ["init-repo"]
2194
def run(self, location, format=None, no_trees=False):
2196
format = controldir.format_registry.make_controldir('default')
2198
if location is None:
2201
to_transport = transport.get_transport(location)
2203
(repo, newdir, require_stacking, repository_policy) = (
2204
format.initialize_on_transport_ex(to_transport,
2205
create_prefix=True, make_working_trees=not no_trees,
2206
shared_repo=True, force_new_repo=True,
2207
use_existing_dir=True,
2208
repo_format_name=format.repository_format.get_format_string()))
2210
from .info import show_bzrdir_info
2211
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2214
class cmd_diff(Command):
2215
__doc__ = """Show differences in the working tree, between revisions or branches.
2217
If no arguments are given, all changes for the current tree are listed.
2218
If files are given, only the changes in those files are listed.
2219
Remote and multiple branches can be compared by using the --old and
2220
--new options. If not provided, the default for both is derived from
2221
the first argument, if any, or the current tree if no arguments are
2224
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2225
produces patches suitable for "patch -p1".
2227
Note that when using the -r argument with a range of revisions, the
2228
differences are computed between the two specified revisions. That
2229
is, the command does not show the changes introduced by the first
2230
revision in the range. This differs from the interpretation of
2231
revision ranges used by "brz log" which includes the first revision
2236
2 - unrepresentable changes
2241
Shows the difference in the working tree versus the last commit::
2245
Difference between the working tree and revision 1::
2249
Difference between revision 3 and revision 1::
2253
Difference between revision 3 and revision 1 for branch xxx::
2257
The changes introduced by revision 2 (equivalent to -r1..2)::
2261
To see the changes introduced by revision X::
2265
Note that in the case of a merge, the -c option shows the changes
2266
compared to the left hand parent. To see the changes against
2267
another parent, use::
2269
brz diff -r<chosen_parent>..X
2271
The changes between the current revision and the previous revision
2272
(equivalent to -c-1 and -r-2..-1)
2276
Show just the differences for file NEWS::
2280
Show the differences in working tree xxx for file NEWS::
2284
Show the differences from branch xxx to this working tree:
2288
Show the differences between two branches for file NEWS::
2290
brz diff --old xxx --new yyy NEWS
2292
Same as 'brz diff' but prefix paths with old/ and new/::
2294
brz diff --prefix old/:new/
2296
Show the differences using a custom diff program with options::
2298
brz diff --using /usr/bin/diff --diff-options -wu
2300
_see_also = ['status']
2301
takes_args = ['file*']
2303
Option('diff-options', type=str,
2304
help='Pass these options to the external diff program.'),
2305
Option('prefix', type=str,
2307
help='Set prefixes added to old and new filenames, as '
2308
'two values separated by a colon. (eg "old/:new/").'),
2310
help='Branch/tree to compare from.',
2314
help='Branch/tree to compare to.',
2320
help='Use this command to compare files.',
2323
RegistryOption('format',
2325
help='Diff format to use.',
2326
lazy_registry=('breezy.diff', 'format_registry'),
2327
title='Diff format'),
2329
help='How many lines of context to show.',
2333
aliases = ['di', 'dif']
2334
encoding_type = 'exact'
2337
def run(self, revision=None, file_list=None, diff_options=None,
2338
prefix=None, old=None, new=None, using=None, format=None,
2340
from .diff import (get_trees_and_branches_to_diff_locked,
2347
elif prefix == '1' or prefix is None:
2351
old_label, new_label = prefix.split(":")
2353
raise errors.BzrCommandError(gettext(
2354
'--prefix expects two values separated by a colon'
2355
' (eg "old/:new/")'))
2357
if revision and len(revision) > 2:
2358
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2359
' one or two revision specifiers'))
2361
if using is not None and format is not None:
2362
raise errors.BzrCommandError(gettext(
2363
'{0} and {1} are mutually exclusive').format(
2364
'--using', '--format'))
2366
(old_tree, new_tree,
2367
old_branch, new_branch,
2368
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2369
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2370
# GNU diff on Windows uses ANSI encoding for filenames
2371
path_encoding = osutils.get_diff_header_encoding()
2372
return show_diff_trees(old_tree, new_tree, sys.stdout,
2373
specific_files=specific_files,
2374
external_diff_options=diff_options,
2375
old_label=old_label, new_label=new_label,
2376
extra_trees=extra_trees,
2377
path_encoding=path_encoding,
2378
using=using, context=context,
2382
class cmd_deleted(Command):
2383
__doc__ = """List files deleted in the working tree.
2385
# TODO: Show files deleted since a previous revision, or
2386
# between two revisions.
2387
# TODO: Much more efficient way to do this: read in new
2388
# directories with readdir, rather than stating each one. Same
2389
# level of effort but possibly much less IO. (Or possibly not,
2390
# if the directories are very large...)
2391
_see_also = ['status', 'ls']
2392
takes_options = ['directory', 'show-ids']
2395
def run(self, show_ids=False, directory=u'.'):
2396
tree = WorkingTree.open_containing(directory)[0]
2397
self.add_cleanup(tree.lock_read().unlock)
2398
old = tree.basis_tree()
2399
self.add_cleanup(old.lock_read().unlock)
2400
for path, ie in old.iter_entries_by_dir():
2401
if not tree.has_id(ie.file_id):
2402
self.outf.write(path)
2404
self.outf.write(' ')
2405
self.outf.write(ie.file_id)
2406
self.outf.write('\n')
2409
class cmd_modified(Command):
2410
__doc__ = """List files modified in working tree.
2414
_see_also = ['status', 'ls']
2415
takes_options = ['directory', 'null']
2418
def run(self, null=False, directory=u'.'):
2419
tree = WorkingTree.open_containing(directory)[0]
2420
self.add_cleanup(tree.lock_read().unlock)
2421
td = tree.changes_from(tree.basis_tree())
2423
for path, id, kind, text_modified, meta_modified in td.modified:
2425
self.outf.write(path + '\0')
2427
self.outf.write(osutils.quotefn(path) + '\n')
2430
class cmd_added(Command):
2431
__doc__ = """List files added in working tree.
2435
_see_also = ['status', 'ls']
2436
takes_options = ['directory', 'null']
2439
def run(self, null=False, directory=u'.'):
2440
wt = WorkingTree.open_containing(directory)[0]
2441
self.add_cleanup(wt.lock_read().unlock)
2442
basis = wt.basis_tree()
2443
self.add_cleanup(basis.lock_read().unlock)
2444
root_id = wt.get_root_id()
2445
for file_id in wt.all_file_ids():
2446
if basis.has_id(file_id):
2448
if root_id == file_id:
2450
path = wt.id2path(file_id)
2451
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2454
self.outf.write(path + '\0')
2456
self.outf.write(osutils.quotefn(path) + '\n')
2459
class cmd_root(Command):
2460
__doc__ = """Show the tree root directory.
2462
The root is the nearest enclosing directory with a .bzr control
2465
takes_args = ['filename?']
2467
def run(self, filename=None):
2468
"""Print the branch root."""
2469
tree = WorkingTree.open_containing(filename)[0]
2470
self.outf.write(tree.basedir + '\n')
2473
def _parse_limit(limitstring):
2475
return int(limitstring)
2477
msg = gettext("The limit argument must be an integer.")
2478
raise errors.BzrCommandError(msg)
2481
def _parse_levels(s):
2485
msg = gettext("The levels argument must be an integer.")
2486
raise errors.BzrCommandError(msg)
2489
class cmd_log(Command):
2490
__doc__ = """Show historical log for a branch or subset of a branch.
2492
log is brz's default tool for exploring the history of a branch.
2493
The branch to use is taken from the first parameter. If no parameters
2494
are given, the branch containing the working directory is logged.
2495
Here are some simple examples::
2497
brz log log the current branch
2498
brz log foo.py log a file in its branch
2499
brz log http://server/branch log a branch on a server
2501
The filtering, ordering and information shown for each revision can
2502
be controlled as explained below. By default, all revisions are
2503
shown sorted (topologically) so that newer revisions appear before
2504
older ones and descendants always appear before ancestors. If displayed,
2505
merged revisions are shown indented under the revision in which they
2510
The log format controls how information about each revision is
2511
displayed. The standard log formats are called ``long``, ``short``
2512
and ``line``. The default is long. See ``brz help log-formats``
2513
for more details on log formats.
2515
The following options can be used to control what information is
2518
-l N display a maximum of N revisions
2519
-n N display N levels of revisions (0 for all, 1 for collapsed)
2520
-v display a status summary (delta) for each revision
2521
-p display a diff (patch) for each revision
2522
--show-ids display revision-ids (and file-ids), not just revnos
2524
Note that the default number of levels to display is a function of the
2525
log format. If the -n option is not used, the standard log formats show
2526
just the top level (mainline).
2528
Status summaries are shown using status flags like A, M, etc. To see
2529
the changes explained using words like ``added`` and ``modified``
2530
instead, use the -vv option.
2534
To display revisions from oldest to newest, use the --forward option.
2535
In most cases, using this option will have little impact on the total
2536
time taken to produce a log, though --forward does not incrementally
2537
display revisions like --reverse does when it can.
2539
:Revision filtering:
2541
The -r option can be used to specify what revision or range of revisions
2542
to filter against. The various forms are shown below::
2544
-rX display revision X
2545
-rX.. display revision X and later
2546
-r..Y display up to and including revision Y
2547
-rX..Y display from X to Y inclusive
2549
See ``brz help revisionspec`` for details on how to specify X and Y.
2550
Some common examples are given below::
2552
-r-1 show just the tip
2553
-r-10.. show the last 10 mainline revisions
2554
-rsubmit:.. show what's new on this branch
2555
-rancestor:path.. show changes since the common ancestor of this
2556
branch and the one at location path
2557
-rdate:yesterday.. show changes since yesterday
2559
When logging a range of revisions using -rX..Y, log starts at
2560
revision Y and searches back in history through the primary
2561
("left-hand") parents until it finds X. When logging just the
2562
top level (using -n1), an error is reported if X is not found
2563
along the way. If multi-level logging is used (-n0), X may be
2564
a nested merge revision and the log will be truncated accordingly.
2568
If parameters are given and the first one is not a branch, the log
2569
will be filtered to show only those revisions that changed the
2570
nominated files or directories.
2572
Filenames are interpreted within their historical context. To log a
2573
deleted file, specify a revision range so that the file existed at
2574
the end or start of the range.
2576
Historical context is also important when interpreting pathnames of
2577
renamed files/directories. Consider the following example:
2579
* revision 1: add tutorial.txt
2580
* revision 2: modify tutorial.txt
2581
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2585
* ``brz log guide.txt`` will log the file added in revision 1
2587
* ``brz log tutorial.txt`` will log the new file added in revision 3
2589
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2590
the original file in revision 2.
2592
* ``brz log -r2 -p guide.txt`` will display an error message as there
2593
was no file called guide.txt in revision 2.
2595
Renames are always followed by log. By design, there is no need to
2596
explicitly ask for this (and no way to stop logging a file back
2597
until it was last renamed).
2601
The --match option can be used for finding revisions that match a
2602
regular expression in a commit message, committer, author or bug.
2603
Specifying the option several times will match any of the supplied
2604
expressions. --match-author, --match-bugs, --match-committer and
2605
--match-message can be used to only match a specific field.
2609
GUI tools and IDEs are often better at exploring history than command
2610
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2611
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2612
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2613
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2615
You may find it useful to add the aliases below to ``bazaar.conf``::
2619
top = log -l10 --line
2622
``brz tip`` will then show the latest revision while ``brz top``
2623
will show the last 10 mainline revisions. To see the details of a
2624
particular revision X, ``brz show -rX``.
2626
If you are interested in looking deeper into a particular merge X,
2627
use ``brz log -n0 -rX``.
2629
``brz log -v`` on a branch with lots of history is currently
2630
very slow. A fix for this issue is currently under development.
2631
With or without that fix, it is recommended that a revision range
2632
be given when using the -v option.
2634
brz has a generic full-text matching plugin, brz-search, that can be
2635
used to find revisions matching user names, commit messages, etc.
2636
Among other features, this plugin can find all revisions containing
2637
a list of words but not others.
2639
When exploring non-mainline history on large projects with deep
2640
history, the performance of log can be greatly improved by installing
2641
the historycache plugin. This plugin buffers historical information
2642
trading disk space for faster speed.
2644
takes_args = ['file*']
2645
_see_also = ['log-formats', 'revisionspec']
2648
help='Show from oldest to newest.'),
2650
custom_help('verbose',
2651
help='Show files changed in each revision.'),
2655
type=breezy.option._parse_revision_str,
2657
help='Show just the specified revision.'
2658
' See also "help revisionspec".'),
2660
RegistryOption('authors',
2661
'What names to list as authors - first, all or committer.',
2663
lazy_registry=('breezy.log', 'author_list_registry'),
2667
help='Number of levels to display - 0 for all, 1 for flat.',
2669
type=_parse_levels),
2671
help='Show revisions whose message matches this '
2672
'regular expression.',
2677
help='Limit the output to the first N revisions.',
2682
help='Show changes made in each revision as a patch.'),
2683
Option('include-merged',
2684
help='Show merged revisions like --levels 0 does.'),
2685
Option('include-merges', hidden=True,
2686
help='Historical alias for --include-merged.'),
2687
Option('omit-merges',
2688
help='Do not report commits with more than one parent.'),
2689
Option('exclude-common-ancestry',
2690
help='Display only the revisions that are not part'
2691
' of both ancestries (require -rX..Y).'
2693
Option('signatures',
2694
help='Show digital signature validity.'),
2697
help='Show revisions whose properties match this '
2700
ListOption('match-message',
2701
help='Show revisions whose message matches this '
2704
ListOption('match-committer',
2705
help='Show revisions whose committer matches this '
2708
ListOption('match-author',
2709
help='Show revisions whose authors match this '
2712
ListOption('match-bugs',
2713
help='Show revisions whose bugs match this '
2717
encoding_type = 'replace'
2720
def run(self, file_list=None, timezone='original',
2731
include_merged=None,
2733
exclude_common_ancestry=False,
2737
match_committer=None,
2744
make_log_request_dict,
2745
_get_info_for_log_files,
2747
direction = (forward and 'forward') or 'reverse'
2748
if include_merged is None:
2749
include_merged = False
2750
if (exclude_common_ancestry
2751
and (revision is None or len(revision) != 2)):
2752
raise errors.BzrCommandError(gettext(
2753
'--exclude-common-ancestry requires -r with two revisions'))
2758
raise errors.BzrCommandError(gettext(
2759
'{0} and {1} are mutually exclusive').format(
2760
'--levels', '--include-merged'))
2762
if change is not None:
2764
raise errors.RangeInChangeOption()
2765
if revision is not None:
2766
raise errors.BzrCommandError(gettext(
2767
'{0} and {1} are mutually exclusive').format(
2768
'--revision', '--change'))
2773
filter_by_dir = False
2775
# find the file ids to log and check for directory filtering
2776
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2777
revision, file_list, self.add_cleanup)
2778
for relpath, file_id, kind in file_info_list:
2780
raise errors.BzrCommandError(gettext(
2781
"Path unknown at end or start of revision range: %s") %
2783
# If the relpath is the top of the tree, we log everything
2788
file_ids.append(file_id)
2789
filter_by_dir = filter_by_dir or (
2790
kind in ['directory', 'tree-reference'])
2793
# FIXME ? log the current subdir only RBC 20060203
2794
if revision is not None \
2795
and len(revision) > 0 and revision[0].get_branch():
2796
location = revision[0].get_branch()
2799
dir, relpath = controldir.ControlDir.open_containing(location)
2800
b = dir.open_branch()
2801
self.add_cleanup(b.lock_read().unlock)
2802
rev1, rev2 = _get_revision_range(revision, b, self.name())
2804
if b.get_config_stack().get('validate_signatures_in_log'):
2808
if not gpg.GPGStrategy.verify_signatures_available():
2809
raise errors.GpgmeNotInstalled(None)
2811
# Decide on the type of delta & diff filtering to use
2812
# TODO: add an --all-files option to make this configurable & consistent
2820
diff_type = 'partial'
2824
# Build the log formatter
2825
if log_format is None:
2826
log_format = log.log_formatter_registry.get_default(b)
2827
# Make a non-encoding output to include the diffs - bug 328007
2828
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2829
lf = log_format(show_ids=show_ids, to_file=self.outf,
2830
to_exact_file=unencoded_output,
2831
show_timezone=timezone,
2832
delta_format=get_verbosity_level(),
2834
show_advice=levels is None,
2835
author_list_handler=authors)
2837
# Choose the algorithm for doing the logging. It's annoying
2838
# having multiple code paths like this but necessary until
2839
# the underlying repository format is faster at generating
2840
# deltas or can provide everything we need from the indices.
2841
# The default algorithm - match-using-deltas - works for
2842
# multiple files and directories and is faster for small
2843
# amounts of history (200 revisions say). However, it's too
2844
# slow for logging a single file in a repository with deep
2845
# history, i.e. > 10K revisions. In the spirit of "do no
2846
# evil when adding features", we continue to use the
2847
# original algorithm - per-file-graph - for the "single
2848
# file that isn't a directory without showing a delta" case.
2849
partial_history = revision and b.repository._format.supports_chks
2850
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2851
or delta_type or partial_history)
2855
match_dict[''] = match
2857
match_dict['message'] = match_message
2859
match_dict['committer'] = match_committer
2861
match_dict['author'] = match_author
2863
match_dict['bugs'] = match_bugs
2865
# Build the LogRequest and execute it
2866
if len(file_ids) == 0:
2868
rqst = make_log_request_dict(
2869
direction=direction, specific_fileids=file_ids,
2870
start_revision=rev1, end_revision=rev2, limit=limit,
2871
message_search=message, delta_type=delta_type,
2872
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2873
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2874
signature=signatures, omit_merges=omit_merges,
2876
Logger(b, rqst).show(lf)
2879
def _get_revision_range(revisionspec_list, branch, command_name):
2880
"""Take the input of a revision option and turn it into a revision range.
2882
It returns RevisionInfo objects which can be used to obtain the rev_id's
2883
of the desired revisions. It does some user input validations.
2885
if revisionspec_list is None:
2888
elif len(revisionspec_list) == 1:
2889
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2890
elif len(revisionspec_list) == 2:
2891
start_spec = revisionspec_list[0]
2892
end_spec = revisionspec_list[1]
2893
if end_spec.get_branch() != start_spec.get_branch():
2894
# b is taken from revision[0].get_branch(), and
2895
# show_log will use its revision_history. Having
2896
# different branches will lead to weird behaviors.
2897
raise errors.BzrCommandError(gettext(
2898
"brz %s doesn't accept two revisions in different"
2899
" branches.") % command_name)
2900
if start_spec.spec is None:
2901
# Avoid loading all the history.
2902
rev1 = RevisionInfo(branch, None, None)
2904
rev1 = start_spec.in_history(branch)
2905
# Avoid loading all of history when we know a missing
2906
# end of range means the last revision ...
2907
if end_spec.spec is None:
2908
last_revno, last_revision_id = branch.last_revision_info()
2909
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2911
rev2 = end_spec.in_history(branch)
2913
raise errors.BzrCommandError(gettext(
2914
'brz %s --revision takes one or two values.') % command_name)
2918
def _revision_range_to_revid_range(revision_range):
2921
if revision_range[0] is not None:
2922
rev_id1 = revision_range[0].rev_id
2923
if revision_range[1] is not None:
2924
rev_id2 = revision_range[1].rev_id
2925
return rev_id1, rev_id2
2927
def get_log_format(long=False, short=False, line=False, default='long'):
2928
log_format = default
2932
log_format = 'short'
2938
class cmd_touching_revisions(Command):
2939
__doc__ = """Return revision-ids which affected a particular file.
2941
A more user-friendly interface is "brz log FILE".
2945
takes_args = ["filename"]
2948
def run(self, filename):
2949
tree, relpath = WorkingTree.open_containing(filename)
2950
file_id = tree.path2id(relpath)
2952
self.add_cleanup(b.lock_read().unlock)
2953
touching_revs = log.find_touching_revisions(b, file_id)
2954
for revno, revision_id, what in touching_revs:
2955
self.outf.write("%6d %s\n" % (revno, what))
2958
class cmd_ls(Command):
2959
__doc__ = """List files in a tree.
2962
_see_also = ['status', 'cat']
2963
takes_args = ['path?']
2967
Option('recursive', short_name='R',
2968
help='Recurse into subdirectories.'),
2970
help='Print paths relative to the root of the branch.'),
2971
Option('unknown', short_name='u',
2972
help='Print unknown files.'),
2973
Option('versioned', help='Print versioned files.',
2975
Option('ignored', short_name='i',
2976
help='Print ignored files.'),
2977
Option('kind', short_name='k',
2978
help='List entries of a particular kind: file, directory, symlink.',
2985
def run(self, revision=None, verbose=False,
2986
recursive=False, from_root=False,
2987
unknown=False, versioned=False, ignored=False,
2988
null=False, kind=None, show_ids=False, path=None, directory=None):
2990
if kind and kind not in ('file', 'directory', 'symlink'):
2991
raise errors.BzrCommandError(gettext('invalid kind specified'))
2993
if verbose and null:
2994
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2995
all = not (unknown or versioned or ignored)
2997
selection = {'I':ignored, '?':unknown, 'V':versioned}
3003
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3006
tree, branch, relpath = \
3007
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3009
# Calculate the prefix to use
3013
prefix = relpath + '/'
3014
elif fs_path != '.' and not fs_path.endswith('/'):
3015
prefix = fs_path + '/'
3017
if revision is not None or tree is None:
3018
tree = _get_one_revision_tree('ls', revision, branch=branch)
3021
if isinstance(tree, WorkingTree) and tree.supports_views():
3022
view_files = tree.views.lookup_view()
3025
view_str = views.view_display_str(view_files)
3026
note(gettext("Ignoring files outside view. View is %s") % view_str)
3028
self.add_cleanup(tree.lock_read().unlock)
3029
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3030
from_dir=relpath, recursive=recursive):
3031
# Apply additional masking
3032
if not all and not selection[fc]:
3034
if kind is not None and fkind != kind:
3039
fullpath = osutils.pathjoin(relpath, fp)
3042
views.check_path_in_view(tree, fullpath)
3043
except views.FileOutsideView:
3048
fp = osutils.pathjoin(prefix, fp)
3049
kindch = entry.kind_character()
3050
outstring = fp + kindch
3051
ui.ui_factory.clear_term()
3053
outstring = '%-8s %s' % (fc, outstring)
3054
if show_ids and fid is not None:
3055
outstring = "%-50s %s" % (outstring, fid)
3056
self.outf.write(outstring + '\n')
3058
self.outf.write(fp + '\0')
3061
self.outf.write(fid)
3062
self.outf.write('\0')
3070
self.outf.write('%-50s %s\n' % (outstring, my_id))
3072
self.outf.write(outstring + '\n')
3075
class cmd_unknowns(Command):
3076
__doc__ = """List unknown files.
3081
takes_options = ['directory']
3084
def run(self, directory=u'.'):
3085
for f in WorkingTree.open_containing(directory)[0].unknowns():
3086
self.outf.write(osutils.quotefn(f) + '\n')
3089
class cmd_ignore(Command):
3090
__doc__ = """Ignore specified files or patterns.
3092
See ``brz help patterns`` for details on the syntax of patterns.
3094
If a .bzrignore file does not exist, the ignore command
3095
will create one and add the specified files or patterns to the newly
3096
created file. The ignore command will also automatically add the
3097
.bzrignore file to be versioned. Creating a .bzrignore file without
3098
the use of the ignore command will require an explicit add command.
3100
To remove patterns from the ignore list, edit the .bzrignore file.
3101
After adding, editing or deleting that file either indirectly by
3102
using this command or directly by using an editor, be sure to commit
3105
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3106
the global ignore file can be found in the application data directory as
3107
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3108
Global ignores are not touched by this command. The global ignore file
3109
can be edited directly using an editor.
3111
Patterns prefixed with '!' are exceptions to ignore patterns and take
3112
precedence over regular ignores. Such exceptions are used to specify
3113
files that should be versioned which would otherwise be ignored.
3115
Patterns prefixed with '!!' act as regular ignore patterns, but have
3116
precedence over the '!' exception patterns.
3120
* Ignore patterns containing shell wildcards must be quoted from
3123
* Ignore patterns starting with "#" act as comments in the ignore file.
3124
To ignore patterns that begin with that character, use the "RE:" prefix.
3127
Ignore the top level Makefile::
3129
brz ignore ./Makefile
3131
Ignore .class files in all directories...::
3133
brz ignore "*.class"
3135
...but do not ignore "special.class"::
3137
brz ignore "!special.class"
3139
Ignore files whose name begins with the "#" character::
3143
Ignore .o files under the lib directory::
3145
brz ignore "lib/**/*.o"
3147
Ignore .o files under the lib directory::
3149
brz ignore "RE:lib/.*\.o"
3151
Ignore everything but the "debian" toplevel directory::
3153
brz ignore "RE:(?!debian/).*"
3155
Ignore everything except the "local" toplevel directory,
3156
but always ignore autosave files ending in ~, even under local/::
3159
brz ignore "!./local"
3163
_see_also = ['status', 'ignored', 'patterns']
3164
takes_args = ['name_pattern*']
3165
takes_options = ['directory',
3166
Option('default-rules',
3167
help='Display the default ignore rules that brz uses.')
3170
def run(self, name_pattern_list=None, default_rules=None,
3172
from breezy import ignores
3173
if default_rules is not None:
3174
# dump the default rules and exit
3175
for pattern in ignores.USER_DEFAULTS:
3176
self.outf.write("%s\n" % pattern)
3178
if not name_pattern_list:
3179
raise errors.BzrCommandError(gettext("ignore requires at least one "
3180
"NAME_PATTERN or --default-rules."))
3181
name_pattern_list = [globbing.normalize_pattern(p)
3182
for p in name_pattern_list]
3184
bad_patterns_count = 0
3185
for p in name_pattern_list:
3186
if not globbing.Globster.is_pattern_valid(p):
3187
bad_patterns_count += 1
3188
bad_patterns += ('\n %s' % p)
3190
msg = (ngettext('Invalid ignore pattern found. %s',
3191
'Invalid ignore patterns found. %s',
3192
bad_patterns_count) % bad_patterns)
3193
ui.ui_factory.show_error(msg)
3194
raise lazy_regex.InvalidPattern('')
3195
for name_pattern in name_pattern_list:
3196
if (name_pattern[0] == '/' or
3197
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3198
raise errors.BzrCommandError(gettext(
3199
"NAME_PATTERN should not be an absolute path"))
3200
tree, relpath = WorkingTree.open_containing(directory)
3201
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3202
ignored = globbing.Globster(name_pattern_list)
3204
self.add_cleanup(tree.lock_read().unlock)
3205
for entry in tree.list_files():
3209
if ignored.match(filename):
3210
matches.append(filename)
3211
if len(matches) > 0:
3212
self.outf.write(gettext("Warning: the following files are version "
3213
"controlled and match your ignore pattern:\n%s"
3214
"\nThese files will continue to be version controlled"
3215
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3218
class cmd_ignored(Command):
3219
__doc__ = """List ignored files and the patterns that matched them.
3221
List all the ignored files and the ignore pattern that caused the file to
3224
Alternatively, to list just the files::
3229
encoding_type = 'replace'
3230
_see_also = ['ignore', 'ls']
3231
takes_options = ['directory']
3234
def run(self, directory=u'.'):
3235
tree = WorkingTree.open_containing(directory)[0]
3236
self.add_cleanup(tree.lock_read().unlock)
3237
for path, file_class, kind, file_id, entry in tree.list_files():
3238
if file_class != 'I':
3240
## XXX: Slightly inefficient since this was already calculated
3241
pat = tree.is_ignored(path)
3242
self.outf.write('%-50s %s\n' % (path, pat))
3245
class cmd_lookup_revision(Command):
3246
__doc__ = """Lookup the revision-id from a revision-number
3249
brz lookup-revision 33
3252
takes_args = ['revno']
3253
takes_options = ['directory']
3256
def run(self, revno, directory=u'.'):
3260
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3262
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3263
self.outf.write("%s\n" % revid)
3266
class cmd_export(Command):
3267
__doc__ = """Export current or past revision to a destination directory or archive.
3269
If no revision is specified this exports the last committed revision.
3271
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3272
given, try to find the format with the extension. If no extension
3273
is found exports to a directory (equivalent to --format=dir).
3275
If root is supplied, it will be used as the root directory inside
3276
container formats (tar, zip, etc). If it is not supplied it will default
3277
to the exported filename. The root option has no effect for 'dir' format.
3279
If branch is omitted then the branch containing the current working
3280
directory will be used.
3282
Note: Export of tree with non-ASCII filenames to zip is not supported.
3284
================= =========================
3285
Supported formats Autodetected by extension
3286
================= =========================
3289
tbz2 .tar.bz2, .tbz2
3292
================= =========================
3295
takes_args = ['dest', 'branch_or_subdir?']
3296
takes_options = ['directory',
3298
help="Type of file to export to.",
3301
Option('filters', help='Apply content filters to export the '
3302
'convenient form.'),
3305
help="Name of the root directory inside the exported file."),
3306
Option('per-file-timestamps',
3307
help='Set modification time of files to that of the last '
3308
'revision in which it was changed.'),
3309
Option('uncommitted',
3310
help='Export the working tree contents rather than that of the '
3313
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3314
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3316
from .export import export
3318
if branch_or_subdir is None:
3319
branch_or_subdir = directory
3321
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3323
if tree is not None:
3324
self.add_cleanup(tree.lock_read().unlock)
3328
raise errors.BzrCommandError(
3329
gettext("--uncommitted requires a working tree"))
3332
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3334
export(export_tree, dest, format, root, subdir, filtered=filters,
3335
per_file_timestamps=per_file_timestamps)
3336
except errors.NoSuchExportFormat as e:
3337
raise errors.BzrCommandError(
3338
gettext('Unsupported export format: %s') % e.format)
3341
class cmd_cat(Command):
3342
__doc__ = """Write the contents of a file as of a given revision to standard output.
3344
If no revision is nominated, the last revision is used.
3346
Note: Take care to redirect standard output when using this command on a
3351
takes_options = ['directory',
3352
Option('name-from-revision', help='The path name in the old tree.'),
3353
Option('filters', help='Apply content filters to display the '
3354
'convenience form.'),
3357
takes_args = ['filename']
3358
encoding_type = 'exact'
3361
def run(self, filename, revision=None, name_from_revision=False,
3362
filters=False, directory=None):
3363
if revision is not None and len(revision) != 1:
3364
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3365
" one revision specifier"))
3366
tree, branch, relpath = \
3367
_open_directory_or_containing_tree_or_branch(filename, directory)
3368
self.add_cleanup(branch.lock_read().unlock)
3369
return self._run(tree, branch, relpath, filename, revision,
3370
name_from_revision, filters)
3372
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3375
tree = b.basis_tree()
3376
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3377
self.add_cleanup(rev_tree.lock_read().unlock)
3379
old_file_id = rev_tree.path2id(relpath)
3381
# TODO: Split out this code to something that generically finds the
3382
# best id for a path across one or more trees; it's like
3383
# find_ids_across_trees but restricted to find just one. -- mbp
3385
if name_from_revision:
3386
# Try in revision if requested
3387
if old_file_id is None:
3388
raise errors.BzrCommandError(gettext(
3389
"{0!r} is not present in revision {1}").format(
3390
filename, rev_tree.get_revision_id()))
3392
actual_file_id = old_file_id
3394
cur_file_id = tree.path2id(relpath)
3395
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3396
actual_file_id = cur_file_id
3397
elif old_file_id is not None:
3398
actual_file_id = old_file_id
3400
raise errors.BzrCommandError(gettext(
3401
"{0!r} is not present in revision {1}").format(
3402
filename, rev_tree.get_revision_id()))
3404
from .filter_tree import ContentFilterTree
3405
filter_tree = ContentFilterTree(rev_tree,
3406
rev_tree._content_filter_stack)
3407
content = filter_tree.get_file_text(actual_file_id)
3409
content = rev_tree.get_file_text(actual_file_id)
3411
self.outf.write(content)
3414
class cmd_local_time_offset(Command):
3415
__doc__ = """Show the offset in seconds from GMT to local time."""
3419
self.outf.write("%s\n" % osutils.local_time_offset())
3423
class cmd_commit(Command):
3424
__doc__ = """Commit changes into a new revision.
3426
An explanatory message needs to be given for each commit. This is
3427
often done by using the --message option (getting the message from the
3428
command line) or by using the --file option (getting the message from
3429
a file). If neither of these options is given, an editor is opened for
3430
the user to enter the message. To see the changed files in the
3431
boilerplate text loaded into the editor, use the --show-diff option.
3433
By default, the entire tree is committed and the person doing the
3434
commit is assumed to be the author. These defaults can be overridden
3439
If selected files are specified, only changes to those files are
3440
committed. If a directory is specified then the directory and
3441
everything within it is committed.
3443
When excludes are given, they take precedence over selected files.
3444
For example, to commit only changes within foo, but not changes
3447
brz commit foo -x foo/bar
3449
A selective commit after a merge is not yet supported.
3453
If the author of the change is not the same person as the committer,
3454
you can specify the author's name using the --author option. The
3455
name should be in the same format as a committer-id, e.g.
3456
"John Doe <jdoe@example.com>". If there is more than one author of
3457
the change you can specify the option multiple times, once for each
3462
A common mistake is to forget to add a new file or directory before
3463
running the commit command. The --strict option checks for unknown
3464
files and aborts the commit if any are found. More advanced pre-commit
3465
checks can be implemented by defining hooks. See ``brz help hooks``
3470
If you accidentially commit the wrong changes or make a spelling
3471
mistake in the commit message say, you can use the uncommit command
3472
to undo it. See ``brz help uncommit`` for details.
3474
Hooks can also be configured to run after a commit. This allows you
3475
to trigger updates to external systems like bug trackers. The --fixes
3476
option can be used to record the association between a revision and
3477
one or more bugs. See ``brz help bugs`` for details.
3480
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3481
takes_args = ['selected*']
3483
ListOption('exclude', type=str, short_name='x',
3484
help="Do not consider changes made to a given path."),
3485
Option('message', type=text_type,
3487
help="Description of the new revision."),
3490
help='Commit even if nothing has changed.'),
3491
Option('file', type=str,
3494
help='Take commit message from this file.'),
3496
help="Refuse to commit if there are unknown "
3497
"files in the working tree."),
3498
Option('commit-time', type=str,
3499
help="Manually set a commit time using commit date "
3500
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3501
ListOption('fixes', type=str,
3502
help="Mark a bug as being fixed by this revision "
3503
"(see \"brz help bugs\")."),
3504
ListOption('author', type=text_type,
3505
help="Set the author's name, if it's different "
3506
"from the committer."),
3508
help="Perform a local commit in a bound "
3509
"branch. Local commits are not pushed to "
3510
"the master branch until a normal commit "
3513
Option('show-diff', short_name='p',
3514
help='When no message is supplied, show the diff along'
3515
' with the status summary in the message editor.'),
3517
help='When committing to a foreign version control '
3518
'system do not push data that can not be natively '
3521
aliases = ['ci', 'checkin']
3523
def _iter_bug_fix_urls(self, fixes, branch):
3524
default_bugtracker = None
3525
# Configure the properties for bug fixing attributes.
3526
for fixed_bug in fixes:
3527
tokens = fixed_bug.split(':')
3528
if len(tokens) == 1:
3529
if default_bugtracker is None:
3530
branch_config = branch.get_config_stack()
3531
default_bugtracker = branch_config.get(
3533
if default_bugtracker is None:
3534
raise errors.BzrCommandError(gettext(
3535
"No tracker specified for bug %s. Use the form "
3536
"'tracker:id' or specify a default bug tracker "
3537
"using the `bugtracker` option.\nSee "
3538
"\"brz help bugs\" for more information on this "
3539
"feature. Commit refused.") % fixed_bug)
3540
tag = default_bugtracker
3542
elif len(tokens) != 2:
3543
raise errors.BzrCommandError(gettext(
3544
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3545
"See \"brz help bugs\" for more information on this "
3546
"feature.\nCommit refused.") % fixed_bug)
3548
tag, bug_id = tokens
3550
yield bugtracker.get_bug_url(tag, branch, bug_id)
3551
except bugtracker.UnknownBugTrackerAbbreviation:
3552
raise errors.BzrCommandError(gettext(
3553
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3554
except bugtracker.MalformedBugIdentifier as e:
3555
raise errors.BzrCommandError(gettext(
3556
"%s\nCommit refused.") % (str(e),))
3558
def run(self, message=None, file=None, verbose=False, selected_list=None,
3559
unchanged=False, strict=False, local=False, fixes=None,
3560
author=None, show_diff=False, exclude=None, commit_time=None,
3562
from .errors import (
3567
from .msgeditor import (
3568
edit_commit_message_encoded,
3569
generate_commit_message_template,
3570
make_commit_message_template_encoded,
3574
commit_stamp = offset = None
3575
if commit_time is not None:
3577
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3578
except ValueError as e:
3579
raise errors.BzrCommandError(gettext(
3580
"Could not parse --commit-time: " + str(e)))
3584
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3585
if selected_list == ['']:
3586
# workaround - commit of root of tree should be exactly the same
3587
# as just default commit in that tree, and succeed even though
3588
# selected-file merge commit is not done yet
3593
bug_property = bugtracker.encode_fixes_bug_urls(
3594
self._iter_bug_fix_urls(fixes, tree.branch))
3596
properties['bugs'] = bug_property
3598
if local and not tree.branch.get_bound_location():
3599
raise errors.LocalRequiresBoundBranch()
3601
if message is not None:
3603
file_exists = osutils.lexists(message)
3604
except UnicodeError:
3605
# The commit message contains unicode characters that can't be
3606
# represented in the filesystem encoding, so that can't be a
3611
'The commit message is a file name: "%(f)s".\n'
3612
'(use --file "%(f)s" to take commit message from that file)'
3614
ui.ui_factory.show_warning(warning_msg)
3616
message = message.replace('\r\n', '\n')
3617
message = message.replace('\r', '\n')
3619
raise errors.BzrCommandError(gettext(
3620
"please specify either --message or --file"))
3622
def get_message(commit_obj):
3623
"""Callback to get commit message"""
3627
my_message = f.read().decode(osutils.get_user_encoding())
3630
elif message is not None:
3631
my_message = message
3633
# No message supplied: make one up.
3634
# text is the status of the tree
3635
text = make_commit_message_template_encoded(tree,
3636
selected_list, diff=show_diff,
3637
output_encoding=osutils.get_user_encoding())
3638
# start_message is the template generated from hooks
3639
# XXX: Warning - looks like hooks return unicode,
3640
# make_commit_message_template_encoded returns user encoding.
3641
# We probably want to be using edit_commit_message instead to
3643
my_message = set_commit_message(commit_obj)
3644
if my_message is None:
3645
start_message = generate_commit_message_template(commit_obj)
3646
my_message = edit_commit_message_encoded(text,
3647
start_message=start_message)
3648
if my_message is None:
3649
raise errors.BzrCommandError(gettext("please specify a commit"
3650
" message with either --message or --file"))
3651
if my_message == "":
3652
raise errors.BzrCommandError(gettext("Empty commit message specified."
3653
" Please specify a commit message with either"
3654
" --message or --file or leave a blank message"
3655
" with --message \"\"."))
3658
# The API permits a commit with a filter of [] to mean 'select nothing'
3659
# but the command line should not do that.
3660
if not selected_list:
3661
selected_list = None
3663
tree.commit(message_callback=get_message,
3664
specific_files=selected_list,
3665
allow_pointless=unchanged, strict=strict, local=local,
3666
reporter=None, verbose=verbose, revprops=properties,
3667
authors=author, timestamp=commit_stamp,
3669
exclude=tree.safe_relpath_files(exclude),
3671
except PointlessCommit:
3672
raise errors.BzrCommandError(gettext("No changes to commit."
3673
" Please 'brz add' the files you want to commit, or use"
3674
" --unchanged to force an empty commit."))
3675
except ConflictsInTree:
3676
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3677
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3679
except StrictCommitFailed:
3680
raise errors.BzrCommandError(gettext("Commit refused because there are"
3681
" unknown files in the working tree."))
3682
except errors.BoundBranchOutOfDate as e:
3683
e.extra_help = (gettext("\n"
3684
'To commit to master branch, run update and then commit.\n'
3685
'You can also pass --local to commit to continue working '
3690
class cmd_check(Command):
3691
__doc__ = """Validate working tree structure, branch consistency and repository history.
3693
This command checks various invariants about branch and repository storage
3694
to detect data corruption or brz bugs.
3696
The working tree and branch checks will only give output if a problem is
3697
detected. The output fields of the repository check are:
3700
This is just the number of revisions checked. It doesn't
3704
This is just the number of versionedfiles checked. It
3705
doesn't indicate a problem.
3707
unreferenced ancestors
3708
Texts that are ancestors of other texts, but
3709
are not properly referenced by the revision ancestry. This is a
3710
subtle problem that Bazaar can work around.
3713
This is the total number of unique file contents
3714
seen in the checked revisions. It does not indicate a problem.
3717
This is the total number of repeated texts seen
3718
in the checked revisions. Texts can be repeated when their file
3719
entries are modified, but the file contents are not. It does not
3722
If no restrictions are specified, all Bazaar data that is found at the given
3723
location will be checked.
3727
Check the tree and branch at 'foo'::
3729
brz check --tree --branch foo
3731
Check only the repository at 'bar'::
3733
brz check --repo bar
3735
Check everything at 'baz'::
3740
_see_also = ['reconcile']
3741
takes_args = ['path?']
3742
takes_options = ['verbose',
3743
Option('branch', help="Check the branch related to the"
3744
" current directory."),
3745
Option('repo', help="Check the repository related to the"
3746
" current directory."),
3747
Option('tree', help="Check the working tree related to"
3748
" the current directory.")]
3750
def run(self, path=None, verbose=False, branch=False, repo=False,
3752
from .check import check_dwim
3755
if not branch and not repo and not tree:
3756
branch = repo = tree = True
3757
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3760
class cmd_upgrade(Command):
3761
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3763
When the default format has changed after a major new release of
3764
Bazaar, you may be informed during certain operations that you
3765
should upgrade. Upgrading to a newer format may improve performance
3766
or make new features available. It may however limit interoperability
3767
with older repositories or with older versions of Bazaar.
3769
If you wish to upgrade to a particular format rather than the
3770
current default, that can be specified using the --format option.
3771
As a consequence, you can use the upgrade command this way to
3772
"downgrade" to an earlier format, though some conversions are
3773
a one way process (e.g. changing from the 1.x default to the
3774
2.x default) so downgrading is not always possible.
3776
A backup.bzr.~#~ directory is created at the start of the conversion
3777
process (where # is a number). By default, this is left there on
3778
completion. If the conversion fails, delete the new .bzr directory
3779
and rename this one back in its place. Use the --clean option to ask
3780
for the backup.bzr directory to be removed on successful conversion.
3781
Alternatively, you can delete it by hand if everything looks good
3784
If the location given is a shared repository, dependent branches
3785
are also converted provided the repository converts successfully.
3786
If the conversion of a branch fails, remaining branches are still
3789
For more information on upgrades, see the Bazaar Upgrade Guide,
3790
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3793
_see_also = ['check', 'reconcile', 'formats']
3794
takes_args = ['url?']
3796
RegistryOption('format',
3797
help='Upgrade to a specific format. See "brz help'
3798
' formats" for details.',
3799
lazy_registry=('breezy.controldir', 'format_registry'),
3800
converter=lambda name: controldir.format_registry.make_controldir(name),
3801
value_switches=True, title='Branch format'),
3803
help='Remove the backup.bzr directory if successful.'),
3805
help="Show what would be done, but don't actually do anything."),
3808
def run(self, url='.', format=None, clean=False, dry_run=False):
3809
from .upgrade import upgrade
3810
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3812
if len(exceptions) == 1:
3813
# Compatibility with historical behavior
3819
class cmd_whoami(Command):
3820
__doc__ = """Show or set brz user id.
3823
Show the email of the current user::
3827
Set the current user::
3829
brz whoami "Frank Chu <fchu@example.com>"
3831
takes_options = [ 'directory',
3833
help='Display email address only.'),
3835
help='Set identity for the current branch instead of '
3838
takes_args = ['name?']
3839
encoding_type = 'replace'
3842
def run(self, email=False, branch=False, name=None, directory=None):
3844
if directory is None:
3845
# use branch if we're inside one; otherwise global config
3847
c = Branch.open_containing(u'.')[0].get_config_stack()
3848
except errors.NotBranchError:
3849
c = _mod_config.GlobalStack()
3851
c = Branch.open(directory).get_config_stack()
3852
identity = c.get('email')
3854
self.outf.write(_mod_config.extract_email_address(identity)
3857
self.outf.write(identity + '\n')
3861
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3864
# display a warning if an email address isn't included in the given name.
3866
_mod_config.extract_email_address(name)
3867
except _mod_config.NoEmailInUsername as e:
3868
warning('"%s" does not seem to contain an email address. '
3869
'This is allowed, but not recommended.', name)
3871
# use global config unless --branch given
3873
if directory is None:
3874
c = Branch.open_containing(u'.')[0].get_config_stack()
3876
b = Branch.open(directory)
3877
self.add_cleanup(b.lock_write().unlock)
3878
c = b.get_config_stack()
3880
c = _mod_config.GlobalStack()
3881
c.set('email', name)
3884
class cmd_nick(Command):
3885
__doc__ = """Print or set the branch nickname.
3887
If unset, the colocated branch name is used for colocated branches, and
3888
the branch directory name is used for other branches. To print the
3889
current nickname, execute with no argument.
3891
Bound branches use the nickname of its master branch unless it is set
3895
_see_also = ['info']
3896
takes_args = ['nickname?']
3897
takes_options = ['directory']
3898
def run(self, nickname=None, directory=u'.'):
3899
branch = Branch.open_containing(directory)[0]
3900
if nickname is None:
3901
self.printme(branch)
3903
branch.nick = nickname
3906
def printme(self, branch):
3907
self.outf.write('%s\n' % branch.nick)
3910
class cmd_alias(Command):
3911
__doc__ = """Set/unset and display aliases.
3914
Show the current aliases::
3918
Show the alias specified for 'll'::
3922
Set an alias for 'll'::
3924
brz alias ll="log --line -r-10..-1"
3926
To remove an alias for 'll'::
3928
brz alias --remove ll
3931
takes_args = ['name?']
3933
Option('remove', help='Remove the alias.'),
3936
def run(self, name=None, remove=False):
3938
self.remove_alias(name)
3940
self.print_aliases()
3942
equal_pos = name.find('=')
3944
self.print_alias(name)
3946
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3948
def remove_alias(self, alias_name):
3949
if alias_name is None:
3950
raise errors.BzrCommandError(gettext(
3951
'brz alias --remove expects an alias to remove.'))
3952
# If alias is not found, print something like:
3953
# unalias: foo: not found
3954
c = _mod_config.GlobalConfig()
3955
c.unset_alias(alias_name)
3958
def print_aliases(self):
3959
"""Print out the defined aliases in a similar format to bash."""
3960
aliases = _mod_config.GlobalConfig().get_aliases()
3961
for key, value in sorted(viewitems(aliases)):
3962
self.outf.write('brz alias %s="%s"\n' % (key, value))
3965
def print_alias(self, alias_name):
3966
from .commands import get_alias
3967
alias = get_alias(alias_name)
3969
self.outf.write("brz alias: %s: not found\n" % alias_name)
3972
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3974
def set_alias(self, alias_name, alias_command):
3975
"""Save the alias in the global config."""
3976
c = _mod_config.GlobalConfig()
3977
c.set_alias(alias_name, alias_command)
3980
class cmd_selftest(Command):
3981
__doc__ = """Run internal test suite.
3983
If arguments are given, they are regular expressions that say which tests
3984
should run. Tests matching any expression are run, and other tests are
3987
Alternatively if --first is given, matching tests are run first and then
3988
all other tests are run. This is useful if you have been working in a
3989
particular area, but want to make sure nothing else was broken.
3991
If --exclude is given, tests that match that regular expression are
3992
excluded, regardless of whether they match --first or not.
3994
To help catch accidential dependencies between tests, the --randomize
3995
option is useful. In most cases, the argument used is the word 'now'.
3996
Note that the seed used for the random number generator is displayed
3997
when this option is used. The seed can be explicitly passed as the
3998
argument to this option if required. This enables reproduction of the
3999
actual ordering used if and when an order sensitive problem is encountered.
4001
If --list-only is given, the tests that would be run are listed. This is
4002
useful when combined with --first, --exclude and/or --randomize to
4003
understand their impact. The test harness reports "Listed nn tests in ..."
4004
instead of "Ran nn tests in ..." when list mode is enabled.
4006
If the global option '--no-plugins' is given, plugins are not loaded
4007
before running the selftests. This has two effects: features provided or
4008
modified by plugins will not be tested, and tests provided by plugins will
4011
Tests that need working space on disk use a common temporary directory,
4012
typically inside $TMPDIR or /tmp.
4014
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4015
into a pdb postmortem session.
4017
The --coverage=DIRNAME global option produces a report with covered code
4021
Run only tests relating to 'ignore'::
4025
Disable plugins and list tests as they're run::
4027
brz --no-plugins selftest -v
4029
# NB: this is used from the class without creating an instance, which is
4030
# why it does not have a self parameter.
4031
def get_transport_type(typestring):
4032
"""Parse and return a transport specifier."""
4033
if typestring == "sftp":
4034
from .tests import stub_sftp
4035
return stub_sftp.SFTPAbsoluteServer
4036
elif typestring == "memory":
4037
from .tests import test_server
4038
return memory.MemoryServer
4039
elif typestring == "fakenfs":
4040
from .tests import test_server
4041
return test_server.FakeNFSServer
4042
msg = "No known transport type %s. Supported types are: sftp\n" %\
4044
raise errors.BzrCommandError(msg)
4047
takes_args = ['testspecs*']
4048
takes_options = ['verbose',
4050
help='Stop when one test fails.',
4054
help='Use a different transport by default '
4055
'throughout the test suite.',
4056
type=get_transport_type),
4058
help='Run the benchmarks rather than selftests.',
4060
Option('lsprof-timed',
4061
help='Generate lsprof output for benchmarked'
4062
' sections of code.'),
4063
Option('lsprof-tests',
4064
help='Generate lsprof output for each test.'),
4066
help='Run all tests, but run specified tests first.',
4070
help='List the tests instead of running them.'),
4071
RegistryOption('parallel',
4072
help="Run the test suite in parallel.",
4073
lazy_registry=('breezy.tests', 'parallel_registry'),
4074
value_switches=False,
4076
Option('randomize', type=str, argname="SEED",
4077
help='Randomize the order of tests using the given'
4078
' seed or "now" for the current time.'),
4079
ListOption('exclude', type=str, argname="PATTERN",
4081
help='Exclude tests that match this regular'
4084
help='Output test progress via subunit.'),
4085
Option('strict', help='Fail on missing dependencies or '
4087
Option('load-list', type=str, argname='TESTLISTFILE',
4088
help='Load a test id list from a text file.'),
4089
ListOption('debugflag', type=str, short_name='E',
4090
help='Turn on a selftest debug flag.'),
4091
ListOption('starting-with', type=str, argname='TESTID',
4092
param_name='starting_with', short_name='s',
4094
'Load only the tests starting with TESTID.'),
4096
help="By default we disable fsync and fdatasync"
4097
" while running the test suite.")
4099
encoding_type = 'replace'
4102
Command.__init__(self)
4103
self.additional_selftest_args = {}
4105
def run(self, testspecs_list=None, verbose=False, one=False,
4106
transport=None, benchmark=None,
4108
first=False, list_only=False,
4109
randomize=None, exclude=None, strict=False,
4110
load_list=None, debugflag=None, starting_with=None, subunit=False,
4111
parallel=None, lsprof_tests=False,
4114
# During selftest, disallow proxying, as it can cause severe
4115
# performance penalties and is only needed for thread
4116
# safety. The selftest command is assumed to not use threads
4117
# too heavily. The call should be as early as possible, as
4118
# error reporting for past duplicate imports won't have useful
4120
lazy_import.disallow_proxying()
4124
if testspecs_list is not None:
4125
pattern = '|'.join(testspecs_list)
4130
from .tests import SubUnitBzrRunner
4132
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4133
"needs to be installed to use --subunit."))
4134
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4135
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4136
# stdout, which would corrupt the subunit stream.
4137
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4138
# following code can be deleted when it's sufficiently deployed
4139
# -- vila/mgz 20100514
4140
if (sys.platform == "win32"
4141
and getattr(sys.stdout, 'fileno', None) is not None):
4143
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4145
self.additional_selftest_args.setdefault(
4146
'suite_decorators', []).append(parallel)
4148
raise errors.BzrCommandError(gettext(
4149
"--benchmark is no longer supported from brz 2.2; "
4150
"use bzr-usertest instead"))
4151
test_suite_factory = None
4153
exclude_pattern = None
4155
exclude_pattern = '(' + '|'.join(exclude) + ')'
4157
self._disable_fsync()
4158
selftest_kwargs = {"verbose": verbose,
4160
"stop_on_failure": one,
4161
"transport": transport,
4162
"test_suite_factory": test_suite_factory,
4163
"lsprof_timed": lsprof_timed,
4164
"lsprof_tests": lsprof_tests,
4165
"matching_tests_first": first,
4166
"list_only": list_only,
4167
"random_seed": randomize,
4168
"exclude_pattern": exclude_pattern,
4170
"load_list": load_list,
4171
"debug_flags": debugflag,
4172
"starting_with": starting_with
4174
selftest_kwargs.update(self.additional_selftest_args)
4176
# Make deprecation warnings visible, unless -Werror is set
4177
cleanup = symbol_versioning.activate_deprecation_warnings(
4180
result = tests.selftest(**selftest_kwargs)
4183
return int(not result)
4185
def _disable_fsync(self):
4186
"""Change the 'os' functionality to not synchronize."""
4187
self._orig_fsync = getattr(os, 'fsync', None)
4188
if self._orig_fsync is not None:
4189
os.fsync = lambda filedes: None
4190
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4191
if self._orig_fdatasync is not None:
4192
os.fdatasync = lambda filedes: None
4195
class cmd_version(Command):
4196
__doc__ = """Show version of brz."""
4198
encoding_type = 'replace'
4200
Option("short", help="Print just the version number."),
4204
def run(self, short=False):
4205
from .version import show_version
4207
self.outf.write(breezy.version_string + '\n')
4209
show_version(to_file=self.outf)
4212
class cmd_rocks(Command):
4213
__doc__ = """Statement of optimism."""
4219
self.outf.write(gettext("It sure does!\n"))
4222
class cmd_find_merge_base(Command):
4223
__doc__ = """Find and print a base revision for merging two branches."""
4224
# TODO: Options to specify revisions on either side, as if
4225
# merging only part of the history.
4226
takes_args = ['branch', 'other']
4230
def run(self, branch, other):
4231
from .revision import ensure_null
4233
branch1 = Branch.open_containing(branch)[0]
4234
branch2 = Branch.open_containing(other)[0]
4235
self.add_cleanup(branch1.lock_read().unlock)
4236
self.add_cleanup(branch2.lock_read().unlock)
4237
last1 = ensure_null(branch1.last_revision())
4238
last2 = ensure_null(branch2.last_revision())
4240
graph = branch1.repository.get_graph(branch2.repository)
4241
base_rev_id = graph.find_unique_lca(last1, last2)
4243
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4246
class cmd_merge(Command):
4247
__doc__ = """Perform a three-way merge.
4249
The source of the merge can be specified either in the form of a branch,
4250
or in the form of a path to a file containing a merge directive generated
4251
with brz send. If neither is specified, the default is the upstream branch
4252
or the branch most recently merged using --remember. The source of the
4253
merge may also be specified in the form of a path to a file in another
4254
branch: in this case, only the modifications to that file are merged into
4255
the current working tree.
4257
When merging from a branch, by default brz will try to merge in all new
4258
work from the other branch, automatically determining an appropriate base
4259
revision. If this fails, you may need to give an explicit base.
4261
To pick a different ending revision, pass "--revision OTHER". brz will
4262
try to merge in all new work up to and including revision OTHER.
4264
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4265
through OTHER, excluding BASE but including OTHER, will be merged. If this
4266
causes some revisions to be skipped, i.e. if the destination branch does
4267
not already contain revision BASE, such a merge is commonly referred to as
4268
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4269
cherrypicks. The changes look like a normal commit, and the history of the
4270
changes from the other branch is not stored in the commit.
4272
Revision numbers are always relative to the source branch.
4274
Merge will do its best to combine the changes in two branches, but there
4275
are some kinds of problems only a human can fix. When it encounters those,
4276
it will mark a conflict. A conflict means that you need to fix something,
4277
before you can commit.
4279
Use brz resolve when you have fixed a problem. See also brz conflicts.
4281
If there is no default branch set, the first merge will set it (use
4282
--no-remember to avoid setting it). After that, you can omit the branch
4283
to use the default. To change the default, use --remember. The value will
4284
only be saved if the remote location can be accessed.
4286
The results of the merge are placed into the destination working
4287
directory, where they can be reviewed (with brz diff), tested, and then
4288
committed to record the result of the merge.
4290
merge refuses to run if there are any uncommitted changes, unless
4291
--force is given. If --force is given, then the changes from the source
4292
will be merged with the current working tree, including any uncommitted
4293
changes in the tree. The --force option can also be used to create a
4294
merge revision which has more than two parents.
4296
If one would like to merge changes from the working tree of the other
4297
branch without merging any committed revisions, the --uncommitted option
4300
To select only some changes to merge, use "merge -i", which will prompt
4301
you to apply each diff hunk and file change, similar to "shelve".
4304
To merge all new revisions from brz.dev::
4306
brz merge ../brz.dev
4308
To merge changes up to and including revision 82 from brz.dev::
4310
brz merge -r 82 ../brz.dev
4312
To merge the changes introduced by 82, without previous changes::
4314
brz merge -r 81..82 ../brz.dev
4316
To apply a merge directive contained in /tmp/merge::
4318
brz merge /tmp/merge
4320
To create a merge revision with three parents from two branches
4321
feature1a and feature1b:
4323
brz merge ../feature1a
4324
brz merge ../feature1b --force
4325
brz commit -m 'revision with three parents'
4328
encoding_type = 'exact'
4329
_see_also = ['update', 'remerge', 'status-flags', 'send']
4330
takes_args = ['location?']
4335
help='Merge even if the destination tree has uncommitted changes.'),
4339
Option('show-base', help="Show base revision text in "
4341
Option('uncommitted', help='Apply uncommitted changes'
4342
' from a working copy, instead of branch changes.'),
4343
Option('pull', help='If the destination is already'
4344
' completely merged into the source, pull from the'
4345
' source rather than merging. When this happens,'
4346
' you do not need to commit the result.'),
4347
custom_help('directory',
4348
help='Branch to merge into, '
4349
'rather than the one containing the working directory.'),
4350
Option('preview', help='Instead of merging, show a diff of the'
4352
Option('interactive', help='Select changes interactively.',
4356
def run(self, location=None, revision=None, force=False,
4357
merge_type=None, show_base=False, reprocess=None, remember=None,
4358
uncommitted=False, pull=False,
4363
if merge_type is None:
4364
merge_type = _mod_merge.Merge3Merger
4366
if directory is None: directory = u'.'
4367
possible_transports = []
4369
allow_pending = True
4370
verified = 'inapplicable'
4372
tree = WorkingTree.open_containing(directory)[0]
4373
if tree.branch.revno() == 0:
4374
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4375
'https://bugs.launchpad.net/bzr/+bug/308562'))
4378
basis_tree = tree.revision_tree(tree.last_revision())
4379
except errors.NoSuchRevision:
4380
basis_tree = tree.basis_tree()
4382
# die as quickly as possible if there are uncommitted changes
4384
if tree.has_changes():
4385
raise errors.UncommittedChanges(tree)
4387
view_info = _get_view_info_for_change_reporter(tree)
4388
change_reporter = delta._ChangeReporter(
4389
unversioned_filter=tree.is_ignored, view_info=view_info)
4390
pb = ui.ui_factory.nested_progress_bar()
4391
self.add_cleanup(pb.finished)
4392
self.add_cleanup(tree.lock_write().unlock)
4393
if location is not None:
4395
mergeable = bundle.read_mergeable_from_url(location,
4396
possible_transports=possible_transports)
4397
except errors.NotABundle:
4401
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4402
' with bundles or merge directives.'))
4404
if revision is not None:
4405
raise errors.BzrCommandError(gettext(
4406
'Cannot use -r with merge directives or bundles'))
4407
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4410
if merger is None and uncommitted:
4411
if revision is not None and len(revision) > 0:
4412
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4413
' --revision at the same time.'))
4414
merger = self.get_merger_from_uncommitted(tree, location, None)
4415
allow_pending = False
4418
merger, allow_pending = self._get_merger_from_branch(tree,
4419
location, revision, remember, possible_transports, None)
4421
merger.merge_type = merge_type
4422
merger.reprocess = reprocess
4423
merger.show_base = show_base
4424
self.sanity_check_merger(merger)
4425
if (merger.base_rev_id == merger.other_rev_id and
4426
merger.other_rev_id is not None):
4427
# check if location is a nonexistent file (and not a branch) to
4428
# disambiguate the 'Nothing to do'
4429
if merger.interesting_files:
4430
if not merger.other_tree.has_filename(
4431
merger.interesting_files[0]):
4432
note(gettext("merger: ") + str(merger))
4433
raise errors.PathsDoNotExist([location])
4434
note(gettext('Nothing to do.'))
4436
if pull and not preview:
4437
if merger.interesting_files is not None:
4438
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4439
if (merger.base_rev_id == tree.last_revision()):
4440
result = tree.pull(merger.other_branch, False,
4441
merger.other_rev_id)
4442
result.report(self.outf)
4444
if merger.this_basis is None:
4445
raise errors.BzrCommandError(gettext(
4446
"This branch has no commits."
4447
" (perhaps you would prefer 'brz pull')"))
4449
return self._do_preview(merger)
4451
return self._do_interactive(merger)
4453
return self._do_merge(merger, change_reporter, allow_pending,
4456
def _get_preview(self, merger):
4457
tree_merger = merger.make_merger()
4458
tt = tree_merger.make_preview_transform()
4459
self.add_cleanup(tt.finalize)
4460
result_tree = tt.get_preview_tree()
4463
def _do_preview(self, merger):
4464
from .diff import show_diff_trees
4465
result_tree = self._get_preview(merger)
4466
path_encoding = osutils.get_diff_header_encoding()
4467
show_diff_trees(merger.this_tree, result_tree, self.outf,
4468
old_label='', new_label='',
4469
path_encoding=path_encoding)
4471
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4472
merger.change_reporter = change_reporter
4473
conflict_count = merger.do_merge()
4475
merger.set_pending()
4476
if verified == 'failed':
4477
warning('Preview patch does not match changes')
4478
if conflict_count != 0:
4483
def _do_interactive(self, merger):
4484
"""Perform an interactive merge.
4486
This works by generating a preview tree of the merge, then using
4487
Shelver to selectively remove the differences between the working tree
4488
and the preview tree.
4490
from . import shelf_ui
4491
result_tree = self._get_preview(merger)
4492
writer = breezy.option.diff_writer_registry.get()
4493
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4494
reporter=shelf_ui.ApplyReporter(),
4495
diff_writer=writer(sys.stdout))
4501
def sanity_check_merger(self, merger):
4502
if (merger.show_base and
4503
not merger.merge_type is _mod_merge.Merge3Merger):
4504
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4505
" merge type. %s") % merger.merge_type)
4506
if merger.reprocess is None:
4507
if merger.show_base:
4508
merger.reprocess = False
4510
# Use reprocess if the merger supports it
4511
merger.reprocess = merger.merge_type.supports_reprocess
4512
if merger.reprocess and not merger.merge_type.supports_reprocess:
4513
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4514
" for merge type %s.") %
4516
if merger.reprocess and merger.show_base:
4517
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4520
def _get_merger_from_branch(self, tree, location, revision, remember,
4521
possible_transports, pb):
4522
"""Produce a merger from a location, assuming it refers to a branch."""
4523
# find the branch locations
4524
other_loc, user_location = self._select_branch_location(tree, location,
4526
if revision is not None and len(revision) == 2:
4527
base_loc, _unused = self._select_branch_location(tree,
4528
location, revision, 0)
4530
base_loc = other_loc
4532
other_branch, other_path = Branch.open_containing(other_loc,
4533
possible_transports)
4534
if base_loc == other_loc:
4535
base_branch = other_branch
4537
base_branch, base_path = Branch.open_containing(base_loc,
4538
possible_transports)
4539
# Find the revision ids
4540
other_revision_id = None
4541
base_revision_id = None
4542
if revision is not None:
4543
if len(revision) >= 1:
4544
other_revision_id = revision[-1].as_revision_id(other_branch)
4545
if len(revision) == 2:
4546
base_revision_id = revision[0].as_revision_id(base_branch)
4547
if other_revision_id is None:
4548
other_revision_id = _mod_revision.ensure_null(
4549
other_branch.last_revision())
4550
# Remember where we merge from. We need to remember if:
4551
# - user specify a location (and we don't merge from the parent
4553
# - user ask to remember or there is no previous location set to merge
4554
# from and user didn't ask to *not* remember
4555
if (user_location is not None
4557
or (remember is None
4558
and tree.branch.get_submit_branch() is None)))):
4559
tree.branch.set_submit_branch(other_branch.base)
4560
# Merge tags (but don't set them in the master branch yet, the user
4561
# might revert this merge). Commit will propagate them.
4562
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4563
merger = _mod_merge.Merger.from_revision_ids(tree,
4564
other_revision_id, base_revision_id, other_branch, base_branch)
4565
if other_path != '':
4566
allow_pending = False
4567
merger.interesting_files = [other_path]
4569
allow_pending = True
4570
return merger, allow_pending
4572
def get_merger_from_uncommitted(self, tree, location, pb):
4573
"""Get a merger for uncommitted changes.
4575
:param tree: The tree the merger should apply to.
4576
:param location: The location containing uncommitted changes.
4577
:param pb: The progress bar to use for showing progress.
4579
location = self._select_branch_location(tree, location)[0]
4580
other_tree, other_path = WorkingTree.open_containing(location)
4581
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4582
if other_path != '':
4583
merger.interesting_files = [other_path]
4586
def _select_branch_location(self, tree, user_location, revision=None,
4588
"""Select a branch location, according to possible inputs.
4590
If provided, branches from ``revision`` are preferred. (Both
4591
``revision`` and ``index`` must be supplied.)
4593
Otherwise, the ``location`` parameter is used. If it is None, then the
4594
``submit`` or ``parent`` location is used, and a note is printed.
4596
:param tree: The working tree to select a branch for merging into
4597
:param location: The location entered by the user
4598
:param revision: The revision parameter to the command
4599
:param index: The index to use for the revision parameter. Negative
4600
indices are permitted.
4601
:return: (selected_location, user_location). The default location
4602
will be the user-entered location.
4604
if (revision is not None and index is not None
4605
and revision[index] is not None):
4606
branch = revision[index].get_branch()
4607
if branch is not None:
4608
return branch, branch
4609
if user_location is None:
4610
location = self._get_remembered(tree, 'Merging from')
4612
location = user_location
4613
return location, user_location
4615
def _get_remembered(self, tree, verb_string):
4616
"""Use tree.branch's parent if none was supplied.
4618
Report if the remembered location was used.
4620
stored_location = tree.branch.get_submit_branch()
4621
stored_location_type = "submit"
4622
if stored_location is None:
4623
stored_location = tree.branch.get_parent()
4624
stored_location_type = "parent"
4625
mutter("%s", stored_location)
4626
if stored_location is None:
4627
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4628
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4629
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4630
stored_location_type, display_url))
4631
return stored_location
4634
class cmd_remerge(Command):
4635
__doc__ = """Redo a merge.
4637
Use this if you want to try a different merge technique while resolving
4638
conflicts. Some merge techniques are better than others, and remerge
4639
lets you try different ones on different files.
4641
The options for remerge have the same meaning and defaults as the ones for
4642
merge. The difference is that remerge can (only) be run when there is a
4643
pending merge, and it lets you specify particular files.
4646
Re-do the merge of all conflicted files, and show the base text in
4647
conflict regions, in addition to the usual THIS and OTHER texts::
4649
brz remerge --show-base
4651
Re-do the merge of "foobar", using the weave merge algorithm, with
4652
additional processing to reduce the size of conflict regions::
4654
brz remerge --merge-type weave --reprocess foobar
4656
takes_args = ['file*']
4661
help="Show base revision text in conflicts."),
4664
def run(self, file_list=None, merge_type=None, show_base=False,
4666
from .conflicts import restore
4667
if merge_type is None:
4668
merge_type = _mod_merge.Merge3Merger
4669
tree, file_list = WorkingTree.open_containing_paths(file_list)
4670
self.add_cleanup(tree.lock_write().unlock)
4671
parents = tree.get_parent_ids()
4672
if len(parents) != 2:
4673
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4674
" merges. Not cherrypicking or"
4676
repository = tree.branch.repository
4677
interesting_ids = None
4679
conflicts = tree.conflicts()
4680
if file_list is not None:
4681
interesting_ids = set()
4682
for filename in file_list:
4683
file_id = tree.path2id(filename)
4685
raise errors.NotVersionedError(filename)
4686
interesting_ids.add(file_id)
4687
if tree.kind(file_id) != "directory":
4690
# FIXME: Support nested trees
4691
for name, ie in tree.root_inventory.iter_entries(file_id):
4692
interesting_ids.add(ie.file_id)
4693
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4695
# Remerge only supports resolving contents conflicts
4696
allowed_conflicts = ('text conflict', 'contents conflict')
4697
restore_files = [c.path for c in conflicts
4698
if c.typestring in allowed_conflicts]
4699
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4700
tree.set_conflicts(ConflictList(new_conflicts))
4701
if file_list is not None:
4702
restore_files = file_list
4703
for filename in restore_files:
4705
restore(tree.abspath(filename))
4706
except errors.NotConflicted:
4708
# Disable pending merges, because the file texts we are remerging
4709
# have not had those merges performed. If we use the wrong parents
4710
# list, we imply that the working tree text has seen and rejected
4711
# all the changes from the other tree, when in fact those changes
4712
# have not yet been seen.
4713
tree.set_parent_ids(parents[:1])
4715
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4716
merger.interesting_ids = interesting_ids
4717
merger.merge_type = merge_type
4718
merger.show_base = show_base
4719
merger.reprocess = reprocess
4720
conflicts = merger.do_merge()
4722
tree.set_parent_ids(parents)
4729
class cmd_revert(Command):
4731
Set files in the working tree back to the contents of a previous revision.
4733
Giving a list of files will revert only those files. Otherwise, all files
4734
will be reverted. If the revision is not specified with '--revision', the
4735
working tree basis revision is used. A revert operation affects only the
4736
working tree, not any revision history like the branch and repository or
4737
the working tree basis revision.
4739
To remove only some changes, without reverting to a prior version, use
4740
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4741
will remove the changes introduced by the second last commit (-2), without
4742
affecting the changes introduced by the last commit (-1). To remove
4743
certain changes on a hunk-by-hunk basis, see the shelve command.
4744
To update the branch to a specific revision or the latest revision and
4745
update the working tree accordingly while preserving local changes, see the
4748
Uncommitted changes to files that are reverted will be discarded.
4749
Howver, by default, any files that have been manually changed will be
4750
backed up first. (Files changed only by merge are not backed up.) Backup
4751
files have '.~#~' appended to their name, where # is a number.
4753
When you provide files, you can use their current pathname or the pathname
4754
from the target revision. So you can use revert to "undelete" a file by
4755
name. If you name a directory, all the contents of that directory will be
4758
If you have newly added files since the target revision, they will be
4759
removed. If the files to be removed have been changed, backups will be
4760
created as above. Directories containing unknown files will not be
4763
The working tree contains a list of revisions that have been merged but
4764
not yet committed. These revisions will be included as additional parents
4765
of the next commit. Normally, using revert clears that list as well as
4766
reverting the files. If any files are specified, revert leaves the list
4767
of uncommitted merges alone and reverts only the files. Use ``brz revert
4768
.`` in the tree root to revert all files but keep the recorded merges,
4769
and ``brz revert --forget-merges`` to clear the pending merge list without
4770
reverting any files.
4772
Using "brz revert --forget-merges", it is possible to apply all of the
4773
changes from a branch in a single revision. To do this, perform the merge
4774
as desired. Then doing revert with the "--forget-merges" option will keep
4775
the content of the tree as it was, but it will clear the list of pending
4776
merges. The next commit will then contain all of the changes that are
4777
present in the other branch, but without any other parent revisions.
4778
Because this technique forgets where these changes originated, it may
4779
cause additional conflicts on later merges involving the same source and
4783
_see_also = ['cat', 'export', 'merge', 'shelve']
4786
Option('no-backup', "Do not save backups of reverted files."),
4787
Option('forget-merges',
4788
'Remove pending merge marker, without changing any files.'),
4790
takes_args = ['file*']
4792
def run(self, revision=None, no_backup=False, file_list=None,
4793
forget_merges=None):
4794
tree, file_list = WorkingTree.open_containing_paths(file_list)
4795
self.add_cleanup(tree.lock_tree_write().unlock)
4797
tree.set_parent_ids(tree.get_parent_ids()[:1])
4799
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4802
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4803
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4804
tree.revert(file_list, rev_tree, not no_backup, None,
4805
report_changes=True)
4808
class cmd_assert_fail(Command):
4809
__doc__ = """Test reporting of assertion failures"""
4810
# intended just for use in testing
4815
raise AssertionError("always fails")
4818
class cmd_help(Command):
4819
__doc__ = """Show help on a command or other topic.
4822
_see_also = ['topics']
4824
Option('long', 'Show help on all commands.'),
4826
takes_args = ['topic?']
4827
aliases = ['?', '--help', '-?', '-h']
4830
def run(self, topic=None, long=False):
4832
if topic is None and long:
4834
breezy.help.help(topic)
4837
class cmd_shell_complete(Command):
4838
__doc__ = """Show appropriate completions for context.
4840
For a list of all available commands, say 'brz shell-complete'.
4842
takes_args = ['context?']
4847
def run(self, context=None):
4848
from . import shellcomplete
4849
shellcomplete.shellcomplete(context)
4852
class cmd_missing(Command):
4853
__doc__ = """Show unmerged/unpulled revisions between two branches.
4855
OTHER_BRANCH may be local or remote.
4857
To filter on a range of revisions, you can use the command -r begin..end
4858
-r revision requests a specific revision, -r ..end or -r begin.. are
4862
1 - some missing revisions
4863
0 - no missing revisions
4867
Determine the missing revisions between this and the branch at the
4868
remembered pull location::
4872
Determine the missing revisions between this and another branch::
4874
brz missing http://server/branch
4876
Determine the missing revisions up to a specific revision on the other
4879
brz missing -r ..-10
4881
Determine the missing revisions up to a specific revision on this
4884
brz missing --my-revision ..-10
4887
_see_also = ['merge', 'pull']
4888
takes_args = ['other_branch?']
4891
Option('reverse', 'Reverse the order of revisions.'),
4893
'Display changes in the local branch only.'),
4894
Option('this' , 'Same as --mine-only.'),
4895
Option('theirs-only',
4896
'Display changes in the remote branch only.'),
4897
Option('other', 'Same as --theirs-only.'),
4901
custom_help('revision',
4902
help='Filter on other branch revisions (inclusive). '
4903
'See "help revisionspec" for details.'),
4904
Option('my-revision',
4905
type=_parse_revision_str,
4906
help='Filter on local branch revisions (inclusive). '
4907
'See "help revisionspec" for details.'),
4908
Option('include-merged',
4909
'Show all revisions in addition to the mainline ones.'),
4910
Option('include-merges', hidden=True,
4911
help='Historical alias for --include-merged.'),
4913
encoding_type = 'replace'
4916
def run(self, other_branch=None, reverse=False, mine_only=False,
4918
log_format=None, long=False, short=False, line=False,
4919
show_ids=False, verbose=False, this=False, other=False,
4920
include_merged=None, revision=None, my_revision=None,
4922
from breezy.missing import find_unmerged, iter_log_revisions
4927
if include_merged is None:
4928
include_merged = False
4933
# TODO: We should probably check that we don't have mine-only and
4934
# theirs-only set, but it gets complicated because we also have
4935
# this and other which could be used.
4942
local_branch = Branch.open_containing(directory)[0]
4943
self.add_cleanup(local_branch.lock_read().unlock)
4945
parent = local_branch.get_parent()
4946
if other_branch is None:
4947
other_branch = parent
4948
if other_branch is None:
4949
raise errors.BzrCommandError(gettext("No peer location known"
4951
display_url = urlutils.unescape_for_display(parent,
4953
message(gettext("Using saved parent location: {0}\n").format(
4956
remote_branch = Branch.open(other_branch)
4957
if remote_branch.base == local_branch.base:
4958
remote_branch = local_branch
4960
self.add_cleanup(remote_branch.lock_read().unlock)
4962
local_revid_range = _revision_range_to_revid_range(
4963
_get_revision_range(my_revision, local_branch,
4966
remote_revid_range = _revision_range_to_revid_range(
4967
_get_revision_range(revision,
4968
remote_branch, self.name()))
4970
local_extra, remote_extra = find_unmerged(
4971
local_branch, remote_branch, restrict,
4972
backward=not reverse,
4973
include_merged=include_merged,
4974
local_revid_range=local_revid_range,
4975
remote_revid_range=remote_revid_range)
4977
if log_format is None:
4978
registry = log.log_formatter_registry
4979
log_format = registry.get_default(local_branch)
4980
lf = log_format(to_file=self.outf,
4982
show_timezone='original')
4985
if local_extra and not theirs_only:
4986
message(ngettext("You have %d extra revision:\n",
4987
"You have %d extra revisions:\n",
4991
if local_branch.supports_tags():
4992
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
4993
for revision in iter_log_revisions(local_extra,
4994
local_branch.repository,
4997
lf.log_revision(revision)
4998
printed_local = True
5001
printed_local = False
5003
if remote_extra and not mine_only:
5004
if printed_local is True:
5006
message(ngettext("You are missing %d revision:\n",
5007
"You are missing %d revisions:\n",
5008
len(remote_extra)) %
5010
if remote_branch.supports_tags():
5011
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5012
for revision in iter_log_revisions(remote_extra,
5013
remote_branch.repository,
5016
lf.log_revision(revision)
5019
if mine_only and not local_extra:
5020
# We checked local, and found nothing extra
5021
message(gettext('This branch has no new revisions.\n'))
5022
elif theirs_only and not remote_extra:
5023
# We checked remote, and found nothing extra
5024
message(gettext('Other branch has no new revisions.\n'))
5025
elif not (mine_only or theirs_only or local_extra or
5027
# We checked both branches, and neither one had extra
5029
message(gettext("Branches are up to date.\n"))
5031
if not status_code and parent is None and other_branch is not None:
5032
self.add_cleanup(local_branch.lock_write().unlock)
5033
# handle race conditions - a parent might be set while we run.
5034
if local_branch.get_parent() is None:
5035
local_branch.set_parent(remote_branch.base)
5039
class cmd_pack(Command):
5040
__doc__ = """Compress the data within a repository.
5042
This operation compresses the data within a bazaar repository. As
5043
bazaar supports automatic packing of repository, this operation is
5044
normally not required to be done manually.
5046
During the pack operation, bazaar takes a backup of existing repository
5047
data, i.e. pack files. This backup is eventually removed by bazaar
5048
automatically when it is safe to do so. To save disk space by removing
5049
the backed up pack files, the --clean-obsolete-packs option may be
5052
Warning: If you use --clean-obsolete-packs and your machine crashes
5053
during or immediately after repacking, you may be left with a state
5054
where the deletion has been written to disk but the new packs have not
5055
been. In this case the repository may be unusable.
5058
_see_also = ['repositories']
5059
takes_args = ['branch_or_repo?']
5061
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5064
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5065
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5067
branch = dir.open_branch()
5068
repository = branch.repository
5069
except errors.NotBranchError:
5070
repository = dir.open_repository()
5071
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5074
class cmd_plugins(Command):
5075
__doc__ = """List the installed plugins.
5077
This command displays the list of installed plugins including
5078
version of plugin and a short description of each.
5080
--verbose shows the path where each plugin is located.
5082
A plugin is an external component for Bazaar that extends the
5083
revision control system, by adding or replacing code in Bazaar.
5084
Plugins can do a variety of things, including overriding commands,
5085
adding new commands, providing additional network transports and
5086
customizing log output.
5088
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5089
for further information on plugins including where to find them and how to
5090
install them. Instructions are also provided there on how to write new
5091
plugins using the Python programming language.
5093
takes_options = ['verbose']
5096
def run(self, verbose=False):
5097
from . import plugin
5098
# Don't give writelines a generator as some codecs don't like that
5099
self.outf.writelines(
5100
list(plugin.describe_plugins(show_paths=verbose)))
5103
class cmd_testament(Command):
5104
__doc__ = """Show testament (signing-form) of a revision."""
5107
Option('long', help='Produce long-format testament.'),
5109
help='Produce a strict-format testament.')]
5110
takes_args = ['branch?']
5111
encoding_type = 'exact'
5113
def run(self, branch=u'.', revision=None, long=False, strict=False):
5114
from .testament import Testament, StrictTestament
5116
testament_class = StrictTestament
5118
testament_class = Testament
5120
b = Branch.open_containing(branch)[0]
5122
b = Branch.open(branch)
5123
self.add_cleanup(b.lock_read().unlock)
5124
if revision is None:
5125
rev_id = b.last_revision()
5127
rev_id = revision[0].as_revision_id(b)
5128
t = testament_class.from_revision(b.repository, rev_id)
5130
self.outf.writelines(t.as_text_lines())
5132
self.outf.write(t.as_short_text())
5135
class cmd_annotate(Command):
5136
__doc__ = """Show the origin of each line in a file.
5138
This prints out the given file with an annotation on the left side
5139
indicating which revision, author and date introduced the change.
5141
If the origin is the same for a run of consecutive lines, it is
5142
shown only at the top, unless the --all option is given.
5144
# TODO: annotate directories; showing when each file was last changed
5145
# TODO: if the working copy is modified, show annotations on that
5146
# with new uncommitted lines marked
5147
aliases = ['ann', 'blame', 'praise']
5148
takes_args = ['filename']
5149
takes_options = [Option('all', help='Show annotations on all lines.'),
5150
Option('long', help='Show commit date in annotations.'),
5155
encoding_type = 'exact'
5158
def run(self, filename, all=False, long=False, revision=None,
5159
show_ids=False, directory=None):
5160
from .annotate import (
5163
wt, branch, relpath = \
5164
_open_directory_or_containing_tree_or_branch(filename, directory)
5166
self.add_cleanup(wt.lock_read().unlock)
5168
self.add_cleanup(branch.lock_read().unlock)
5169
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5170
self.add_cleanup(tree.lock_read().unlock)
5171
if wt is not None and revision is None:
5172
file_id = wt.path2id(relpath)
5174
file_id = tree.path2id(relpath)
5176
raise errors.NotVersionedError(filename)
5177
if wt is not None and revision is None:
5178
# If there is a tree and we're not annotating historical
5179
# versions, annotate the working tree's content.
5180
annotate_file_tree(wt, file_id, self.outf, long, all,
5183
annotate_file_tree(tree, file_id, self.outf, long, all,
5184
show_ids=show_ids, branch=branch)
5187
class cmd_re_sign(Command):
5188
__doc__ = """Create a digital signature for an existing revision."""
5189
# TODO be able to replace existing ones.
5191
hidden = True # is this right ?
5192
takes_args = ['revision_id*']
5193
takes_options = ['directory', 'revision']
5195
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5196
if revision_id_list is not None and revision is not None:
5197
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5198
if revision_id_list is None and revision is None:
5199
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5200
b = WorkingTree.open_containing(directory)[0].branch
5201
self.add_cleanup(b.lock_write().unlock)
5202
return self._run(b, revision_id_list, revision)
5204
def _run(self, b, revision_id_list, revision):
5206
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5207
if revision_id_list is not None:
5208
b.repository.start_write_group()
5210
for revision_id in revision_id_list:
5211
revision_id = cache_utf8.encode(revision_id)
5212
b.repository.sign_revision(revision_id, gpg_strategy)
5214
b.repository.abort_write_group()
5217
b.repository.commit_write_group()
5218
elif revision is not None:
5219
if len(revision) == 1:
5220
revno, rev_id = revision[0].in_history(b)
5221
b.repository.start_write_group()
5223
b.repository.sign_revision(rev_id, gpg_strategy)
5225
b.repository.abort_write_group()
5228
b.repository.commit_write_group()
5229
elif len(revision) == 2:
5230
# are they both on rh- if so we can walk between them
5231
# might be nice to have a range helper for arbitrary
5232
# revision paths. hmm.
5233
from_revno, from_revid = revision[0].in_history(b)
5234
to_revno, to_revid = revision[1].in_history(b)
5235
if to_revid is None:
5236
to_revno = b.revno()
5237
if from_revno is None or to_revno is None:
5238
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5239
b.repository.start_write_group()
5241
for revno in range(from_revno, to_revno + 1):
5242
b.repository.sign_revision(b.get_rev_id(revno),
5245
b.repository.abort_write_group()
5248
b.repository.commit_write_group()
5250
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5253
class cmd_bind(Command):
5254
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5255
If no branch is supplied, rebind to the last bound location.
5257
Once converted into a checkout, commits must succeed on the master branch
5258
before they will be applied to the local branch.
5260
Bound branches use the nickname of its master branch unless it is set
5261
locally, in which case binding will update the local nickname to be
5265
_see_also = ['checkouts', 'unbind']
5266
takes_args = ['location?']
5267
takes_options = ['directory']
5269
def run(self, location=None, directory=u'.'):
5270
b, relpath = Branch.open_containing(directory)
5271
if location is None:
5273
location = b.get_old_bound_location()
5274
except errors.UpgradeRequired:
5275
raise errors.BzrCommandError(gettext('No location supplied. '
5276
'This format does not remember old locations.'))
5278
if location is None:
5279
if b.get_bound_location() is not None:
5280
raise errors.BzrCommandError(
5281
gettext('Branch is already bound'))
5283
raise errors.BzrCommandError(
5284
gettext('No location supplied'
5285
' and no previous location known'))
5286
b_other = Branch.open(location)
5289
except errors.DivergedBranches:
5290
raise errors.BzrCommandError(gettext('These branches have diverged.'
5291
' Try merging, and then bind again.'))
5292
if b.get_config().has_explicit_nickname():
5293
b.nick = b_other.nick
5296
class cmd_unbind(Command):
5297
__doc__ = """Convert the current checkout into a regular branch.
5299
After unbinding, the local branch is considered independent and subsequent
5300
commits will be local only.
5303
_see_also = ['checkouts', 'bind']
5305
takes_options = ['directory']
5307
def run(self, directory=u'.'):
5308
b, relpath = Branch.open_containing(directory)
5310
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5313
class cmd_uncommit(Command):
5314
__doc__ = """Remove the last committed revision.
5316
--verbose will print out what is being removed.
5317
--dry-run will go through all the motions, but not actually
5320
If --revision is specified, uncommit revisions to leave the branch at the
5321
specified revision. For example, "brz uncommit -r 15" will leave the
5322
branch at revision 15.
5324
Uncommit leaves the working tree ready for a new commit. The only change
5325
it may make is to restore any pending merges that were present before
5329
# TODO: jam 20060108 Add an option to allow uncommit to remove
5330
# unreferenced information in 'branch-as-repository' branches.
5331
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5332
# information in shared branches as well.
5333
_see_also = ['commit']
5334
takes_options = ['verbose', 'revision',
5335
Option('dry-run', help='Don\'t actually make changes.'),
5336
Option('force', help='Say yes to all questions.'),
5338
help='Keep tags that point to removed revisions.'),
5340
help="Only remove the commits from the local branch"
5341
" when in a checkout."
5344
takes_args = ['location?']
5346
encoding_type = 'replace'
5348
def run(self, location=None, dry_run=False, verbose=False,
5349
revision=None, force=False, local=False, keep_tags=False):
5350
if location is None:
5352
control, relpath = controldir.ControlDir.open_containing(location)
5354
tree = control.open_workingtree()
5356
except (errors.NoWorkingTree, errors.NotLocalUrl):
5358
b = control.open_branch()
5360
if tree is not None:
5361
self.add_cleanup(tree.lock_write().unlock)
5363
self.add_cleanup(b.lock_write().unlock)
5364
return self._run(b, tree, dry_run, verbose, revision, force,
5367
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5369
from .log import log_formatter, show_log
5370
from .uncommit import uncommit
5372
last_revno, last_rev_id = b.last_revision_info()
5375
if revision is None:
5377
rev_id = last_rev_id
5379
# 'brz uncommit -r 10' actually means uncommit
5380
# so that the final tree is at revno 10.
5381
# but breezy.uncommit.uncommit() actually uncommits
5382
# the revisions that are supplied.
5383
# So we need to offset it by one
5384
revno = revision[0].in_history(b).revno + 1
5385
if revno <= last_revno:
5386
rev_id = b.get_rev_id(revno)
5388
if rev_id is None or _mod_revision.is_null(rev_id):
5389
self.outf.write(gettext('No revisions to uncommit.\n'))
5392
lf = log_formatter('short',
5394
show_timezone='original')
5399
direction='forward',
5400
start_revision=revno,
5401
end_revision=last_revno)
5404
self.outf.write(gettext('Dry-run, pretending to remove'
5405
' the above revisions.\n'))
5407
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5410
if not ui.ui_factory.confirm_action(
5411
gettext(u'Uncommit these revisions'),
5412
'breezy.builtins.uncommit',
5414
self.outf.write(gettext('Canceled\n'))
5417
mutter('Uncommitting from {%s} to {%s}',
5418
last_rev_id, rev_id)
5419
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5420
revno=revno, local=local, keep_tags=keep_tags)
5421
self.outf.write(gettext('You can restore the old tip by running:\n'
5422
' brz pull . -r revid:%s\n') % last_rev_id)
5425
class cmd_break_lock(Command):
5426
__doc__ = """Break a dead lock.
5428
This command breaks a lock on a repository, branch, working directory or
5431
CAUTION: Locks should only be broken when you are sure that the process
5432
holding the lock has been stopped.
5434
You can get information on what locks are open via the 'brz info
5435
[location]' command.
5439
brz break-lock brz+ssh://example.com/brz/foo
5440
brz break-lock --conf ~/.bazaar
5443
takes_args = ['location?']
5446
help='LOCATION is the directory where the config lock is.'),
5448
help='Do not ask for confirmation before breaking the lock.'),
5451
def run(self, location=None, config=False, force=False):
5452
if location is None:
5455
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5457
{'breezy.lockdir.break': True})
5459
conf = _mod_config.LockableConfig(file_name=location)
5462
control, relpath = controldir.ControlDir.open_containing(location)
5464
control.break_lock()
5465
except NotImplementedError:
5469
class cmd_wait_until_signalled(Command):
5470
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5472
This just prints a line to signal when it is ready, then blocks on stdin.
5478
sys.stdout.write("running\n")
5480
sys.stdin.readline()
5483
class cmd_serve(Command):
5484
__doc__ = """Run the brz server."""
5486
aliases = ['server']
5490
help='Serve on stdin/out for use from inetd or sshd.'),
5491
RegistryOption('protocol',
5492
help="Protocol to serve.",
5493
lazy_registry=('breezy.transport', 'transport_server_registry'),
5494
value_switches=True),
5496
help='Listen for connections on nominated address.', type=str),
5498
help='Listen for connections on nominated port. Passing 0 as '
5499
'the port number will result in a dynamically allocated '
5500
'port. The default port depends on the protocol.',
5502
custom_help('directory',
5503
help='Serve contents of this directory.'),
5504
Option('allow-writes',
5505
help='By default the server is a readonly server. Supplying '
5506
'--allow-writes enables write access to the contents of '
5507
'the served directory and below. Note that ``brz serve`` '
5508
'does not perform authentication, so unless some form of '
5509
'external authentication is arranged supplying this '
5510
'option leads to global uncontrolled write access to your '
5513
Option('client-timeout', type=float,
5514
help='Override the default idle client timeout (5min).'),
5517
def run(self, listen=None, port=None, inet=False, directory=None,
5518
allow_writes=False, protocol=None, client_timeout=None):
5519
from . import transport
5520
if directory is None:
5521
directory = osutils.getcwd()
5522
if protocol is None:
5523
protocol = transport.transport_server_registry.get()
5524
url = transport.location_to_url(directory)
5525
if not allow_writes:
5526
url = 'readonly+' + url
5527
t = transport.get_transport_from_url(url)
5528
protocol(t, listen, port, inet, client_timeout)
5531
class cmd_join(Command):
5532
__doc__ = """Combine a tree into its containing tree.
5534
This command requires the target tree to be in a rich-root format.
5536
The TREE argument should be an independent tree, inside another tree, but
5537
not part of it. (Such trees can be produced by "brz split", but also by
5538
running "brz branch" with the target inside a tree.)
5540
The result is a combined tree, with the subtree no longer an independent
5541
part. This is marked as a merge of the subtree into the containing tree,
5542
and all history is preserved.
5545
_see_also = ['split']
5546
takes_args = ['tree']
5548
Option('reference', help='Join by reference.', hidden=True),
5551
def run(self, tree, reference=False):
5552
sub_tree = WorkingTree.open(tree)
5553
parent_dir = osutils.dirname(sub_tree.basedir)
5554
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5555
repo = containing_tree.branch.repository
5556
if not repo.supports_rich_root():
5557
raise errors.BzrCommandError(gettext(
5558
"Can't join trees because %s doesn't support rich root data.\n"
5559
"You can use brz upgrade on the repository.")
5563
containing_tree.add_reference(sub_tree)
5564
except errors.BadReferenceTarget as e:
5565
# XXX: Would be better to just raise a nicely printable
5566
# exception from the real origin. Also below. mbp 20070306
5567
raise errors.BzrCommandError(
5568
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5571
containing_tree.subsume(sub_tree)
5572
except errors.BadSubsumeSource as e:
5573
raise errors.BzrCommandError(
5574
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5577
class cmd_split(Command):
5578
__doc__ = """Split a subdirectory of a tree into a separate tree.
5580
This command will produce a target tree in a format that supports
5581
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5582
converted into earlier formats like 'dirstate-tags'.
5584
The TREE argument should be a subdirectory of a working tree. That
5585
subdirectory will be converted into an independent tree, with its own
5586
branch. Commits in the top-level tree will not apply to the new subtree.
5589
_see_also = ['join']
5590
takes_args = ['tree']
5592
def run(self, tree):
5593
containing_tree, subdir = WorkingTree.open_containing(tree)
5594
sub_id = containing_tree.path2id(subdir)
5596
raise errors.NotVersionedError(subdir)
5598
containing_tree.extract(sub_id)
5599
except errors.RootNotRich:
5600
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5603
class cmd_merge_directive(Command):
5604
__doc__ = """Generate a merge directive for auto-merge tools.
5606
A directive requests a merge to be performed, and also provides all the
5607
information necessary to do so. This means it must either include a
5608
revision bundle, or the location of a branch containing the desired
5611
A submit branch (the location to merge into) must be supplied the first
5612
time the command is issued. After it has been supplied once, it will
5613
be remembered as the default.
5615
A public branch is optional if a revision bundle is supplied, but required
5616
if --diff or --plain is specified. It will be remembered as the default
5617
after the first use.
5620
takes_args = ['submit_branch?', 'public_branch?']
5624
_see_also = ['send']
5628
RegistryOption.from_kwargs('patch-type',
5629
'The type of patch to include in the directive.',
5631
value_switches=True,
5633
bundle='Bazaar revision bundle (default).',
5634
diff='Normal unified diff.',
5635
plain='No patch, just directive.'),
5636
Option('sign', help='GPG-sign the directive.'), 'revision',
5637
Option('mail-to', type=str,
5638
help='Instead of printing the directive, email to this address.'),
5639
Option('message', type=str, short_name='m',
5640
help='Message to use when committing this merge.')
5643
encoding_type = 'exact'
5645
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5646
sign=False, revision=None, mail_to=None, message=None,
5648
from .revision import ensure_null, NULL_REVISION
5649
include_patch, include_bundle = {
5650
'plain': (False, False),
5651
'diff': (True, False),
5652
'bundle': (True, True),
5654
branch = Branch.open(directory)
5655
stored_submit_branch = branch.get_submit_branch()
5656
if submit_branch is None:
5657
submit_branch = stored_submit_branch
5659
if stored_submit_branch is None:
5660
branch.set_submit_branch(submit_branch)
5661
if submit_branch is None:
5662
submit_branch = branch.get_parent()
5663
if submit_branch is None:
5664
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5666
stored_public_branch = branch.get_public_branch()
5667
if public_branch is None:
5668
public_branch = stored_public_branch
5669
elif stored_public_branch is None:
5670
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5671
branch.set_public_branch(public_branch)
5672
if not include_bundle and public_branch is None:
5673
raise errors.BzrCommandError(gettext('No public branch specified or'
5675
base_revision_id = None
5676
if revision is not None:
5677
if len(revision) > 2:
5678
raise errors.BzrCommandError(gettext('brz merge-directive takes '
5679
'at most two one revision identifiers'))
5680
revision_id = revision[-1].as_revision_id(branch)
5681
if len(revision) == 2:
5682
base_revision_id = revision[0].as_revision_id(branch)
5684
revision_id = branch.last_revision()
5685
revision_id = ensure_null(revision_id)
5686
if revision_id == NULL_REVISION:
5687
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5688
directive = merge_directive.MergeDirective2.from_objects(
5689
branch.repository, revision_id, time.time(),
5690
osutils.local_time_offset(), submit_branch,
5691
public_branch=public_branch, include_patch=include_patch,
5692
include_bundle=include_bundle, message=message,
5693
base_revision_id=base_revision_id)
5696
self.outf.write(directive.to_signed(branch))
5698
self.outf.writelines(directive.to_lines())
5700
message = directive.to_email(mail_to, branch, sign)
5701
s = SMTPConnection(branch.get_config_stack())
5702
s.send_email(message)
5705
class cmd_send(Command):
5706
__doc__ = """Mail or create a merge-directive for submitting changes.
5708
A merge directive provides many things needed for requesting merges:
5710
* A machine-readable description of the merge to perform
5712
* An optional patch that is a preview of the changes requested
5714
* An optional bundle of revision data, so that the changes can be applied
5715
directly from the merge directive, without retrieving data from a
5718
`brz send` creates a compact data set that, when applied using brz
5719
merge, has the same effect as merging from the source branch.
5721
By default the merge directive is self-contained and can be applied to any
5722
branch containing submit_branch in its ancestory without needing access to
5725
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5726
revisions, but only a structured request to merge from the
5727
public_location. In that case the public_branch is needed and it must be
5728
up-to-date and accessible to the recipient. The public_branch is always
5729
included if known, so that people can check it later.
5731
The submit branch defaults to the parent of the source branch, but can be
5732
overridden. Both submit branch and public branch will be remembered in
5733
branch.conf the first time they are used for a particular branch. The
5734
source branch defaults to that containing the working directory, but can
5735
be changed using --from.
5737
Both the submit branch and the public branch follow the usual behavior with
5738
respect to --remember: If there is no default location set, the first send
5739
will set it (use --no-remember to avoid setting it). After that, you can
5740
omit the location to use the default. To change the default, use
5741
--remember. The value will only be saved if the location can be accessed.
5743
In order to calculate those changes, brz must analyse the submit branch.
5744
Therefore it is most efficient for the submit branch to be a local mirror.
5745
If a public location is known for the submit_branch, that location is used
5746
in the merge directive.
5748
The default behaviour is to send the merge directive by mail, unless -o is
5749
given, in which case it is sent to a file.
5751
Mail is sent using your preferred mail program. This should be transparent
5752
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5753
If the preferred client can't be found (or used), your editor will be used.
5755
To use a specific mail program, set the mail_client configuration option.
5756
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5757
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5758
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5759
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5762
If mail is being sent, a to address is required. This can be supplied
5763
either on the commandline, by setting the submit_to configuration
5764
option in the branch itself or the child_submit_to configuration option
5765
in the submit branch.
5767
Two formats are currently supported: "4" uses revision bundle format 4 and
5768
merge directive format 2. It is significantly faster and smaller than
5769
older formats. It is compatible with Bazaar 0.19 and later. It is the
5770
default. "0.9" uses revision bundle format 0.9 and merge directive
5771
format 1. It is compatible with Bazaar 0.12 - 0.18.
5773
The merge directives created by brz send may be applied using brz merge or
5774
brz pull by specifying a file containing a merge directive as the location.
5776
brz send makes extensive use of public locations to map local locations into
5777
URLs that can be used by other people. See `brz help configuration` to
5778
set them, and use `brz info` to display them.
5781
encoding_type = 'exact'
5783
_see_also = ['merge', 'pull']
5785
takes_args = ['submit_branch?', 'public_branch?']
5789
help='Do not include a bundle in the merge directive.'),
5790
Option('no-patch', help='Do not include a preview patch in the merge'
5793
help='Remember submit and public branch.'),
5795
help='Branch to generate the submission from, '
5796
'rather than the one containing the working directory.',
5799
Option('output', short_name='o',
5800
help='Write merge directive to this file or directory; '
5801
'use - for stdout.',
5804
help='Refuse to send if there are uncommitted changes in'
5805
' the working tree, --no-strict disables the check.'),
5806
Option('mail-to', help='Mail the request to this address.',
5810
Option('body', help='Body for the email.', type=text_type),
5811
RegistryOption('format',
5812
help='Use the specified output format.',
5813
lazy_registry=('breezy.send', 'format_registry')),
5816
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5817
no_patch=False, revision=None, remember=None, output=None,
5818
format=None, mail_to=None, message=None, body=None,
5819
strict=None, **kwargs):
5820
from .send import send
5821
return send(submit_branch, revision, public_branch, remember,
5822
format, no_bundle, no_patch, output,
5823
kwargs.get('from', '.'), mail_to, message, body,
5828
class cmd_bundle_revisions(cmd_send):
5829
__doc__ = """Create a merge-directive for submitting changes.
5831
A merge directive provides many things needed for requesting merges:
5833
* A machine-readable description of the merge to perform
5835
* An optional patch that is a preview of the changes requested
5837
* An optional bundle of revision data, so that the changes can be applied
5838
directly from the merge directive, without retrieving data from a
5841
If --no-bundle is specified, then public_branch is needed (and must be
5842
up-to-date), so that the receiver can perform the merge using the
5843
public_branch. The public_branch is always included if known, so that
5844
people can check it later.
5846
The submit branch defaults to the parent, but can be overridden. Both
5847
submit branch and public branch will be remembered if supplied.
5849
If a public_branch is known for the submit_branch, that public submit
5850
branch is used in the merge instructions. This means that a local mirror
5851
can be used as your actual submit branch, once you have set public_branch
5854
Two formats are currently supported: "4" uses revision bundle format 4 and
5855
merge directive format 2. It is significantly faster and smaller than
5856
older formats. It is compatible with Bazaar 0.19 and later. It is the
5857
default. "0.9" uses revision bundle format 0.9 and merge directive
5858
format 1. It is compatible with Bazaar 0.12 - 0.18.
5863
help='Do not include a bundle in the merge directive.'),
5864
Option('no-patch', help='Do not include a preview patch in the merge'
5867
help='Remember submit and public branch.'),
5869
help='Branch to generate the submission from, '
5870
'rather than the one containing the working directory.',
5873
Option('output', short_name='o', help='Write directive to this file.',
5876
help='Refuse to bundle revisions if there are uncommitted'
5877
' changes in the working tree, --no-strict disables the check.'),
5879
RegistryOption('format',
5880
help='Use the specified output format.',
5881
lazy_registry=('breezy.send', 'format_registry')),
5883
aliases = ['bundle']
5885
_see_also = ['send', 'merge']
5889
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5890
no_patch=False, revision=None, remember=False, output=None,
5891
format=None, strict=None, **kwargs):
5894
from .send import send
5895
return send(submit_branch, revision, public_branch, remember,
5896
format, no_bundle, no_patch, output,
5897
kwargs.get('from', '.'), None, None, None,
5898
self.outf, strict=strict)
5901
class cmd_tag(Command):
5902
__doc__ = """Create, remove or modify a tag naming a revision.
5904
Tags give human-meaningful names to revisions. Commands that take a -r
5905
(--revision) option can be given -rtag:X, where X is any previously
5908
Tags are stored in the branch. Tags are copied from one branch to another
5909
along when you branch, push, pull or merge.
5911
It is an error to give a tag name that already exists unless you pass
5912
--force, in which case the tag is moved to point to the new revision.
5914
To rename a tag (change the name but keep it on the same revsion), run ``brz
5915
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
5917
If no tag name is specified it will be determined through the
5918
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5919
upstream releases by reading configure.ac. See ``brz help hooks`` for
5923
_see_also = ['commit', 'tags']
5924
takes_args = ['tag_name?']
5927
help='Delete this tag rather than placing it.',
5929
custom_help('directory',
5930
help='Branch in which to place the tag.'),
5932
help='Replace existing tags.',
5937
def run(self, tag_name=None,
5943
branch, relpath = Branch.open_containing(directory)
5944
self.add_cleanup(branch.lock_write().unlock)
5946
if tag_name is None:
5947
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5948
branch.tags.delete_tag(tag_name)
5949
note(gettext('Deleted tag %s.') % tag_name)
5952
if len(revision) != 1:
5953
raise errors.BzrCommandError(gettext(
5954
"Tags can only be placed on a single revision, "
5956
revision_id = revision[0].as_revision_id(branch)
5958
revision_id = branch.last_revision()
5959
if tag_name is None:
5960
tag_name = branch.automatic_tag_name(revision_id)
5961
if tag_name is None:
5962
raise errors.BzrCommandError(gettext(
5963
"Please specify a tag name."))
5965
existing_target = branch.tags.lookup_tag(tag_name)
5966
except errors.NoSuchTag:
5967
existing_target = None
5968
if not force and existing_target not in (None, revision_id):
5969
raise errors.TagAlreadyExists(tag_name)
5970
if existing_target == revision_id:
5971
note(gettext('Tag %s already exists for that revision.') % tag_name)
5973
branch.tags.set_tag(tag_name, revision_id)
5974
if existing_target is None:
5975
note(gettext('Created tag %s.') % tag_name)
5977
note(gettext('Updated tag %s.') % tag_name)
5980
class cmd_tags(Command):
5981
__doc__ = """List tags.
5983
This command shows a table of tag names and the revisions they reference.
5988
custom_help('directory',
5989
help='Branch whose tags should be displayed.'),
5990
RegistryOption('sort',
5991
'Sort tags by different criteria.', title='Sorting',
5992
lazy_registry=('breezy.tag', 'tag_sort_methods')
5999
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6000
from .tag import tag_sort_methods
6001
branch, relpath = Branch.open_containing(directory)
6003
tags = list(viewitems(branch.tags.get_tag_dict()))
6007
self.add_cleanup(branch.lock_read().unlock)
6009
# Restrict to the specified range
6010
tags = self._tags_for_range(branch, revision)
6012
sort = tag_sort_methods.get()
6015
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6016
for index, (tag, revid) in enumerate(tags):
6018
revno = branch.revision_id_to_dotted_revno(revid)
6019
if isinstance(revno, tuple):
6020
revno = '.'.join(map(str, revno))
6021
except (errors.NoSuchRevision,
6022
errors.GhostRevisionsHaveNoRevno,
6023
errors.UnsupportedOperation):
6024
# Bad tag data/merges can lead to tagged revisions
6025
# which are not in this branch. Fail gracefully ...
6027
tags[index] = (tag, revno)
6029
for tag, revspec in tags:
6030
self.outf.write('%-20s %s\n' % (tag, revspec))
6032
def _tags_for_range(self, branch, revision):
6034
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6035
revid1, revid2 = rev1.rev_id, rev2.rev_id
6036
# _get_revision_range will always set revid2 if it's not specified.
6037
# If revid1 is None, it means we want to start from the branch
6038
# origin which is always a valid ancestor. If revid1 == revid2, the
6039
# ancestry check is useless.
6040
if revid1 and revid1 != revid2:
6041
# FIXME: We really want to use the same graph than
6042
# branch.iter_merge_sorted_revisions below, but this is not
6043
# easily available -- vila 2011-09-23
6044
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6045
# We don't want to output anything in this case...
6047
# only show revisions between revid1 and revid2 (inclusive)
6048
tagged_revids = branch.tags.get_reverse_tag_dict()
6050
for r in branch.iter_merge_sorted_revisions(
6051
start_revision_id=revid2, stop_revision_id=revid1,
6052
stop_rule='include'):
6053
revid_tags = tagged_revids.get(r[0], None)
6055
found.extend([(tag, r[0]) for tag in revid_tags])
6059
class cmd_reconfigure(Command):
6060
__doc__ = """Reconfigure the type of a brz directory.
6062
A target configuration must be specified.
6064
For checkouts, the bind-to location will be auto-detected if not specified.
6065
The order of preference is
6066
1. For a lightweight checkout, the current bound location.
6067
2. For branches that used to be checkouts, the previously-bound location.
6068
3. The push location.
6069
4. The parent location.
6070
If none of these is available, --bind-to must be specified.
6073
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6074
takes_args = ['location?']
6076
RegistryOption.from_kwargs(
6079
help='The relation between branch and tree.',
6080
value_switches=True, enum_switch=False,
6081
branch='Reconfigure to be an unbound branch with no working tree.',
6082
tree='Reconfigure to be an unbound branch with a working tree.',
6083
checkout='Reconfigure to be a bound branch with a working tree.',
6084
lightweight_checkout='Reconfigure to be a lightweight'
6085
' checkout (with no local history).',
6087
RegistryOption.from_kwargs(
6089
title='Repository type',
6090
help='Location fo the repository.',
6091
value_switches=True, enum_switch=False,
6092
standalone='Reconfigure to be a standalone branch '
6093
'(i.e. stop using shared repository).',
6094
use_shared='Reconfigure to use a shared repository.',
6096
RegistryOption.from_kwargs(
6098
title='Trees in Repository',
6099
help='Whether new branches in the repository have trees.',
6100
value_switches=True, enum_switch=False,
6101
with_trees='Reconfigure repository to create '
6102
'working trees on branches by default.',
6103
with_no_trees='Reconfigure repository to not create '
6104
'working trees on branches by default.'
6106
Option('bind-to', help='Branch to bind checkout to.', type=str),
6108
help='Perform reconfiguration even if local changes'
6110
Option('stacked-on',
6111
help='Reconfigure a branch to be stacked on another branch.',
6115
help='Reconfigure a branch to be unstacked. This '
6116
'may require copying substantial data into it.',
6120
def run(self, location=None, bind_to=None, force=False,
6121
tree_type=None, repository_type=None, repository_trees=None,
6122
stacked_on=None, unstacked=None):
6123
directory = controldir.ControlDir.open(location)
6124
if stacked_on and unstacked:
6125
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6126
elif stacked_on is not None:
6127
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6129
reconfigure.ReconfigureUnstacked().apply(directory)
6130
# At the moment you can use --stacked-on and a different
6131
# reconfiguration shape at the same time; there seems no good reason
6133
if (tree_type is None and
6134
repository_type is None and
6135
repository_trees is None):
6136
if stacked_on or unstacked:
6139
raise errors.BzrCommandError(gettext('No target configuration '
6141
reconfiguration = None
6142
if tree_type == 'branch':
6143
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6144
elif tree_type == 'tree':
6145
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6146
elif tree_type == 'checkout':
6147
reconfiguration = reconfigure.Reconfigure.to_checkout(
6149
elif tree_type == 'lightweight-checkout':
6150
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6153
reconfiguration.apply(force)
6154
reconfiguration = None
6155
if repository_type == 'use-shared':
6156
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6157
elif repository_type == 'standalone':
6158
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6160
reconfiguration.apply(force)
6161
reconfiguration = None
6162
if repository_trees == 'with-trees':
6163
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6165
elif repository_trees == 'with-no-trees':
6166
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6169
reconfiguration.apply(force)
6170
reconfiguration = None
6173
class cmd_switch(Command):
6174
__doc__ = """Set the branch of a checkout and update.
6176
For lightweight checkouts, this changes the branch being referenced.
6177
For heavyweight checkouts, this checks that there are no local commits
6178
versus the current bound branch, then it makes the local branch a mirror
6179
of the new location and binds to it.
6181
In both cases, the working tree is updated and uncommitted changes
6182
are merged. The user can commit or revert these as they desire.
6184
Pending merges need to be committed or reverted before using switch.
6186
The path to the branch to switch to can be specified relative to the parent
6187
directory of the current branch. For example, if you are currently in a
6188
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6191
Bound branches use the nickname of its master branch unless it is set
6192
locally, in which case switching will update the local nickname to be
6196
takes_args = ['to_location?']
6197
takes_options = ['directory',
6199
help='Switch even if local commits will be lost.'),
6201
Option('create-branch', short_name='b',
6202
help='Create the target branch from this one before'
6203
' switching to it.'),
6205
help='Store and restore uncommitted changes in the'
6209
def run(self, to_location=None, force=False, create_branch=False,
6210
revision=None, directory=u'.', store=False):
6211
from . import switch
6212
tree_location = directory
6213
revision = _get_one_revision('switch', revision)
6214
possible_transports = []
6215
control_dir = controldir.ControlDir.open_containing(tree_location,
6216
possible_transports=possible_transports)[0]
6217
if to_location is None:
6218
if revision is None:
6219
raise errors.BzrCommandError(gettext('You must supply either a'
6220
' revision or a location'))
6221
to_location = tree_location
6223
branch = control_dir.open_branch(
6224
possible_transports=possible_transports)
6225
had_explicit_nick = branch.get_config().has_explicit_nickname()
6226
except errors.NotBranchError:
6228
had_explicit_nick = False
6231
raise errors.BzrCommandError(
6232
gettext('cannot create branch without source branch'))
6233
to_location = lookup_new_sibling_branch(control_dir, to_location,
6234
possible_transports=possible_transports)
6235
to_branch = branch.controldir.sprout(to_location,
6236
possible_transports=possible_transports,
6237
source_branch=branch).open_branch()
6240
to_branch = Branch.open(to_location,
6241
possible_transports=possible_transports)
6242
except errors.NotBranchError:
6243
to_branch = open_sibling_branch(control_dir, to_location,
6244
possible_transports=possible_transports)
6245
if revision is not None:
6246
revision = revision.as_revision_id(to_branch)
6247
switch.switch(control_dir, to_branch, force, revision_id=revision,
6248
store_uncommitted=store)
6249
if had_explicit_nick:
6250
branch = control_dir.open_branch() #get the new branch!
6251
branch.nick = to_branch.nick
6252
note(gettext('Switched to branch: %s'),
6253
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6257
class cmd_view(Command):
6258
__doc__ = """Manage filtered views.
6260
Views provide a mask over the tree so that users can focus on
6261
a subset of a tree when doing their work. After creating a view,
6262
commands that support a list of files - status, diff, commit, etc -
6263
effectively have that list of files implicitly given each time.
6264
An explicit list of files can still be given but those files
6265
must be within the current view.
6267
In most cases, a view has a short life-span: it is created to make
6268
a selected change and is deleted once that change is committed.
6269
At other times, you may wish to create one or more named views
6270
and switch between them.
6272
To disable the current view without deleting it, you can switch to
6273
the pseudo view called ``off``. This can be useful when you need
6274
to see the whole tree for an operation or two (e.g. merge) but
6275
want to switch back to your view after that.
6278
To define the current view::
6280
brz view file1 dir1 ...
6282
To list the current view::
6286
To delete the current view::
6290
To disable the current view without deleting it::
6292
brz view --switch off
6294
To define a named view and switch to it::
6296
brz view --name view-name file1 dir1 ...
6298
To list a named view::
6300
brz view --name view-name
6302
To delete a named view::
6304
brz view --name view-name --delete
6306
To switch to a named view::
6308
brz view --switch view-name
6310
To list all views defined::
6314
To delete all views::
6316
brz view --delete --all
6320
takes_args = ['file*']
6323
help='Apply list or delete action to all views.',
6326
help='Delete the view.',
6329
help='Name of the view to define, list or delete.',
6333
help='Name of the view to switch to.',
6338
def run(self, file_list,
6344
tree, file_list = WorkingTree.open_containing_paths(file_list,
6346
current_view, view_dict = tree.views.get_view_info()
6351
raise errors.BzrCommandError(gettext(
6352
"Both --delete and a file list specified"))
6354
raise errors.BzrCommandError(gettext(
6355
"Both --delete and --switch specified"))
6357
tree.views.set_view_info(None, {})
6358
self.outf.write(gettext("Deleted all views.\n"))
6360
raise errors.BzrCommandError(gettext("No current view to delete"))
6362
tree.views.delete_view(name)
6363
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6366
raise errors.BzrCommandError(gettext(
6367
"Both --switch and a file list specified"))
6369
raise errors.BzrCommandError(gettext(
6370
"Both --switch and --all specified"))
6371
elif switch == 'off':
6372
if current_view is None:
6373
raise errors.BzrCommandError(gettext("No current view to disable"))
6374
tree.views.set_view_info(None, view_dict)
6375
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6377
tree.views.set_view_info(switch, view_dict)
6378
view_str = views.view_display_str(tree.views.lookup_view())
6379
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6382
self.outf.write(gettext('Views defined:\n'))
6383
for view in sorted(view_dict):
6384
if view == current_view:
6388
view_str = views.view_display_str(view_dict[view])
6389
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6391
self.outf.write(gettext('No views defined.\n'))
6394
# No name given and no current view set
6397
raise errors.BzrCommandError(gettext(
6398
"Cannot change the 'off' pseudo view"))
6399
tree.views.set_view(name, sorted(file_list))
6400
view_str = views.view_display_str(tree.views.lookup_view())
6401
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6405
# No name given and no current view set
6406
self.outf.write(gettext('No current view.\n'))
6408
view_str = views.view_display_str(tree.views.lookup_view(name))
6409
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6412
class cmd_hooks(Command):
6413
__doc__ = """Show hooks."""
6418
for hook_key in sorted(hooks.known_hooks.keys()):
6419
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6420
self.outf.write("%s:\n" % type(some_hooks).__name__)
6421
for hook_name, hook_point in sorted(some_hooks.items()):
6422
self.outf.write(" %s:\n" % (hook_name,))
6423
found_hooks = list(hook_point)
6425
for hook in found_hooks:
6426
self.outf.write(" %s\n" %
6427
(some_hooks.get_hook_name(hook),))
6429
self.outf.write(gettext(" <no hooks installed>\n"))
6432
class cmd_remove_branch(Command):
6433
__doc__ = """Remove a branch.
6435
This will remove the branch from the specified location but
6436
will keep any working tree or repository in place.
6440
Remove the branch at repo/trunk::
6442
brz remove-branch repo/trunk
6446
takes_args = ["location?"]
6448
takes_options = ['directory',
6449
Option('force', help='Remove branch even if it is the active branch.')]
6451
aliases = ["rmbranch"]
6453
def run(self, directory=None, location=None, force=False):
6454
br = open_nearby_branch(near=directory, location=location)
6455
if not force and br.controldir.has_workingtree():
6457
active_branch = br.controldir.open_branch(name="")
6458
except errors.NotBranchError:
6459
active_branch = None
6460
if (active_branch is not None and
6461
br.control_url == active_branch.control_url):
6462
raise errors.BzrCommandError(
6463
gettext("Branch is active. Use --force to remove it."))
6464
br.controldir.destroy_branch(br.name)
6467
class cmd_shelve(Command):
6468
__doc__ = """Temporarily set aside some changes from the current tree.
6470
Shelve allows you to temporarily put changes you've made "on the shelf",
6471
ie. out of the way, until a later time when you can bring them back from
6472
the shelf with the 'unshelve' command. The changes are stored alongside
6473
your working tree, and so they aren't propagated along with your branch nor
6474
will they survive its deletion.
6476
If shelve --list is specified, previously-shelved changes are listed.
6478
Shelve is intended to help separate several sets of changes that have
6479
been inappropriately mingled. If you just want to get rid of all changes
6480
and you don't need to restore them later, use revert. If you want to
6481
shelve all text changes at once, use shelve --all.
6483
If filenames are specified, only the changes to those files will be
6484
shelved. Other files will be left untouched.
6486
If a revision is specified, changes since that revision will be shelved.
6488
You can put multiple items on the shelf, and by default, 'unshelve' will
6489
restore the most recently shelved changes.
6491
For complicated changes, it is possible to edit the changes in a separate
6492
editor program to decide what the file remaining in the working copy
6493
should look like. To do this, add the configuration option
6495
change_editor = PROGRAM @new_path @old_path
6497
where @new_path is replaced with the path of the new version of the
6498
file and @old_path is replaced with the path of the old version of
6499
the file. The PROGRAM should save the new file with the desired
6500
contents of the file in the working tree.
6504
takes_args = ['file*']
6509
Option('all', help='Shelve all changes.'),
6511
RegistryOption('writer', 'Method to use for writing diffs.',
6512
breezy.option.diff_writer_registry,
6513
value_switches=True, enum_switch=False),
6515
Option('list', help='List shelved changes.'),
6517
help='Destroy removed changes instead of shelving them.'),
6519
_see_also = ['unshelve', 'configuration']
6521
def run(self, revision=None, all=False, file_list=None, message=None,
6522
writer=None, list=False, destroy=False, directory=None):
6524
return self.run_for_list(directory=directory)
6525
from .shelf_ui import Shelver
6527
writer = breezy.option.diff_writer_registry.get()
6529
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6530
file_list, message, destroy=destroy, directory=directory)
6535
except errors.UserAbort:
6538
def run_for_list(self, directory=None):
6539
if directory is None:
6541
tree = WorkingTree.open_containing(directory)[0]
6542
self.add_cleanup(tree.lock_read().unlock)
6543
manager = tree.get_shelf_manager()
6544
shelves = manager.active_shelves()
6545
if len(shelves) == 0:
6546
note(gettext('No shelved changes.'))
6548
for shelf_id in reversed(shelves):
6549
message = manager.get_metadata(shelf_id).get('message')
6551
message = '<no message>'
6552
self.outf.write('%3d: %s\n' % (shelf_id, message))
6556
class cmd_unshelve(Command):
6557
__doc__ = """Restore shelved changes.
6559
By default, the most recently shelved changes are restored. However if you
6560
specify a shelf by id those changes will be restored instead. This works
6561
best when the changes don't depend on each other.
6564
takes_args = ['shelf_id?']
6567
RegistryOption.from_kwargs(
6568
'action', help="The action to perform.",
6569
enum_switch=False, value_switches=True,
6570
apply="Apply changes and remove from the shelf.",
6571
dry_run="Show changes, but do not apply or remove them.",
6572
preview="Instead of unshelving the changes, show the diff that "
6573
"would result from unshelving.",
6574
delete_only="Delete changes without applying them.",
6575
keep="Apply changes but don't delete them.",
6578
_see_also = ['shelve']
6580
def run(self, shelf_id=None, action='apply', directory=u'.'):
6581
from .shelf_ui import Unshelver
6582
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6586
unshelver.tree.unlock()
6589
class cmd_clean_tree(Command):
6590
__doc__ = """Remove unwanted files from working tree.
6592
By default, only unknown files, not ignored files, are deleted. Versioned
6593
files are never deleted.
6595
Another class is 'detritus', which includes files emitted by brz during
6596
normal operations and selftests. (The value of these files decreases with
6599
If no options are specified, unknown files are deleted. Otherwise, option
6600
flags are respected, and may be combined.
6602
To check what clean-tree will do, use --dry-run.
6604
takes_options = ['directory',
6605
Option('ignored', help='Delete all ignored files.'),
6606
Option('detritus', help='Delete conflict files, merge and revert'
6607
' backups, and failed selftest dirs.'),
6609
help='Delete files unknown to brz (default).'),
6610
Option('dry-run', help='Show files to delete instead of'
6612
Option('force', help='Do not prompt before deleting.')]
6613
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6614
force=False, directory=u'.'):
6615
from .clean_tree import clean_tree
6616
if not (unknown or ignored or detritus):
6620
clean_tree(directory, unknown=unknown, ignored=ignored,
6621
detritus=detritus, dry_run=dry_run, no_prompt=force)
6624
class cmd_reference(Command):
6625
__doc__ = """list, view and set branch locations for nested trees.
6627
If no arguments are provided, lists the branch locations for nested trees.
6628
If one argument is provided, display the branch location for that tree.
6629
If two arguments are provided, set the branch location for that tree.
6634
takes_args = ['path?', 'location?']
6636
def run(self, path=None, location=None):
6638
if path is not None:
6640
tree, branch, relpath =(
6641
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6642
if path is not None:
6645
tree = branch.basis_tree()
6647
info = viewitems(branch._get_all_reference_info())
6648
self._display_reference_info(tree, branch, info)
6650
file_id = tree.path2id(path)
6652
raise errors.NotVersionedError(path)
6653
if location is None:
6654
info = [(file_id, branch.get_reference_info(file_id))]
6655
self._display_reference_info(tree, branch, info)
6657
branch.set_reference_info(file_id, path, location)
6659
def _display_reference_info(self, tree, branch, info):
6661
for file_id, (path, location) in info:
6663
path = tree.id2path(file_id)
6664
except errors.NoSuchId:
6666
ref_list.append((path, location))
6667
for path, location in sorted(ref_list):
6668
self.outf.write('%s %s\n' % (path, location))
6671
class cmd_export_pot(Command):
6672
__doc__ = """Export command helps and error messages in po format."""
6675
takes_options = [Option('plugin',
6676
help='Export help text from named command '\
6677
'(defaults to all built in commands).',
6679
Option('include-duplicates',
6680
help='Output multiple copies of the same msgid '
6681
'string if it appears more than once.'),
6684
def run(self, plugin=None, include_duplicates=False):
6685
from .export_pot import export_pot
6686
export_pot(self.outf, plugin, include_duplicates)
6689
class cmd_import(Command):
6690
__doc__ = """Import sources from a directory, tarball or zip file
6692
This command will import a directory, tarball or zip file into a bzr
6693
tree, replacing any versioned files already present. If a directory is
6694
specified, it is used as the target. If the directory does not exist, or
6695
is not versioned, it is created.
6697
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6699
If the tarball or zip has a single root directory, that directory is
6700
stripped when extracting the tarball. This is not done for directories.
6703
takes_args = ['source', 'tree?']
6705
def run(self, source, tree=None):
6706
from .upstream_import import do_import
6707
do_import(source, tree)
6710
class cmd_fetch_ghosts(Command):
6711
__doc__ = """Attempt to retrieve ghosts from another branch.
6713
If the other branch is not supplied, the last-pulled branch is used.
6717
aliases = ['fetch-missing']
6718
takes_args = ['branch?']
6719
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6721
def run(self, branch=None, no_fix=False):
6722
from .fetch_ghosts import GhostFetcher
6723
installed, failed = GhostFetcher.from_cmdline(branch).run()
6724
if len(installed) > 0:
6725
self.outf.write("Installed:\n")
6726
for rev in installed:
6727
self.outf.write(rev + "\n")
6729
self.outf.write("Still missing:\n")
6731
self.outf.write(rev + "\n")
6732
if not no_fix and len(installed) > 0:
6733
cmd_reconcile().run(".")
6736
def _register_lazy_builtins():
6737
# register lazy builtins from other modules; called at startup and should
6738
# be only called once.
6739
for (name, aliases, module_name) in [
6740
('cmd_bisect', [], 'breezy.bisect'),
6741
('cmd_bundle_info', [], 'breezy.bundle.commands'),
6742
('cmd_config', [], 'breezy.config'),
6743
('cmd_dpush', [], 'breezy.foreign'),
6744
('cmd_version_info', [], 'breezy.cmd_version_info'),
6745
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
6746
('cmd_conflicts', [], 'breezy.conflicts'),
6747
('cmd_ping', [], 'breezy.bzr.smart.ping'),
6748
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
6749
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
6750
('cmd_test_script', [], 'breezy.cmd_test_script'),
6752
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
