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 bzr commands"""
19
from __future__ import absolute_import
25
from bzrlib import lazy_import
26
lazy_import.lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
59
from bzrlib.branch import Branch
60
from bzrlib.conflicts import ConflictList
61
from bzrlib.transport import memory
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
63
from bzrlib.smtp_connection import SMTPConnection
64
from bzrlib.workingtree import WorkingTree
65
from bzrlib.i18n import gettext, ngettext
68
from bzrlib.commands import (
70
builtin_command_registry,
73
from bzrlib.option import (
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
86
def _get_branch_location(control_dir, possible_transports=None):
87
"""Return location of branch for this control dir."""
89
target = control_dir.get_branch_reference()
90
except errors.NotBranchError:
91
return control_dir.root_transport.base
92
if target is not None:
94
this_branch = control_dir.open_branch(
95
possible_transports=possible_transports)
96
# This may be a heavy checkout, where we want the master branch
97
master_location = this_branch.get_bound_location()
98
if master_location is not None:
99
return master_location
100
# If not, use a local sibling
101
return this_branch.base
104
def _is_colocated(control_dir, possible_transports=None):
105
"""Check if the branch in control_dir is colocated.
107
:param control_dir: Control directory
108
:return: Tuple with boolean indicating whether the branch is colocated
109
and the full URL to the actual branch
111
# This path is meant to be relative to the existing branch
112
this_url = _get_branch_location(control_dir,
113
possible_transports=possible_transports)
114
# Perhaps the target control dir supports colocated branches?
116
root = controldir.ControlDir.open(this_url,
117
possible_transports=possible_transports)
118
except errors.NotBranchError:
119
return (False, this_url)
122
wt = control_dir.open_workingtree()
123
except (errors.NoWorkingTree, errors.NotLocalUrl):
124
return (False, this_url)
127
root._format.colocated_branches and
128
control_dir.control_url == root.control_url,
132
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
133
"""Lookup the location for a new sibling branch.
135
:param control_dir: Control directory to find sibling branches from
136
:param location: Name of the new branch
137
:return: Full location to the new branch
139
location = directory_service.directories.dereference(location)
140
if '/' not in location and '\\' not in location:
141
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
144
return urlutils.join_segment_parameters(this_url,
145
{"branch": urlutils.escape(location)})
147
return urlutils.join(this_url, '..', urlutils.escape(location))
151
def open_sibling_branch(control_dir, location, possible_transports=None):
152
"""Open a branch, possibly a sibling of another.
154
:param control_dir: Control directory relative to which to lookup the
156
:param location: Location to look up
157
:return: branch to open
160
# Perhaps it's a colocated branch?
161
return control_dir.open_branch(location,
162
possible_transports=possible_transports)
163
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
164
this_url = _get_branch_location(control_dir)
167
this_url, '..', urlutils.escape(location)))
170
def open_nearby_branch(near=None, location=None, possible_transports=None):
171
"""Open a nearby branch.
173
:param near: Optional location of container from which to open branch
174
:param location: Location of the branch
175
:return: Branch instance
181
return Branch.open(location,
182
possible_transports=possible_transports)
183
except errors.NotBranchError:
185
cdir = controldir.ControlDir.open(near,
186
possible_transports=possible_transports)
187
return open_sibling_branch(cdir, location,
188
possible_transports=possible_transports)
191
def iter_sibling_branches(control_dir, possible_transports=None):
192
"""Iterate over the siblings of a branch.
194
:param control_dir: Control directory for which to look up the siblings
195
:return: Iterator over tuples with branch name and branch object
199
reference = control_dir.get_branch_reference()
200
except errors.NotBranchError:
201
# There is no active branch, just return the colocated branches.
202
for name, branch in control_dir.get_branches().iteritems():
205
if reference is not None:
206
ref_branch = Branch.open(reference,
207
possible_transports=possible_transports)
210
if ref_branch is None or ref_branch.name:
211
if ref_branch is not None:
212
control_dir = ref_branch.bzrdir
213
for name, branch in control_dir.get_branches().iteritems():
216
repo = ref_branch.bzrdir.find_repository()
217
for branch in repo.find_branches(using=True):
218
name = urlutils.relative_url(repo.user_url,
219
branch.user_url).rstrip("/")
223
def tree_files_for_add(file_list):
225
Return a tree and list of absolute paths from a file list.
227
Similar to tree_files, but add handles files a bit differently, so it a
228
custom implementation. In particular, MutableTreeTree.smart_add expects
229
absolute paths, which it immediately converts to relative paths.
231
# FIXME Would be nice to just return the relative paths like
232
# internal_tree_files does, but there are a large number of unit tests
233
# that assume the current interface to mutabletree.smart_add
235
tree, relpath = WorkingTree.open_containing(file_list[0])
236
if tree.supports_views():
237
view_files = tree.views.lookup_view()
239
for filename in file_list:
240
if not osutils.is_inside_any(view_files, filename):
241
raise errors.FileOutsideView(filename, view_files)
242
file_list = file_list[:]
243
file_list[0] = tree.abspath(relpath)
245
tree = WorkingTree.open_containing(u'.')[0]
246
if tree.supports_views():
247
view_files = tree.views.lookup_view()
249
file_list = view_files
250
view_str = views.view_display_str(view_files)
251
note(gettext("Ignoring files outside view. View is %s") % view_str)
252
return tree, file_list
255
def _get_one_revision(command_name, revisions):
256
if revisions is None:
258
if len(revisions) != 1:
259
raise errors.BzrCommandError(gettext(
260
'bzr %s --revision takes exactly one revision identifier') % (
265
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
266
"""Get a revision tree. Not suitable for commands that change the tree.
268
Specifically, the basis tree in dirstate trees is coupled to the dirstate
269
and doing a commit/uncommit/pull will at best fail due to changing the
272
If tree is passed in, it should be already locked, for lifetime management
273
of the trees internal cached state.
277
if revisions is None:
279
rev_tree = tree.basis_tree()
281
rev_tree = branch.basis_tree()
283
revision = _get_one_revision(command_name, revisions)
284
rev_tree = revision.as_tree(branch)
288
def _get_view_info_for_change_reporter(tree):
289
"""Get the view information from a tree for change reporting."""
292
current_view = tree.views.get_view_info()[0]
293
if current_view is not None:
294
view_info = (current_view, tree.views.lookup_view())
295
except errors.ViewsNotSupported:
300
def _open_directory_or_containing_tree_or_branch(filename, directory):
301
"""Open the tree or branch containing the specified file, unless
302
the --directory option is used to specify a different branch."""
303
if directory is not None:
304
return (None, Branch.open(directory), filename)
305
return controldir.ControlDir.open_containing_tree_or_branch(filename)
308
# TODO: Make sure no commands unconditionally use the working directory as a
309
# branch. If a filename argument is used, the first of them should be used to
310
# specify the branch. (Perhaps this can be factored out into some kind of
311
# Argument class, representing a file in a branch, where the first occurrence
314
class cmd_status(Command):
315
__doc__ = """Display status summary.
317
This reports on versioned and unknown files, reporting them
318
grouped by state. Possible states are:
321
Versioned in the working copy but not in the previous revision.
324
Versioned in the previous revision but removed or deleted
328
Path of this file changed from the previous revision;
329
the text may also have changed. This includes files whose
330
parent directory was renamed.
333
Text has changed since the previous revision.
336
File kind has been changed (e.g. from file to directory).
339
Not versioned and not matching an ignore pattern.
341
Additionally for directories, symlinks and files with a changed
342
executable bit, Bazaar indicates their type using a trailing
343
character: '/', '@' or '*' respectively. These decorations can be
344
disabled using the '--no-classify' option.
346
To see ignored files use 'bzr ignored'. For details on the
347
changes to file texts, use 'bzr diff'.
349
Note that --short or -S gives status flags for each item, similar
350
to Subversion's status command. To get output similar to svn -q,
353
If no arguments are specified, the status of the entire working
354
directory is shown. Otherwise, only the status of the specified
355
files or directories is reported. If a directory is given, status
356
is reported for everything inside that directory.
358
Before merges are committed, the pending merge tip revisions are
359
shown. To see all pending merge revisions, use the -v option.
360
To skip the display of pending merge information altogether, use
361
the no-pending option or specify a file/directory.
363
To compare the working directory to a specific revision, pass a
364
single revision to the revision argument.
366
To see which files have changed in a specific revision, or between
367
two revisions, pass a revision range to the revision argument.
368
This will produce the same results as calling 'bzr diff --summarize'.
371
# TODO: --no-recurse/-N, --recurse options
373
takes_args = ['file*']
374
takes_options = ['show-ids', 'revision', 'change', 'verbose',
375
Option('short', help='Use short status indicators.',
377
Option('versioned', help='Only show versioned files.',
379
Option('no-pending', help='Don\'t show pending merges.',
381
Option('no-classify',
382
help='Do not mark object type using indicator.',
385
aliases = ['st', 'stat']
387
encoding_type = 'replace'
388
_see_also = ['diff', 'revert', 'status-flags']
391
def run(self, show_ids=False, file_list=None, revision=None, short=False,
392
versioned=False, no_pending=False, verbose=False,
394
from bzrlib.status import show_tree_status
396
if revision and len(revision) > 2:
397
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
398
' one or two revision specifiers'))
400
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
401
# Avoid asking for specific files when that is not needed.
402
if relfile_list == ['']:
404
# Don't disable pending merges for full trees other than '.'.
405
if file_list == ['.']:
407
# A specific path within a tree was given.
408
elif relfile_list is not None:
410
show_tree_status(tree, show_ids=show_ids,
411
specific_files=relfile_list, revision=revision,
412
to_file=self.outf, short=short, versioned=versioned,
413
show_pending=(not no_pending), verbose=verbose,
414
classify=not no_classify)
417
class cmd_cat_revision(Command):
418
__doc__ = """Write out metadata for a revision.
420
The revision to print can either be specified by a specific
421
revision identifier, or you can use --revision.
425
takes_args = ['revision_id?']
426
takes_options = ['directory', 'revision']
427
# cat-revision is more for frontends so should be exact
430
def print_revision(self, revisions, revid):
431
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
432
record = stream.next()
433
if record.storage_kind == 'absent':
434
raise errors.NoSuchRevision(revisions, revid)
435
revtext = record.get_bytes_as('fulltext')
436
self.outf.write(revtext.decode('utf-8'))
439
def run(self, revision_id=None, revision=None, directory=u'.'):
440
if revision_id is not None and revision is not None:
441
raise errors.BzrCommandError(gettext('You can only supply one of'
442
' revision_id or --revision'))
443
if revision_id is None and revision is None:
444
raise errors.BzrCommandError(gettext('You must supply either'
445
' --revision or a revision_id'))
447
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
449
revisions = b.repository.revisions
450
if revisions is None:
451
raise errors.BzrCommandError(gettext('Repository %r does not support '
452
'access to raw revision texts'))
454
b.repository.lock_read()
456
# TODO: jam 20060112 should cat-revision always output utf-8?
457
if revision_id is not None:
458
revision_id = osutils.safe_revision_id(revision_id, warn=False)
460
self.print_revision(revisions, revision_id)
461
except errors.NoSuchRevision:
462
msg = gettext("The repository {0} contains no revision {1}.").format(
463
b.repository.base, revision_id)
464
raise errors.BzrCommandError(msg)
465
elif revision is not None:
468
raise errors.BzrCommandError(
469
gettext('You cannot specify a NULL revision.'))
470
rev_id = rev.as_revision_id(b)
471
self.print_revision(revisions, rev_id)
473
b.repository.unlock()
476
class cmd_dump_btree(Command):
477
__doc__ = """Dump the contents of a btree index file to stdout.
479
PATH is a btree index file, it can be any URL. This includes things like
480
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
482
By default, the tuples stored in the index file will be displayed. With
483
--raw, we will uncompress the pages, but otherwise display the raw bytes
487
# TODO: Do we want to dump the internal nodes as well?
488
# TODO: It would be nice to be able to dump the un-parsed information,
489
# rather than only going through iter_all_entries. However, this is
490
# good enough for a start
492
encoding_type = 'exact'
493
takes_args = ['path']
494
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
495
' rather than the parsed tuples.'),
498
def run(self, path, raw=False):
499
dirname, basename = osutils.split(path)
500
t = transport.get_transport(dirname)
502
self._dump_raw_bytes(t, basename)
504
self._dump_entries(t, basename)
506
def _get_index_and_bytes(self, trans, basename):
507
"""Create a BTreeGraphIndex and raw bytes."""
508
bt = btree_index.BTreeGraphIndex(trans, basename, None)
509
bytes = trans.get_bytes(basename)
510
bt._file = cStringIO.StringIO(bytes)
511
bt._size = len(bytes)
514
def _dump_raw_bytes(self, trans, basename):
517
# We need to parse at least the root node.
518
# This is because the first page of every row starts with an
519
# uncompressed header.
520
bt, bytes = self._get_index_and_bytes(trans, basename)
521
for page_idx, page_start in enumerate(xrange(0, len(bytes),
522
btree_index._PAGE_SIZE)):
523
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
524
page_bytes = bytes[page_start:page_end]
526
self.outf.write('Root node:\n')
527
header_end, data = bt._parse_header_from_bytes(page_bytes)
528
self.outf.write(page_bytes[:header_end])
530
self.outf.write('\nPage %d\n' % (page_idx,))
531
if len(page_bytes) == 0:
532
self.outf.write('(empty)\n');
534
decomp_bytes = zlib.decompress(page_bytes)
535
self.outf.write(decomp_bytes)
536
self.outf.write('\n')
538
def _dump_entries(self, trans, basename):
540
st = trans.stat(basename)
541
except errors.TransportNotPossible:
542
# We can't stat, so we'll fake it because we have to do the 'get()'
544
bt, _ = self._get_index_and_bytes(trans, basename)
546
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
547
for node in bt.iter_all_entries():
548
# Node is made up of:
549
# (index, key, value, [references])
553
refs_as_tuples = None
555
refs_as_tuples = static_tuple.as_tuples(refs)
556
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
557
self.outf.write('%s\n' % (as_tuple,))
560
class cmd_remove_tree(Command):
561
__doc__ = """Remove the working tree from a given branch/checkout.
563
Since a lightweight checkout is little more than a working tree
564
this will refuse to run against one.
566
To re-create the working tree, use "bzr checkout".
568
_see_also = ['checkout', 'working-trees']
569
takes_args = ['location*']
572
help='Remove the working tree even if it has '
573
'uncommitted or shelved changes.'),
576
def run(self, location_list, force=False):
577
if not location_list:
580
for location in location_list:
581
d = controldir.ControlDir.open(location)
584
working = d.open_workingtree()
585
except errors.NoWorkingTree:
586
raise errors.BzrCommandError(gettext("No working tree to remove"))
587
except errors.NotLocalUrl:
588
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
589
" of a remote path"))
591
if (working.has_changes()):
592
raise errors.UncommittedChanges(working)
593
if working.get_shelf_manager().last_shelf() is not None:
594
raise errors.ShelvedChanges(working)
596
if working.user_url != working.branch.user_url:
597
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
598
" from a lightweight checkout"))
600
d.destroy_workingtree()
603
class cmd_repair_workingtree(Command):
604
__doc__ = """Reset the working tree state file.
606
This is not meant to be used normally, but more as a way to recover from
607
filesystem corruption, etc. This rebuilds the working inventory back to a
608
'known good' state. Any new modifications (adding a file, renaming, etc)
609
will be lost, though modified files will still be detected as such.
611
Most users will want something more like "bzr revert" or "bzr update"
612
unless the state file has become corrupted.
614
By default this attempts to recover the current state by looking at the
615
headers of the state file. If the state file is too corrupted to even do
616
that, you can supply --revision to force the state of the tree.
619
takes_options = ['revision', 'directory',
621
help='Reset the tree even if it doesn\'t appear to be'
626
def run(self, revision=None, directory='.', force=False):
627
tree, _ = WorkingTree.open_containing(directory)
628
self.add_cleanup(tree.lock_tree_write().unlock)
632
except errors.BzrError:
633
pass # There seems to be a real error here, so we'll reset
636
raise errors.BzrCommandError(gettext(
637
'The tree does not appear to be corrupt. You probably'
638
' want "bzr revert" instead. Use "--force" if you are'
639
' sure you want to reset the working tree.'))
643
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
645
tree.reset_state(revision_ids)
646
except errors.BzrError, e:
647
if revision_ids is None:
648
extra = (gettext(', the header appears corrupt, try passing -r -1'
649
' to set the state to the last commit'))
652
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
655
class cmd_revno(Command):
656
__doc__ = """Show current revision number.
658
This is equal to the number of revisions on this branch.
662
takes_args = ['location?']
664
Option('tree', help='Show revno of working tree.'),
669
def run(self, tree=False, location=u'.', revision=None):
670
if revision is not None and tree:
671
raise errors.BzrCommandError(gettext("--tree and --revision can "
672
"not be used together"))
676
wt = WorkingTree.open_containing(location)[0]
677
self.add_cleanup(wt.lock_read().unlock)
678
except (errors.NoWorkingTree, errors.NotLocalUrl):
679
raise errors.NoWorkingTree(location)
681
revid = wt.last_revision()
683
b = Branch.open_containing(location)[0]
684
self.add_cleanup(b.lock_read().unlock)
686
if len(revision) != 1:
687
raise errors.BzrCommandError(gettext(
688
"Tags can only be placed on a single revision, "
690
revid = revision[0].as_revision_id(b)
692
revid = b.last_revision()
694
revno_t = b.revision_id_to_dotted_revno(revid)
695
except errors.NoSuchRevision:
697
revno = ".".join(str(n) for n in revno_t)
699
self.outf.write(revno + '\n')
702
class cmd_revision_info(Command):
703
__doc__ = """Show revision number and revision id for a given revision identifier.
706
takes_args = ['revision_info*']
709
custom_help('directory',
710
help='Branch to examine, '
711
'rather than the one containing the working directory.'),
712
Option('tree', help='Show revno of working tree.'),
716
def run(self, revision=None, directory=u'.', tree=False,
717
revision_info_list=[]):
720
wt = WorkingTree.open_containing(directory)[0]
722
self.add_cleanup(wt.lock_read().unlock)
723
except (errors.NoWorkingTree, errors.NotLocalUrl):
725
b = Branch.open_containing(directory)[0]
726
self.add_cleanup(b.lock_read().unlock)
728
if revision is not None:
729
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
730
if revision_info_list is not None:
731
for rev_str in revision_info_list:
732
rev_spec = RevisionSpec.from_string(rev_str)
733
revision_ids.append(rev_spec.as_revision_id(b))
734
# No arguments supplied, default to the last revision
735
if len(revision_ids) == 0:
738
raise errors.NoWorkingTree(directory)
739
revision_ids.append(wt.last_revision())
741
revision_ids.append(b.last_revision())
745
for revision_id in revision_ids:
747
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
748
revno = '.'.join(str(i) for i in dotted_revno)
749
except errors.NoSuchRevision:
751
maxlen = max(maxlen, len(revno))
752
revinfos.append([revno, revision_id])
756
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
759
class cmd_add(Command):
760
__doc__ = """Add specified files or directories.
762
In non-recursive mode, all the named items are added, regardless
763
of whether they were previously ignored. A warning is given if
764
any of the named files are already versioned.
766
In recursive mode (the default), files are treated the same way
767
but the behaviour for directories is different. Directories that
768
are already versioned do not give a warning. All directories,
769
whether already versioned or not, are searched for files or
770
subdirectories that are neither versioned or ignored, and these
771
are added. This search proceeds recursively into versioned
772
directories. If no names are given '.' is assumed.
774
A warning will be printed when nested trees are encountered,
775
unless they are explicitly ignored.
777
Therefore simply saying 'bzr add' will version all files that
778
are currently unknown.
780
Adding a file whose parent directory is not versioned will
781
implicitly add the parent, and so on up to the root. This means
782
you should never need to explicitly add a directory, they'll just
783
get added when you add a file in the directory.
785
--dry-run will show which files would be added, but not actually
788
--file-ids-from will try to use the file ids from the supplied path.
789
It looks up ids trying to find a matching parent directory with the
790
same filename, and then by pure path. This option is rarely needed
791
but can be useful when adding the same logical file into two
792
branches that will be merged later (without showing the two different
793
adds as a conflict). It is also useful when merging another project
794
into a subdirectory of this one.
796
Any files matching patterns in the ignore list will not be added
797
unless they are explicitly mentioned.
799
In recursive mode, files larger than the configuration option
800
add.maximum_file_size will be skipped. Named items are never skipped due
803
takes_args = ['file*']
806
help="Don't recursively add the contents of directories.",
809
help="Show what would be done, but don't actually do anything."),
811
Option('file-ids-from',
813
help='Lookup file ids from this tree.'),
815
encoding_type = 'replace'
816
_see_also = ['remove', 'ignore']
818
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
823
if file_ids_from is not None:
825
base_tree, base_path = WorkingTree.open_containing(
827
except errors.NoWorkingTree:
828
base_branch, base_path = Branch.open_containing(
830
base_tree = base_branch.basis_tree()
832
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
833
to_file=self.outf, should_print=(not is_quiet()))
835
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
836
should_print=(not is_quiet()))
839
self.add_cleanup(base_tree.lock_read().unlock)
840
tree, file_list = tree_files_for_add(file_list)
841
added, ignored = tree.smart_add(file_list, not
842
no_recurse, action=action, save=not dry_run)
846
for glob in sorted(ignored.keys()):
847
for path in ignored[glob]:
849
gettext("ignored {0} matching \"{1}\"\n").format(
853
class cmd_mkdir(Command):
854
__doc__ = """Create a new versioned directory.
856
This is equivalent to creating the directory and then adding it.
859
takes_args = ['dir+']
863
help='No error if existing, make parent directories as needed.',
867
encoding_type = 'replace'
870
def add_file_with_parents(cls, wt, relpath):
871
if wt.path2id(relpath) is not None:
873
cls.add_file_with_parents(wt, osutils.dirname(relpath))
877
def add_file_single(cls, wt, relpath):
880
def run(self, dir_list, parents=False):
882
add_file = self.add_file_with_parents
884
add_file = self.add_file_single
886
wt, relpath = WorkingTree.open_containing(dir)
891
if e.errno != errno.EEXIST:
895
add_file(wt, relpath)
897
self.outf.write(gettext('added %s\n') % dir)
900
class cmd_relpath(Command):
901
__doc__ = """Show path of a file relative to root"""
903
takes_args = ['filename']
907
def run(self, filename):
908
# TODO: jam 20050106 Can relpath return a munged path if
909
# sys.stdout encoding cannot represent it?
910
tree, relpath = WorkingTree.open_containing(filename)
911
self.outf.write(relpath)
912
self.outf.write('\n')
915
class cmd_inventory(Command):
916
__doc__ = """Show inventory of the current working copy or a revision.
918
It is possible to limit the output to a particular entry
919
type using the --kind option. For example: --kind file.
921
It is also possible to restrict the list of files to a specific
922
set. For example: bzr inventory --show-ids this/file
931
help='List entries of a particular kind: file, directory, symlink.',
934
takes_args = ['file*']
937
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
938
if kind and kind not in ['file', 'directory', 'symlink']:
939
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
941
revision = _get_one_revision('inventory', revision)
942
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
943
self.add_cleanup(work_tree.lock_read().unlock)
944
if revision is not None:
945
tree = revision.as_tree(work_tree.branch)
947
extra_trees = [work_tree]
948
self.add_cleanup(tree.lock_read().unlock)
953
self.add_cleanup(tree.lock_read().unlock)
954
if file_list is not None:
955
file_ids = tree.paths2ids(file_list, trees=extra_trees,
956
require_versioned=True)
957
# find_ids_across_trees may include some paths that don't
959
entries = tree.iter_entries_by_dir(specific_file_ids=file_ids)
961
entries = tree.iter_entries_by_dir()
963
for path, entry in sorted(entries):
964
if kind and kind != entry.kind:
969
self.outf.write('%-50s %s\n' % (path, entry.file_id))
971
self.outf.write(path)
972
self.outf.write('\n')
975
class cmd_mv(Command):
976
__doc__ = """Move or rename a file.
979
bzr mv OLDNAME NEWNAME
981
bzr mv SOURCE... DESTINATION
983
If the last argument is a versioned directory, all the other names
984
are moved into it. Otherwise, there must be exactly two arguments
985
and the file is changed to a new name.
987
If OLDNAME does not exist on the filesystem but is versioned and
988
NEWNAME does exist on the filesystem but is not versioned, mv
989
assumes that the file has been manually moved and only updates
990
its internal inventory to reflect that change.
991
The same is valid when moving many SOURCE files to a DESTINATION.
993
Files cannot be moved between branches.
996
takes_args = ['names*']
997
takes_options = [Option("after", help="Move only the bzr identifier"
998
" of the file, because the file has already been moved."),
999
Option('auto', help='Automatically guess renames.'),
1000
Option('dry-run', help='Avoid making changes when guessing renames.'),
1002
aliases = ['move', 'rename']
1003
encoding_type = 'replace'
1005
def run(self, names_list, after=False, auto=False, dry_run=False):
1007
return self.run_auto(names_list, after, dry_run)
1009
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1010
if names_list is None:
1012
if len(names_list) < 2:
1013
raise errors.BzrCommandError(gettext("missing file argument"))
1014
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1015
for file_name in rel_names[0:-1]:
1017
raise errors.BzrCommandError(gettext("can not move root of branch"))
1018
self.add_cleanup(tree.lock_tree_write().unlock)
1019
self._run(tree, names_list, rel_names, after)
1021
def run_auto(self, names_list, after, dry_run):
1022
if names_list is not None and len(names_list) > 1:
1023
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1026
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1028
work_tree, file_list = WorkingTree.open_containing_paths(
1029
names_list, default_directory='.')
1030
self.add_cleanup(work_tree.lock_tree_write().unlock)
1031
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1033
def _run(self, tree, names_list, rel_names, after):
1034
into_existing = osutils.isdir(names_list[-1])
1035
if into_existing and len(names_list) == 2:
1037
# a. case-insensitive filesystem and change case of dir
1038
# b. move directory after the fact (if the source used to be
1039
# a directory, but now doesn't exist in the working tree
1040
# and the target is an existing directory, just rename it)
1041
if (not tree.case_sensitive
1042
and rel_names[0].lower() == rel_names[1].lower()):
1043
into_existing = False
1045
# 'fix' the case of a potential 'from'
1046
from_id = tree.path2id(
1047
tree.get_canonical_inventory_path(rel_names[0]))
1048
if (not osutils.lexists(names_list[0]) and
1049
from_id and tree.stored_kind(from_id) == "directory"):
1050
into_existing = False
1053
# move into existing directory
1054
# All entries reference existing inventory items, so fix them up
1055
# for cicp file-systems.
1056
rel_names = tree.get_canonical_inventory_paths(rel_names)
1057
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1059
self.outf.write("%s => %s\n" % (src, dest))
1061
if len(names_list) != 2:
1062
raise errors.BzrCommandError(gettext('to mv multiple files the'
1063
' destination must be a versioned'
1066
# for cicp file-systems: the src references an existing inventory
1068
src = tree.get_canonical_inventory_path(rel_names[0])
1069
# Find the canonical version of the destination: In all cases, the
1070
# parent of the target must be in the inventory, so we fetch the
1071
# canonical version from there (we do not always *use* the
1072
# canonicalized tail portion - we may be attempting to rename the
1074
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1075
dest_parent = osutils.dirname(canon_dest)
1076
spec_tail = osutils.basename(rel_names[1])
1077
# For a CICP file-system, we need to avoid creating 2 inventory
1078
# entries that differ only by case. So regardless of the case
1079
# we *want* to use (ie, specified by the user or the file-system),
1080
# we must always choose to use the case of any existing inventory
1081
# items. The only exception to this is when we are attempting a
1082
# case-only rename (ie, canonical versions of src and dest are
1084
dest_id = tree.path2id(canon_dest)
1085
if dest_id is None or tree.path2id(src) == dest_id:
1086
# No existing item we care about, so work out what case we
1087
# are actually going to use.
1089
# If 'after' is specified, the tail must refer to a file on disk.
1091
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1093
# pathjoin with an empty tail adds a slash, which breaks
1095
dest_parent_fq = tree.basedir
1097
dest_tail = osutils.canonical_relpath(
1099
osutils.pathjoin(dest_parent_fq, spec_tail))
1101
# not 'after', so case as specified is used
1102
dest_tail = spec_tail
1104
# Use the existing item so 'mv' fails with AlreadyVersioned.
1105
dest_tail = os.path.basename(canon_dest)
1106
dest = osutils.pathjoin(dest_parent, dest_tail)
1107
mutter("attempting to move %s => %s", src, dest)
1108
tree.rename_one(src, dest, after=after)
1110
self.outf.write("%s => %s\n" % (src, dest))
1113
class cmd_pull(Command):
1114
__doc__ = """Turn this branch into a mirror of another branch.
1116
By default, this command only works on branches that have not diverged.
1117
Branches are considered diverged if the destination branch's most recent
1118
commit is one that has not been merged (directly or indirectly) into the
1121
If branches have diverged, you can use 'bzr merge' to integrate the changes
1122
from one into the other. Once one branch has merged, the other should
1123
be able to pull it again.
1125
If you want to replace your local changes and just want your branch to
1126
match the remote one, use pull --overwrite. This will work even if the two
1127
branches have diverged.
1129
If there is no default location set, the first pull will set it (use
1130
--no-remember to avoid setting it). After that, you can omit the
1131
location to use the default. To change the default, use --remember. The
1132
value will only be saved if the remote location can be accessed.
1134
The --verbose option will display the revisions pulled using the log_format
1135
configuration option. You can use a different format by overriding it with
1136
-Olog_format=<other_format>.
1138
Note: The location can be specified either in the form of a branch,
1139
or in the form of a path to a file containing a merge directive generated
1143
_see_also = ['push', 'update', 'status-flags', 'send']
1144
takes_options = ['remember', 'overwrite', 'revision',
1145
custom_help('verbose',
1146
help='Show logs of pulled revisions.'),
1147
custom_help('directory',
1148
help='Branch to pull into, '
1149
'rather than the one containing the working directory.'),
1151
help="Perform a local pull in a bound "
1152
"branch. Local pulls are not applied to "
1153
"the master branch."
1156
help="Show base revision text in conflicts.")
1158
takes_args = ['location?']
1159
encoding_type = 'replace'
1161
def run(self, location=None, remember=None, overwrite=False,
1162
revision=None, verbose=False,
1163
directory=None, local=False,
1165
# FIXME: too much stuff is in the command class
1168
if directory is None:
1171
tree_to = WorkingTree.open_containing(directory)[0]
1172
branch_to = tree_to.branch
1173
self.add_cleanup(tree_to.lock_write().unlock)
1174
except errors.NoWorkingTree:
1176
branch_to = Branch.open_containing(directory)[0]
1177
self.add_cleanup(branch_to.lock_write().unlock)
1179
if tree_to is None and show_base:
1180
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1182
if local and not branch_to.get_bound_location():
1183
raise errors.LocalRequiresBoundBranch()
1185
possible_transports = []
1186
if location is not None:
1188
mergeable = bundle.read_mergeable_from_url(location,
1189
possible_transports=possible_transports)
1190
except errors.NotABundle:
1193
stored_loc = branch_to.get_parent()
1194
if location is None:
1195
if stored_loc is None:
1196
raise errors.BzrCommandError(gettext("No pull location known or"
1199
display_url = urlutils.unescape_for_display(stored_loc,
1202
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1203
location = stored_loc
1205
revision = _get_one_revision('pull', revision)
1206
if mergeable is not None:
1207
if revision is not None:
1208
raise errors.BzrCommandError(gettext(
1209
'Cannot use -r with merge directives or bundles'))
1210
mergeable.install_revisions(branch_to.repository)
1211
base_revision_id, revision_id, verified = \
1212
mergeable.get_merge_request(branch_to.repository)
1213
branch_from = branch_to
1215
branch_from = Branch.open(location,
1216
possible_transports=possible_transports)
1217
self.add_cleanup(branch_from.lock_read().unlock)
1218
# Remembers if asked explicitly or no previous location is set
1220
or (remember is None and branch_to.get_parent() is None)):
1221
# FIXME: This shouldn't be done before the pull
1222
# succeeds... -- vila 2012-01-02
1223
branch_to.set_parent(branch_from.base)
1225
if revision is not None:
1226
revision_id = revision.as_revision_id(branch_from)
1228
if tree_to is not None:
1229
view_info = _get_view_info_for_change_reporter(tree_to)
1230
change_reporter = delta._ChangeReporter(
1231
unversioned_filter=tree_to.is_ignored,
1232
view_info=view_info)
1233
result = tree_to.pull(
1234
branch_from, overwrite, revision_id, change_reporter,
1235
local=local, show_base=show_base)
1237
result = branch_to.pull(
1238
branch_from, overwrite, revision_id, local=local)
1240
result.report(self.outf)
1241
if verbose and result.old_revid != result.new_revid:
1242
log.show_branch_change(
1243
branch_to, self.outf, result.old_revno,
1245
if getattr(result, 'tag_conflicts', None):
1251
class cmd_push(Command):
1252
__doc__ = """Update a mirror of this branch.
1254
The target branch will not have its working tree populated because this
1255
is both expensive, and is not supported on remote file systems.
1257
Some smart servers or protocols *may* put the working tree in place in
1260
This command only works on branches that have not diverged. Branches are
1261
considered diverged if the destination branch's most recent commit is one
1262
that has not been merged (directly or indirectly) by the source branch.
1264
If branches have diverged, you can use 'bzr push --overwrite' to replace
1265
the other branch completely, discarding its unmerged changes.
1267
If you want to ensure you have the different changes in the other branch,
1268
do a merge (see bzr help merge) from the other branch, and commit that.
1269
After that you will be able to do a push without '--overwrite'.
1271
If there is no default push location set, the first push will set it (use
1272
--no-remember to avoid setting it). After that, you can omit the
1273
location to use the default. To change the default, use --remember. The
1274
value will only be saved if the remote location can be accessed.
1276
The --verbose option will display the revisions pushed using the log_format
1277
configuration option. You can use a different format by overriding it with
1278
-Olog_format=<other_format>.
1281
_see_also = ['pull', 'update', 'working-trees']
1282
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1283
Option('create-prefix',
1284
help='Create the path leading up to the branch '
1285
'if it does not already exist.'),
1286
custom_help('directory',
1287
help='Branch to push from, '
1288
'rather than the one containing the working directory.'),
1289
Option('use-existing-dir',
1290
help='By default push will fail if the target'
1291
' directory exists, but does not already'
1292
' have a control directory. This flag will'
1293
' allow push to proceed.'),
1295
help='Create a stacked branch that references the public location '
1296
'of the parent branch.'),
1297
Option('stacked-on',
1298
help='Create a stacked branch that refers to another branch '
1299
'for the commit history. Only the work not present in the '
1300
'referenced branch is included in the branch created.',
1303
help='Refuse to push if there are uncommitted changes in'
1304
' the working tree, --no-strict disables the check.'),
1306
help="Don't populate the working tree, even for protocols"
1307
" that support it."),
1309
takes_args = ['location?']
1310
encoding_type = 'replace'
1312
def run(self, location=None, remember=None, overwrite=False,
1313
create_prefix=False, verbose=False, revision=None,
1314
use_existing_dir=False, directory=None, stacked_on=None,
1315
stacked=False, strict=None, no_tree=False):
1316
from bzrlib.push import _show_push_branch
1318
if directory is None:
1320
# Get the source branch
1322
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1323
# Get the tip's revision_id
1324
revision = _get_one_revision('push', revision)
1325
if revision is not None:
1326
revision_id = revision.in_history(br_from).rev_id
1329
if tree is not None and revision_id is None:
1330
tree.check_changed_or_out_of_date(
1331
strict, 'push_strict',
1332
more_error='Use --no-strict to force the push.',
1333
more_warning='Uncommitted changes will not be pushed.')
1334
# Get the stacked_on branch, if any
1335
if stacked_on is not None:
1336
stacked_on = urlutils.normalize_url(stacked_on)
1338
parent_url = br_from.get_parent()
1340
parent = Branch.open(parent_url)
1341
stacked_on = parent.get_public_branch()
1343
# I considered excluding non-http url's here, thus forcing
1344
# 'public' branches only, but that only works for some
1345
# users, so it's best to just depend on the user spotting an
1346
# error by the feedback given to them. RBC 20080227.
1347
stacked_on = parent_url
1349
raise errors.BzrCommandError(gettext(
1350
"Could not determine branch to refer to."))
1352
# Get the destination location
1353
if location is None:
1354
stored_loc = br_from.get_push_location()
1355
if stored_loc is None:
1356
parent_loc = br_from.get_parent()
1358
raise errors.BzrCommandError(gettext(
1359
"No push location known or specified. To push to the "
1360
"parent branch (at %s), use 'bzr push :parent'." %
1361
urlutils.unescape_for_display(parent_loc,
1362
self.outf.encoding)))
1364
raise errors.BzrCommandError(gettext(
1365
"No push location known or specified."))
1367
display_url = urlutils.unescape_for_display(stored_loc,
1369
note(gettext("Using saved push location: %s") % display_url)
1370
location = stored_loc
1372
_show_push_branch(br_from, revision_id, location, self.outf,
1373
verbose=verbose, overwrite=overwrite, remember=remember,
1374
stacked_on=stacked_on, create_prefix=create_prefix,
1375
use_existing_dir=use_existing_dir, no_tree=no_tree)
1378
class cmd_branch(Command):
1379
__doc__ = """Create a new branch that is a copy of an existing branch.
1381
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1382
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1383
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1384
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1385
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1388
To retrieve the branch as of a particular revision, supply the --revision
1389
parameter, as in "branch foo/bar -r 5".
1391
The synonyms 'clone' and 'get' for this command are deprecated.
1394
_see_also = ['checkout']
1395
takes_args = ['from_location', 'to_location?']
1396
takes_options = ['revision',
1397
Option('hardlink', help='Hard-link working tree files where possible.'),
1398
Option('files-from', type=str,
1399
help="Get file contents from this tree."),
1401
help="Create a branch without a working-tree."),
1403
help="Switch the checkout in the current directory "
1404
"to the new branch."),
1406
help='Create a stacked branch referring to the source branch. '
1407
'The new branch will depend on the availability of the source '
1408
'branch for all operations.'),
1409
Option('standalone',
1410
help='Do not use a shared repository, even if available.'),
1411
Option('use-existing-dir',
1412
help='By default branch will fail if the target'
1413
' directory exists, but does not already'
1414
' have a control directory. This flag will'
1415
' allow branch to proceed.'),
1417
help="Bind new branch to from location."),
1419
aliases = ['get', 'clone']
1421
def run(self, from_location, to_location=None, revision=None,
1422
hardlink=False, stacked=False, standalone=False, no_tree=False,
1423
use_existing_dir=False, switch=False, bind=False,
1425
from bzrlib import switch as _mod_switch
1426
from bzrlib.tag import _merge_tags_if_possible
1427
if self.invoked_as in ['get', 'clone']:
1428
ui.ui_factory.show_user_warning(
1429
'deprecated_command',
1430
deprecated_name=self.invoked_as,
1431
recommended_name='branch',
1432
deprecated_in_version='2.4')
1433
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1435
if not (hardlink or files_from):
1436
# accelerator_tree is usually slower because you have to read N
1437
# files (no readahead, lots of seeks, etc), but allow the user to
1438
# explicitly request it
1439
accelerator_tree = None
1440
if files_from is not None and files_from != from_location:
1441
accelerator_tree = WorkingTree.open(files_from)
1442
revision = _get_one_revision('branch', revision)
1443
self.add_cleanup(br_from.lock_read().unlock)
1444
if revision is not None:
1445
revision_id = revision.as_revision_id(br_from)
1447
# FIXME - wt.last_revision, fallback to branch, fall back to
1448
# None or perhaps NULL_REVISION to mean copy nothing
1450
revision_id = br_from.last_revision()
1451
if to_location is None:
1452
to_location = getattr(br_from, "name", None)
1454
to_location = urlutils.derive_to_location(from_location)
1455
to_transport = transport.get_transport(to_location)
1457
to_transport.mkdir('.')
1458
except errors.FileExists:
1460
to_dir = controldir.ControlDir.open_from_transport(
1462
except errors.NotBranchError:
1463
if not use_existing_dir:
1464
raise errors.BzrCommandError(gettext('Target directory "%s" '
1465
'already exists.') % to_location)
1470
to_dir.open_branch()
1471
except errors.NotBranchError:
1474
raise errors.AlreadyBranchError(to_location)
1475
except errors.NoSuchFile:
1476
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1482
# preserve whatever source format we have.
1483
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1484
possible_transports=[to_transport],
1485
accelerator_tree=accelerator_tree,
1486
hardlink=hardlink, stacked=stacked,
1487
force_new_repo=standalone,
1488
create_tree_if_local=not no_tree,
1489
source_branch=br_from)
1490
branch = to_dir.open_branch(
1491
possible_transports=[
1492
br_from.bzrdir.root_transport, to_transport])
1493
except errors.NoSuchRevision:
1494
to_transport.delete_tree('.')
1495
msg = gettext("The branch {0} has no revision {1}.").format(
1496
from_location, revision)
1497
raise errors.BzrCommandError(msg)
1500
to_repo = to_dir.open_repository()
1501
except errors.NoRepositoryPresent:
1502
to_repo = to_dir.create_repository()
1503
to_repo.fetch(br_from.repository, revision_id=revision_id)
1504
branch = br_from.sprout(to_dir, revision_id=revision_id)
1505
_merge_tags_if_possible(br_from, branch)
1506
# If the source branch is stacked, the new branch may
1507
# be stacked whether we asked for that explicitly or not.
1508
# We therefore need a try/except here and not just 'if stacked:'
1510
note(gettext('Created new stacked branch referring to %s.') %
1511
branch.get_stacked_on_url())
1512
except (errors.NotStacked, errors.UnstackableBranchFormat,
1513
errors.UnstackableRepositoryFormat), e:
1514
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1516
# Bind to the parent
1517
parent_branch = Branch.open(from_location)
1518
branch.bind(parent_branch)
1519
note(gettext('New branch bound to %s') % from_location)
1521
# Switch to the new branch
1522
wt, _ = WorkingTree.open_containing('.')
1523
_mod_switch.switch(wt.bzrdir, branch)
1524
note(gettext('Switched to branch: %s'),
1525
urlutils.unescape_for_display(branch.base, 'utf-8'))
1528
class cmd_branches(Command):
1529
__doc__ = """List the branches available at the current location.
1531
This command will print the names of all the branches at the current
1535
takes_args = ['location?']
1537
Option('recursive', short_name='R',
1538
help='Recursively scan for branches rather than '
1539
'just looking in the specified location.')]
1541
def run(self, location=".", recursive=False):
1543
t = transport.get_transport(location)
1544
if not t.listable():
1545
raise errors.BzrCommandError(
1546
"Can't scan this type of location.")
1547
for b in controldir.ControlDir.find_branches(t):
1548
self.outf.write("%s\n" % urlutils.unescape_for_display(
1549
urlutils.relative_url(t.base, b.base),
1550
self.outf.encoding).rstrip("/"))
1552
dir = controldir.ControlDir.open_containing(location)[0]
1554
active_branch = dir.open_branch(name="")
1555
except errors.NotBranchError:
1556
active_branch = None
1558
for name, branch in iter_sibling_branches(dir):
1561
active = (active_branch is not None and
1562
active_branch.base == branch.base)
1563
names[name] = active
1564
# Only mention the current branch explicitly if it's not
1565
# one of the colocated branches
1566
if not any(names.values()) and active_branch is not None:
1567
self.outf.write("* %s\n" % gettext("(default)"))
1568
for name in sorted(names.keys()):
1569
active = names[name]
1574
self.outf.write("%s %s\n" % (
1575
prefix, name.encode(self.outf.encoding)))
1578
class cmd_checkout(Command):
1579
__doc__ = """Create a new checkout of an existing branch.
1581
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1582
the branch found in '.'. This is useful if you have removed the working tree
1583
or if it was never created - i.e. if you pushed the branch to its current
1584
location using SFTP.
1586
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1587
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1588
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1589
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1590
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1593
To retrieve the branch as of a particular revision, supply the --revision
1594
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1595
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1599
_see_also = ['checkouts', 'branch']
1600
takes_args = ['branch_location?', 'to_location?']
1601
takes_options = ['revision',
1602
Option('lightweight',
1603
help="Perform a lightweight checkout. Lightweight "
1604
"checkouts depend on access to the branch for "
1605
"every operation. Normal checkouts can perform "
1606
"common operations like diff and status without "
1607
"such access, and also support local commits."
1609
Option('files-from', type=str,
1610
help="Get file contents from this tree."),
1612
help='Hard-link working tree files where possible.'
1617
def run(self, branch_location=None, to_location=None, revision=None,
1618
lightweight=False, files_from=None, hardlink=False):
1619
if branch_location is None:
1620
branch_location = osutils.getcwd()
1621
to_location = branch_location
1622
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1624
if not (hardlink or files_from):
1625
# accelerator_tree is usually slower because you have to read N
1626
# files (no readahead, lots of seeks, etc), but allow the user to
1627
# explicitly request it
1628
accelerator_tree = None
1629
revision = _get_one_revision('checkout', revision)
1630
if files_from is not None and files_from != branch_location:
1631
accelerator_tree = WorkingTree.open(files_from)
1632
if revision is not None:
1633
revision_id = revision.as_revision_id(source)
1636
if to_location is None:
1637
to_location = urlutils.derive_to_location(branch_location)
1638
# if the source and to_location are the same,
1639
# and there is no working tree,
1640
# then reconstitute a branch
1641
if (osutils.abspath(to_location) ==
1642
osutils.abspath(branch_location)):
1644
source.bzrdir.open_workingtree()
1645
except errors.NoWorkingTree:
1646
source.bzrdir.create_workingtree(revision_id)
1648
source.create_checkout(to_location, revision_id, lightweight,
1649
accelerator_tree, hardlink)
1652
class cmd_renames(Command):
1653
__doc__ = """Show list of renamed files.
1655
# TODO: Option to show renames between two historical versions.
1657
# TODO: Only show renames under dir, rather than in the whole branch.
1658
_see_also = ['status']
1659
takes_args = ['dir?']
1662
def run(self, dir=u'.'):
1663
tree = WorkingTree.open_containing(dir)[0]
1664
self.add_cleanup(tree.lock_read().unlock)
1665
old_tree = tree.basis_tree()
1666
self.add_cleanup(old_tree.lock_read().unlock)
1668
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1669
for f, paths, c, v, p, n, k, e in iterator:
1670
if paths[0] == paths[1]:
1674
renames.append(paths)
1676
for old_name, new_name in renames:
1677
self.outf.write("%s => %s\n" % (old_name, new_name))
1680
class cmd_update(Command):
1681
__doc__ = """Update a working tree to a new revision.
1683
This will perform a merge of the destination revision (the tip of the
1684
branch, or the specified revision) into the working tree, and then make
1685
that revision the basis revision for the working tree.
1687
You can use this to visit an older revision, or to update a working tree
1688
that is out of date from its branch.
1690
If there are any uncommitted changes in the tree, they will be carried
1691
across and remain as uncommitted changes after the update. To discard
1692
these changes, use 'bzr revert'. The uncommitted changes may conflict
1693
with the changes brought in by the change in basis revision.
1695
If the tree's branch is bound to a master branch, bzr will also update
1696
the branch from the master.
1698
You cannot update just a single file or directory, because each Bazaar
1699
working tree has just a single basis revision. If you want to restore a
1700
file that has been removed locally, use 'bzr revert' instead of 'bzr
1701
update'. If you want to restore a file to its state in a previous
1702
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1703
out the old content of that file to a new location.
1705
The 'dir' argument, if given, must be the location of the root of a
1706
working tree to update. By default, the working tree that contains the
1707
current working directory is used.
1710
_see_also = ['pull', 'working-trees', 'status-flags']
1711
takes_args = ['dir?']
1712
takes_options = ['revision',
1714
help="Show base revision text in conflicts."),
1718
def run(self, dir=None, revision=None, show_base=None):
1719
if revision is not None and len(revision) != 1:
1720
raise errors.BzrCommandError(gettext(
1721
"bzr update --revision takes exactly one revision"))
1723
tree = WorkingTree.open_containing('.')[0]
1725
tree, relpath = WorkingTree.open_containing(dir)
1728
raise errors.BzrCommandError(gettext(
1729
"bzr update can only update a whole tree, "
1730
"not a file or subdirectory"))
1731
branch = tree.branch
1732
possible_transports = []
1733
master = branch.get_master_branch(
1734
possible_transports=possible_transports)
1735
if master is not None:
1736
branch_location = master.base
1739
branch_location = tree.branch.base
1740
tree.lock_tree_write()
1741
self.add_cleanup(tree.unlock)
1742
# get rid of the final '/' and be ready for display
1743
branch_location = urlutils.unescape_for_display(
1744
branch_location.rstrip('/'),
1746
existing_pending_merges = tree.get_parent_ids()[1:]
1750
# may need to fetch data into a heavyweight checkout
1751
# XXX: this may take some time, maybe we should display a
1753
old_tip = branch.update(possible_transports)
1754
if revision is not None:
1755
revision_id = revision[0].as_revision_id(branch)
1757
revision_id = branch.last_revision()
1758
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1759
revno = branch.revision_id_to_dotted_revno(revision_id)
1760
note(gettext("Tree is up to date at revision {0} of branch {1}"
1761
).format('.'.join(map(str, revno)), branch_location))
1763
view_info = _get_view_info_for_change_reporter(tree)
1764
change_reporter = delta._ChangeReporter(
1765
unversioned_filter=tree.is_ignored,
1766
view_info=view_info)
1768
conflicts = tree.update(
1770
possible_transports=possible_transports,
1771
revision=revision_id,
1773
show_base=show_base)
1774
except errors.NoSuchRevision, e:
1775
raise errors.BzrCommandError(gettext(
1776
"branch has no revision %s\n"
1777
"bzr update --revision only works"
1778
" for a revision in the branch history")
1780
revno = tree.branch.revision_id_to_dotted_revno(
1781
_mod_revision.ensure_null(tree.last_revision()))
1782
note(gettext('Updated to revision {0} of branch {1}').format(
1783
'.'.join(map(str, revno)), branch_location))
1784
parent_ids = tree.get_parent_ids()
1785
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1786
note(gettext('Your local commits will now show as pending merges with '
1787
"'bzr status', and can be committed with 'bzr commit'."))
1794
class cmd_info(Command):
1795
__doc__ = """Show information about a working tree, branch or repository.
1797
This command will show all known locations and formats associated to the
1798
tree, branch or repository.
1800
In verbose mode, statistical information is included with each report.
1801
To see extended statistic information, use a verbosity level of 2 or
1802
higher by specifying the verbose option multiple times, e.g. -vv.
1804
Branches and working trees will also report any missing revisions.
1808
Display information on the format and related locations:
1812
Display the above together with extended format information and
1813
basic statistics (like the number of files in the working tree and
1814
number of revisions in the branch and repository):
1818
Display the above together with number of committers to the branch:
1822
_see_also = ['revno', 'working-trees', 'repositories']
1823
takes_args = ['location?']
1824
takes_options = ['verbose']
1825
encoding_type = 'replace'
1828
def run(self, location=None, verbose=False):
1830
noise_level = get_verbosity_level()
1833
from bzrlib.info import show_bzrdir_info
1834
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1835
verbose=noise_level, outfile=self.outf)
1838
class cmd_remove(Command):
1839
__doc__ = """Remove files or directories.
1841
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1842
delete them if they can easily be recovered using revert otherwise they
1843
will be backed up (adding an extension of the form .~#~). If no options or
1844
parameters are given Bazaar will scan for files that are being tracked by
1845
Bazaar but missing in your tree and stop tracking them for you.
1847
takes_args = ['file*']
1848
takes_options = ['verbose',
1849
Option('new', help='Only remove files that have never been committed.'),
1850
RegistryOption.from_kwargs('file-deletion-strategy',
1851
'The file deletion mode to be used.',
1852
title='Deletion Strategy', value_switches=True, enum_switch=False,
1853
safe='Backup changed files (default).',
1854
keep='Delete from bzr but leave the working copy.',
1855
no_backup='Don\'t backup changed files.',
1856
force='Delete all the specified files, even if they can not be '
1857
'recovered and even if they are non-empty directories. '
1858
'(deprecated, use no-backup)')]
1859
aliases = ['rm', 'del']
1860
encoding_type = 'replace'
1862
def run(self, file_list, verbose=False, new=False,
1863
file_deletion_strategy='safe'):
1864
if file_deletion_strategy == 'force':
1865
note(gettext("(The --force option is deprecated, rather use --no-backup "
1867
file_deletion_strategy = 'no-backup'
1869
tree, file_list = WorkingTree.open_containing_paths(file_list)
1871
if file_list is not None:
1872
file_list = [f for f in file_list]
1874
self.add_cleanup(tree.lock_write().unlock)
1875
# Heuristics should probably all move into tree.remove_smart or
1878
added = tree.changes_from(tree.basis_tree(),
1879
specific_files=file_list).added
1880
file_list = sorted([f[0] for f in added], reverse=True)
1881
if len(file_list) == 0:
1882
raise errors.BzrCommandError(gettext('No matching files.'))
1883
elif file_list is None:
1884
# missing files show up in iter_changes(basis) as
1885
# versioned-with-no-kind.
1887
for change in tree.iter_changes(tree.basis_tree()):
1888
# Find paths in the working tree that have no kind:
1889
if change[1][1] is not None and change[6][1] is None:
1890
missing.append(change[1][1])
1891
file_list = sorted(missing, reverse=True)
1892
file_deletion_strategy = 'keep'
1893
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1894
keep_files=file_deletion_strategy=='keep',
1895
force=(file_deletion_strategy=='no-backup'))
1898
class cmd_file_id(Command):
1899
__doc__ = """Print file_id of a particular file or directory.
1901
The file_id is assigned when the file is first added and remains the
1902
same through all revisions where the file exists, even when it is
1907
_see_also = ['inventory', 'ls']
1908
takes_args = ['filename']
1911
def run(self, filename):
1912
tree, relpath = WorkingTree.open_containing(filename)
1913
i = tree.path2id(relpath)
1915
raise errors.NotVersionedError(filename)
1917
self.outf.write(i + '\n')
1920
class cmd_file_path(Command):
1921
__doc__ = """Print path of file_ids to a file or directory.
1923
This prints one line for each directory down to the target,
1924
starting at the branch root.
1928
takes_args = ['filename']
1931
def run(self, filename):
1932
tree, relpath = WorkingTree.open_containing(filename)
1933
fid = tree.path2id(relpath)
1935
raise errors.NotVersionedError(filename)
1936
segments = osutils.splitpath(relpath)
1937
for pos in range(1, len(segments) + 1):
1938
path = osutils.joinpath(segments[:pos])
1939
self.outf.write("%s\n" % tree.path2id(path))
1942
class cmd_reconcile(Command):
1943
__doc__ = """Reconcile bzr metadata in a branch.
1945
This can correct data mismatches that may have been caused by
1946
previous ghost operations or bzr upgrades. You should only
1947
need to run this command if 'bzr check' or a bzr developer
1948
advises you to run it.
1950
If a second branch is provided, cross-branch reconciliation is
1951
also attempted, which will check that data like the tree root
1952
id which was not present in very early bzr versions is represented
1953
correctly in both branches.
1955
At the same time it is run it may recompress data resulting in
1956
a potential saving in disk space or performance gain.
1958
The branch *MUST* be on a listable system such as local disk or sftp.
1961
_see_also = ['check']
1962
takes_args = ['branch?']
1964
Option('canonicalize-chks',
1965
help='Make sure CHKs are in canonical form (repairs '
1970
def run(self, branch=".", canonicalize_chks=False):
1971
from bzrlib.reconcile import reconcile
1972
dir = controldir.ControlDir.open(branch)
1973
reconcile(dir, canonicalize_chks=canonicalize_chks)
1976
class cmd_revision_history(Command):
1977
__doc__ = """Display the list of revision ids on a branch."""
1980
takes_args = ['location?']
1985
def run(self, location="."):
1986
branch = Branch.open_containing(location)[0]
1987
self.add_cleanup(branch.lock_read().unlock)
1988
graph = branch.repository.get_graph()
1989
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1990
[_mod_revision.NULL_REVISION]))
1991
for revid in reversed(history):
1992
self.outf.write(revid)
1993
self.outf.write('\n')
1996
class cmd_ancestry(Command):
1997
__doc__ = """List all revisions merged into this branch."""
1999
_see_also = ['log', 'revision-history']
2000
takes_args = ['location?']
2005
def run(self, location="."):
2007
wt = WorkingTree.open_containing(location)[0]
2008
except errors.NoWorkingTree:
2009
b = Branch.open(location)
2010
last_revision = b.last_revision()
2013
last_revision = wt.last_revision()
2015
self.add_cleanup(b.repository.lock_read().unlock)
2016
graph = b.repository.get_graph()
2017
revisions = [revid for revid, parents in
2018
graph.iter_ancestry([last_revision])]
2019
for revision_id in reversed(revisions):
2020
if _mod_revision.is_null(revision_id):
2022
self.outf.write(revision_id + '\n')
2025
class cmd_init(Command):
2026
__doc__ = """Make a directory into a versioned branch.
2028
Use this to create an empty branch, or before importing an
2031
If there is a repository in a parent directory of the location, then
2032
the history of the branch will be stored in the repository. Otherwise
2033
init creates a standalone branch which carries its own history
2034
in the .bzr directory.
2036
If there is already a branch at the location but it has no working tree,
2037
the tree can be populated with 'bzr checkout'.
2039
Recipe for importing a tree of files::
2045
bzr commit -m "imported project"
2048
_see_also = ['init-repository', 'branch', 'checkout']
2049
takes_args = ['location?']
2051
Option('create-prefix',
2052
help='Create the path leading up to the branch '
2053
'if it does not already exist.'),
2054
RegistryOption('format',
2055
help='Specify a format for this branch. '
2056
'See "help formats".',
2057
lazy_registry=('bzrlib.controldir', 'format_registry'),
2058
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2059
value_switches=True,
2060
title="Branch format",
2062
Option('append-revisions-only',
2063
help='Never change revnos or the existing log.'
2064
' Append revisions to it only.'),
2066
'Create a branch without a working tree.')
2068
def run(self, location=None, format=None, append_revisions_only=False,
2069
create_prefix=False, no_tree=False):
2071
format = controldir.format_registry.make_bzrdir('default')
2072
if location is None:
2075
to_transport = transport.get_transport(location)
2077
# The path has to exist to initialize a
2078
# branch inside of it.
2079
# Just using os.mkdir, since I don't
2080
# believe that we want to create a bunch of
2081
# locations if the user supplies an extended path
2083
to_transport.ensure_base()
2084
except errors.NoSuchFile:
2085
if not create_prefix:
2086
raise errors.BzrCommandError(gettext("Parent directory of %s"
2088
"\nYou may supply --create-prefix to create all"
2089
" leading parent directories.")
2091
to_transport.create_prefix()
2094
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
2095
except errors.NotBranchError:
2096
# really a NotBzrDir error...
2097
create_branch = controldir.ControlDir.create_branch_convenience
2099
force_new_tree = False
2101
force_new_tree = None
2102
branch = create_branch(to_transport.base, format=format,
2103
possible_transports=[to_transport],
2104
force_new_tree=force_new_tree)
2105
a_bzrdir = branch.bzrdir
2107
from bzrlib.transport.local import LocalTransport
2108
if a_bzrdir.has_branch():
2109
if (isinstance(to_transport, LocalTransport)
2110
and not a_bzrdir.has_workingtree()):
2111
raise errors.BranchExistsWithoutWorkingTree(location)
2112
raise errors.AlreadyBranchError(location)
2113
branch = a_bzrdir.create_branch()
2114
if not no_tree and not a_bzrdir.has_workingtree():
2115
a_bzrdir.create_workingtree()
2116
if append_revisions_only:
2118
branch.set_append_revisions_only(True)
2119
except errors.UpgradeRequired:
2120
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2121
' to append-revisions-only. Try --default.'))
2123
from bzrlib.info import describe_layout, describe_format
2125
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2126
except (errors.NoWorkingTree, errors.NotLocalUrl):
2128
repository = branch.repository
2129
layout = describe_layout(repository, branch, tree).lower()
2130
format = describe_format(a_bzrdir, repository, branch, tree)
2131
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2133
if repository.is_shared():
2134
#XXX: maybe this can be refactored into transport.path_or_url()
2135
url = repository.bzrdir.root_transport.external_url()
2137
url = urlutils.local_path_from_url(url)
2138
except errors.InvalidURL:
2140
self.outf.write(gettext("Using shared repository: %s\n") % url)
2143
class cmd_init_repository(Command):
2144
__doc__ = """Create a shared repository for branches to share storage space.
2146
New branches created under the repository directory will store their
2147
revisions in the repository, not in the branch directory. For branches
2148
with shared history, this reduces the amount of storage needed and
2149
speeds up the creation of new branches.
2151
If the --no-trees option is given then the branches in the repository
2152
will not have working trees by default. They will still exist as
2153
directories on disk, but they will not have separate copies of the
2154
files at a certain revision. This can be useful for repositories that
2155
store branches which are interacted with through checkouts or remote
2156
branches, such as on a server.
2159
Create a shared repository holding just branches::
2161
bzr init-repo --no-trees repo
2164
Make a lightweight checkout elsewhere::
2166
bzr checkout --lightweight repo/trunk trunk-checkout
2171
_see_also = ['init', 'branch', 'checkout', 'repositories']
2172
takes_args = ["location"]
2173
takes_options = [RegistryOption('format',
2174
help='Specify a format for this repository. See'
2175
' "bzr help formats" for details.',
2176
lazy_registry=('bzrlib.controldir', 'format_registry'),
2177
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2178
value_switches=True, title='Repository format'),
2180
help='Branches in the repository will default to'
2181
' not having a working tree.'),
2183
aliases = ["init-repo"]
2185
def run(self, location, format=None, no_trees=False):
2187
format = controldir.format_registry.make_bzrdir('default')
2189
if location is None:
2192
to_transport = transport.get_transport(location)
2194
(repo, newdir, require_stacking, repository_policy) = (
2195
format.initialize_on_transport_ex(to_transport,
2196
create_prefix=True, make_working_trees=not no_trees,
2197
shared_repo=True, force_new_repo=True,
2198
use_existing_dir=True,
2199
repo_format_name=format.repository_format.get_format_string()))
2201
from bzrlib.info import show_bzrdir_info
2202
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2205
class cmd_diff(Command):
2206
__doc__ = """Show differences in the working tree, between revisions or branches.
2208
If no arguments are given, all changes for the current tree are listed.
2209
If files are given, only the changes in those files are listed.
2210
Remote and multiple branches can be compared by using the --old and
2211
--new options. If not provided, the default for both is derived from
2212
the first argument, if any, or the current tree if no arguments are
2215
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2216
produces patches suitable for "patch -p1".
2218
Note that when using the -r argument with a range of revisions, the
2219
differences are computed between the two specified revisions. That
2220
is, the command does not show the changes introduced by the first
2221
revision in the range. This differs from the interpretation of
2222
revision ranges used by "bzr log" which includes the first revision
2227
2 - unrepresentable changes
2232
Shows the difference in the working tree versus the last commit::
2236
Difference between the working tree and revision 1::
2240
Difference between revision 3 and revision 1::
2244
Difference between revision 3 and revision 1 for branch xxx::
2248
The changes introduced by revision 2 (equivalent to -r1..2)::
2252
To see the changes introduced by revision X::
2256
Note that in the case of a merge, the -c option shows the changes
2257
compared to the left hand parent. To see the changes against
2258
another parent, use::
2260
bzr diff -r<chosen_parent>..X
2262
The changes between the current revision and the previous revision
2263
(equivalent to -c-1 and -r-2..-1)
2267
Show just the differences for file NEWS::
2271
Show the differences in working tree xxx for file NEWS::
2275
Show the differences from branch xxx to this working tree:
2279
Show the differences between two branches for file NEWS::
2281
bzr diff --old xxx --new yyy NEWS
2283
Same as 'bzr diff' but prefix paths with old/ and new/::
2285
bzr diff --prefix old/:new/
2287
Show the differences using a custom diff program with options::
2289
bzr diff --using /usr/bin/diff --diff-options -wu
2291
_see_also = ['status']
2292
takes_args = ['file*']
2294
Option('diff-options', type=str,
2295
help='Pass these options to the external diff program.'),
2296
Option('prefix', type=str,
2298
help='Set prefixes added to old and new filenames, as '
2299
'two values separated by a colon. (eg "old/:new/").'),
2301
help='Branch/tree to compare from.',
2305
help='Branch/tree to compare to.',
2311
help='Use this command to compare files.',
2314
RegistryOption('format',
2316
help='Diff format to use.',
2317
lazy_registry=('bzrlib.diff', 'format_registry'),
2318
title='Diff format'),
2320
aliases = ['di', 'dif']
2321
encoding_type = 'exact'
2324
def run(self, revision=None, file_list=None, diff_options=None,
2325
prefix=None, old=None, new=None, using=None, format=None):
2326
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2329
if (prefix is None) or (prefix == '0'):
2337
old_label, new_label = prefix.split(":")
2339
raise errors.BzrCommandError(gettext(
2340
'--prefix expects two values separated by a colon'
2341
' (eg "old/:new/")'))
2343
if revision and len(revision) > 2:
2344
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2345
' one or two revision specifiers'))
2347
if using is not None and format is not None:
2348
raise errors.BzrCommandError(gettext(
2349
'{0} and {1} are mutually exclusive').format(
2350
'--using', '--format'))
2352
(old_tree, new_tree,
2353
old_branch, new_branch,
2354
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2355
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2356
# GNU diff on Windows uses ANSI encoding for filenames
2357
path_encoding = osutils.get_diff_header_encoding()
2358
return show_diff_trees(old_tree, new_tree, sys.stdout,
2359
specific_files=specific_files,
2360
external_diff_options=diff_options,
2361
old_label=old_label, new_label=new_label,
2362
extra_trees=extra_trees,
2363
path_encoding=path_encoding,
2368
class cmd_deleted(Command):
2369
__doc__ = """List files deleted in the working tree.
2371
# TODO: Show files deleted since a previous revision, or
2372
# between two revisions.
2373
# TODO: Much more efficient way to do this: read in new
2374
# directories with readdir, rather than stating each one. Same
2375
# level of effort but possibly much less IO. (Or possibly not,
2376
# if the directories are very large...)
2377
_see_also = ['status', 'ls']
2378
takes_options = ['directory', 'show-ids']
2381
def run(self, show_ids=False, directory=u'.'):
2382
tree = WorkingTree.open_containing(directory)[0]
2383
self.add_cleanup(tree.lock_read().unlock)
2384
old = tree.basis_tree()
2385
self.add_cleanup(old.lock_read().unlock)
2386
for path, ie in old.iter_entries_by_dir():
2387
if not tree.has_id(ie.file_id):
2388
self.outf.write(path)
2390
self.outf.write(' ')
2391
self.outf.write(ie.file_id)
2392
self.outf.write('\n')
2395
class cmd_modified(Command):
2396
__doc__ = """List files modified in working tree.
2400
_see_also = ['status', 'ls']
2401
takes_options = ['directory', 'null']
2404
def run(self, null=False, directory=u'.'):
2405
tree = WorkingTree.open_containing(directory)[0]
2406
self.add_cleanup(tree.lock_read().unlock)
2407
td = tree.changes_from(tree.basis_tree())
2409
for path, id, kind, text_modified, meta_modified in td.modified:
2411
self.outf.write(path + '\0')
2413
self.outf.write(osutils.quotefn(path) + '\n')
2416
class cmd_added(Command):
2417
__doc__ = """List files added in working tree.
2421
_see_also = ['status', 'ls']
2422
takes_options = ['directory', 'null']
2425
def run(self, null=False, directory=u'.'):
2426
wt = WorkingTree.open_containing(directory)[0]
2427
self.add_cleanup(wt.lock_read().unlock)
2428
basis = wt.basis_tree()
2429
self.add_cleanup(basis.lock_read().unlock)
2430
root_id = wt.get_root_id()
2431
for file_id in wt.all_file_ids():
2432
if basis.has_id(file_id):
2434
if root_id == file_id:
2436
path = wt.id2path(file_id)
2437
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2440
self.outf.write(path + '\0')
2442
self.outf.write(osutils.quotefn(path) + '\n')
2445
class cmd_root(Command):
2446
__doc__ = """Show the tree root directory.
2448
The root is the nearest enclosing directory with a .bzr control
2451
takes_args = ['filename?']
2453
def run(self, filename=None):
2454
"""Print the branch root."""
2455
tree = WorkingTree.open_containing(filename)[0]
2456
self.outf.write(tree.basedir + '\n')
2459
def _parse_limit(limitstring):
2461
return int(limitstring)
2463
msg = gettext("The limit argument must be an integer.")
2464
raise errors.BzrCommandError(msg)
2467
def _parse_levels(s):
2471
msg = gettext("The levels argument must be an integer.")
2472
raise errors.BzrCommandError(msg)
2475
class cmd_log(Command):
2476
__doc__ = """Show historical log for a branch or subset of a branch.
2478
log is bzr's default tool for exploring the history of a branch.
2479
The branch to use is taken from the first parameter. If no parameters
2480
are given, the branch containing the working directory is logged.
2481
Here are some simple examples::
2483
bzr log log the current branch
2484
bzr log foo.py log a file in its branch
2485
bzr log http://server/branch log a branch on a server
2487
The filtering, ordering and information shown for each revision can
2488
be controlled as explained below. By default, all revisions are
2489
shown sorted (topologically) so that newer revisions appear before
2490
older ones and descendants always appear before ancestors. If displayed,
2491
merged revisions are shown indented under the revision in which they
2496
The log format controls how information about each revision is
2497
displayed. The standard log formats are called ``long``, ``short``
2498
and ``line``. The default is long. See ``bzr help log-formats``
2499
for more details on log formats.
2501
The following options can be used to control what information is
2504
-l N display a maximum of N revisions
2505
-n N display N levels of revisions (0 for all, 1 for collapsed)
2506
-v display a status summary (delta) for each revision
2507
-p display a diff (patch) for each revision
2508
--show-ids display revision-ids (and file-ids), not just revnos
2510
Note that the default number of levels to display is a function of the
2511
log format. If the -n option is not used, the standard log formats show
2512
just the top level (mainline).
2514
Status summaries are shown using status flags like A, M, etc. To see
2515
the changes explained using words like ``added`` and ``modified``
2516
instead, use the -vv option.
2520
To display revisions from oldest to newest, use the --forward option.
2521
In most cases, using this option will have little impact on the total
2522
time taken to produce a log, though --forward does not incrementally
2523
display revisions like --reverse does when it can.
2525
:Revision filtering:
2527
The -r option can be used to specify what revision or range of revisions
2528
to filter against. The various forms are shown below::
2530
-rX display revision X
2531
-rX.. display revision X and later
2532
-r..Y display up to and including revision Y
2533
-rX..Y display from X to Y inclusive
2535
See ``bzr help revisionspec`` for details on how to specify X and Y.
2536
Some common examples are given below::
2538
-r-1 show just the tip
2539
-r-10.. show the last 10 mainline revisions
2540
-rsubmit:.. show what's new on this branch
2541
-rancestor:path.. show changes since the common ancestor of this
2542
branch and the one at location path
2543
-rdate:yesterday.. show changes since yesterday
2545
When logging a range of revisions using -rX..Y, log starts at
2546
revision Y and searches back in history through the primary
2547
("left-hand") parents until it finds X. When logging just the
2548
top level (using -n1), an error is reported if X is not found
2549
along the way. If multi-level logging is used (-n0), X may be
2550
a nested merge revision and the log will be truncated accordingly.
2554
If parameters are given and the first one is not a branch, the log
2555
will be filtered to show only those revisions that changed the
2556
nominated files or directories.
2558
Filenames are interpreted within their historical context. To log a
2559
deleted file, specify a revision range so that the file existed at
2560
the end or start of the range.
2562
Historical context is also important when interpreting pathnames of
2563
renamed files/directories. Consider the following example:
2565
* revision 1: add tutorial.txt
2566
* revision 2: modify tutorial.txt
2567
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2571
* ``bzr log guide.txt`` will log the file added in revision 1
2573
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2575
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2576
the original file in revision 2.
2578
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2579
was no file called guide.txt in revision 2.
2581
Renames are always followed by log. By design, there is no need to
2582
explicitly ask for this (and no way to stop logging a file back
2583
until it was last renamed).
2587
The --match option can be used for finding revisions that match a
2588
regular expression in a commit message, committer, author or bug.
2589
Specifying the option several times will match any of the supplied
2590
expressions. --match-author, --match-bugs, --match-committer and
2591
--match-message can be used to only match a specific field.
2595
GUI tools and IDEs are often better at exploring history than command
2596
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2597
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2598
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2599
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2601
You may find it useful to add the aliases below to ``bazaar.conf``::
2605
top = log -l10 --line
2608
``bzr tip`` will then show the latest revision while ``bzr top``
2609
will show the last 10 mainline revisions. To see the details of a
2610
particular revision X, ``bzr show -rX``.
2612
If you are interested in looking deeper into a particular merge X,
2613
use ``bzr log -n0 -rX``.
2615
``bzr log -v`` on a branch with lots of history is currently
2616
very slow. A fix for this issue is currently under development.
2617
With or without that fix, it is recommended that a revision range
2618
be given when using the -v option.
2620
bzr has a generic full-text matching plugin, bzr-search, that can be
2621
used to find revisions matching user names, commit messages, etc.
2622
Among other features, this plugin can find all revisions containing
2623
a list of words but not others.
2625
When exploring non-mainline history on large projects with deep
2626
history, the performance of log can be greatly improved by installing
2627
the historycache plugin. This plugin buffers historical information
2628
trading disk space for faster speed.
2630
takes_args = ['file*']
2631
_see_also = ['log-formats', 'revisionspec']
2634
help='Show from oldest to newest.'),
2636
custom_help('verbose',
2637
help='Show files changed in each revision.'),
2641
type=bzrlib.option._parse_revision_str,
2643
help='Show just the specified revision.'
2644
' See also "help revisionspec".'),
2646
RegistryOption('authors',
2647
'What names to list as authors - first, all or committer.',
2649
lazy_registry=('bzrlib.log', 'author_list_registry'),
2653
help='Number of levels to display - 0 for all, 1 for flat.',
2655
type=_parse_levels),
2657
help='Show revisions whose message matches this '
2658
'regular expression.',
2663
help='Limit the output to the first N revisions.',
2668
help='Show changes made in each revision as a patch.'),
2669
Option('include-merged',
2670
help='Show merged revisions like --levels 0 does.'),
2671
Option('include-merges', hidden=True,
2672
help='Historical alias for --include-merged.'),
2673
Option('omit-merges',
2674
help='Do not report commits with more than one parent.'),
2675
Option('exclude-common-ancestry',
2676
help='Display only the revisions that are not part'
2677
' of both ancestries (require -rX..Y).'
2679
Option('signatures',
2680
help='Show digital signature validity.'),
2683
help='Show revisions whose properties match this '
2686
ListOption('match-message',
2687
help='Show revisions whose message matches this '
2690
ListOption('match-committer',
2691
help='Show revisions whose committer matches this '
2694
ListOption('match-author',
2695
help='Show revisions whose authors match this '
2698
ListOption('match-bugs',
2699
help='Show revisions whose bugs match this '
2703
encoding_type = 'replace'
2706
def run(self, file_list=None, timezone='original',
2717
include_merged=None,
2719
exclude_common_ancestry=False,
2723
match_committer=None,
2727
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2729
from bzrlib.log import (
2731
make_log_request_dict,
2732
_get_info_for_log_files,
2734
direction = (forward and 'forward') or 'reverse'
2735
if symbol_versioning.deprecated_passed(include_merges):
2736
ui.ui_factory.show_user_warning(
2737
'deprecated_command_option',
2738
deprecated_name='--include-merges',
2739
recommended_name='--include-merged',
2740
deprecated_in_version='2.5',
2741
command=self.invoked_as)
2742
if include_merged is None:
2743
include_merged = include_merges
2745
raise errors.BzrCommandError(gettext(
2746
'{0} and {1} are mutually exclusive').format(
2747
'--include-merges', '--include-merged'))
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
"bzr %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
'bzr %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 "bzr 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 errors.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 ``bzr 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
bzr ignore ./Makefile
3131
Ignore .class files in all directories...::
3133
bzr ignore "*.class"
3135
...but do not ignore "special.class"::
3137
bzr ignore "!special.class"
3139
Ignore files whose name begins with the "#" character::
3143
Ignore .o files under the lib directory::
3145
bzr ignore "lib/**/*.o"
3147
Ignore .o files under the lib directory::
3149
bzr ignore "RE:lib/.*\.o"
3151
Ignore everything but the "debian" toplevel directory::
3153
bzr ignore "RE:(?!debian/).*"
3155
Ignore everything except the "local" toplevel directory,
3156
but always ignore autosave files ending in ~, even under local/::
3159
bzr 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 bzr uses.')
3170
def run(self, name_pattern_list=None, default_rules=None,
3172
from bzrlib 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 errors.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 'bzr 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
bzr 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 bzrlib.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, 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("bzr 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 bzrlib.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
bzr 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 ``bzr 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 ``bzr 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 ``bzr 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=unicode,
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 \"bzr help bugs\")."),
3504
ListOption('author', type=unicode,
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
"\"bzr 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 \"bzr 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 errors.UnknownBugTrackerAbbreviation:
3552
raise errors.BzrCommandError(gettext(
3553
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3554
except errors.MalformedBugIdentifier, 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 bzrlib.errors import (
3567
from bzrlib.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, 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 'bzr 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 "bzr conflicts" to list, "bzr 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, 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 bzr 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
bzr check --tree --branch foo
3731
Check only the repository at 'bar'::
3733
bzr 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 bzrlib.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 "bzr help'
3798
' formats" for details.',
3799
lazy_registry=('bzrlib.controldir', 'format_registry'),
3800
converter=lambda name: controldir.format_registry.make_bzrdir(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 bzrlib.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 bzr user id.
3823
Show the email of the current user::
3827
Set the current user::
3829
bzr 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 errors.NoEmailInUsername, 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
bzr alias ll="log --line -r-10..-1"
3926
To remove an alias for 'll'::
3928
bzr 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
'bzr 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(aliases.iteritems()):
3962
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3965
def print_alias(self, alias_name):
3966
from bzrlib.commands import get_alias
3967
alias = get_alias(alias_name)
3969
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3972
'bzr 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 BZR_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
bzr --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 bzrlib.tests import stub_sftp
4035
return stub_sftp.SFTPAbsoluteServer
4036
elif typestring == "memory":
4037
from bzrlib.tests import test_server
4038
return memory.MemoryServer
4039
elif typestring == "fakenfs":
4040
from bzrlib.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=('bzrlib.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()
4122
from bzrlib import tests
4124
if testspecs_list is not None:
4125
pattern = '|'.join(testspecs_list)
4130
from bzrlib.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 bzr 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 bzr."""
4198
encoding_type = 'replace'
4200
Option("short", help="Print just the version number."),
4204
def run(self, short=False):
4205
from bzrlib.version import show_version
4207
self.outf.write(bzrlib.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 bzrlib.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 bzr 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 bzr 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". bzr 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 bzr resolve when you have fixed a problem. See also bzr 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 bzr 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 bzr.dev::
4306
bzr merge ../bzr.dev
4308
To merge changes up to and including revision 82 from bzr.dev::
4310
bzr merge -r 82 ../bzr.dev
4312
To merge the changes introduced by 82, without previous changes::
4314
bzr merge -r 81..82 ../bzr.dev
4316
To apply a merge directive contained in /tmp/merge::
4318
bzr merge /tmp/merge
4320
To create a merge revision with three parents from two branches
4321
feature1a and feature1b:
4323
bzr merge ../feature1a
4324
bzr merge ../feature1b --force
4325
bzr 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 'bzr 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 bzrlib.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 bzrlib import shelf_ui
4491
result_tree = self._get_preview(merger)
4492
writer = bzrlib.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
from bzrlib.tag import _merge_tags_if_possible
4524
# find the branch locations
4525
other_loc, user_location = self._select_branch_location(tree, location,
4527
if revision is not None and len(revision) == 2:
4528
base_loc, _unused = self._select_branch_location(tree,
4529
location, revision, 0)
4531
base_loc = other_loc
4533
other_branch, other_path = Branch.open_containing(other_loc,
4534
possible_transports)
4535
if base_loc == other_loc:
4536
base_branch = other_branch
4538
base_branch, base_path = Branch.open_containing(base_loc,
4539
possible_transports)
4540
# Find the revision ids
4541
other_revision_id = None
4542
base_revision_id = None
4543
if revision is not None:
4544
if len(revision) >= 1:
4545
other_revision_id = revision[-1].as_revision_id(other_branch)
4546
if len(revision) == 2:
4547
base_revision_id = revision[0].as_revision_id(base_branch)
4548
if other_revision_id is None:
4549
other_revision_id = _mod_revision.ensure_null(
4550
other_branch.last_revision())
4551
# Remember where we merge from. We need to remember if:
4552
# - user specify a location (and we don't merge from the parent
4554
# - user ask to remember or there is no previous location set to merge
4555
# from and user didn't ask to *not* remember
4556
if (user_location is not None
4558
or (remember is None
4559
and tree.branch.get_submit_branch() is None)))):
4560
tree.branch.set_submit_branch(other_branch.base)
4561
# Merge tags (but don't set them in the master branch yet, the user
4562
# might revert this merge). Commit will propagate them.
4563
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4564
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4565
other_revision_id, base_revision_id, other_branch, base_branch)
4566
if other_path != '':
4567
allow_pending = False
4568
merger.interesting_files = [other_path]
4570
allow_pending = True
4571
return merger, allow_pending
4573
def get_merger_from_uncommitted(self, tree, location, pb):
4574
"""Get a merger for uncommitted changes.
4576
:param tree: The tree the merger should apply to.
4577
:param location: The location containing uncommitted changes.
4578
:param pb: The progress bar to use for showing progress.
4580
location = self._select_branch_location(tree, location)[0]
4581
other_tree, other_path = WorkingTree.open_containing(location)
4582
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4583
if other_path != '':
4584
merger.interesting_files = [other_path]
4587
def _select_branch_location(self, tree, user_location, revision=None,
4589
"""Select a branch location, according to possible inputs.
4591
If provided, branches from ``revision`` are preferred. (Both
4592
``revision`` and ``index`` must be supplied.)
4594
Otherwise, the ``location`` parameter is used. If it is None, then the
4595
``submit`` or ``parent`` location is used, and a note is printed.
4597
:param tree: The working tree to select a branch for merging into
4598
:param location: The location entered by the user
4599
:param revision: The revision parameter to the command
4600
:param index: The index to use for the revision parameter. Negative
4601
indices are permitted.
4602
:return: (selected_location, user_location). The default location
4603
will be the user-entered location.
4605
if (revision is not None and index is not None
4606
and revision[index] is not None):
4607
branch = revision[index].get_branch()
4608
if branch is not None:
4609
return branch, branch
4610
if user_location is None:
4611
location = self._get_remembered(tree, 'Merging from')
4613
location = user_location
4614
return location, user_location
4616
def _get_remembered(self, tree, verb_string):
4617
"""Use tree.branch's parent if none was supplied.
4619
Report if the remembered location was used.
4621
stored_location = tree.branch.get_submit_branch()
4622
stored_location_type = "submit"
4623
if stored_location is None:
4624
stored_location = tree.branch.get_parent()
4625
stored_location_type = "parent"
4626
mutter("%s", stored_location)
4627
if stored_location is None:
4628
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4629
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4630
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4631
stored_location_type, display_url))
4632
return stored_location
4635
class cmd_remerge(Command):
4636
__doc__ = """Redo a merge.
4638
Use this if you want to try a different merge technique while resolving
4639
conflicts. Some merge techniques are better than others, and remerge
4640
lets you try different ones on different files.
4642
The options for remerge have the same meaning and defaults as the ones for
4643
merge. The difference is that remerge can (only) be run when there is a
4644
pending merge, and it lets you specify particular files.
4647
Re-do the merge of all conflicted files, and show the base text in
4648
conflict regions, in addition to the usual THIS and OTHER texts::
4650
bzr remerge --show-base
4652
Re-do the merge of "foobar", using the weave merge algorithm, with
4653
additional processing to reduce the size of conflict regions::
4655
bzr remerge --merge-type weave --reprocess foobar
4657
takes_args = ['file*']
4662
help="Show base revision text in conflicts."),
4665
def run(self, file_list=None, merge_type=None, show_base=False,
4667
from bzrlib.conflicts import restore
4668
if merge_type is None:
4669
merge_type = _mod_merge.Merge3Merger
4670
tree, file_list = WorkingTree.open_containing_paths(file_list)
4671
self.add_cleanup(tree.lock_write().unlock)
4672
parents = tree.get_parent_ids()
4673
if len(parents) != 2:
4674
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4675
" merges. Not cherrypicking or"
4677
repository = tree.branch.repository
4678
interesting_ids = None
4680
conflicts = tree.conflicts()
4681
if file_list is not None:
4682
interesting_ids = set()
4683
for filename in file_list:
4684
file_id = tree.path2id(filename)
4686
raise errors.NotVersionedError(filename)
4687
interesting_ids.add(file_id)
4688
if tree.kind(file_id) != "directory":
4691
# FIXME: Support nested trees
4692
for name, ie in tree.root_inventory.iter_entries(file_id):
4693
interesting_ids.add(ie.file_id)
4694
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4696
# Remerge only supports resolving contents conflicts
4697
allowed_conflicts = ('text conflict', 'contents conflict')
4698
restore_files = [c.path for c in conflicts
4699
if c.typestring in allowed_conflicts]
4700
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4701
tree.set_conflicts(ConflictList(new_conflicts))
4702
if file_list is not None:
4703
restore_files = file_list
4704
for filename in restore_files:
4706
restore(tree.abspath(filename))
4707
except errors.NotConflicted:
4709
# Disable pending merges, because the file texts we are remerging
4710
# have not had those merges performed. If we use the wrong parents
4711
# list, we imply that the working tree text has seen and rejected
4712
# all the changes from the other tree, when in fact those changes
4713
# have not yet been seen.
4714
tree.set_parent_ids(parents[:1])
4716
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4717
merger.interesting_ids = interesting_ids
4718
merger.merge_type = merge_type
4719
merger.show_base = show_base
4720
merger.reprocess = reprocess
4721
conflicts = merger.do_merge()
4723
tree.set_parent_ids(parents)
4730
class cmd_revert(Command):
4732
Set files in the working tree back to the contents of a previous revision.
4734
Giving a list of files will revert only those files. Otherwise, all files
4735
will be reverted. If the revision is not specified with '--revision', the
4736
working tree basis revision is used. A revert operation affects only the
4737
working tree, not any revision history like the branch and repository or
4738
the working tree basis revision.
4740
To remove only some changes, without reverting to a prior version, use
4741
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4742
will remove the changes introduced by the second last commit (-2), without
4743
affecting the changes introduced by the last commit (-1). To remove
4744
certain changes on a hunk-by-hunk basis, see the shelve command.
4745
To update the branch to a specific revision or the latest revision and
4746
update the working tree accordingly while preserving local changes, see the
4749
Uncommitted changes to files that are reverted will be discarded.
4750
Howver, by default, any files that have been manually changed will be
4751
backed up first. (Files changed only by merge are not backed up.) Backup
4752
files have '.~#~' appended to their name, where # is a number.
4754
When you provide files, you can use their current pathname or the pathname
4755
from the target revision. So you can use revert to "undelete" a file by
4756
name. If you name a directory, all the contents of that directory will be
4759
If you have newly added files since the target revision, they will be
4760
removed. If the files to be removed have been changed, backups will be
4761
created as above. Directories containing unknown files will not be
4764
The working tree contains a list of revisions that have been merged but
4765
not yet committed. These revisions will be included as additional parents
4766
of the next commit. Normally, using revert clears that list as well as
4767
reverting the files. If any files are specified, revert leaves the list
4768
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4769
.`` in the tree root to revert all files but keep the recorded merges,
4770
and ``bzr revert --forget-merges`` to clear the pending merge list without
4771
reverting any files.
4773
Using "bzr revert --forget-merges", it is possible to apply all of the
4774
changes from a branch in a single revision. To do this, perform the merge
4775
as desired. Then doing revert with the "--forget-merges" option will keep
4776
the content of the tree as it was, but it will clear the list of pending
4777
merges. The next commit will then contain all of the changes that are
4778
present in the other branch, but without any other parent revisions.
4779
Because this technique forgets where these changes originated, it may
4780
cause additional conflicts on later merges involving the same source and
4784
_see_also = ['cat', 'export', 'merge', 'shelve']
4787
Option('no-backup', "Do not save backups of reverted files."),
4788
Option('forget-merges',
4789
'Remove pending merge marker, without changing any files.'),
4791
takes_args = ['file*']
4793
def run(self, revision=None, no_backup=False, file_list=None,
4794
forget_merges=None):
4795
tree, file_list = WorkingTree.open_containing_paths(file_list)
4796
self.add_cleanup(tree.lock_tree_write().unlock)
4798
tree.set_parent_ids(tree.get_parent_ids()[:1])
4800
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4803
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4804
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4805
tree.revert(file_list, rev_tree, not no_backup, None,
4806
report_changes=True)
4809
class cmd_assert_fail(Command):
4810
__doc__ = """Test reporting of assertion failures"""
4811
# intended just for use in testing
4816
raise AssertionError("always fails")
4819
class cmd_help(Command):
4820
__doc__ = """Show help on a command or other topic.
4823
_see_also = ['topics']
4825
Option('long', 'Show help on all commands.'),
4827
takes_args = ['topic?']
4828
aliases = ['?', '--help', '-?', '-h']
4831
def run(self, topic=None, long=False):
4833
if topic is None and long:
4835
bzrlib.help.help(topic)
4838
class cmd_shell_complete(Command):
4839
__doc__ = """Show appropriate completions for context.
4841
For a list of all available commands, say 'bzr shell-complete'.
4843
takes_args = ['context?']
4848
def run(self, context=None):
4849
from bzrlib import shellcomplete
4850
shellcomplete.shellcomplete(context)
4853
class cmd_missing(Command):
4854
__doc__ = """Show unmerged/unpulled revisions between two branches.
4856
OTHER_BRANCH may be local or remote.
4858
To filter on a range of revisions, you can use the command -r begin..end
4859
-r revision requests a specific revision, -r ..end or -r begin.. are
4863
1 - some missing revisions
4864
0 - no missing revisions
4868
Determine the missing revisions between this and the branch at the
4869
remembered pull location::
4873
Determine the missing revisions between this and another branch::
4875
bzr missing http://server/branch
4877
Determine the missing revisions up to a specific revision on the other
4880
bzr missing -r ..-10
4882
Determine the missing revisions up to a specific revision on this
4885
bzr missing --my-revision ..-10
4888
_see_also = ['merge', 'pull']
4889
takes_args = ['other_branch?']
4892
Option('reverse', 'Reverse the order of revisions.'),
4894
'Display changes in the local branch only.'),
4895
Option('this' , 'Same as --mine-only.'),
4896
Option('theirs-only',
4897
'Display changes in the remote branch only.'),
4898
Option('other', 'Same as --theirs-only.'),
4902
custom_help('revision',
4903
help='Filter on other branch revisions (inclusive). '
4904
'See "help revisionspec" for details.'),
4905
Option('my-revision',
4906
type=_parse_revision_str,
4907
help='Filter on local branch revisions (inclusive). '
4908
'See "help revisionspec" for details.'),
4909
Option('include-merged',
4910
'Show all revisions in addition to the mainline ones.'),
4911
Option('include-merges', hidden=True,
4912
help='Historical alias for --include-merged.'),
4914
encoding_type = 'replace'
4917
def run(self, other_branch=None, reverse=False, mine_only=False,
4919
log_format=None, long=False, short=False, line=False,
4920
show_ids=False, verbose=False, this=False, other=False,
4921
include_merged=None, revision=None, my_revision=None,
4923
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4924
from bzrlib.missing import find_unmerged, iter_log_revisions
4929
if symbol_versioning.deprecated_passed(include_merges):
4930
ui.ui_factory.show_user_warning(
4931
'deprecated_command_option',
4932
deprecated_name='--include-merges',
4933
recommended_name='--include-merged',
4934
deprecated_in_version='2.5',
4935
command=self.invoked_as)
4936
if include_merged is None:
4937
include_merged = include_merges
4939
raise errors.BzrCommandError(gettext(
4940
'{0} and {1} are mutually exclusive').format(
4941
'--include-merges', '--include-merged'))
4942
if include_merged is None:
4943
include_merged = False
4948
# TODO: We should probably check that we don't have mine-only and
4949
# theirs-only set, but it gets complicated because we also have
4950
# this and other which could be used.
4957
local_branch = Branch.open_containing(directory)[0]
4958
self.add_cleanup(local_branch.lock_read().unlock)
4960
parent = local_branch.get_parent()
4961
if other_branch is None:
4962
other_branch = parent
4963
if other_branch is None:
4964
raise errors.BzrCommandError(gettext("No peer location known"
4966
display_url = urlutils.unescape_for_display(parent,
4968
message(gettext("Using saved parent location: {0}\n").format(
4971
remote_branch = Branch.open(other_branch)
4972
if remote_branch.base == local_branch.base:
4973
remote_branch = local_branch
4975
self.add_cleanup(remote_branch.lock_read().unlock)
4977
local_revid_range = _revision_range_to_revid_range(
4978
_get_revision_range(my_revision, local_branch,
4981
remote_revid_range = _revision_range_to_revid_range(
4982
_get_revision_range(revision,
4983
remote_branch, self.name()))
4985
local_extra, remote_extra = find_unmerged(
4986
local_branch, remote_branch, restrict,
4987
backward=not reverse,
4988
include_merged=include_merged,
4989
local_revid_range=local_revid_range,
4990
remote_revid_range=remote_revid_range)
4992
if log_format is None:
4993
registry = log.log_formatter_registry
4994
log_format = registry.get_default(local_branch)
4995
lf = log_format(to_file=self.outf,
4997
show_timezone='original')
5000
if local_extra and not theirs_only:
5001
message(ngettext("You have %d extra revision:\n",
5002
"You have %d extra revisions:\n",
5005
for revision in iter_log_revisions(local_extra,
5006
local_branch.repository,
5008
lf.log_revision(revision)
5009
printed_local = True
5012
printed_local = False
5014
if remote_extra and not mine_only:
5015
if printed_local is True:
5017
message(ngettext("You are missing %d revision:\n",
5018
"You are missing %d revisions:\n",
5019
len(remote_extra)) %
5021
for revision in iter_log_revisions(remote_extra,
5022
remote_branch.repository,
5024
lf.log_revision(revision)
5027
if mine_only and not local_extra:
5028
# We checked local, and found nothing extra
5029
message(gettext('This branch has no new revisions.\n'))
5030
elif theirs_only and not remote_extra:
5031
# We checked remote, and found nothing extra
5032
message(gettext('Other branch has no new revisions.\n'))
5033
elif not (mine_only or theirs_only or local_extra or
5035
# We checked both branches, and neither one had extra
5037
message(gettext("Branches are up to date.\n"))
5039
if not status_code and parent is None and other_branch is not None:
5040
self.add_cleanup(local_branch.lock_write().unlock)
5041
# handle race conditions - a parent might be set while we run.
5042
if local_branch.get_parent() is None:
5043
local_branch.set_parent(remote_branch.base)
5047
class cmd_pack(Command):
5048
__doc__ = """Compress the data within a repository.
5050
This operation compresses the data within a bazaar repository. As
5051
bazaar supports automatic packing of repository, this operation is
5052
normally not required to be done manually.
5054
During the pack operation, bazaar takes a backup of existing repository
5055
data, i.e. pack files. This backup is eventually removed by bazaar
5056
automatically when it is safe to do so. To save disk space by removing
5057
the backed up pack files, the --clean-obsolete-packs option may be
5060
Warning: If you use --clean-obsolete-packs and your machine crashes
5061
during or immediately after repacking, you may be left with a state
5062
where the deletion has been written to disk but the new packs have not
5063
been. In this case the repository may be unusable.
5066
_see_also = ['repositories']
5067
takes_args = ['branch_or_repo?']
5069
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5072
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5073
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5075
branch = dir.open_branch()
5076
repository = branch.repository
5077
except errors.NotBranchError:
5078
repository = dir.open_repository()
5079
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5082
class cmd_plugins(Command):
5083
__doc__ = """List the installed plugins.
5085
This command displays the list of installed plugins including
5086
version of plugin and a short description of each.
5088
--verbose shows the path where each plugin is located.
5090
A plugin is an external component for Bazaar that extends the
5091
revision control system, by adding or replacing code in Bazaar.
5092
Plugins can do a variety of things, including overriding commands,
5093
adding new commands, providing additional network transports and
5094
customizing log output.
5096
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5097
for further information on plugins including where to find them and how to
5098
install them. Instructions are also provided there on how to write new
5099
plugins using the Python programming language.
5101
takes_options = ['verbose']
5104
def run(self, verbose=False):
5105
from bzrlib import plugin
5106
# Don't give writelines a generator as some codecs don't like that
5107
self.outf.writelines(
5108
list(plugin.describe_plugins(show_paths=verbose)))
5111
class cmd_testament(Command):
5112
__doc__ = """Show testament (signing-form) of a revision."""
5115
Option('long', help='Produce long-format testament.'),
5117
help='Produce a strict-format testament.')]
5118
takes_args = ['branch?']
5120
def run(self, branch=u'.', revision=None, long=False, strict=False):
5121
from bzrlib.testament import Testament, StrictTestament
5123
testament_class = StrictTestament
5125
testament_class = Testament
5127
b = Branch.open_containing(branch)[0]
5129
b = Branch.open(branch)
5130
self.add_cleanup(b.lock_read().unlock)
5131
if revision is None:
5132
rev_id = b.last_revision()
5134
rev_id = revision[0].as_revision_id(b)
5135
t = testament_class.from_revision(b.repository, rev_id)
5137
sys.stdout.writelines(t.as_text_lines())
5139
sys.stdout.write(t.as_short_text())
5142
class cmd_annotate(Command):
5143
__doc__ = """Show the origin of each line in a file.
5145
This prints out the given file with an annotation on the left side
5146
indicating which revision, author and date introduced the change.
5148
If the origin is the same for a run of consecutive lines, it is
5149
shown only at the top, unless the --all option is given.
5151
# TODO: annotate directories; showing when each file was last changed
5152
# TODO: if the working copy is modified, show annotations on that
5153
# with new uncommitted lines marked
5154
aliases = ['ann', 'blame', 'praise']
5155
takes_args = ['filename']
5156
takes_options = [Option('all', help='Show annotations on all lines.'),
5157
Option('long', help='Show commit date in annotations.'),
5162
encoding_type = 'exact'
5165
def run(self, filename, all=False, long=False, revision=None,
5166
show_ids=False, directory=None):
5167
from bzrlib.annotate import (
5170
wt, branch, relpath = \
5171
_open_directory_or_containing_tree_or_branch(filename, directory)
5173
self.add_cleanup(wt.lock_read().unlock)
5175
self.add_cleanup(branch.lock_read().unlock)
5176
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5177
self.add_cleanup(tree.lock_read().unlock)
5178
if wt is not None and revision is None:
5179
file_id = wt.path2id(relpath)
5181
file_id = tree.path2id(relpath)
5183
raise errors.NotVersionedError(filename)
5184
if wt is not None and revision is None:
5185
# If there is a tree and we're not annotating historical
5186
# versions, annotate the working tree's content.
5187
annotate_file_tree(wt, file_id, self.outf, long, all,
5190
annotate_file_tree(tree, file_id, self.outf, long, all,
5191
show_ids=show_ids, branch=branch)
5194
class cmd_re_sign(Command):
5195
__doc__ = """Create a digital signature for an existing revision."""
5196
# TODO be able to replace existing ones.
5198
hidden = True # is this right ?
5199
takes_args = ['revision_id*']
5200
takes_options = ['directory', 'revision']
5202
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5203
if revision_id_list is not None and revision is not None:
5204
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5205
if revision_id_list is None and revision is None:
5206
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5207
b = WorkingTree.open_containing(directory)[0].branch
5208
self.add_cleanup(b.lock_write().unlock)
5209
return self._run(b, revision_id_list, revision)
5211
def _run(self, b, revision_id_list, revision):
5212
import bzrlib.gpg as gpg
5213
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5214
if revision_id_list is not None:
5215
b.repository.start_write_group()
5217
for revision_id in revision_id_list:
5218
b.repository.sign_revision(revision_id, gpg_strategy)
5220
b.repository.abort_write_group()
5223
b.repository.commit_write_group()
5224
elif revision is not None:
5225
if len(revision) == 1:
5226
revno, rev_id = revision[0].in_history(b)
5227
b.repository.start_write_group()
5229
b.repository.sign_revision(rev_id, gpg_strategy)
5231
b.repository.abort_write_group()
5234
b.repository.commit_write_group()
5235
elif len(revision) == 2:
5236
# are they both on rh- if so we can walk between them
5237
# might be nice to have a range helper for arbitrary
5238
# revision paths. hmm.
5239
from_revno, from_revid = revision[0].in_history(b)
5240
to_revno, to_revid = revision[1].in_history(b)
5241
if to_revid is None:
5242
to_revno = b.revno()
5243
if from_revno is None or to_revno is None:
5244
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5245
b.repository.start_write_group()
5247
for revno in range(from_revno, to_revno + 1):
5248
b.repository.sign_revision(b.get_rev_id(revno),
5251
b.repository.abort_write_group()
5254
b.repository.commit_write_group()
5256
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5259
class cmd_bind(Command):
5260
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5261
If no branch is supplied, rebind to the last bound location.
5263
Once converted into a checkout, commits must succeed on the master branch
5264
before they will be applied to the local branch.
5266
Bound branches use the nickname of its master branch unless it is set
5267
locally, in which case binding will update the local nickname to be
5271
_see_also = ['checkouts', 'unbind']
5272
takes_args = ['location?']
5273
takes_options = ['directory']
5275
def run(self, location=None, directory=u'.'):
5276
b, relpath = Branch.open_containing(directory)
5277
if location is None:
5279
location = b.get_old_bound_location()
5280
except errors.UpgradeRequired:
5281
raise errors.BzrCommandError(gettext('No location supplied. '
5282
'This format does not remember old locations.'))
5284
if location is None:
5285
if b.get_bound_location() is not None:
5286
raise errors.BzrCommandError(
5287
gettext('Branch is already bound'))
5289
raise errors.BzrCommandError(
5290
gettext('No location supplied'
5291
' and no previous location known'))
5292
b_other = Branch.open(location)
5295
except errors.DivergedBranches:
5296
raise errors.BzrCommandError(gettext('These branches have diverged.'
5297
' Try merging, and then bind again.'))
5298
if b.get_config().has_explicit_nickname():
5299
b.nick = b_other.nick
5302
class cmd_unbind(Command):
5303
__doc__ = """Convert the current checkout into a regular branch.
5305
After unbinding, the local branch is considered independent and subsequent
5306
commits will be local only.
5309
_see_also = ['checkouts', 'bind']
5311
takes_options = ['directory']
5313
def run(self, directory=u'.'):
5314
b, relpath = Branch.open_containing(directory)
5316
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5319
class cmd_uncommit(Command):
5320
__doc__ = """Remove the last committed revision.
5322
--verbose will print out what is being removed.
5323
--dry-run will go through all the motions, but not actually
5326
If --revision is specified, uncommit revisions to leave the branch at the
5327
specified revision. For example, "bzr uncommit -r 15" will leave the
5328
branch at revision 15.
5330
Uncommit leaves the working tree ready for a new commit. The only change
5331
it may make is to restore any pending merges that were present before
5335
# TODO: jam 20060108 Add an option to allow uncommit to remove
5336
# unreferenced information in 'branch-as-repository' branches.
5337
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5338
# information in shared branches as well.
5339
_see_also = ['commit']
5340
takes_options = ['verbose', 'revision',
5341
Option('dry-run', help='Don\'t actually make changes.'),
5342
Option('force', help='Say yes to all questions.'),
5344
help='Keep tags that point to removed revisions.'),
5346
help="Only remove the commits from the local branch"
5347
" when in a checkout."
5350
takes_args = ['location?']
5352
encoding_type = 'replace'
5354
def run(self, location=None, dry_run=False, verbose=False,
5355
revision=None, force=False, local=False, keep_tags=False):
5356
if location is None:
5358
control, relpath = controldir.ControlDir.open_containing(location)
5360
tree = control.open_workingtree()
5362
except (errors.NoWorkingTree, errors.NotLocalUrl):
5364
b = control.open_branch()
5366
if tree is not None:
5367
self.add_cleanup(tree.lock_write().unlock)
5369
self.add_cleanup(b.lock_write().unlock)
5370
return self._run(b, tree, dry_run, verbose, revision, force,
5373
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5375
from bzrlib.log import log_formatter, show_log
5376
from bzrlib.uncommit import uncommit
5378
last_revno, last_rev_id = b.last_revision_info()
5381
if revision is None:
5383
rev_id = last_rev_id
5385
# 'bzr uncommit -r 10' actually means uncommit
5386
# so that the final tree is at revno 10.
5387
# but bzrlib.uncommit.uncommit() actually uncommits
5388
# the revisions that are supplied.
5389
# So we need to offset it by one
5390
revno = revision[0].in_history(b).revno + 1
5391
if revno <= last_revno:
5392
rev_id = b.get_rev_id(revno)
5394
if rev_id is None or _mod_revision.is_null(rev_id):
5395
self.outf.write(gettext('No revisions to uncommit.\n'))
5398
lf = log_formatter('short',
5400
show_timezone='original')
5405
direction='forward',
5406
start_revision=revno,
5407
end_revision=last_revno)
5410
self.outf.write(gettext('Dry-run, pretending to remove'
5411
' the above revisions.\n'))
5413
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5416
if not ui.ui_factory.confirm_action(
5417
gettext(u'Uncommit these revisions'),
5418
'bzrlib.builtins.uncommit',
5420
self.outf.write(gettext('Canceled\n'))
5423
mutter('Uncommitting from {%s} to {%s}',
5424
last_rev_id, rev_id)
5425
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5426
revno=revno, local=local, keep_tags=keep_tags)
5427
self.outf.write(gettext('You can restore the old tip by running:\n'
5428
' bzr pull . -r revid:%s\n') % last_rev_id)
5431
class cmd_break_lock(Command):
5432
__doc__ = """Break a dead lock.
5434
This command breaks a lock on a repository, branch, working directory or
5437
CAUTION: Locks should only be broken when you are sure that the process
5438
holding the lock has been stopped.
5440
You can get information on what locks are open via the 'bzr info
5441
[location]' command.
5445
bzr break-lock bzr+ssh://example.com/bzr/foo
5446
bzr break-lock --conf ~/.bazaar
5449
takes_args = ['location?']
5452
help='LOCATION is the directory where the config lock is.'),
5454
help='Do not ask for confirmation before breaking the lock.'),
5457
def run(self, location=None, config=False, force=False):
5458
if location is None:
5461
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5463
{'bzrlib.lockdir.break': True})
5465
conf = _mod_config.LockableConfig(file_name=location)
5468
control, relpath = controldir.ControlDir.open_containing(location)
5470
control.break_lock()
5471
except NotImplementedError:
5475
class cmd_wait_until_signalled(Command):
5476
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5478
This just prints a line to signal when it is ready, then blocks on stdin.
5484
sys.stdout.write("running\n")
5486
sys.stdin.readline()
5489
class cmd_serve(Command):
5490
__doc__ = """Run the bzr server."""
5492
aliases = ['server']
5496
help='Serve on stdin/out for use from inetd or sshd.'),
5497
RegistryOption('protocol',
5498
help="Protocol to serve.",
5499
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5500
value_switches=True),
5502
help='Listen for connections on nominated address.', type=str),
5504
help='Listen for connections on nominated port. Passing 0 as '
5505
'the port number will result in a dynamically allocated '
5506
'port. The default port depends on the protocol.',
5508
custom_help('directory',
5509
help='Serve contents of this directory.'),
5510
Option('allow-writes',
5511
help='By default the server is a readonly server. Supplying '
5512
'--allow-writes enables write access to the contents of '
5513
'the served directory and below. Note that ``bzr serve`` '
5514
'does not perform authentication, so unless some form of '
5515
'external authentication is arranged supplying this '
5516
'option leads to global uncontrolled write access to your '
5519
Option('client-timeout', type=float,
5520
help='Override the default idle client timeout (5min).'),
5523
def run(self, listen=None, port=None, inet=False, directory=None,
5524
allow_writes=False, protocol=None, client_timeout=None):
5525
from bzrlib import transport
5526
if directory is None:
5527
directory = os.getcwd()
5528
if protocol is None:
5529
protocol = transport.transport_server_registry.get()
5530
url = transport.location_to_url(directory)
5531
if not allow_writes:
5532
url = 'readonly+' + url
5533
t = transport.get_transport_from_url(url)
5534
protocol(t, listen, port, inet, client_timeout)
5537
class cmd_join(Command):
5538
__doc__ = """Combine a tree into its containing tree.
5540
This command requires the target tree to be in a rich-root format.
5542
The TREE argument should be an independent tree, inside another tree, but
5543
not part of it. (Such trees can be produced by "bzr split", but also by
5544
running "bzr branch" with the target inside a tree.)
5546
The result is a combined tree, with the subtree no longer an independent
5547
part. This is marked as a merge of the subtree into the containing tree,
5548
and all history is preserved.
5551
_see_also = ['split']
5552
takes_args = ['tree']
5554
Option('reference', help='Join by reference.', hidden=True),
5557
def run(self, tree, reference=False):
5558
sub_tree = WorkingTree.open(tree)
5559
parent_dir = osutils.dirname(sub_tree.basedir)
5560
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5561
repo = containing_tree.branch.repository
5562
if not repo.supports_rich_root():
5563
raise errors.BzrCommandError(gettext(
5564
"Can't join trees because %s doesn't support rich root data.\n"
5565
"You can use bzr upgrade on the repository.")
5569
containing_tree.add_reference(sub_tree)
5570
except errors.BadReferenceTarget, e:
5571
# XXX: Would be better to just raise a nicely printable
5572
# exception from the real origin. Also below. mbp 20070306
5573
raise errors.BzrCommandError(
5574
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5577
containing_tree.subsume(sub_tree)
5578
except errors.BadSubsumeSource, e:
5579
raise errors.BzrCommandError(
5580
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5583
class cmd_split(Command):
5584
__doc__ = """Split a subdirectory of a tree into a separate tree.
5586
This command will produce a target tree in a format that supports
5587
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5588
converted into earlier formats like 'dirstate-tags'.
5590
The TREE argument should be a subdirectory of a working tree. That
5591
subdirectory will be converted into an independent tree, with its own
5592
branch. Commits in the top-level tree will not apply to the new subtree.
5595
_see_also = ['join']
5596
takes_args = ['tree']
5598
def run(self, tree):
5599
containing_tree, subdir = WorkingTree.open_containing(tree)
5600
sub_id = containing_tree.path2id(subdir)
5602
raise errors.NotVersionedError(subdir)
5604
containing_tree.extract(sub_id)
5605
except errors.RootNotRich:
5606
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5609
class cmd_merge_directive(Command):
5610
__doc__ = """Generate a merge directive for auto-merge tools.
5612
A directive requests a merge to be performed, and also provides all the
5613
information necessary to do so. This means it must either include a
5614
revision bundle, or the location of a branch containing the desired
5617
A submit branch (the location to merge into) must be supplied the first
5618
time the command is issued. After it has been supplied once, it will
5619
be remembered as the default.
5621
A public branch is optional if a revision bundle is supplied, but required
5622
if --diff or --plain is specified. It will be remembered as the default
5623
after the first use.
5626
takes_args = ['submit_branch?', 'public_branch?']
5630
_see_also = ['send']
5634
RegistryOption.from_kwargs('patch-type',
5635
'The type of patch to include in the directive.',
5637
value_switches=True,
5639
bundle='Bazaar revision bundle (default).',
5640
diff='Normal unified diff.',
5641
plain='No patch, just directive.'),
5642
Option('sign', help='GPG-sign the directive.'), 'revision',
5643
Option('mail-to', type=str,
5644
help='Instead of printing the directive, email to this address.'),
5645
Option('message', type=str, short_name='m',
5646
help='Message to use when committing this merge.')
5649
encoding_type = 'exact'
5651
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5652
sign=False, revision=None, mail_to=None, message=None,
5654
from bzrlib.revision import ensure_null, NULL_REVISION
5655
include_patch, include_bundle = {
5656
'plain': (False, False),
5657
'diff': (True, False),
5658
'bundle': (True, True),
5660
branch = Branch.open(directory)
5661
stored_submit_branch = branch.get_submit_branch()
5662
if submit_branch is None:
5663
submit_branch = stored_submit_branch
5665
if stored_submit_branch is None:
5666
branch.set_submit_branch(submit_branch)
5667
if submit_branch is None:
5668
submit_branch = branch.get_parent()
5669
if submit_branch is None:
5670
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5672
stored_public_branch = branch.get_public_branch()
5673
if public_branch is None:
5674
public_branch = stored_public_branch
5675
elif stored_public_branch is None:
5676
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5677
branch.set_public_branch(public_branch)
5678
if not include_bundle and public_branch is None:
5679
raise errors.BzrCommandError(gettext('No public branch specified or'
5681
base_revision_id = None
5682
if revision is not None:
5683
if len(revision) > 2:
5684
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5685
'at most two one revision identifiers'))
5686
revision_id = revision[-1].as_revision_id(branch)
5687
if len(revision) == 2:
5688
base_revision_id = revision[0].as_revision_id(branch)
5690
revision_id = branch.last_revision()
5691
revision_id = ensure_null(revision_id)
5692
if revision_id == NULL_REVISION:
5693
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5694
directive = merge_directive.MergeDirective2.from_objects(
5695
branch.repository, revision_id, time.time(),
5696
osutils.local_time_offset(), submit_branch,
5697
public_branch=public_branch, include_patch=include_patch,
5698
include_bundle=include_bundle, message=message,
5699
base_revision_id=base_revision_id)
5702
self.outf.write(directive.to_signed(branch))
5704
self.outf.writelines(directive.to_lines())
5706
message = directive.to_email(mail_to, branch, sign)
5707
s = SMTPConnection(branch.get_config_stack())
5708
s.send_email(message)
5711
class cmd_send(Command):
5712
__doc__ = """Mail or create a merge-directive for submitting changes.
5714
A merge directive provides many things needed for requesting merges:
5716
* A machine-readable description of the merge to perform
5718
* An optional patch that is a preview of the changes requested
5720
* An optional bundle of revision data, so that the changes can be applied
5721
directly from the merge directive, without retrieving data from a
5724
`bzr send` creates a compact data set that, when applied using bzr
5725
merge, has the same effect as merging from the source branch.
5727
By default the merge directive is self-contained and can be applied to any
5728
branch containing submit_branch in its ancestory without needing access to
5731
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5732
revisions, but only a structured request to merge from the
5733
public_location. In that case the public_branch is needed and it must be
5734
up-to-date and accessible to the recipient. The public_branch is always
5735
included if known, so that people can check it later.
5737
The submit branch defaults to the parent of the source branch, but can be
5738
overridden. Both submit branch and public branch will be remembered in
5739
branch.conf the first time they are used for a particular branch. The
5740
source branch defaults to that containing the working directory, but can
5741
be changed using --from.
5743
Both the submit branch and the public branch follow the usual behavior with
5744
respect to --remember: If there is no default location set, the first send
5745
will set it (use --no-remember to avoid setting it). After that, you can
5746
omit the location to use the default. To change the default, use
5747
--remember. The value will only be saved if the location can be accessed.
5749
In order to calculate those changes, bzr must analyse the submit branch.
5750
Therefore it is most efficient for the submit branch to be a local mirror.
5751
If a public location is known for the submit_branch, that location is used
5752
in the merge directive.
5754
The default behaviour is to send the merge directive by mail, unless -o is
5755
given, in which case it is sent to a file.
5757
Mail is sent using your preferred mail program. This should be transparent
5758
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5759
If the preferred client can't be found (or used), your editor will be used.
5761
To use a specific mail program, set the mail_client configuration option.
5762
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5763
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5764
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5765
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5768
If mail is being sent, a to address is required. This can be supplied
5769
either on the commandline, by setting the submit_to configuration
5770
option in the branch itself or the child_submit_to configuration option
5771
in the submit branch.
5773
Two formats are currently supported: "4" uses revision bundle format 4 and
5774
merge directive format 2. It is significantly faster and smaller than
5775
older formats. It is compatible with Bazaar 0.19 and later. It is the
5776
default. "0.9" uses revision bundle format 0.9 and merge directive
5777
format 1. It is compatible with Bazaar 0.12 - 0.18.
5779
The merge directives created by bzr send may be applied using bzr merge or
5780
bzr pull by specifying a file containing a merge directive as the location.
5782
bzr send makes extensive use of public locations to map local locations into
5783
URLs that can be used by other people. See `bzr help configuration` to
5784
set them, and use `bzr info` to display them.
5787
encoding_type = 'exact'
5789
_see_also = ['merge', 'pull']
5791
takes_args = ['submit_branch?', 'public_branch?']
5795
help='Do not include a bundle in the merge directive.'),
5796
Option('no-patch', help='Do not include a preview patch in the merge'
5799
help='Remember submit and public branch.'),
5801
help='Branch to generate the submission from, '
5802
'rather than the one containing the working directory.',
5805
Option('output', short_name='o',
5806
help='Write merge directive to this file or directory; '
5807
'use - for stdout.',
5810
help='Refuse to send if there are uncommitted changes in'
5811
' the working tree, --no-strict disables the check.'),
5812
Option('mail-to', help='Mail the request to this address.',
5816
Option('body', help='Body for the email.', type=unicode),
5817
RegistryOption('format',
5818
help='Use the specified output format.',
5819
lazy_registry=('bzrlib.send', 'format_registry')),
5822
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5823
no_patch=False, revision=None, remember=None, output=None,
5824
format=None, mail_to=None, message=None, body=None,
5825
strict=None, **kwargs):
5826
from bzrlib.send import send
5827
return send(submit_branch, revision, public_branch, remember,
5828
format, no_bundle, no_patch, output,
5829
kwargs.get('from', '.'), mail_to, message, body,
5834
class cmd_bundle_revisions(cmd_send):
5835
__doc__ = """Create a merge-directive for submitting changes.
5837
A merge directive provides many things needed for requesting merges:
5839
* A machine-readable description of the merge to perform
5841
* An optional patch that is a preview of the changes requested
5843
* An optional bundle of revision data, so that the changes can be applied
5844
directly from the merge directive, without retrieving data from a
5847
If --no-bundle is specified, then public_branch is needed (and must be
5848
up-to-date), so that the receiver can perform the merge using the
5849
public_branch. The public_branch is always included if known, so that
5850
people can check it later.
5852
The submit branch defaults to the parent, but can be overridden. Both
5853
submit branch and public branch will be remembered if supplied.
5855
If a public_branch is known for the submit_branch, that public submit
5856
branch is used in the merge instructions. This means that a local mirror
5857
can be used as your actual submit branch, once you have set public_branch
5860
Two formats are currently supported: "4" uses revision bundle format 4 and
5861
merge directive format 2. It is significantly faster and smaller than
5862
older formats. It is compatible with Bazaar 0.19 and later. It is the
5863
default. "0.9" uses revision bundle format 0.9 and merge directive
5864
format 1. It is compatible with Bazaar 0.12 - 0.18.
5869
help='Do not include a bundle in the merge directive.'),
5870
Option('no-patch', help='Do not include a preview patch in the merge'
5873
help='Remember submit and public branch.'),
5875
help='Branch to generate the submission from, '
5876
'rather than the one containing the working directory.',
5879
Option('output', short_name='o', help='Write directive to this file.',
5882
help='Refuse to bundle revisions if there are uncommitted'
5883
' changes in the working tree, --no-strict disables the check.'),
5885
RegistryOption('format',
5886
help='Use the specified output format.',
5887
lazy_registry=('bzrlib.send', 'format_registry')),
5889
aliases = ['bundle']
5891
_see_also = ['send', 'merge']
5895
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5896
no_patch=False, revision=None, remember=False, output=None,
5897
format=None, strict=None, **kwargs):
5900
from bzrlib.send import send
5901
return send(submit_branch, revision, public_branch, remember,
5902
format, no_bundle, no_patch, output,
5903
kwargs.get('from', '.'), None, None, None,
5904
self.outf, strict=strict)
5907
class cmd_tag(Command):
5908
__doc__ = """Create, remove or modify a tag naming a revision.
5910
Tags give human-meaningful names to revisions. Commands that take a -r
5911
(--revision) option can be given -rtag:X, where X is any previously
5914
Tags are stored in the branch. Tags are copied from one branch to another
5915
along when you branch, push, pull or merge.
5917
It is an error to give a tag name that already exists unless you pass
5918
--force, in which case the tag is moved to point to the new revision.
5920
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5921
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5923
If no tag name is specified it will be determined through the
5924
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5925
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5929
_see_also = ['commit', 'tags']
5930
takes_args = ['tag_name?']
5933
help='Delete this tag rather than placing it.',
5935
custom_help('directory',
5936
help='Branch in which to place the tag.'),
5938
help='Replace existing tags.',
5943
def run(self, tag_name=None,
5949
branch, relpath = Branch.open_containing(directory)
5950
self.add_cleanup(branch.lock_write().unlock)
5952
if tag_name is None:
5953
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5954
branch.tags.delete_tag(tag_name)
5955
note(gettext('Deleted tag %s.') % tag_name)
5958
if len(revision) != 1:
5959
raise errors.BzrCommandError(gettext(
5960
"Tags can only be placed on a single revision, "
5962
revision_id = revision[0].as_revision_id(branch)
5964
revision_id = branch.last_revision()
5965
if tag_name is None:
5966
tag_name = branch.automatic_tag_name(revision_id)
5967
if tag_name is None:
5968
raise errors.BzrCommandError(gettext(
5969
"Please specify a tag name."))
5971
existing_target = branch.tags.lookup_tag(tag_name)
5972
except errors.NoSuchTag:
5973
existing_target = None
5974
if not force and existing_target not in (None, revision_id):
5975
raise errors.TagAlreadyExists(tag_name)
5976
if existing_target == revision_id:
5977
note(gettext('Tag %s already exists for that revision.') % tag_name)
5979
branch.tags.set_tag(tag_name, revision_id)
5980
if existing_target is None:
5981
note(gettext('Created tag %s.') % tag_name)
5983
note(gettext('Updated tag %s.') % tag_name)
5986
class cmd_tags(Command):
5987
__doc__ = """List tags.
5989
This command shows a table of tag names and the revisions they reference.
5994
custom_help('directory',
5995
help='Branch whose tags should be displayed.'),
5996
RegistryOption('sort',
5997
'Sort tags by different criteria.', title='Sorting',
5998
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
6005
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6006
from bzrlib.tag import tag_sort_methods
6007
branch, relpath = Branch.open_containing(directory)
6009
tags = branch.tags.get_tag_dict().items()
6013
self.add_cleanup(branch.lock_read().unlock)
6015
# Restrict to the specified range
6016
tags = self._tags_for_range(branch, revision)
6018
sort = tag_sort_methods.get()
6021
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6022
for index, (tag, revid) in enumerate(tags):
6024
revno = branch.revision_id_to_dotted_revno(revid)
6025
if isinstance(revno, tuple):
6026
revno = '.'.join(map(str, revno))
6027
except (errors.NoSuchRevision,
6028
errors.GhostRevisionsHaveNoRevno,
6029
errors.UnsupportedOperation):
6030
# Bad tag data/merges can lead to tagged revisions
6031
# which are not in this branch. Fail gracefully ...
6033
tags[index] = (tag, revno)
6035
for tag, revspec in tags:
6036
self.outf.write('%-20s %s\n' % (tag, revspec))
6038
def _tags_for_range(self, branch, revision):
6040
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6041
revid1, revid2 = rev1.rev_id, rev2.rev_id
6042
# _get_revision_range will always set revid2 if it's not specified.
6043
# If revid1 is None, it means we want to start from the branch
6044
# origin which is always a valid ancestor. If revid1 == revid2, the
6045
# ancestry check is useless.
6046
if revid1 and revid1 != revid2:
6047
# FIXME: We really want to use the same graph than
6048
# branch.iter_merge_sorted_revisions below, but this is not
6049
# easily available -- vila 2011-09-23
6050
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6051
# We don't want to output anything in this case...
6053
# only show revisions between revid1 and revid2 (inclusive)
6054
tagged_revids = branch.tags.get_reverse_tag_dict()
6056
for r in branch.iter_merge_sorted_revisions(
6057
start_revision_id=revid2, stop_revision_id=revid1,
6058
stop_rule='include'):
6059
revid_tags = tagged_revids.get(r[0], None)
6061
found.extend([(tag, r[0]) for tag in revid_tags])
6065
class cmd_reconfigure(Command):
6066
__doc__ = """Reconfigure the type of a bzr directory.
6068
A target configuration must be specified.
6070
For checkouts, the bind-to location will be auto-detected if not specified.
6071
The order of preference is
6072
1. For a lightweight checkout, the current bound location.
6073
2. For branches that used to be checkouts, the previously-bound location.
6074
3. The push location.
6075
4. The parent location.
6076
If none of these is available, --bind-to must be specified.
6079
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6080
takes_args = ['location?']
6082
RegistryOption.from_kwargs(
6085
help='The relation between branch and tree.',
6086
value_switches=True, enum_switch=False,
6087
branch='Reconfigure to be an unbound branch with no working tree.',
6088
tree='Reconfigure to be an unbound branch with a working tree.',
6089
checkout='Reconfigure to be a bound branch with a working tree.',
6090
lightweight_checkout='Reconfigure to be a lightweight'
6091
' checkout (with no local history).',
6093
RegistryOption.from_kwargs(
6095
title='Repository type',
6096
help='Location fo the repository.',
6097
value_switches=True, enum_switch=False,
6098
standalone='Reconfigure to be a standalone branch '
6099
'(i.e. stop using shared repository).',
6100
use_shared='Reconfigure to use a shared repository.',
6102
RegistryOption.from_kwargs(
6104
title='Trees in Repository',
6105
help='Whether new branches in the repository have trees.',
6106
value_switches=True, enum_switch=False,
6107
with_trees='Reconfigure repository to create '
6108
'working trees on branches by default.',
6109
with_no_trees='Reconfigure repository to not create '
6110
'working trees on branches by default.'
6112
Option('bind-to', help='Branch to bind checkout to.', type=str),
6114
help='Perform reconfiguration even if local changes'
6116
Option('stacked-on',
6117
help='Reconfigure a branch to be stacked on another branch.',
6121
help='Reconfigure a branch to be unstacked. This '
6122
'may require copying substantial data into it.',
6126
def run(self, location=None, bind_to=None, force=False,
6127
tree_type=None, repository_type=None, repository_trees=None,
6128
stacked_on=None, unstacked=None):
6129
directory = controldir.ControlDir.open(location)
6130
if stacked_on and unstacked:
6131
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6132
elif stacked_on is not None:
6133
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6135
reconfigure.ReconfigureUnstacked().apply(directory)
6136
# At the moment you can use --stacked-on and a different
6137
# reconfiguration shape at the same time; there seems no good reason
6139
if (tree_type is None and
6140
repository_type is None and
6141
repository_trees is None):
6142
if stacked_on or unstacked:
6145
raise errors.BzrCommandError(gettext('No target configuration '
6147
reconfiguration = None
6148
if tree_type == 'branch':
6149
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6150
elif tree_type == 'tree':
6151
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6152
elif tree_type == 'checkout':
6153
reconfiguration = reconfigure.Reconfigure.to_checkout(
6155
elif tree_type == 'lightweight-checkout':
6156
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6159
reconfiguration.apply(force)
6160
reconfiguration = None
6161
if repository_type == 'use-shared':
6162
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6163
elif repository_type == 'standalone':
6164
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6166
reconfiguration.apply(force)
6167
reconfiguration = None
6168
if repository_trees == 'with-trees':
6169
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6171
elif repository_trees == 'with-no-trees':
6172
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6175
reconfiguration.apply(force)
6176
reconfiguration = None
6179
class cmd_switch(Command):
6180
__doc__ = """Set the branch of a checkout and update.
6182
For lightweight checkouts, this changes the branch being referenced.
6183
For heavyweight checkouts, this checks that there are no local commits
6184
versus the current bound branch, then it makes the local branch a mirror
6185
of the new location and binds to it.
6187
In both cases, the working tree is updated and uncommitted changes
6188
are merged. The user can commit or revert these as they desire.
6190
Pending merges need to be committed or reverted before using switch.
6192
The path to the branch to switch to can be specified relative to the parent
6193
directory of the current branch. For example, if you are currently in a
6194
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6197
Bound branches use the nickname of its master branch unless it is set
6198
locally, in which case switching will update the local nickname to be
6202
takes_args = ['to_location?']
6203
takes_options = ['directory',
6205
help='Switch even if local commits will be lost.'),
6207
Option('create-branch', short_name='b',
6208
help='Create the target branch from this one before'
6209
' switching to it.'),
6212
def run(self, to_location=None, force=False, create_branch=False,
6213
revision=None, directory=u'.'):
6214
from bzrlib import switch
6215
tree_location = directory
6216
revision = _get_one_revision('switch', revision)
6217
possible_transports = []
6218
control_dir = controldir.ControlDir.open_containing(tree_location,
6219
possible_transports=possible_transports)[0]
6220
if to_location is None:
6221
if revision is None:
6222
raise errors.BzrCommandError(gettext('You must supply either a'
6223
' revision or a location'))
6224
to_location = tree_location
6226
branch = control_dir.open_branch(
6227
possible_transports=possible_transports)
6228
had_explicit_nick = branch.get_config().has_explicit_nickname()
6229
except errors.NotBranchError:
6231
had_explicit_nick = False
6234
raise errors.BzrCommandError(
6235
gettext('cannot create branch without source branch'))
6236
to_location = lookup_new_sibling_branch(control_dir, to_location,
6237
possible_transports=possible_transports)
6238
to_branch = branch.bzrdir.sprout(to_location,
6239
possible_transports=possible_transports,
6240
source_branch=branch).open_branch()
6243
to_branch = Branch.open(to_location,
6244
possible_transports=possible_transports)
6245
except errors.NotBranchError:
6246
to_branch = open_sibling_branch(control_dir, to_location,
6247
possible_transports=possible_transports)
6248
if revision is not None:
6249
revision = revision.as_revision_id(to_branch)
6250
switch.switch(control_dir, to_branch, force, revision_id=revision)
6251
if had_explicit_nick:
6252
branch = control_dir.open_branch() #get the new branch!
6253
branch.nick = to_branch.nick
6254
note(gettext('Switched to branch: %s'),
6255
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6259
class cmd_view(Command):
6260
__doc__ = """Manage filtered views.
6262
Views provide a mask over the tree so that users can focus on
6263
a subset of a tree when doing their work. After creating a view,
6264
commands that support a list of files - status, diff, commit, etc -
6265
effectively have that list of files implicitly given each time.
6266
An explicit list of files can still be given but those files
6267
must be within the current view.
6269
In most cases, a view has a short life-span: it is created to make
6270
a selected change and is deleted once that change is committed.
6271
At other times, you may wish to create one or more named views
6272
and switch between them.
6274
To disable the current view without deleting it, you can switch to
6275
the pseudo view called ``off``. This can be useful when you need
6276
to see the whole tree for an operation or two (e.g. merge) but
6277
want to switch back to your view after that.
6280
To define the current view::
6282
bzr view file1 dir1 ...
6284
To list the current view::
6288
To delete the current view::
6292
To disable the current view without deleting it::
6294
bzr view --switch off
6296
To define a named view and switch to it::
6298
bzr view --name view-name file1 dir1 ...
6300
To list a named view::
6302
bzr view --name view-name
6304
To delete a named view::
6306
bzr view --name view-name --delete
6308
To switch to a named view::
6310
bzr view --switch view-name
6312
To list all views defined::
6316
To delete all views::
6318
bzr view --delete --all
6322
takes_args = ['file*']
6325
help='Apply list or delete action to all views.',
6328
help='Delete the view.',
6331
help='Name of the view to define, list or delete.',
6335
help='Name of the view to switch to.',
6340
def run(self, file_list,
6346
tree, file_list = WorkingTree.open_containing_paths(file_list,
6348
current_view, view_dict = tree.views.get_view_info()
6353
raise errors.BzrCommandError(gettext(
6354
"Both --delete and a file list specified"))
6356
raise errors.BzrCommandError(gettext(
6357
"Both --delete and --switch specified"))
6359
tree.views.set_view_info(None, {})
6360
self.outf.write(gettext("Deleted all views.\n"))
6362
raise errors.BzrCommandError(gettext("No current view to delete"))
6364
tree.views.delete_view(name)
6365
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6368
raise errors.BzrCommandError(gettext(
6369
"Both --switch and a file list specified"))
6371
raise errors.BzrCommandError(gettext(
6372
"Both --switch and --all specified"))
6373
elif switch == 'off':
6374
if current_view is None:
6375
raise errors.BzrCommandError(gettext("No current view to disable"))
6376
tree.views.set_view_info(None, view_dict)
6377
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6379
tree.views.set_view_info(switch, view_dict)
6380
view_str = views.view_display_str(tree.views.lookup_view())
6381
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6384
self.outf.write(gettext('Views defined:\n'))
6385
for view in sorted(view_dict):
6386
if view == current_view:
6390
view_str = views.view_display_str(view_dict[view])
6391
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6393
self.outf.write(gettext('No views defined.\n'))
6396
# No name given and no current view set
6399
raise errors.BzrCommandError(gettext(
6400
"Cannot change the 'off' pseudo view"))
6401
tree.views.set_view(name, sorted(file_list))
6402
view_str = views.view_display_str(tree.views.lookup_view())
6403
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6407
# No name given and no current view set
6408
self.outf.write(gettext('No current view.\n'))
6410
view_str = views.view_display_str(tree.views.lookup_view(name))
6411
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6414
class cmd_hooks(Command):
6415
__doc__ = """Show hooks."""
6420
for hook_key in sorted(hooks.known_hooks.keys()):
6421
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6422
self.outf.write("%s:\n" % type(some_hooks).__name__)
6423
for hook_name, hook_point in sorted(some_hooks.items()):
6424
self.outf.write(" %s:\n" % (hook_name,))
6425
found_hooks = list(hook_point)
6427
for hook in found_hooks:
6428
self.outf.write(" %s\n" %
6429
(some_hooks.get_hook_name(hook),))
6431
self.outf.write(gettext(" <no hooks installed>\n"))
6434
class cmd_remove_branch(Command):
6435
__doc__ = """Remove a branch.
6437
This will remove the branch from the specified location but
6438
will keep any working tree or repository in place.
6442
Remove the branch at repo/trunk::
6444
bzr remove-branch repo/trunk
6448
takes_args = ["location?"]
6450
takes_options = ['directory',
6451
Option('force', help='Remove branch even if it is the active branch.')]
6453
aliases = ["rmbranch"]
6455
def run(self, directory=None, location=None, force=False):
6456
br = open_nearby_branch(near=directory, location=location)
6457
if not force and br.bzrdir.has_workingtree():
6459
active_branch = br.bzrdir.open_branch(name="")
6460
except errors.NotBranchError:
6461
active_branch = None
6462
if (active_branch is not None and
6463
br.control_url == active_branch.control_url):
6464
raise errors.BzrCommandError(
6465
gettext("Branch is active. Use --force to remove it."))
6466
br.bzrdir.destroy_branch(br.name)
6469
class cmd_shelve(Command):
6470
__doc__ = """Temporarily set aside some changes from the current tree.
6472
Shelve allows you to temporarily put changes you've made "on the shelf",
6473
ie. out of the way, until a later time when you can bring them back from
6474
the shelf with the 'unshelve' command. The changes are stored alongside
6475
your working tree, and so they aren't propagated along with your branch nor
6476
will they survive its deletion.
6478
If shelve --list is specified, previously-shelved changes are listed.
6480
Shelve is intended to help separate several sets of changes that have
6481
been inappropriately mingled. If you just want to get rid of all changes
6482
and you don't need to restore them later, use revert. If you want to
6483
shelve all text changes at once, use shelve --all.
6485
If filenames are specified, only the changes to those files will be
6486
shelved. Other files will be left untouched.
6488
If a revision is specified, changes since that revision will be shelved.
6490
You can put multiple items on the shelf, and by default, 'unshelve' will
6491
restore the most recently shelved changes.
6493
For complicated changes, it is possible to edit the changes in a separate
6494
editor program to decide what the file remaining in the working copy
6495
should look like. To do this, add the configuration option
6497
change_editor = PROGRAM @new_path @old_path
6499
where @new_path is replaced with the path of the new version of the
6500
file and @old_path is replaced with the path of the old version of
6501
the file. The PROGRAM should save the new file with the desired
6502
contents of the file in the working tree.
6506
takes_args = ['file*']
6511
Option('all', help='Shelve all changes.'),
6513
RegistryOption('writer', 'Method to use for writing diffs.',
6514
bzrlib.option.diff_writer_registry,
6515
value_switches=True, enum_switch=False),
6517
Option('list', help='List shelved changes.'),
6519
help='Destroy removed changes instead of shelving them.'),
6521
_see_also = ['unshelve', 'configuration']
6523
def run(self, revision=None, all=False, file_list=None, message=None,
6524
writer=None, list=False, destroy=False, directory=None):
6526
return self.run_for_list(directory=directory)
6527
from bzrlib.shelf_ui import Shelver
6529
writer = bzrlib.option.diff_writer_registry.get()
6531
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6532
file_list, message, destroy=destroy, directory=directory)
6537
except errors.UserAbort:
6540
def run_for_list(self, directory=None):
6541
if directory is None:
6543
tree = WorkingTree.open_containing(directory)[0]
6544
self.add_cleanup(tree.lock_read().unlock)
6545
manager = tree.get_shelf_manager()
6546
shelves = manager.active_shelves()
6547
if len(shelves) == 0:
6548
note(gettext('No shelved changes.'))
6550
for shelf_id in reversed(shelves):
6551
message = manager.get_metadata(shelf_id).get('message')
6553
message = '<no message>'
6554
self.outf.write('%3d: %s\n' % (shelf_id, message))
6558
class cmd_unshelve(Command):
6559
__doc__ = """Restore shelved changes.
6561
By default, the most recently shelved changes are restored. However if you
6562
specify a shelf by id those changes will be restored instead. This works
6563
best when the changes don't depend on each other.
6566
takes_args = ['shelf_id?']
6569
RegistryOption.from_kwargs(
6570
'action', help="The action to perform.",
6571
enum_switch=False, value_switches=True,
6572
apply="Apply changes and remove from the shelf.",
6573
dry_run="Show changes, but do not apply or remove them.",
6574
preview="Instead of unshelving the changes, show the diff that "
6575
"would result from unshelving.",
6576
delete_only="Delete changes without applying them.",
6577
keep="Apply changes but don't delete them.",
6580
_see_also = ['shelve']
6582
def run(self, shelf_id=None, action='apply', directory=u'.'):
6583
from bzrlib.shelf_ui import Unshelver
6584
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6588
unshelver.tree.unlock()
6591
class cmd_clean_tree(Command):
6592
__doc__ = """Remove unwanted files from working tree.
6594
By default, only unknown files, not ignored files, are deleted. Versioned
6595
files are never deleted.
6597
Another class is 'detritus', which includes files emitted by bzr during
6598
normal operations and selftests. (The value of these files decreases with
6601
If no options are specified, unknown files are deleted. Otherwise, option
6602
flags are respected, and may be combined.
6604
To check what clean-tree will do, use --dry-run.
6606
takes_options = ['directory',
6607
Option('ignored', help='Delete all ignored files.'),
6608
Option('detritus', help='Delete conflict files, merge and revert'
6609
' backups, and failed selftest dirs.'),
6611
help='Delete files unknown to bzr (default).'),
6612
Option('dry-run', help='Show files to delete instead of'
6614
Option('force', help='Do not prompt before deleting.')]
6615
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6616
force=False, directory=u'.'):
6617
from bzrlib.clean_tree import clean_tree
6618
if not (unknown or ignored or detritus):
6622
clean_tree(directory, unknown=unknown, ignored=ignored,
6623
detritus=detritus, dry_run=dry_run, no_prompt=force)
6626
class cmd_reference(Command):
6627
__doc__ = """list, view and set branch locations for nested trees.
6629
If no arguments are provided, lists the branch locations for nested trees.
6630
If one argument is provided, display the branch location for that tree.
6631
If two arguments are provided, set the branch location for that tree.
6636
takes_args = ['path?', 'location?']
6638
def run(self, path=None, location=None):
6640
if path is not None:
6642
tree, branch, relpath =(
6643
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6644
if path is not None:
6647
tree = branch.basis_tree()
6649
info = branch._get_all_reference_info().iteritems()
6650
self._display_reference_info(tree, branch, info)
6652
file_id = tree.path2id(path)
6654
raise errors.NotVersionedError(path)
6655
if location is None:
6656
info = [(file_id, branch.get_reference_info(file_id))]
6657
self._display_reference_info(tree, branch, info)
6659
branch.set_reference_info(file_id, path, location)
6661
def _display_reference_info(self, tree, branch, info):
6663
for file_id, (path, location) in info:
6665
path = tree.id2path(file_id)
6666
except errors.NoSuchId:
6668
ref_list.append((path, location))
6669
for path, location in sorted(ref_list):
6670
self.outf.write('%s %s\n' % (path, location))
6673
class cmd_export_pot(Command):
6674
__doc__ = """Export command helps and error messages in po format."""
6677
takes_options = [Option('plugin',
6678
help='Export help text from named command '\
6679
'(defaults to all built in commands).',
6681
Option('include-duplicates',
6682
help='Output multiple copies of the same msgid '
6683
'string if it appears more than once.'),
6686
def run(self, plugin=None, include_duplicates=False):
6687
from bzrlib.export_pot import export_pot
6688
export_pot(self.outf, plugin, include_duplicates)
6691
def _register_lazy_builtins():
6692
# register lazy builtins from other modules; called at startup and should
6693
# be only called once.
6694
for (name, aliases, module_name) in [
6695
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6696
('cmd_config', [], 'bzrlib.config'),
6697
('cmd_dpush', [], 'bzrlib.foreign'),
6698
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6699
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6700
('cmd_conflicts', [], 'bzrlib.conflicts'),
6701
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6702
('cmd_verify_signatures', [], 'bzrlib.commit_signature_commands'),
6703
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6705
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
