1
# Copyright (C) 2005-2011 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
this_branch = control_dir.open_branch(
90
possible_transports=possible_transports)
91
# This may be a heavy checkout, where we want the master branch
92
master_location = this_branch.get_bound_location()
93
if master_location is not None:
94
return master_location
95
# If not, use a local sibling
96
return this_branch.base
97
except errors.NotBranchError:
98
format = control_dir.find_branch_format()
99
if getattr(format, 'get_reference', None) is not None:
100
return format.get_reference(control_dir)
102
return control_dir.root_transport.base
105
def _is_colocated(control_dir, possible_transports=None):
106
"""Check if the branch in control_dir is colocated.
108
:param control_dir: Control directory
109
:return: Boolean indicating whether
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 relative to which to look up
137
:param location: Name of the new branch
138
:return: Full location to the new branch
140
location = directory_service.directories.dereference(location)
141
if '/' not in location and '\\' not in location:
142
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
145
return urlutils.join_segment_parameters(this_url,
146
{"branch": urlutils.escape(location)})
148
return urlutils.join(this_url, '..', urlutils.escape(location))
152
def open_sibling_branch(control_dir, location, possible_transports=None):
153
"""Open a branch, possibly a sibling.
155
:param control_dir: Control directory relative to which to lookup the
157
:param location: Location to look up
158
:return: branch to open
161
# Perhaps it's a colocated branch?
162
return control_dir.open_branch(location,
163
possible_transports=possible_transports)
164
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
165
this_url = _get_branch_location(control_dir)
168
this_url, '..', urlutils.escape(location)))
171
def open_nearby_branch(near=None, location=None, possible_transports=None):
172
"""Open a nearby branch.
174
:param near: Optional location of container from which to open branch
175
:param location: Location of the branch
176
:return: Branch instance
182
return Branch.open(location,
183
possible_transports=possible_transports)
184
except errors.NotBranchError:
186
cdir = controldir.ControlDir.open(near,
187
possible_transports=possible_transports)
188
return open_sibling_branch(cdir, location,
189
possible_transports=possible_transports)
192
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
193
def tree_files(file_list, default_branch=u'.', canonicalize=True,
195
return internal_tree_files(file_list, default_branch, canonicalize,
199
def tree_files_for_add(file_list):
201
Return a tree and list of absolute paths from a file list.
203
Similar to tree_files, but add handles files a bit differently, so it a
204
custom implementation. In particular, MutableTreeTree.smart_add expects
205
absolute paths, which it immediately converts to relative paths.
207
# FIXME Would be nice to just return the relative paths like
208
# internal_tree_files does, but there are a large number of unit tests
209
# that assume the current interface to mutabletree.smart_add
211
tree, relpath = WorkingTree.open_containing(file_list[0])
212
if tree.supports_views():
213
view_files = tree.views.lookup_view()
215
for filename in file_list:
216
if not osutils.is_inside_any(view_files, filename):
217
raise errors.FileOutsideView(filename, view_files)
218
file_list = file_list[:]
219
file_list[0] = tree.abspath(relpath)
221
tree = WorkingTree.open_containing(u'.')[0]
222
if tree.supports_views():
223
view_files = tree.views.lookup_view()
225
file_list = view_files
226
view_str = views.view_display_str(view_files)
227
note(gettext("Ignoring files outside view. View is %s") % view_str)
228
return tree, file_list
231
def _get_one_revision(command_name, revisions):
232
if revisions is None:
234
if len(revisions) != 1:
235
raise errors.BzrCommandError(gettext(
236
'bzr %s --revision takes exactly one revision identifier') % (
241
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
242
"""Get a revision tree. Not suitable for commands that change the tree.
244
Specifically, the basis tree in dirstate trees is coupled to the dirstate
245
and doing a commit/uncommit/pull will at best fail due to changing the
248
If tree is passed in, it should be already locked, for lifetime management
249
of the trees internal cached state.
253
if revisions is None:
255
rev_tree = tree.basis_tree()
257
rev_tree = branch.basis_tree()
259
revision = _get_one_revision(command_name, revisions)
260
rev_tree = revision.as_tree(branch)
264
# XXX: Bad function name; should possibly also be a class method of
265
# WorkingTree rather than a function.
266
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
267
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
269
"""Convert command-line paths to a WorkingTree and relative paths.
271
Deprecated: use WorkingTree.open_containing_paths instead.
273
This is typically used for command-line processors that take one or
274
more filenames, and infer the workingtree that contains them.
276
The filenames given are not required to exist.
278
:param file_list: Filenames to convert.
280
:param default_branch: Fallback tree path to use if file_list is empty or
283
:param apply_view: if True and a view is set, apply it or check that
284
specified files are within it
286
:return: workingtree, [relative_paths]
288
return WorkingTree.open_containing_paths(
289
file_list, default_directory='.',
294
def _get_view_info_for_change_reporter(tree):
295
"""Get the view information from a tree for change reporting."""
298
current_view = tree.views.get_view_info()[0]
299
if current_view is not None:
300
view_info = (current_view, tree.views.lookup_view())
301
except errors.ViewsNotSupported:
306
def _open_directory_or_containing_tree_or_branch(filename, directory):
307
"""Open the tree or branch containing the specified file, unless
308
the --directory option is used to specify a different branch."""
309
if directory is not None:
310
return (None, Branch.open(directory), filename)
311
return controldir.ControlDir.open_containing_tree_or_branch(filename)
314
# TODO: Make sure no commands unconditionally use the working directory as a
315
# branch. If a filename argument is used, the first of them should be used to
316
# specify the branch. (Perhaps this can be factored out into some kind of
317
# Argument class, representing a file in a branch, where the first occurrence
320
class cmd_status(Command):
321
__doc__ = """Display status summary.
323
This reports on versioned and unknown files, reporting them
324
grouped by state. Possible states are:
327
Versioned in the working copy but not in the previous revision.
330
Versioned in the previous revision but removed or deleted
334
Path of this file changed from the previous revision;
335
the text may also have changed. This includes files whose
336
parent directory was renamed.
339
Text has changed since the previous revision.
342
File kind has been changed (e.g. from file to directory).
345
Not versioned and not matching an ignore pattern.
347
Additionally for directories, symlinks and files with a changed
348
executable bit, Bazaar indicates their type using a trailing
349
character: '/', '@' or '*' respectively. These decorations can be
350
disabled using the '--no-classify' option.
352
To see ignored files use 'bzr ignored'. For details on the
353
changes to file texts, use 'bzr diff'.
355
Note that --short or -S gives status flags for each item, similar
356
to Subversion's status command. To get output similar to svn -q,
359
If no arguments are specified, the status of the entire working
360
directory is shown. Otherwise, only the status of the specified
361
files or directories is reported. If a directory is given, status
362
is reported for everything inside that directory.
364
Before merges are committed, the pending merge tip revisions are
365
shown. To see all pending merge revisions, use the -v option.
366
To skip the display of pending merge information altogether, use
367
the no-pending option or specify a file/directory.
369
To compare the working directory to a specific revision, pass a
370
single revision to the revision argument.
372
To see which files have changed in a specific revision, or between
373
two revisions, pass a revision range to the revision argument.
374
This will produce the same results as calling 'bzr diff --summarize'.
377
# TODO: --no-recurse, --recurse options
379
takes_args = ['file*']
380
takes_options = ['show-ids', 'revision', 'change', 'verbose',
381
Option('short', help='Use short status indicators.',
383
Option('versioned', help='Only show versioned files.',
385
Option('no-pending', help='Don\'t show pending merges.',
387
Option('no-classify',
388
help='Do not mark object type using indicator.',
391
aliases = ['st', 'stat']
393
encoding_type = 'replace'
394
_see_also = ['diff', 'revert', 'status-flags']
397
def run(self, show_ids=False, file_list=None, revision=None, short=False,
398
versioned=False, no_pending=False, verbose=False,
400
from bzrlib.status import show_tree_status
402
if revision and len(revision) > 2:
403
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
404
' one or two revision specifiers'))
406
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
407
# Avoid asking for specific files when that is not needed.
408
if relfile_list == ['']:
410
# Don't disable pending merges for full trees other than '.'.
411
if file_list == ['.']:
413
# A specific path within a tree was given.
414
elif relfile_list is not None:
416
show_tree_status(tree, show_ids=show_ids,
417
specific_files=relfile_list, revision=revision,
418
to_file=self.outf, short=short, versioned=versioned,
419
show_pending=(not no_pending), verbose=verbose,
420
classify=not no_classify)
423
class cmd_cat_revision(Command):
424
__doc__ = """Write out metadata for a revision.
426
The revision to print can either be specified by a specific
427
revision identifier, or you can use --revision.
431
takes_args = ['revision_id?']
432
takes_options = ['directory', 'revision']
433
# cat-revision is more for frontends so should be exact
436
def print_revision(self, revisions, revid):
437
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
438
record = stream.next()
439
if record.storage_kind == 'absent':
440
raise errors.NoSuchRevision(revisions, revid)
441
revtext = record.get_bytes_as('fulltext')
442
self.outf.write(revtext.decode('utf-8'))
445
def run(self, revision_id=None, revision=None, directory=u'.'):
446
if revision_id is not None and revision is not None:
447
raise errors.BzrCommandError(gettext('You can only supply one of'
448
' revision_id or --revision'))
449
if revision_id is None and revision is None:
450
raise errors.BzrCommandError(gettext('You must supply either'
451
' --revision or a revision_id'))
453
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
455
revisions = b.repository.revisions
456
if revisions is None:
457
raise errors.BzrCommandError(gettext('Repository %r does not support '
458
'access to raw revision texts'))
460
b.repository.lock_read()
462
# TODO: jam 20060112 should cat-revision always output utf-8?
463
if revision_id is not None:
464
revision_id = osutils.safe_revision_id(revision_id, warn=False)
466
self.print_revision(revisions, revision_id)
467
except errors.NoSuchRevision:
468
msg = gettext("The repository {0} contains no revision {1}.").format(
469
b.repository.base, revision_id)
470
raise errors.BzrCommandError(msg)
471
elif revision is not None:
474
raise errors.BzrCommandError(
475
gettext('You cannot specify a NULL revision.'))
476
rev_id = rev.as_revision_id(b)
477
self.print_revision(revisions, rev_id)
479
b.repository.unlock()
482
class cmd_dump_btree(Command):
483
__doc__ = """Dump the contents of a btree index file to stdout.
485
PATH is a btree index file, it can be any URL. This includes things like
486
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
488
By default, the tuples stored in the index file will be displayed. With
489
--raw, we will uncompress the pages, but otherwise display the raw bytes
493
# TODO: Do we want to dump the internal nodes as well?
494
# TODO: It would be nice to be able to dump the un-parsed information,
495
# rather than only going through iter_all_entries. However, this is
496
# good enough for a start
498
encoding_type = 'exact'
499
takes_args = ['path']
500
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
501
' rather than the parsed tuples.'),
504
def run(self, path, raw=False):
505
dirname, basename = osutils.split(path)
506
t = transport.get_transport(dirname)
508
self._dump_raw_bytes(t, basename)
510
self._dump_entries(t, basename)
512
def _get_index_and_bytes(self, trans, basename):
513
"""Create a BTreeGraphIndex and raw bytes."""
514
bt = btree_index.BTreeGraphIndex(trans, basename, None)
515
bytes = trans.get_bytes(basename)
516
bt._file = cStringIO.StringIO(bytes)
517
bt._size = len(bytes)
520
def _dump_raw_bytes(self, trans, basename):
523
# We need to parse at least the root node.
524
# This is because the first page of every row starts with an
525
# uncompressed header.
526
bt, bytes = self._get_index_and_bytes(trans, basename)
527
for page_idx, page_start in enumerate(xrange(0, len(bytes),
528
btree_index._PAGE_SIZE)):
529
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
530
page_bytes = bytes[page_start:page_end]
532
self.outf.write('Root node:\n')
533
header_end, data = bt._parse_header_from_bytes(page_bytes)
534
self.outf.write(page_bytes[:header_end])
536
self.outf.write('\nPage %d\n' % (page_idx,))
537
if len(page_bytes) == 0:
538
self.outf.write('(empty)\n');
540
decomp_bytes = zlib.decompress(page_bytes)
541
self.outf.write(decomp_bytes)
542
self.outf.write('\n')
544
def _dump_entries(self, trans, basename):
546
st = trans.stat(basename)
547
except errors.TransportNotPossible:
548
# We can't stat, so we'll fake it because we have to do the 'get()'
550
bt, _ = self._get_index_and_bytes(trans, basename)
552
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
553
for node in bt.iter_all_entries():
554
# Node is made up of:
555
# (index, key, value, [references])
559
refs_as_tuples = None
561
refs_as_tuples = static_tuple.as_tuples(refs)
562
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
563
self.outf.write('%s\n' % (as_tuple,))
566
class cmd_remove_tree(Command):
567
__doc__ = """Remove the working tree from a given branch/checkout.
569
Since a lightweight checkout is little more than a working tree
570
this will refuse to run against one.
572
To re-create the working tree, use "bzr checkout".
574
_see_also = ['checkout', 'working-trees']
575
takes_args = ['location*']
578
help='Remove the working tree even if it has '
579
'uncommitted or shelved changes.'),
582
def run(self, location_list, force=False):
583
if not location_list:
586
for location in location_list:
587
d = controldir.ControlDir.open(location)
590
working = d.open_workingtree()
591
except errors.NoWorkingTree:
592
raise errors.BzrCommandError(gettext("No working tree to remove"))
593
except errors.NotLocalUrl:
594
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
595
" of a remote path"))
597
if (working.has_changes()):
598
raise errors.UncommittedChanges(working)
599
if working.get_shelf_manager().last_shelf() is not None:
600
raise errors.ShelvedChanges(working)
602
if working.user_url != working.branch.user_url:
603
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
604
" from a lightweight checkout"))
606
d.destroy_workingtree()
609
class cmd_repair_workingtree(Command):
610
__doc__ = """Reset the working tree state file.
612
This is not meant to be used normally, but more as a way to recover from
613
filesystem corruption, etc. This rebuilds the working inventory back to a
614
'known good' state. Any new modifications (adding a file, renaming, etc)
615
will be lost, though modified files will still be detected as such.
617
Most users will want something more like "bzr revert" or "bzr update"
618
unless the state file has become corrupted.
620
By default this attempts to recover the current state by looking at the
621
headers of the state file. If the state file is too corrupted to even do
622
that, you can supply --revision to force the state of the tree.
625
takes_options = ['revision', 'directory',
627
help='Reset the tree even if it doesn\'t appear to be'
632
def run(self, revision=None, directory='.', force=False):
633
tree, _ = WorkingTree.open_containing(directory)
634
self.add_cleanup(tree.lock_tree_write().unlock)
638
except errors.BzrError:
639
pass # There seems to be a real error here, so we'll reset
642
raise errors.BzrCommandError(gettext(
643
'The tree does not appear to be corrupt. You probably'
644
' want "bzr revert" instead. Use "--force" if you are'
645
' sure you want to reset the working tree.'))
649
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
651
tree.reset_state(revision_ids)
652
except errors.BzrError, e:
653
if revision_ids is None:
654
extra = (gettext(', the header appears corrupt, try passing -r -1'
655
' to set the state to the last commit'))
658
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
661
class cmd_revno(Command):
662
__doc__ = """Show current revision number.
664
This is equal to the number of revisions on this branch.
668
takes_args = ['location?']
670
Option('tree', help='Show revno of working tree.'),
675
def run(self, tree=False, location=u'.', revision=None):
676
if revision is not None and tree:
677
raise errors.BzrCommandError(gettext("--tree and --revision can "
678
"not be used together"))
682
wt = WorkingTree.open_containing(location)[0]
683
self.add_cleanup(wt.lock_read().unlock)
684
except (errors.NoWorkingTree, errors.NotLocalUrl):
685
raise errors.NoWorkingTree(location)
687
revid = wt.last_revision()
689
b = Branch.open_containing(location)[0]
690
self.add_cleanup(b.lock_read().unlock)
692
if len(revision) != 1:
693
raise errors.BzrCommandError(gettext(
694
"Tags can only be placed on a single revision, "
696
revid = revision[0].as_revision_id(b)
698
revid = b.last_revision()
700
revno_t = b.revision_id_to_dotted_revno(revid)
701
except errors.NoSuchRevision:
703
revno = ".".join(str(n) for n in revno_t)
705
self.outf.write(revno + '\n')
708
class cmd_revision_info(Command):
709
__doc__ = """Show revision number and revision id for a given revision identifier.
712
takes_args = ['revision_info*']
715
custom_help('directory',
716
help='Branch to examine, '
717
'rather than the one containing the working directory.'),
718
Option('tree', help='Show revno of working tree.'),
722
def run(self, revision=None, directory=u'.', tree=False,
723
revision_info_list=[]):
726
wt = WorkingTree.open_containing(directory)[0]
728
self.add_cleanup(wt.lock_read().unlock)
729
except (errors.NoWorkingTree, errors.NotLocalUrl):
731
b = Branch.open_containing(directory)[0]
732
self.add_cleanup(b.lock_read().unlock)
734
if revision is not None:
735
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
736
if revision_info_list is not None:
737
for rev_str in revision_info_list:
738
rev_spec = RevisionSpec.from_string(rev_str)
739
revision_ids.append(rev_spec.as_revision_id(b))
740
# No arguments supplied, default to the last revision
741
if len(revision_ids) == 0:
744
raise errors.NoWorkingTree(directory)
745
revision_ids.append(wt.last_revision())
747
revision_ids.append(b.last_revision())
751
for revision_id in revision_ids:
753
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
754
revno = '.'.join(str(i) for i in dotted_revno)
755
except errors.NoSuchRevision:
757
maxlen = max(maxlen, len(revno))
758
revinfos.append([revno, revision_id])
762
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
765
class cmd_add(Command):
766
__doc__ = """Add specified files or directories.
768
In non-recursive mode, all the named items are added, regardless
769
of whether they were previously ignored. A warning is given if
770
any of the named files are already versioned.
772
In recursive mode (the default), files are treated the same way
773
but the behaviour for directories is different. Directories that
774
are already versioned do not give a warning. All directories,
775
whether already versioned or not, are searched for files or
776
subdirectories that are neither versioned or ignored, and these
777
are added. This search proceeds recursively into versioned
778
directories. If no names are given '.' is assumed.
780
A warning will be printed when nested trees are encountered,
781
unless they are explicitly ignored.
783
Therefore simply saying 'bzr add' will version all files that
784
are currently unknown.
786
Adding a file whose parent directory is not versioned will
787
implicitly add the parent, and so on up to the root. This means
788
you should never need to explicitly add a directory, they'll just
789
get added when you add a file in the directory.
791
--dry-run will show which files would be added, but not actually
794
--file-ids-from will try to use the file ids from the supplied path.
795
It looks up ids trying to find a matching parent directory with the
796
same filename, and then by pure path. This option is rarely needed
797
but can be useful when adding the same logical file into two
798
branches that will be merged later (without showing the two different
799
adds as a conflict). It is also useful when merging another project
800
into a subdirectory of this one.
802
Any files matching patterns in the ignore list will not be added
803
unless they are explicitly mentioned.
805
In recursive mode, files larger than the configuration option
806
add.maximum_file_size will be skipped. Named items are never skipped due
809
takes_args = ['file*']
812
help="Don't recursively add the contents of directories."),
814
help="Show what would be done, but don't actually do anything."),
816
Option('file-ids-from',
818
help='Lookup file ids from this tree.'),
820
encoding_type = 'replace'
821
_see_also = ['remove', 'ignore']
823
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
828
if file_ids_from is not None:
830
base_tree, base_path = WorkingTree.open_containing(
832
except errors.NoWorkingTree:
833
base_branch, base_path = Branch.open_containing(
835
base_tree = base_branch.basis_tree()
837
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
838
to_file=self.outf, should_print=(not is_quiet()))
840
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
841
should_print=(not is_quiet()))
844
self.add_cleanup(base_tree.lock_read().unlock)
845
tree, file_list = tree_files_for_add(file_list)
846
added, ignored = tree.smart_add(file_list, not
847
no_recurse, action=action, save=not dry_run)
851
for glob in sorted(ignored.keys()):
852
for path in ignored[glob]:
854
gettext("ignored {0} matching \"{1}\"\n").format(
858
class cmd_mkdir(Command):
859
__doc__ = """Create a new versioned directory.
861
This is equivalent to creating the directory and then adding it.
864
takes_args = ['dir+']
868
help='No error if existing, make parent directories as needed.',
872
encoding_type = 'replace'
875
def add_file_with_parents(cls, wt, relpath):
876
if wt.path2id(relpath) is not None:
878
cls.add_file_with_parents(wt, osutils.dirname(relpath))
882
def add_file_single(cls, wt, relpath):
885
def run(self, dir_list, parents=False):
887
add_file = self.add_file_with_parents
889
add_file = self.add_file_single
891
wt, relpath = WorkingTree.open_containing(dir)
896
if e.errno != errno.EEXIST:
900
add_file(wt, relpath)
902
self.outf.write(gettext('added %s\n') % dir)
905
class cmd_relpath(Command):
906
__doc__ = """Show path of a file relative to root"""
908
takes_args = ['filename']
912
def run(self, filename):
913
# TODO: jam 20050106 Can relpath return a munged path if
914
# sys.stdout encoding cannot represent it?
915
tree, relpath = WorkingTree.open_containing(filename)
916
self.outf.write(relpath)
917
self.outf.write('\n')
920
class cmd_inventory(Command):
921
__doc__ = """Show inventory of the current working copy or a revision.
923
It is possible to limit the output to a particular entry
924
type using the --kind option. For example: --kind file.
926
It is also possible to restrict the list of files to a specific
927
set. For example: bzr inventory --show-ids this/file
936
help='List entries of a particular kind: file, directory, symlink.',
939
takes_args = ['file*']
942
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
943
if kind and kind not in ['file', 'directory', 'symlink']:
944
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
946
revision = _get_one_revision('inventory', revision)
947
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
948
self.add_cleanup(work_tree.lock_read().unlock)
949
if revision is not None:
950
tree = revision.as_tree(work_tree.branch)
952
extra_trees = [work_tree]
953
self.add_cleanup(tree.lock_read().unlock)
958
if file_list is not None:
959
file_ids = tree.paths2ids(file_list, trees=extra_trees,
960
require_versioned=True)
961
# find_ids_across_trees may include some paths that don't
964
(tree.id2path(file_id), tree.inventory[file_id])
965
for file_id in file_ids if tree.has_id(file_id))
967
entries = tree.inventory.entries()
970
for path, entry in entries:
971
if kind and kind != entry.kind:
974
self.outf.write('%-50s %s\n' % (path, entry.file_id))
976
self.outf.write(path)
977
self.outf.write('\n')
980
class cmd_mv(Command):
981
__doc__ = """Move or rename a file.
984
bzr mv OLDNAME NEWNAME
986
bzr mv SOURCE... DESTINATION
988
If the last argument is a versioned directory, all the other names
989
are moved into it. Otherwise, there must be exactly two arguments
990
and the file is changed to a new name.
992
If OLDNAME does not exist on the filesystem but is versioned and
993
NEWNAME does exist on the filesystem but is not versioned, mv
994
assumes that the file has been manually moved and only updates
995
its internal inventory to reflect that change.
996
The same is valid when moving many SOURCE files to a DESTINATION.
998
Files cannot be moved between branches.
1001
takes_args = ['names*']
1002
takes_options = [Option("after", help="Move only the bzr identifier"
1003
" of the file, because the file has already been moved."),
1004
Option('auto', help='Automatically guess renames.'),
1005
Option('dry-run', help='Avoid making changes when guessing renames.'),
1007
aliases = ['move', 'rename']
1008
encoding_type = 'replace'
1010
def run(self, names_list, after=False, auto=False, dry_run=False):
1012
return self.run_auto(names_list, after, dry_run)
1014
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1015
if names_list is None:
1017
if len(names_list) < 2:
1018
raise errors.BzrCommandError(gettext("missing file argument"))
1019
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1020
for file_name in rel_names[0:-1]:
1022
raise errors.BzrCommandError(gettext("can not move root of branch"))
1023
self.add_cleanup(tree.lock_tree_write().unlock)
1024
self._run(tree, names_list, rel_names, after)
1026
def run_auto(self, names_list, after, dry_run):
1027
if names_list is not None and len(names_list) > 1:
1028
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1031
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1033
work_tree, file_list = WorkingTree.open_containing_paths(
1034
names_list, default_directory='.')
1035
self.add_cleanup(work_tree.lock_tree_write().unlock)
1036
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1038
def _run(self, tree, names_list, rel_names, after):
1039
into_existing = osutils.isdir(names_list[-1])
1040
if into_existing and len(names_list) == 2:
1042
# a. case-insensitive filesystem and change case of dir
1043
# b. move directory after the fact (if the source used to be
1044
# a directory, but now doesn't exist in the working tree
1045
# and the target is an existing directory, just rename it)
1046
if (not tree.case_sensitive
1047
and rel_names[0].lower() == rel_names[1].lower()):
1048
into_existing = False
1050
inv = tree.inventory
1051
# 'fix' the case of a potential 'from'
1052
from_id = tree.path2id(
1053
tree.get_canonical_inventory_path(rel_names[0]))
1054
if (not osutils.lexists(names_list[0]) and
1055
from_id and inv.get_file_kind(from_id) == "directory"):
1056
into_existing = False
1059
# move into existing directory
1060
# All entries reference existing inventory items, so fix them up
1061
# for cicp file-systems.
1062
rel_names = tree.get_canonical_inventory_paths(rel_names)
1063
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1065
self.outf.write("%s => %s\n" % (src, dest))
1067
if len(names_list) != 2:
1068
raise errors.BzrCommandError(gettext('to mv multiple files the'
1069
' destination must be a versioned'
1072
# for cicp file-systems: the src references an existing inventory
1074
src = tree.get_canonical_inventory_path(rel_names[0])
1075
# Find the canonical version of the destination: In all cases, the
1076
# parent of the target must be in the inventory, so we fetch the
1077
# canonical version from there (we do not always *use* the
1078
# canonicalized tail portion - we may be attempting to rename the
1080
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1081
dest_parent = osutils.dirname(canon_dest)
1082
spec_tail = osutils.basename(rel_names[1])
1083
# For a CICP file-system, we need to avoid creating 2 inventory
1084
# entries that differ only by case. So regardless of the case
1085
# we *want* to use (ie, specified by the user or the file-system),
1086
# we must always choose to use the case of any existing inventory
1087
# items. The only exception to this is when we are attempting a
1088
# case-only rename (ie, canonical versions of src and dest are
1090
dest_id = tree.path2id(canon_dest)
1091
if dest_id is None or tree.path2id(src) == dest_id:
1092
# No existing item we care about, so work out what case we
1093
# are actually going to use.
1095
# If 'after' is specified, the tail must refer to a file on disk.
1097
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1099
# pathjoin with an empty tail adds a slash, which breaks
1101
dest_parent_fq = tree.basedir
1103
dest_tail = osutils.canonical_relpath(
1105
osutils.pathjoin(dest_parent_fq, spec_tail))
1107
# not 'after', so case as specified is used
1108
dest_tail = spec_tail
1110
# Use the existing item so 'mv' fails with AlreadyVersioned.
1111
dest_tail = os.path.basename(canon_dest)
1112
dest = osutils.pathjoin(dest_parent, dest_tail)
1113
mutter("attempting to move %s => %s", src, dest)
1114
tree.rename_one(src, dest, after=after)
1116
self.outf.write("%s => %s\n" % (src, dest))
1119
class cmd_pull(Command):
1120
__doc__ = """Turn this branch into a mirror of another branch.
1122
By default, this command only works on branches that have not diverged.
1123
Branches are considered diverged if the destination branch's most recent
1124
commit is one that has not been merged (directly or indirectly) into the
1127
If branches have diverged, you can use 'bzr merge' to integrate the changes
1128
from one into the other. Once one branch has merged, the other should
1129
be able to pull it again.
1131
If you want to replace your local changes and just want your branch to
1132
match the remote one, use pull --overwrite. This will work even if the two
1133
branches have diverged.
1135
If there is no default location set, the first pull will set it (use
1136
--no-remember to avoid setting it). After that, you can omit the
1137
location to use the default. To change the default, use --remember. The
1138
value will only be saved if the remote location can be accessed.
1140
The --verbose option will display the revisions pulled using the log_format
1141
configuration option. You can use a different format by overriding it with
1142
-Olog_format=<other_format>.
1144
Note: The location can be specified either in the form of a branch,
1145
or in the form of a path to a file containing a merge directive generated
1149
_see_also = ['push', 'update', 'status-flags', 'send']
1150
takes_options = ['remember', 'overwrite', 'revision',
1151
custom_help('verbose',
1152
help='Show logs of pulled revisions.'),
1153
custom_help('directory',
1154
help='Branch to pull into, '
1155
'rather than the one containing the working directory.'),
1157
help="Perform a local pull in a bound "
1158
"branch. Local pulls are not applied to "
1159
"the master branch."
1162
help="Show base revision text in conflicts.")
1164
takes_args = ['location?']
1165
encoding_type = 'replace'
1167
def run(self, location=None, remember=None, overwrite=False,
1168
revision=None, verbose=False,
1169
directory=None, local=False,
1171
# FIXME: too much stuff is in the command class
1174
if directory is None:
1177
tree_to = WorkingTree.open_containing(directory)[0]
1178
branch_to = tree_to.branch
1179
self.add_cleanup(tree_to.lock_write().unlock)
1180
except errors.NoWorkingTree:
1182
branch_to = Branch.open_containing(directory)[0]
1183
self.add_cleanup(branch_to.lock_write().unlock)
1185
if tree_to is None and show_base:
1186
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1188
if local and not branch_to.get_bound_location():
1189
raise errors.LocalRequiresBoundBranch()
1191
possible_transports = []
1192
if location is not None:
1194
mergeable = bundle.read_mergeable_from_url(location,
1195
possible_transports=possible_transports)
1196
except errors.NotABundle:
1199
stored_loc = branch_to.get_parent()
1200
if location is None:
1201
if stored_loc is None:
1202
raise errors.BzrCommandError(gettext("No pull location known or"
1205
display_url = urlutils.unescape_for_display(stored_loc,
1208
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1209
location = stored_loc
1211
revision = _get_one_revision('pull', revision)
1212
if mergeable is not None:
1213
if revision is not None:
1214
raise errors.BzrCommandError(gettext(
1215
'Cannot use -r with merge directives or bundles'))
1216
mergeable.install_revisions(branch_to.repository)
1217
base_revision_id, revision_id, verified = \
1218
mergeable.get_merge_request(branch_to.repository)
1219
branch_from = branch_to
1221
branch_from = Branch.open(location,
1222
possible_transports=possible_transports)
1223
self.add_cleanup(branch_from.lock_read().unlock)
1224
# Remembers if asked explicitly or no previous location is set
1226
or (remember is None and branch_to.get_parent() is None)):
1227
branch_to.set_parent(branch_from.base)
1229
if revision is not None:
1230
revision_id = revision.as_revision_id(branch_from)
1232
if tree_to is not None:
1233
view_info = _get_view_info_for_change_reporter(tree_to)
1234
change_reporter = delta._ChangeReporter(
1235
unversioned_filter=tree_to.is_ignored,
1236
view_info=view_info)
1237
result = tree_to.pull(
1238
branch_from, overwrite, revision_id, change_reporter,
1239
local=local, show_base=show_base)
1241
result = branch_to.pull(
1242
branch_from, overwrite, revision_id, local=local)
1244
result.report(self.outf)
1245
if verbose and result.old_revid != result.new_revid:
1246
log.show_branch_change(
1247
branch_to, self.outf, result.old_revno,
1249
if getattr(result, 'tag_conflicts', None):
1255
class cmd_push(Command):
1256
__doc__ = """Update a mirror of this branch.
1258
The target branch will not have its working tree populated because this
1259
is both expensive, and is not supported on remote file systems.
1261
Some smart servers or protocols *may* put the working tree in place in
1264
This command only works on branches that have not diverged. Branches are
1265
considered diverged if the destination branch's most recent commit is one
1266
that has not been merged (directly or indirectly) by the source branch.
1268
If branches have diverged, you can use 'bzr push --overwrite' to replace
1269
the other branch completely, discarding its unmerged changes.
1271
If you want to ensure you have the different changes in the other branch,
1272
do a merge (see bzr help merge) from the other branch, and commit that.
1273
After that you will be able to do a push without '--overwrite'.
1275
If there is no default push location set, the first push will set it (use
1276
--no-remember to avoid setting it). After that, you can omit the
1277
location to use the default. To change the default, use --remember. The
1278
value will only be saved if the remote location can be accessed.
1280
The --verbose option will display the revisions pushed using the log_format
1281
configuration option. You can use a different format by overriding it with
1282
-Olog_format=<other_format>.
1285
_see_also = ['pull', 'update', 'working-trees']
1286
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1287
Option('create-prefix',
1288
help='Create the path leading up to the branch '
1289
'if it does not already exist.'),
1290
custom_help('directory',
1291
help='Branch to push from, '
1292
'rather than the one containing the working directory.'),
1293
Option('use-existing-dir',
1294
help='By default push will fail if the target'
1295
' directory exists, but does not already'
1296
' have a control directory. This flag will'
1297
' allow push to proceed.'),
1299
help='Create a stacked branch that references the public location '
1300
'of the parent branch.'),
1301
Option('stacked-on',
1302
help='Create a stacked branch that refers to another branch '
1303
'for the commit history. Only the work not present in the '
1304
'referenced branch is included in the branch created.',
1307
help='Refuse to push if there are uncommitted changes in'
1308
' the working tree, --no-strict disables the check.'),
1310
help="Don't populate the working tree, even for protocols"
1311
" that support it."),
1313
takes_args = ['location?']
1314
encoding_type = 'replace'
1316
def run(self, location=None, remember=None, overwrite=False,
1317
create_prefix=False, verbose=False, revision=None,
1318
use_existing_dir=False, directory=None, stacked_on=None,
1319
stacked=False, strict=None, no_tree=False):
1320
from bzrlib.push import _show_push_branch
1322
if directory is None:
1324
# Get the source branch
1326
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1327
# Get the tip's revision_id
1328
revision = _get_one_revision('push', revision)
1329
if revision is not None:
1330
revision_id = revision.in_history(br_from).rev_id
1333
if tree is not None and revision_id is None:
1334
tree.check_changed_or_out_of_date(
1335
strict, 'push_strict',
1336
more_error='Use --no-strict to force the push.',
1337
more_warning='Uncommitted changes will not be pushed.')
1338
# Get the stacked_on branch, if any
1339
if stacked_on is not None:
1340
stacked_on = urlutils.normalize_url(stacked_on)
1342
parent_url = br_from.get_parent()
1344
parent = Branch.open(parent_url)
1345
stacked_on = parent.get_public_branch()
1347
# I considered excluding non-http url's here, thus forcing
1348
# 'public' branches only, but that only works for some
1349
# users, so it's best to just depend on the user spotting an
1350
# error by the feedback given to them. RBC 20080227.
1351
stacked_on = parent_url
1353
raise errors.BzrCommandError(gettext(
1354
"Could not determine branch to refer to."))
1356
# Get the destination location
1357
if location is None:
1358
stored_loc = br_from.get_push_location()
1359
if stored_loc is None:
1360
parent_loc = br_from.get_parent()
1362
raise errors.BzrCommandError(gettext(
1363
"No push location known or specified. To push to the "
1364
"parent branch (at %s), use 'bzr push :parent'." %
1365
urlutils.unescape_for_display(parent_loc,
1366
self.outf.encoding)))
1368
raise errors.BzrCommandError(gettext(
1369
"No push location known or specified."))
1371
display_url = urlutils.unescape_for_display(stored_loc,
1373
note(gettext("Using saved push location: %s") % display_url)
1374
location = stored_loc
1376
_show_push_branch(br_from, revision_id, location, self.outf,
1377
verbose=verbose, overwrite=overwrite, remember=remember,
1378
stacked_on=stacked_on, create_prefix=create_prefix,
1379
use_existing_dir=use_existing_dir, no_tree=no_tree)
1382
class cmd_branch(Command):
1383
__doc__ = """Create a new branch that is a copy of an existing branch.
1385
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1386
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1387
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1388
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1389
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1392
To retrieve the branch as of a particular revision, supply the --revision
1393
parameter, as in "branch foo/bar -r 5".
1395
The synonyms 'clone' and 'get' for this command are deprecated.
1398
_see_also = ['checkout']
1399
takes_args = ['from_location', 'to_location?']
1400
takes_options = ['revision',
1401
Option('hardlink', help='Hard-link working tree files where possible.'),
1402
Option('files-from', type=str,
1403
help="Get file contents from this tree."),
1405
help="Create a branch without a working-tree."),
1407
help="Switch the checkout in the current directory "
1408
"to the new branch."),
1410
help='Create a stacked branch referring to the source branch. '
1411
'The new branch will depend on the availability of the source '
1412
'branch for all operations.'),
1413
Option('standalone',
1414
help='Do not use a shared repository, even if available.'),
1415
Option('use-existing-dir',
1416
help='By default branch will fail if the target'
1417
' directory exists, but does not already'
1418
' have a control directory. This flag will'
1419
' allow branch to proceed.'),
1421
help="Bind new branch to from location."),
1423
aliases = ['get', 'clone']
1425
def run(self, from_location, to_location=None, revision=None,
1426
hardlink=False, stacked=False, standalone=False, no_tree=False,
1427
use_existing_dir=False, switch=False, bind=False,
1429
from bzrlib import switch as _mod_switch
1430
from bzrlib.tag import _merge_tags_if_possible
1431
if self.invoked_as in ['get', 'clone']:
1432
ui.ui_factory.show_user_warning(
1433
'deprecated_command',
1434
deprecated_name=self.invoked_as,
1435
recommended_name='branch',
1436
deprecated_in_version='2.4')
1437
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1439
if not (hardlink or files_from):
1440
# accelerator_tree is usually slower because you have to read N
1441
# files (no readahead, lots of seeks, etc), but allow the user to
1442
# explicitly request it
1443
accelerator_tree = None
1444
if files_from is not None and files_from != from_location:
1445
accelerator_tree = WorkingTree.open(files_from)
1446
revision = _get_one_revision('branch', revision)
1447
self.add_cleanup(br_from.lock_read().unlock)
1448
if revision is not None:
1449
revision_id = revision.as_revision_id(br_from)
1451
# FIXME - wt.last_revision, fallback to branch, fall back to
1452
# None or perhaps NULL_REVISION to mean copy nothing
1454
revision_id = br_from.last_revision()
1455
if to_location is None:
1456
to_location = getattr(br_from, "name", None)
1458
to_location = urlutils.derive_to_location(from_location)
1459
to_transport = transport.get_transport(to_location)
1461
to_transport.mkdir('.')
1462
except errors.FileExists:
1464
to_dir = controldir.ControlDir.open_from_transport(
1466
except errors.NotBranchError:
1467
if not use_existing_dir:
1468
raise errors.BzrCommandError(gettext('Target directory "%s" '
1469
'already exists.') % to_location)
1474
to_dir.open_branch()
1475
except errors.NotBranchError:
1478
raise errors.AlreadyBranchError(to_location)
1479
except errors.NoSuchFile:
1480
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1486
# preserve whatever source format we have.
1487
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1488
possible_transports=[to_transport],
1489
accelerator_tree=accelerator_tree,
1490
hardlink=hardlink, stacked=stacked,
1491
force_new_repo=standalone,
1492
create_tree_if_local=not no_tree,
1493
source_branch=br_from)
1494
branch = to_dir.open_branch(
1495
possible_transports=[
1496
br_from.bzrdir.root_transport, to_transport])
1497
except errors.NoSuchRevision:
1498
to_transport.delete_tree('.')
1499
msg = gettext("The branch {0} has no revision {1}.").format(
1500
from_location, revision)
1501
raise errors.BzrCommandError(msg)
1504
to_repo = to_dir.open_repository()
1505
except errors.NoRepositoryPresent:
1506
to_repo = to_dir.create_repository()
1507
to_repo.fetch(br_from.repository, revision_id=revision_id)
1508
branch = br_from.sprout(to_dir, revision_id=revision_id)
1509
_merge_tags_if_possible(br_from, branch)
1510
# If the source branch is stacked, the new branch may
1511
# be stacked whether we asked for that explicitly or not.
1512
# We therefore need a try/except here and not just 'if stacked:'
1514
note(gettext('Created new stacked branch referring to %s.') %
1515
branch.get_stacked_on_url())
1516
except (errors.NotStacked, errors.UnstackableBranchFormat,
1517
errors.UnstackableRepositoryFormat), e:
1518
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1520
# Bind to the parent
1521
parent_branch = Branch.open(from_location)
1522
branch.bind(parent_branch)
1523
note(gettext('New branch bound to %s') % from_location)
1525
# Switch to the new branch
1526
wt, _ = WorkingTree.open_containing('.')
1527
_mod_switch.switch(wt.bzrdir, branch)
1528
note(gettext('Switched to branch: %s'),
1529
urlutils.unescape_for_display(branch.base, 'utf-8'))
1532
class cmd_branches(Command):
1533
__doc__ = """List the branches available at the current location.
1535
This command will print the names of all the branches at the current
1539
takes_args = ['location?']
1541
Option('recursive', short_name='R',
1542
help='Recursively scan for branches rather than '
1543
'just looking in the specified location.')]
1545
def run(self, location=".", recursive=False):
1547
t = transport.get_transport(location)
1548
if not t.listable():
1549
raise errors.BzrCommandError(
1550
"Can't scan this type of location.")
1551
for b in controldir.ControlDir.find_branches(t):
1552
self.outf.write("%s\n" % urlutils.unescape_for_display(
1553
urlutils.relative_url(t.base, b.base),
1554
self.outf.encoding).rstrip("/"))
1556
dir = controldir.ControlDir.open_containing(location)[0]
1558
active_branch = dir.open_branch(name="")
1559
except errors.NotBranchError:
1560
active_branch = None
1561
branches = dir.get_branches()
1563
for name, branch in branches.iteritems():
1566
active = (active_branch is not None and
1567
active_branch.base == branch.base)
1568
names[name] = active
1569
# Only mention the current branch explicitly if it's not
1570
# one of the colocated branches
1571
if not any(names.values()) and active_branch is not None:
1572
self.outf.write("* %s\n" % gettext("(default)"))
1573
for name in sorted(names.keys()):
1574
active = names[name]
1579
self.outf.write("%s %s\n" % (
1580
prefix, name.encode(self.outf.encoding)))
1583
class cmd_checkout(Command):
1584
__doc__ = """Create a new checkout of an existing branch.
1586
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1587
the branch found in '.'. This is useful if you have removed the working tree
1588
or if it was never created - i.e. if you pushed the branch to its current
1589
location using SFTP.
1591
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1592
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1593
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1594
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1595
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1598
To retrieve the branch as of a particular revision, supply the --revision
1599
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1600
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1604
_see_also = ['checkouts', 'branch']
1605
takes_args = ['branch_location?', 'to_location?']
1606
takes_options = ['revision',
1607
Option('lightweight',
1608
help="Perform a lightweight checkout. Lightweight "
1609
"checkouts depend on access to the branch for "
1610
"every operation. Normal checkouts can perform "
1611
"common operations like diff and status without "
1612
"such access, and also support local commits."
1614
Option('files-from', type=str,
1615
help="Get file contents from this tree."),
1617
help='Hard-link working tree files where possible.'
1622
def run(self, branch_location=None, to_location=None, revision=None,
1623
lightweight=False, files_from=None, hardlink=False):
1624
if branch_location is None:
1625
branch_location = osutils.getcwd()
1626
to_location = branch_location
1627
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1629
if not (hardlink or files_from):
1630
# accelerator_tree is usually slower because you have to read N
1631
# files (no readahead, lots of seeks, etc), but allow the user to
1632
# explicitly request it
1633
accelerator_tree = None
1634
revision = _get_one_revision('checkout', revision)
1635
if files_from is not None and files_from != branch_location:
1636
accelerator_tree = WorkingTree.open(files_from)
1637
if revision is not None:
1638
revision_id = revision.as_revision_id(source)
1641
if to_location is None:
1642
to_location = urlutils.derive_to_location(branch_location)
1643
# if the source and to_location are the same,
1644
# and there is no working tree,
1645
# then reconstitute a branch
1646
if (osutils.abspath(to_location) ==
1647
osutils.abspath(branch_location)):
1649
source.bzrdir.open_workingtree()
1650
except errors.NoWorkingTree:
1651
source.bzrdir.create_workingtree(revision_id)
1653
source.create_checkout(to_location, revision_id, lightweight,
1654
accelerator_tree, hardlink)
1657
class cmd_renames(Command):
1658
__doc__ = """Show list of renamed files.
1660
# TODO: Option to show renames between two historical versions.
1662
# TODO: Only show renames under dir, rather than in the whole branch.
1663
_see_also = ['status']
1664
takes_args = ['dir?']
1667
def run(self, dir=u'.'):
1668
tree = WorkingTree.open_containing(dir)[0]
1669
self.add_cleanup(tree.lock_read().unlock)
1670
new_inv = tree.inventory
1671
old_tree = tree.basis_tree()
1672
self.add_cleanup(old_tree.lock_read().unlock)
1673
old_inv = old_tree.inventory
1675
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1676
for f, paths, c, v, p, n, k, e in iterator:
1677
if paths[0] == paths[1]:
1681
renames.append(paths)
1683
for old_name, new_name in renames:
1684
self.outf.write("%s => %s\n" % (old_name, new_name))
1687
class cmd_update(Command):
1688
__doc__ = """Update a working tree to a new revision.
1690
This will perform a merge of the destination revision (the tip of the
1691
branch, or the specified revision) into the working tree, and then make
1692
that revision the basis revision for the working tree.
1694
You can use this to visit an older revision, or to update a working tree
1695
that is out of date from its branch.
1697
If there are any uncommitted changes in the tree, they will be carried
1698
across and remain as uncommitted changes after the update. To discard
1699
these changes, use 'bzr revert'. The uncommitted changes may conflict
1700
with the changes brought in by the change in basis revision.
1702
If the tree's branch is bound to a master branch, bzr will also update
1703
the branch from the master.
1705
You cannot update just a single file or directory, because each Bazaar
1706
working tree has just a single basis revision. If you want to restore a
1707
file that has been removed locally, use 'bzr revert' instead of 'bzr
1708
update'. If you want to restore a file to its state in a previous
1709
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1710
out the old content of that file to a new location.
1712
The 'dir' argument, if given, must be the location of the root of a
1713
working tree to update. By default, the working tree that contains the
1714
current working directory is used.
1717
_see_also = ['pull', 'working-trees', 'status-flags']
1718
takes_args = ['dir?']
1719
takes_options = ['revision',
1721
help="Show base revision text in conflicts."),
1725
def run(self, dir=None, revision=None, show_base=None):
1726
if revision is not None and len(revision) != 1:
1727
raise errors.BzrCommandError(gettext(
1728
"bzr update --revision takes exactly one revision"))
1730
tree = WorkingTree.open_containing('.')[0]
1732
tree, relpath = WorkingTree.open_containing(dir)
1735
raise errors.BzrCommandError(gettext(
1736
"bzr update can only update a whole tree, "
1737
"not a file or subdirectory"))
1738
branch = tree.branch
1739
possible_transports = []
1740
master = branch.get_master_branch(
1741
possible_transports=possible_transports)
1742
if master is not None:
1743
branch_location = master.base
1746
branch_location = tree.branch.base
1747
tree.lock_tree_write()
1748
self.add_cleanup(tree.unlock)
1749
# get rid of the final '/' and be ready for display
1750
branch_location = urlutils.unescape_for_display(
1751
branch_location.rstrip('/'),
1753
existing_pending_merges = tree.get_parent_ids()[1:]
1757
# may need to fetch data into a heavyweight checkout
1758
# XXX: this may take some time, maybe we should display a
1760
old_tip = branch.update(possible_transports)
1761
if revision is not None:
1762
revision_id = revision[0].as_revision_id(branch)
1764
revision_id = branch.last_revision()
1765
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1766
revno = branch.revision_id_to_dotted_revno(revision_id)
1767
note(gettext("Tree is up to date at revision {0} of branch {1}"
1768
).format('.'.join(map(str, revno)), branch_location))
1770
view_info = _get_view_info_for_change_reporter(tree)
1771
change_reporter = delta._ChangeReporter(
1772
unversioned_filter=tree.is_ignored,
1773
view_info=view_info)
1775
conflicts = tree.update(
1777
possible_transports=possible_transports,
1778
revision=revision_id,
1780
show_base=show_base)
1781
except errors.NoSuchRevision, e:
1782
raise errors.BzrCommandError(gettext(
1783
"branch has no revision %s\n"
1784
"bzr update --revision only works"
1785
" for a revision in the branch history")
1787
revno = tree.branch.revision_id_to_dotted_revno(
1788
_mod_revision.ensure_null(tree.last_revision()))
1789
note(gettext('Updated to revision {0} of branch {1}').format(
1790
'.'.join(map(str, revno)), branch_location))
1791
parent_ids = tree.get_parent_ids()
1792
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1793
note(gettext('Your local commits will now show as pending merges with '
1794
"'bzr status', and can be committed with 'bzr commit'."))
1801
class cmd_info(Command):
1802
__doc__ = """Show information about a working tree, branch or repository.
1804
This command will show all known locations and formats associated to the
1805
tree, branch or repository.
1807
In verbose mode, statistical information is included with each report.
1808
To see extended statistic information, use a verbosity level of 2 or
1809
higher by specifying the verbose option multiple times, e.g. -vv.
1811
Branches and working trees will also report any missing revisions.
1815
Display information on the format and related locations:
1819
Display the above together with extended format information and
1820
basic statistics (like the number of files in the working tree and
1821
number of revisions in the branch and repository):
1825
Display the above together with number of committers to the branch:
1829
_see_also = ['revno', 'working-trees', 'repositories']
1830
takes_args = ['location?']
1831
takes_options = ['verbose']
1832
encoding_type = 'replace'
1835
def run(self, location=None, verbose=False):
1837
noise_level = get_verbosity_level()
1840
from bzrlib.info import show_bzrdir_info
1841
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1842
verbose=noise_level, outfile=self.outf)
1845
class cmd_remove(Command):
1846
__doc__ = """Remove files or directories.
1848
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1849
delete them if they can easily be recovered using revert otherwise they
1850
will be backed up (adding an extention of the form .~#~). If no options or
1851
parameters are given Bazaar will scan for files that are being tracked by
1852
Bazaar but missing in your tree and stop tracking them for you.
1854
takes_args = ['file*']
1855
takes_options = ['verbose',
1856
Option('new', help='Only remove files that have never been committed.'),
1857
RegistryOption.from_kwargs('file-deletion-strategy',
1858
'The file deletion mode to be used.',
1859
title='Deletion Strategy', value_switches=True, enum_switch=False,
1860
safe='Backup changed files (default).',
1861
keep='Delete from bzr but leave the working copy.',
1862
no_backup='Don\'t backup changed files.',
1863
force='Delete all the specified files, even if they can not be '
1864
'recovered and even if they are non-empty directories. '
1865
'(deprecated, use no-backup)')]
1866
aliases = ['rm', 'del']
1867
encoding_type = 'replace'
1869
def run(self, file_list, verbose=False, new=False,
1870
file_deletion_strategy='safe'):
1871
if file_deletion_strategy == 'force':
1872
note(gettext("(The --force option is deprecated, rather use --no-backup "
1874
file_deletion_strategy = 'no-backup'
1876
tree, file_list = WorkingTree.open_containing_paths(file_list)
1878
if file_list is not None:
1879
file_list = [f for f in file_list]
1881
self.add_cleanup(tree.lock_write().unlock)
1882
# Heuristics should probably all move into tree.remove_smart or
1885
added = tree.changes_from(tree.basis_tree(),
1886
specific_files=file_list).added
1887
file_list = sorted([f[0] for f in added], reverse=True)
1888
if len(file_list) == 0:
1889
raise errors.BzrCommandError(gettext('No matching files.'))
1890
elif file_list is None:
1891
# missing files show up in iter_changes(basis) as
1892
# versioned-with-no-kind.
1894
for change in tree.iter_changes(tree.basis_tree()):
1895
# Find paths in the working tree that have no kind:
1896
if change[1][1] is not None and change[6][1] is None:
1897
missing.append(change[1][1])
1898
file_list = sorted(missing, reverse=True)
1899
file_deletion_strategy = 'keep'
1900
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1901
keep_files=file_deletion_strategy=='keep',
1902
force=(file_deletion_strategy=='no-backup'))
1905
class cmd_file_id(Command):
1906
__doc__ = """Print file_id of a particular file or directory.
1908
The file_id is assigned when the file is first added and remains the
1909
same through all revisions where the file exists, even when it is
1914
_see_also = ['inventory', 'ls']
1915
takes_args = ['filename']
1918
def run(self, filename):
1919
tree, relpath = WorkingTree.open_containing(filename)
1920
i = tree.path2id(relpath)
1922
raise errors.NotVersionedError(filename)
1924
self.outf.write(i + '\n')
1927
class cmd_file_path(Command):
1928
__doc__ = """Print path of file_ids to a file or directory.
1930
This prints one line for each directory down to the target,
1931
starting at the branch root.
1935
takes_args = ['filename']
1938
def run(self, filename):
1939
tree, relpath = WorkingTree.open_containing(filename)
1940
fid = tree.path2id(relpath)
1942
raise errors.NotVersionedError(filename)
1943
segments = osutils.splitpath(relpath)
1944
for pos in range(1, len(segments) + 1):
1945
path = osutils.joinpath(segments[:pos])
1946
self.outf.write("%s\n" % tree.path2id(path))
1949
class cmd_reconcile(Command):
1950
__doc__ = """Reconcile bzr metadata in a branch.
1952
This can correct data mismatches that may have been caused by
1953
previous ghost operations or bzr upgrades. You should only
1954
need to run this command if 'bzr check' or a bzr developer
1955
advises you to run it.
1957
If a second branch is provided, cross-branch reconciliation is
1958
also attempted, which will check that data like the tree root
1959
id which was not present in very early bzr versions is represented
1960
correctly in both branches.
1962
At the same time it is run it may recompress data resulting in
1963
a potential saving in disk space or performance gain.
1965
The branch *MUST* be on a listable system such as local disk or sftp.
1968
_see_also = ['check']
1969
takes_args = ['branch?']
1971
Option('canonicalize-chks',
1972
help='Make sure CHKs are in canonical form (repairs '
1977
def run(self, branch=".", canonicalize_chks=False):
1978
from bzrlib.reconcile import reconcile
1979
dir = controldir.ControlDir.open(branch)
1980
reconcile(dir, canonicalize_chks=canonicalize_chks)
1983
class cmd_revision_history(Command):
1984
__doc__ = """Display the list of revision ids on a branch."""
1987
takes_args = ['location?']
1992
def run(self, location="."):
1993
branch = Branch.open_containing(location)[0]
1994
self.add_cleanup(branch.lock_read().unlock)
1995
graph = branch.repository.get_graph()
1996
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1997
[_mod_revision.NULL_REVISION]))
1998
for revid in reversed(history):
1999
self.outf.write(revid)
2000
self.outf.write('\n')
2003
class cmd_ancestry(Command):
2004
__doc__ = """List all revisions merged into this branch."""
2006
_see_also = ['log', 'revision-history']
2007
takes_args = ['location?']
2012
def run(self, location="."):
2014
wt = WorkingTree.open_containing(location)[0]
2015
except errors.NoWorkingTree:
2016
b = Branch.open(location)
2017
last_revision = b.last_revision()
2020
last_revision = wt.last_revision()
2022
self.add_cleanup(b.repository.lock_read().unlock)
2023
graph = b.repository.get_graph()
2024
revisions = [revid for revid, parents in
2025
graph.iter_ancestry([last_revision])]
2026
for revision_id in reversed(revisions):
2027
if _mod_revision.is_null(revision_id):
2029
self.outf.write(revision_id + '\n')
2032
class cmd_init(Command):
2033
__doc__ = """Make a directory into a versioned branch.
2035
Use this to create an empty branch, or before importing an
2038
If there is a repository in a parent directory of the location, then
2039
the history of the branch will be stored in the repository. Otherwise
2040
init creates a standalone branch which carries its own history
2041
in the .bzr directory.
2043
If there is already a branch at the location but it has no working tree,
2044
the tree can be populated with 'bzr checkout'.
2046
Recipe for importing a tree of files::
2052
bzr commit -m "imported project"
2055
_see_also = ['init-repository', 'branch', 'checkout']
2056
takes_args = ['location?']
2058
Option('create-prefix',
2059
help='Create the path leading up to the branch '
2060
'if it does not already exist.'),
2061
RegistryOption('format',
2062
help='Specify a format for this branch. '
2063
'See "help formats".',
2064
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2065
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2066
value_switches=True,
2067
title="Branch format",
2069
Option('append-revisions-only',
2070
help='Never change revnos or the existing log.'
2071
' Append revisions to it only.'),
2073
'Create a branch without a working tree.')
2075
def run(self, location=None, format=None, append_revisions_only=False,
2076
create_prefix=False, no_tree=False):
2078
format = controldir.format_registry.make_bzrdir('default')
2079
if location is None:
2082
to_transport = transport.get_transport(location)
2084
# The path has to exist to initialize a
2085
# branch inside of it.
2086
# Just using os.mkdir, since I don't
2087
# believe that we want to create a bunch of
2088
# locations if the user supplies an extended path
2090
to_transport.ensure_base()
2091
except errors.NoSuchFile:
2092
if not create_prefix:
2093
raise errors.BzrCommandError(gettext("Parent directory of %s"
2095
"\nYou may supply --create-prefix to create all"
2096
" leading parent directories.")
2098
to_transport.create_prefix()
2101
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
2102
except errors.NotBranchError:
2103
# really a NotBzrDir error...
2104
create_branch = controldir.ControlDir.create_branch_convenience
2106
force_new_tree = False
2108
force_new_tree = None
2109
branch = create_branch(to_transport.base, format=format,
2110
possible_transports=[to_transport],
2111
force_new_tree=force_new_tree)
2112
a_bzrdir = branch.bzrdir
2114
from bzrlib.transport.local import LocalTransport
2115
if a_bzrdir.has_branch():
2116
if (isinstance(to_transport, LocalTransport)
2117
and not a_bzrdir.has_workingtree()):
2118
raise errors.BranchExistsWithoutWorkingTree(location)
2119
raise errors.AlreadyBranchError(location)
2120
branch = a_bzrdir.create_branch()
2121
if not no_tree and not a_bzrdir.has_workingtree():
2122
a_bzrdir.create_workingtree()
2123
if append_revisions_only:
2125
branch.set_append_revisions_only(True)
2126
except errors.UpgradeRequired:
2127
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2128
' to append-revisions-only. Try --default.'))
2130
from bzrlib.info import describe_layout, describe_format
2132
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2133
except (errors.NoWorkingTree, errors.NotLocalUrl):
2135
repository = branch.repository
2136
layout = describe_layout(repository, branch, tree).lower()
2137
format = describe_format(a_bzrdir, repository, branch, tree)
2138
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2140
if repository.is_shared():
2141
#XXX: maybe this can be refactored into transport.path_or_url()
2142
url = repository.bzrdir.root_transport.external_url()
2144
url = urlutils.local_path_from_url(url)
2145
except errors.InvalidURL:
2147
self.outf.write(gettext("Using shared repository: %s\n") % url)
2150
class cmd_init_repository(Command):
2151
__doc__ = """Create a shared repository for branches to share storage space.
2153
New branches created under the repository directory will store their
2154
revisions in the repository, not in the branch directory. For branches
2155
with shared history, this reduces the amount of storage needed and
2156
speeds up the creation of new branches.
2158
If the --no-trees option is given then the branches in the repository
2159
will not have working trees by default. They will still exist as
2160
directories on disk, but they will not have separate copies of the
2161
files at a certain revision. This can be useful for repositories that
2162
store branches which are interacted with through checkouts or remote
2163
branches, such as on a server.
2166
Create a shared repository holding just branches::
2168
bzr init-repo --no-trees repo
2171
Make a lightweight checkout elsewhere::
2173
bzr checkout --lightweight repo/trunk trunk-checkout
2178
_see_also = ['init', 'branch', 'checkout', 'repositories']
2179
takes_args = ["location"]
2180
takes_options = [RegistryOption('format',
2181
help='Specify a format for this repository. See'
2182
' "bzr help formats" for details.',
2183
lazy_registry=('bzrlib.controldir', 'format_registry'),
2184
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2185
value_switches=True, title='Repository format'),
2187
help='Branches in the repository will default to'
2188
' not having a working tree.'),
2190
aliases = ["init-repo"]
2192
def run(self, location, format=None, no_trees=False):
2194
format = controldir.format_registry.make_bzrdir('default')
2196
if location is None:
2199
to_transport = transport.get_transport(location)
2201
(repo, newdir, require_stacking, repository_policy) = (
2202
format.initialize_on_transport_ex(to_transport,
2203
create_prefix=True, make_working_trees=not no_trees,
2204
shared_repo=True, force_new_repo=True,
2205
use_existing_dir=True,
2206
repo_format_name=format.repository_format.get_format_string()))
2208
from bzrlib.info import show_bzrdir_info
2209
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2212
class cmd_diff(Command):
2213
__doc__ = """Show differences in the working tree, between revisions or branches.
2215
If no arguments are given, all changes for the current tree are listed.
2216
If files are given, only the changes in those files are listed.
2217
Remote and multiple branches can be compared by using the --old and
2218
--new options. If not provided, the default for both is derived from
2219
the first argument, if any, or the current tree if no arguments are
2222
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2223
produces patches suitable for "patch -p1".
2225
Note that when using the -r argument with a range of revisions, the
2226
differences are computed between the two specified revisions. That
2227
is, the command does not show the changes introduced by the first
2228
revision in the range. This differs from the interpretation of
2229
revision ranges used by "bzr log" which includes the first revision
2234
2 - unrepresentable changes
2239
Shows the difference in the working tree versus the last commit::
2243
Difference between the working tree and revision 1::
2247
Difference between revision 3 and revision 1::
2251
Difference between revision 3 and revision 1 for branch xxx::
2255
The changes introduced by revision 2 (equivalent to -r1..2)::
2259
To see the changes introduced by revision X::
2263
Note that in the case of a merge, the -c option shows the changes
2264
compared to the left hand parent. To see the changes against
2265
another parent, use::
2267
bzr diff -r<chosen_parent>..X
2269
The changes between the current revision and the previous revision
2270
(equivalent to -c-1 and -r-2..-1)
2274
Show just the differences for file NEWS::
2278
Show the differences in working tree xxx for file NEWS::
2282
Show the differences from branch xxx to this working tree:
2286
Show the differences between two branches for file NEWS::
2288
bzr diff --old xxx --new yyy NEWS
2290
Same as 'bzr diff' but prefix paths with old/ and new/::
2292
bzr diff --prefix old/:new/
2294
Show the differences using a custom diff program with options::
2296
bzr diff --using /usr/bin/diff --diff-options -wu
2298
_see_also = ['status']
2299
takes_args = ['file*']
2301
Option('diff-options', type=str,
2302
help='Pass these options to the external diff program.'),
2303
Option('prefix', type=str,
2305
help='Set prefixes added to old and new filenames, as '
2306
'two values separated by a colon. (eg "old/:new/").'),
2308
help='Branch/tree to compare from.',
2312
help='Branch/tree to compare to.',
2318
help='Use this command to compare files.',
2321
RegistryOption('format',
2323
help='Diff format to use.',
2324
lazy_registry=('bzrlib.diff', 'format_registry'),
2325
title='Diff format'),
2327
aliases = ['di', 'dif']
2328
encoding_type = 'exact'
2331
def run(self, revision=None, file_list=None, diff_options=None,
2332
prefix=None, old=None, new=None, using=None, format=None):
2333
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2336
if (prefix is None) or (prefix == '0'):
2344
old_label, new_label = prefix.split(":")
2346
raise errors.BzrCommandError(gettext(
2347
'--prefix expects two values separated by a colon'
2348
' (eg "old/:new/")'))
2350
if revision and len(revision) > 2:
2351
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2352
' one or two revision specifiers'))
2354
if using is not None and format is not None:
2355
raise errors.BzrCommandError(gettext(
2356
'{0} and {1} are mutually exclusive').format(
2357
'--using', '--format'))
2359
(old_tree, new_tree,
2360
old_branch, new_branch,
2361
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2362
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2363
# GNU diff on Windows uses ANSI encoding for filenames
2364
path_encoding = osutils.get_diff_header_encoding()
2365
return show_diff_trees(old_tree, new_tree, sys.stdout,
2366
specific_files=specific_files,
2367
external_diff_options=diff_options,
2368
old_label=old_label, new_label=new_label,
2369
extra_trees=extra_trees,
2370
path_encoding=path_encoding,
2375
class cmd_deleted(Command):
2376
__doc__ = """List files deleted in the working tree.
2378
# TODO: Show files deleted since a previous revision, or
2379
# between two revisions.
2380
# TODO: Much more efficient way to do this: read in new
2381
# directories with readdir, rather than stating each one. Same
2382
# level of effort but possibly much less IO. (Or possibly not,
2383
# if the directories are very large...)
2384
_see_also = ['status', 'ls']
2385
takes_options = ['directory', 'show-ids']
2388
def run(self, show_ids=False, directory=u'.'):
2389
tree = WorkingTree.open_containing(directory)[0]
2390
self.add_cleanup(tree.lock_read().unlock)
2391
old = tree.basis_tree()
2392
self.add_cleanup(old.lock_read().unlock)
2393
for path, ie in old.inventory.iter_entries():
2394
if not tree.has_id(ie.file_id):
2395
self.outf.write(path)
2397
self.outf.write(' ')
2398
self.outf.write(ie.file_id)
2399
self.outf.write('\n')
2402
class cmd_modified(Command):
2403
__doc__ = """List files modified in working tree.
2407
_see_also = ['status', 'ls']
2408
takes_options = ['directory', 'null']
2411
def run(self, null=False, directory=u'.'):
2412
tree = WorkingTree.open_containing(directory)[0]
2413
self.add_cleanup(tree.lock_read().unlock)
2414
td = tree.changes_from(tree.basis_tree())
2416
for path, id, kind, text_modified, meta_modified in td.modified:
2418
self.outf.write(path + '\0')
2420
self.outf.write(osutils.quotefn(path) + '\n')
2423
class cmd_added(Command):
2424
__doc__ = """List files added in working tree.
2428
_see_also = ['status', 'ls']
2429
takes_options = ['directory', 'null']
2432
def run(self, null=False, directory=u'.'):
2433
wt = WorkingTree.open_containing(directory)[0]
2434
self.add_cleanup(wt.lock_read().unlock)
2435
basis = wt.basis_tree()
2436
self.add_cleanup(basis.lock_read().unlock)
2437
basis_inv = basis.inventory
2440
if basis_inv.has_id(file_id):
2442
if inv.is_root(file_id) and len(basis_inv) == 0:
2444
path = inv.id2path(file_id)
2445
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2448
self.outf.write(path + '\0')
2450
self.outf.write(osutils.quotefn(path) + '\n')
2453
class cmd_root(Command):
2454
__doc__ = """Show the tree root directory.
2456
The root is the nearest enclosing directory with a .bzr control
2459
takes_args = ['filename?']
2461
def run(self, filename=None):
2462
"""Print the branch root."""
2463
tree = WorkingTree.open_containing(filename)[0]
2464
self.outf.write(tree.basedir + '\n')
2467
def _parse_limit(limitstring):
2469
return int(limitstring)
2471
msg = gettext("The limit argument must be an integer.")
2472
raise errors.BzrCommandError(msg)
2475
def _parse_levels(s):
2479
msg = gettext("The levels argument must be an integer.")
2480
raise errors.BzrCommandError(msg)
2483
class cmd_log(Command):
2484
__doc__ = """Show historical log for a branch or subset of a branch.
2486
log is bzr's default tool for exploring the history of a branch.
2487
The branch to use is taken from the first parameter. If no parameters
2488
are given, the branch containing the working directory is logged.
2489
Here are some simple examples::
2491
bzr log log the current branch
2492
bzr log foo.py log a file in its branch
2493
bzr log http://server/branch log a branch on a server
2495
The filtering, ordering and information shown for each revision can
2496
be controlled as explained below. By default, all revisions are
2497
shown sorted (topologically) so that newer revisions appear before
2498
older ones and descendants always appear before ancestors. If displayed,
2499
merged revisions are shown indented under the revision in which they
2504
The log format controls how information about each revision is
2505
displayed. The standard log formats are called ``long``, ``short``
2506
and ``line``. The default is long. See ``bzr help log-formats``
2507
for more details on log formats.
2509
The following options can be used to control what information is
2512
-l N display a maximum of N revisions
2513
-n N display N levels of revisions (0 for all, 1 for collapsed)
2514
-v display a status summary (delta) for each revision
2515
-p display a diff (patch) for each revision
2516
--show-ids display revision-ids (and file-ids), not just revnos
2518
Note that the default number of levels to display is a function of the
2519
log format. If the -n option is not used, the standard log formats show
2520
just the top level (mainline).
2522
Status summaries are shown using status flags like A, M, etc. To see
2523
the changes explained using words like ``added`` and ``modified``
2524
instead, use the -vv option.
2528
To display revisions from oldest to newest, use the --forward option.
2529
In most cases, using this option will have little impact on the total
2530
time taken to produce a log, though --forward does not incrementally
2531
display revisions like --reverse does when it can.
2533
:Revision filtering:
2535
The -r option can be used to specify what revision or range of revisions
2536
to filter against. The various forms are shown below::
2538
-rX display revision X
2539
-rX.. display revision X and later
2540
-r..Y display up to and including revision Y
2541
-rX..Y display from X to Y inclusive
2543
See ``bzr help revisionspec`` for details on how to specify X and Y.
2544
Some common examples are given below::
2546
-r-1 show just the tip
2547
-r-10.. show the last 10 mainline revisions
2548
-rsubmit:.. show what's new on this branch
2549
-rancestor:path.. show changes since the common ancestor of this
2550
branch and the one at location path
2551
-rdate:yesterday.. show changes since yesterday
2553
When logging a range of revisions using -rX..Y, log starts at
2554
revision Y and searches back in history through the primary
2555
("left-hand") parents until it finds X. When logging just the
2556
top level (using -n1), an error is reported if X is not found
2557
along the way. If multi-level logging is used (-n0), X may be
2558
a nested merge revision and the log will be truncated accordingly.
2562
If parameters are given and the first one is not a branch, the log
2563
will be filtered to show only those revisions that changed the
2564
nominated files or directories.
2566
Filenames are interpreted within their historical context. To log a
2567
deleted file, specify a revision range so that the file existed at
2568
the end or start of the range.
2570
Historical context is also important when interpreting pathnames of
2571
renamed files/directories. Consider the following example:
2573
* revision 1: add tutorial.txt
2574
* revision 2: modify tutorial.txt
2575
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2579
* ``bzr log guide.txt`` will log the file added in revision 1
2581
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2583
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2584
the original file in revision 2.
2586
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2587
was no file called guide.txt in revision 2.
2589
Renames are always followed by log. By design, there is no need to
2590
explicitly ask for this (and no way to stop logging a file back
2591
until it was last renamed).
2595
The --match option can be used for finding revisions that match a
2596
regular expression in a commit message, committer, author or bug.
2597
Specifying the option several times will match any of the supplied
2598
expressions. --match-author, --match-bugs, --match-committer and
2599
--match-message can be used to only match a specific field.
2603
GUI tools and IDEs are often better at exploring history than command
2604
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2605
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2606
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2607
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2609
You may find it useful to add the aliases below to ``bazaar.conf``::
2613
top = log -l10 --line
2616
``bzr tip`` will then show the latest revision while ``bzr top``
2617
will show the last 10 mainline revisions. To see the details of a
2618
particular revision X, ``bzr show -rX``.
2620
If you are interested in looking deeper into a particular merge X,
2621
use ``bzr log -n0 -rX``.
2623
``bzr log -v`` on a branch with lots of history is currently
2624
very slow. A fix for this issue is currently under development.
2625
With or without that fix, it is recommended that a revision range
2626
be given when using the -v option.
2628
bzr has a generic full-text matching plugin, bzr-search, that can be
2629
used to find revisions matching user names, commit messages, etc.
2630
Among other features, this plugin can find all revisions containing
2631
a list of words but not others.
2633
When exploring non-mainline history on large projects with deep
2634
history, the performance of log can be greatly improved by installing
2635
the historycache plugin. This plugin buffers historical information
2636
trading disk space for faster speed.
2638
takes_args = ['file*']
2639
_see_also = ['log-formats', 'revisionspec']
2642
help='Show from oldest to newest.'),
2644
custom_help('verbose',
2645
help='Show files changed in each revision.'),
2649
type=bzrlib.option._parse_revision_str,
2651
help='Show just the specified revision.'
2652
' See also "help revisionspec".'),
2654
RegistryOption('authors',
2655
'What names to list as authors - first, all or committer.',
2657
lazy_registry=('bzrlib.log', 'author_list_registry'),
2661
help='Number of levels to display - 0 for all, 1 for flat.',
2663
type=_parse_levels),
2665
help='Show revisions whose message matches this '
2666
'regular expression.',
2671
help='Limit the output to the first N revisions.',
2676
help='Show changes made in each revision as a patch.'),
2677
Option('include-merged',
2678
help='Show merged revisions like --levels 0 does.'),
2679
Option('include-merges', hidden=True,
2680
help='Historical alias for --include-merged.'),
2681
Option('omit-merges',
2682
help='Do not report commits with more than one parent.'),
2683
Option('exclude-common-ancestry',
2684
help='Display only the revisions that are not part'
2685
' of both ancestries (require -rX..Y).'
2687
Option('signatures',
2688
help='Show digital signature validity.'),
2691
help='Show revisions whose properties match this '
2694
ListOption('match-message',
2695
help='Show revisions whose message matches this '
2698
ListOption('match-committer',
2699
help='Show revisions whose committer matches this '
2702
ListOption('match-author',
2703
help='Show revisions whose authors match this '
2706
ListOption('match-bugs',
2707
help='Show revisions whose bugs match this '
2711
encoding_type = 'replace'
2714
def run(self, file_list=None, timezone='original',
2725
include_merged=None,
2727
exclude_common_ancestry=False,
2731
match_committer=None,
2735
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2737
from bzrlib.log import (
2739
make_log_request_dict,
2740
_get_info_for_log_files,
2742
direction = (forward and 'forward') or 'reverse'
2743
if symbol_versioning.deprecated_passed(include_merges):
2744
ui.ui_factory.show_user_warning(
2745
'deprecated_command_option',
2746
deprecated_name='--include-merges',
2747
recommended_name='--include-merged',
2748
deprecated_in_version='2.5',
2749
command=self.invoked_as)
2750
if include_merged is None:
2751
include_merged = include_merges
2753
raise errors.BzrCommandError(gettext(
2754
'{0} and {1} are mutually exclusive').format(
2755
'--include-merges', '--include-merged'))
2756
if include_merged is None:
2757
include_merged = False
2758
if (exclude_common_ancestry
2759
and (revision is None or len(revision) != 2)):
2760
raise errors.BzrCommandError(gettext(
2761
'--exclude-common-ancestry requires -r with two revisions'))
2766
raise errors.BzrCommandError(gettext(
2767
'{0} and {1} are mutually exclusive').format(
2768
'--levels', '--include-merged'))
2770
if change is not None:
2772
raise errors.RangeInChangeOption()
2773
if revision is not None:
2774
raise errors.BzrCommandError(gettext(
2775
'{0} and {1} are mutually exclusive').format(
2776
'--revision', '--change'))
2781
filter_by_dir = False
2783
# find the file ids to log and check for directory filtering
2784
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2785
revision, file_list, self.add_cleanup)
2786
for relpath, file_id, kind in file_info_list:
2788
raise errors.BzrCommandError(gettext(
2789
"Path unknown at end or start of revision range: %s") %
2791
# If the relpath is the top of the tree, we log everything
2796
file_ids.append(file_id)
2797
filter_by_dir = filter_by_dir or (
2798
kind in ['directory', 'tree-reference'])
2801
# FIXME ? log the current subdir only RBC 20060203
2802
if revision is not None \
2803
and len(revision) > 0 and revision[0].get_branch():
2804
location = revision[0].get_branch()
2807
dir, relpath = controldir.ControlDir.open_containing(location)
2808
b = dir.open_branch()
2809
self.add_cleanup(b.lock_read().unlock)
2810
rev1, rev2 = _get_revision_range(revision, b, self.name())
2812
if b.get_config().validate_signatures_in_log():
2816
if not gpg.GPGStrategy.verify_signatures_available():
2817
raise errors.GpgmeNotInstalled(None)
2819
# Decide on the type of delta & diff filtering to use
2820
# TODO: add an --all-files option to make this configurable & consistent
2828
diff_type = 'partial'
2832
# Build the log formatter
2833
if log_format is None:
2834
log_format = log.log_formatter_registry.get_default(b)
2835
# Make a non-encoding output to include the diffs - bug 328007
2836
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2837
lf = log_format(show_ids=show_ids, to_file=self.outf,
2838
to_exact_file=unencoded_output,
2839
show_timezone=timezone,
2840
delta_format=get_verbosity_level(),
2842
show_advice=levels is None,
2843
author_list_handler=authors)
2845
# Choose the algorithm for doing the logging. It's annoying
2846
# having multiple code paths like this but necessary until
2847
# the underlying repository format is faster at generating
2848
# deltas or can provide everything we need from the indices.
2849
# The default algorithm - match-using-deltas - works for
2850
# multiple files and directories and is faster for small
2851
# amounts of history (200 revisions say). However, it's too
2852
# slow for logging a single file in a repository with deep
2853
# history, i.e. > 10K revisions. In the spirit of "do no
2854
# evil when adding features", we continue to use the
2855
# original algorithm - per-file-graph - for the "single
2856
# file that isn't a directory without showing a delta" case.
2857
partial_history = revision and b.repository._format.supports_chks
2858
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2859
or delta_type or partial_history)
2863
match_dict[''] = match
2865
match_dict['message'] = match_message
2867
match_dict['committer'] = match_committer
2869
match_dict['author'] = match_author
2871
match_dict['bugs'] = match_bugs
2873
# Build the LogRequest and execute it
2874
if len(file_ids) == 0:
2876
rqst = make_log_request_dict(
2877
direction=direction, specific_fileids=file_ids,
2878
start_revision=rev1, end_revision=rev2, limit=limit,
2879
message_search=message, delta_type=delta_type,
2880
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2881
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2882
signature=signatures, omit_merges=omit_merges,
2884
Logger(b, rqst).show(lf)
2887
def _get_revision_range(revisionspec_list, branch, command_name):
2888
"""Take the input of a revision option and turn it into a revision range.
2890
It returns RevisionInfo objects which can be used to obtain the rev_id's
2891
of the desired revisions. It does some user input validations.
2893
if revisionspec_list is None:
2896
elif len(revisionspec_list) == 1:
2897
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2898
elif len(revisionspec_list) == 2:
2899
start_spec = revisionspec_list[0]
2900
end_spec = revisionspec_list[1]
2901
if end_spec.get_branch() != start_spec.get_branch():
2902
# b is taken from revision[0].get_branch(), and
2903
# show_log will use its revision_history. Having
2904
# different branches will lead to weird behaviors.
2905
raise errors.BzrCommandError(gettext(
2906
"bzr %s doesn't accept two revisions in different"
2907
" branches.") % command_name)
2908
if start_spec.spec is None:
2909
# Avoid loading all the history.
2910
rev1 = RevisionInfo(branch, None, None)
2912
rev1 = start_spec.in_history(branch)
2913
# Avoid loading all of history when we know a missing
2914
# end of range means the last revision ...
2915
if end_spec.spec is None:
2916
last_revno, last_revision_id = branch.last_revision_info()
2917
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2919
rev2 = end_spec.in_history(branch)
2921
raise errors.BzrCommandError(gettext(
2922
'bzr %s --revision takes one or two values.') % command_name)
2926
def _revision_range_to_revid_range(revision_range):
2929
if revision_range[0] is not None:
2930
rev_id1 = revision_range[0].rev_id
2931
if revision_range[1] is not None:
2932
rev_id2 = revision_range[1].rev_id
2933
return rev_id1, rev_id2
2935
def get_log_format(long=False, short=False, line=False, default='long'):
2936
log_format = default
2940
log_format = 'short'
2946
class cmd_touching_revisions(Command):
2947
__doc__ = """Return revision-ids which affected a particular file.
2949
A more user-friendly interface is "bzr log FILE".
2953
takes_args = ["filename"]
2956
def run(self, filename):
2957
tree, relpath = WorkingTree.open_containing(filename)
2958
file_id = tree.path2id(relpath)
2960
self.add_cleanup(b.lock_read().unlock)
2961
touching_revs = log.find_touching_revisions(b, file_id)
2962
for revno, revision_id, what in touching_revs:
2963
self.outf.write("%6d %s\n" % (revno, what))
2966
class cmd_ls(Command):
2967
__doc__ = """List files in a tree.
2970
_see_also = ['status', 'cat']
2971
takes_args = ['path?']
2975
Option('recursive', short_name='R',
2976
help='Recurse into subdirectories.'),
2978
help='Print paths relative to the root of the branch.'),
2979
Option('unknown', short_name='u',
2980
help='Print unknown files.'),
2981
Option('versioned', help='Print versioned files.',
2983
Option('ignored', short_name='i',
2984
help='Print ignored files.'),
2985
Option('kind', short_name='k',
2986
help='List entries of a particular kind: file, directory, symlink.',
2993
def run(self, revision=None, verbose=False,
2994
recursive=False, from_root=False,
2995
unknown=False, versioned=False, ignored=False,
2996
null=False, kind=None, show_ids=False, path=None, directory=None):
2998
if kind and kind not in ('file', 'directory', 'symlink'):
2999
raise errors.BzrCommandError(gettext('invalid kind specified'))
3001
if verbose and null:
3002
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
3003
all = not (unknown or versioned or ignored)
3005
selection = {'I':ignored, '?':unknown, 'V':versioned}
3011
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3014
tree, branch, relpath = \
3015
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3017
# Calculate the prefix to use
3021
prefix = relpath + '/'
3022
elif fs_path != '.' and not fs_path.endswith('/'):
3023
prefix = fs_path + '/'
3025
if revision is not None or tree is None:
3026
tree = _get_one_revision_tree('ls', revision, branch=branch)
3029
if isinstance(tree, WorkingTree) and tree.supports_views():
3030
view_files = tree.views.lookup_view()
3033
view_str = views.view_display_str(view_files)
3034
note(gettext("Ignoring files outside view. View is %s") % view_str)
3036
self.add_cleanup(tree.lock_read().unlock)
3037
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3038
from_dir=relpath, recursive=recursive):
3039
# Apply additional masking
3040
if not all and not selection[fc]:
3042
if kind is not None and fkind != kind:
3047
fullpath = osutils.pathjoin(relpath, fp)
3050
views.check_path_in_view(tree, fullpath)
3051
except errors.FileOutsideView:
3056
fp = osutils.pathjoin(prefix, fp)
3057
kindch = entry.kind_character()
3058
outstring = fp + kindch
3059
ui.ui_factory.clear_term()
3061
outstring = '%-8s %s' % (fc, outstring)
3062
if show_ids and fid is not None:
3063
outstring = "%-50s %s" % (outstring, fid)
3064
self.outf.write(outstring + '\n')
3066
self.outf.write(fp + '\0')
3069
self.outf.write(fid)
3070
self.outf.write('\0')
3078
self.outf.write('%-50s %s\n' % (outstring, my_id))
3080
self.outf.write(outstring + '\n')
3083
class cmd_unknowns(Command):
3084
__doc__ = """List unknown files.
3089
takes_options = ['directory']
3092
def run(self, directory=u'.'):
3093
for f in WorkingTree.open_containing(directory)[0].unknowns():
3094
self.outf.write(osutils.quotefn(f) + '\n')
3097
class cmd_ignore(Command):
3098
__doc__ = """Ignore specified files or patterns.
3100
See ``bzr help patterns`` for details on the syntax of patterns.
3102
If a .bzrignore file does not exist, the ignore command
3103
will create one and add the specified files or patterns to the newly
3104
created file. The ignore command will also automatically add the
3105
.bzrignore file to be versioned. Creating a .bzrignore file without
3106
the use of the ignore command will require an explicit add command.
3108
To remove patterns from the ignore list, edit the .bzrignore file.
3109
After adding, editing or deleting that file either indirectly by
3110
using this command or directly by using an editor, be sure to commit
3113
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3114
the global ignore file can be found in the application data directory as
3115
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3116
Global ignores are not touched by this command. The global ignore file
3117
can be edited directly using an editor.
3119
Patterns prefixed with '!' are exceptions to ignore patterns and take
3120
precedence over regular ignores. Such exceptions are used to specify
3121
files that should be versioned which would otherwise be ignored.
3123
Patterns prefixed with '!!' act as regular ignore patterns, but have
3124
precedence over the '!' exception patterns.
3128
* Ignore patterns containing shell wildcards must be quoted from
3131
* Ignore patterns starting with "#" act as comments in the ignore file.
3132
To ignore patterns that begin with that character, use the "RE:" prefix.
3135
Ignore the top level Makefile::
3137
bzr ignore ./Makefile
3139
Ignore .class files in all directories...::
3141
bzr ignore "*.class"
3143
...but do not ignore "special.class"::
3145
bzr ignore "!special.class"
3147
Ignore files whose name begins with the "#" character::
3151
Ignore .o files under the lib directory::
3153
bzr ignore "lib/**/*.o"
3155
Ignore .o files under the lib directory::
3157
bzr ignore "RE:lib/.*\.o"
3159
Ignore everything but the "debian" toplevel directory::
3161
bzr ignore "RE:(?!debian/).*"
3163
Ignore everything except the "local" toplevel directory,
3164
but always ignore autosave files ending in ~, even under local/::
3167
bzr ignore "!./local"
3171
_see_also = ['status', 'ignored', 'patterns']
3172
takes_args = ['name_pattern*']
3173
takes_options = ['directory',
3174
Option('default-rules',
3175
help='Display the default ignore rules that bzr uses.')
3178
def run(self, name_pattern_list=None, default_rules=None,
3180
from bzrlib import ignores
3181
if default_rules is not None:
3182
# dump the default rules and exit
3183
for pattern in ignores.USER_DEFAULTS:
3184
self.outf.write("%s\n" % pattern)
3186
if not name_pattern_list:
3187
raise errors.BzrCommandError(gettext("ignore requires at least one "
3188
"NAME_PATTERN or --default-rules."))
3189
name_pattern_list = [globbing.normalize_pattern(p)
3190
for p in name_pattern_list]
3192
bad_patterns_count = 0
3193
for p in name_pattern_list:
3194
if not globbing.Globster.is_pattern_valid(p):
3195
bad_patterns_count += 1
3196
bad_patterns += ('\n %s' % p)
3198
msg = (ngettext('Invalid ignore pattern found. %s',
3199
'Invalid ignore patterns found. %s',
3200
bad_patterns_count) % bad_patterns)
3201
ui.ui_factory.show_error(msg)
3202
raise errors.InvalidPattern('')
3203
for name_pattern in name_pattern_list:
3204
if (name_pattern[0] == '/' or
3205
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3206
raise errors.BzrCommandError(gettext(
3207
"NAME_PATTERN should not be an absolute path"))
3208
tree, relpath = WorkingTree.open_containing(directory)
3209
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3210
ignored = globbing.Globster(name_pattern_list)
3212
self.add_cleanup(tree.lock_read().unlock)
3213
for entry in tree.list_files():
3217
if ignored.match(filename):
3218
matches.append(filename)
3219
if len(matches) > 0:
3220
self.outf.write(gettext("Warning: the following files are version "
3221
"controlled and match your ignore pattern:\n%s"
3222
"\nThese files will continue to be version controlled"
3223
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3226
class cmd_ignored(Command):
3227
__doc__ = """List ignored files and the patterns that matched them.
3229
List all the ignored files and the ignore pattern that caused the file to
3232
Alternatively, to list just the files::
3237
encoding_type = 'replace'
3238
_see_also = ['ignore', 'ls']
3239
takes_options = ['directory']
3242
def run(self, directory=u'.'):
3243
tree = WorkingTree.open_containing(directory)[0]
3244
self.add_cleanup(tree.lock_read().unlock)
3245
for path, file_class, kind, file_id, entry in tree.list_files():
3246
if file_class != 'I':
3248
## XXX: Slightly inefficient since this was already calculated
3249
pat = tree.is_ignored(path)
3250
self.outf.write('%-50s %s\n' % (path, pat))
3253
class cmd_lookup_revision(Command):
3254
__doc__ = """Lookup the revision-id from a revision-number
3257
bzr lookup-revision 33
3260
takes_args = ['revno']
3261
takes_options = ['directory']
3264
def run(self, revno, directory=u'.'):
3268
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3270
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3271
self.outf.write("%s\n" % revid)
3274
class cmd_export(Command):
3275
__doc__ = """Export current or past revision to a destination directory or archive.
3277
If no revision is specified this exports the last committed revision.
3279
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3280
given, try to find the format with the extension. If no extension
3281
is found exports to a directory (equivalent to --format=dir).
3283
If root is supplied, it will be used as the root directory inside
3284
container formats (tar, zip, etc). If it is not supplied it will default
3285
to the exported filename. The root option has no effect for 'dir' format.
3287
If branch is omitted then the branch containing the current working
3288
directory will be used.
3290
Note: Export of tree with non-ASCII filenames to zip is not supported.
3292
================= =========================
3293
Supported formats Autodetected by extension
3294
================= =========================
3297
tbz2 .tar.bz2, .tbz2
3300
================= =========================
3303
takes_args = ['dest', 'branch_or_subdir?']
3304
takes_options = ['directory',
3306
help="Type of file to export to.",
3309
Option('filters', help='Apply content filters to export the '
3310
'convenient form.'),
3313
help="Name of the root directory inside the exported file."),
3314
Option('per-file-timestamps',
3315
help='Set modification time of files to that of the last '
3316
'revision in which it was changed.'),
3317
Option('uncommitted',
3318
help='Export the working tree contents rather than that of the '
3321
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3322
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3324
from bzrlib.export import export
3326
if branch_or_subdir is None:
3327
branch_or_subdir = directory
3329
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3331
if tree is not None:
3332
self.add_cleanup(tree.lock_read().unlock)
3336
raise errors.BzrCommandError(
3337
gettext("--uncommitted requires a working tree"))
3340
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3342
export(export_tree, dest, format, root, subdir, filtered=filters,
3343
per_file_timestamps=per_file_timestamps)
3344
except errors.NoSuchExportFormat, e:
3345
raise errors.BzrCommandError(
3346
gettext('Unsupported export format: %s') % e.format)
3349
class cmd_cat(Command):
3350
__doc__ = """Write the contents of a file as of a given revision to standard output.
3352
If no revision is nominated, the last revision is used.
3354
Note: Take care to redirect standard output when using this command on a
3359
takes_options = ['directory',
3360
Option('name-from-revision', help='The path name in the old tree.'),
3361
Option('filters', help='Apply content filters to display the '
3362
'convenience form.'),
3365
takes_args = ['filename']
3366
encoding_type = 'exact'
3369
def run(self, filename, revision=None, name_from_revision=False,
3370
filters=False, directory=None):
3371
if revision is not None and len(revision) != 1:
3372
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3373
" one revision specifier"))
3374
tree, branch, relpath = \
3375
_open_directory_or_containing_tree_or_branch(filename, directory)
3376
self.add_cleanup(branch.lock_read().unlock)
3377
return self._run(tree, branch, relpath, filename, revision,
3378
name_from_revision, filters)
3380
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3383
tree = b.basis_tree()
3384
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3385
self.add_cleanup(rev_tree.lock_read().unlock)
3387
old_file_id = rev_tree.path2id(relpath)
3389
# TODO: Split out this code to something that generically finds the
3390
# best id for a path across one or more trees; it's like
3391
# find_ids_across_trees but restricted to find just one. -- mbp
3393
if name_from_revision:
3394
# Try in revision if requested
3395
if old_file_id is None:
3396
raise errors.BzrCommandError(gettext(
3397
"{0!r} is not present in revision {1}").format(
3398
filename, rev_tree.get_revision_id()))
3400
actual_file_id = old_file_id
3402
cur_file_id = tree.path2id(relpath)
3403
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3404
actual_file_id = cur_file_id
3405
elif old_file_id is not None:
3406
actual_file_id = old_file_id
3408
raise errors.BzrCommandError(gettext(
3409
"{0!r} is not present in revision {1}").format(
3410
filename, rev_tree.get_revision_id()))
3412
from bzrlib.filter_tree import ContentFilterTree
3413
filter_tree = ContentFilterTree(rev_tree,
3414
rev_tree._content_filter_stack)
3415
content = filter_tree.get_file_text(actual_file_id)
3417
content = rev_tree.get_file_text(actual_file_id)
3419
self.outf.write(content)
3422
class cmd_local_time_offset(Command):
3423
__doc__ = """Show the offset in seconds from GMT to local time."""
3427
self.outf.write("%s\n" % osutils.local_time_offset())
3431
class cmd_commit(Command):
3432
__doc__ = """Commit changes into a new revision.
3434
An explanatory message needs to be given for each commit. This is
3435
often done by using the --message option (getting the message from the
3436
command line) or by using the --file option (getting the message from
3437
a file). If neither of these options is given, an editor is opened for
3438
the user to enter the message. To see the changed files in the
3439
boilerplate text loaded into the editor, use the --show-diff option.
3441
By default, the entire tree is committed and the person doing the
3442
commit is assumed to be the author. These defaults can be overridden
3447
If selected files are specified, only changes to those files are
3448
committed. If a directory is specified then the directory and
3449
everything within it is committed.
3451
When excludes are given, they take precedence over selected files.
3452
For example, to commit only changes within foo, but not changes
3455
bzr commit foo -x foo/bar
3457
A selective commit after a merge is not yet supported.
3461
If the author of the change is not the same person as the committer,
3462
you can specify the author's name using the --author option. The
3463
name should be in the same format as a committer-id, e.g.
3464
"John Doe <jdoe@example.com>". If there is more than one author of
3465
the change you can specify the option multiple times, once for each
3470
A common mistake is to forget to add a new file or directory before
3471
running the commit command. The --strict option checks for unknown
3472
files and aborts the commit if any are found. More advanced pre-commit
3473
checks can be implemented by defining hooks. See ``bzr help hooks``
3478
If you accidentially commit the wrong changes or make a spelling
3479
mistake in the commit message say, you can use the uncommit command
3480
to undo it. See ``bzr help uncommit`` for details.
3482
Hooks can also be configured to run after a commit. This allows you
3483
to trigger updates to external systems like bug trackers. The --fixes
3484
option can be used to record the association between a revision and
3485
one or more bugs. See ``bzr help bugs`` for details.
3488
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3489
takes_args = ['selected*']
3491
ListOption('exclude', type=str, short_name='x',
3492
help="Do not consider changes made to a given path."),
3493
Option('message', type=unicode,
3495
help="Description of the new revision."),
3498
help='Commit even if nothing has changed.'),
3499
Option('file', type=str,
3502
help='Take commit message from this file.'),
3504
help="Refuse to commit if there are unknown "
3505
"files in the working tree."),
3506
Option('commit-time', type=str,
3507
help="Manually set a commit time using commit date "
3508
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3509
ListOption('fixes', type=str,
3510
help="Mark a bug as being fixed by this revision "
3511
"(see \"bzr help bugs\")."),
3512
ListOption('author', type=unicode,
3513
help="Set the author's name, if it's different "
3514
"from the committer."),
3516
help="Perform a local commit in a bound "
3517
"branch. Local commits are not pushed to "
3518
"the master branch until a normal commit "
3521
Option('show-diff', short_name='p',
3522
help='When no message is supplied, show the diff along'
3523
' with the status summary in the message editor.'),
3525
help='When committing to a foreign version control '
3526
'system do not push data that can not be natively '
3529
aliases = ['ci', 'checkin']
3531
def _iter_bug_fix_urls(self, fixes, branch):
3532
default_bugtracker = None
3533
# Configure the properties for bug fixing attributes.
3534
for fixed_bug in fixes:
3535
tokens = fixed_bug.split(':')
3536
if len(tokens) == 1:
3537
if default_bugtracker is None:
3538
branch_config = branch.get_config()
3539
default_bugtracker = branch_config.get_user_option(
3541
if default_bugtracker is None:
3542
raise errors.BzrCommandError(gettext(
3543
"No tracker specified for bug %s. Use the form "
3544
"'tracker:id' or specify a default bug tracker "
3545
"using the `bugtracker` option.\nSee "
3546
"\"bzr help bugs\" for more information on this "
3547
"feature. Commit refused.") % fixed_bug)
3548
tag = default_bugtracker
3550
elif len(tokens) != 2:
3551
raise errors.BzrCommandError(gettext(
3552
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3553
"See \"bzr help bugs\" for more information on this "
3554
"feature.\nCommit refused.") % fixed_bug)
3556
tag, bug_id = tokens
3558
yield bugtracker.get_bug_url(tag, branch, bug_id)
3559
except errors.UnknownBugTrackerAbbreviation:
3560
raise errors.BzrCommandError(gettext(
3561
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3562
except errors.MalformedBugIdentifier, e:
3563
raise errors.BzrCommandError(gettext(
3564
"%s\nCommit refused.") % (str(e),))
3566
def run(self, message=None, file=None, verbose=False, selected_list=None,
3567
unchanged=False, strict=False, local=False, fixes=None,
3568
author=None, show_diff=False, exclude=None, commit_time=None,
3570
from bzrlib.errors import (
3575
from bzrlib.msgeditor import (
3576
edit_commit_message_encoded,
3577
generate_commit_message_template,
3578
make_commit_message_template_encoded,
3582
commit_stamp = offset = None
3583
if commit_time is not None:
3585
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3586
except ValueError, e:
3587
raise errors.BzrCommandError(gettext(
3588
"Could not parse --commit-time: " + str(e)))
3592
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3593
if selected_list == ['']:
3594
# workaround - commit of root of tree should be exactly the same
3595
# as just default commit in that tree, and succeed even though
3596
# selected-file merge commit is not done yet
3601
bug_property = bugtracker.encode_fixes_bug_urls(
3602
self._iter_bug_fix_urls(fixes, tree.branch))
3604
properties['bugs'] = bug_property
3606
if local and not tree.branch.get_bound_location():
3607
raise errors.LocalRequiresBoundBranch()
3609
if message is not None:
3611
file_exists = osutils.lexists(message)
3612
except UnicodeError:
3613
# The commit message contains unicode characters that can't be
3614
# represented in the filesystem encoding, so that can't be a
3619
'The commit message is a file name: "%(f)s".\n'
3620
'(use --file "%(f)s" to take commit message from that file)'
3622
ui.ui_factory.show_warning(warning_msg)
3624
message = message.replace('\r\n', '\n')
3625
message = message.replace('\r', '\n')
3627
raise errors.BzrCommandError(gettext(
3628
"please specify either --message or --file"))
3630
def get_message(commit_obj):
3631
"""Callback to get commit message"""
3635
my_message = f.read().decode(osutils.get_user_encoding())
3638
elif message is not None:
3639
my_message = message
3641
# No message supplied: make one up.
3642
# text is the status of the tree
3643
text = make_commit_message_template_encoded(tree,
3644
selected_list, diff=show_diff,
3645
output_encoding=osutils.get_user_encoding())
3646
# start_message is the template generated from hooks
3647
# XXX: Warning - looks like hooks return unicode,
3648
# make_commit_message_template_encoded returns user encoding.
3649
# We probably want to be using edit_commit_message instead to
3651
my_message = set_commit_message(commit_obj)
3652
if my_message is None:
3653
start_message = generate_commit_message_template(commit_obj)
3654
my_message = edit_commit_message_encoded(text,
3655
start_message=start_message)
3656
if my_message is None:
3657
raise errors.BzrCommandError(gettext("please specify a commit"
3658
" message with either --message or --file"))
3659
if my_message == "":
3660
raise errors.BzrCommandError(gettext("Empty commit message specified."
3661
" Please specify a commit message with either"
3662
" --message or --file or leave a blank message"
3663
" with --message \"\"."))
3666
# The API permits a commit with a filter of [] to mean 'select nothing'
3667
# but the command line should not do that.
3668
if not selected_list:
3669
selected_list = None
3671
tree.commit(message_callback=get_message,
3672
specific_files=selected_list,
3673
allow_pointless=unchanged, strict=strict, local=local,
3674
reporter=None, verbose=verbose, revprops=properties,
3675
authors=author, timestamp=commit_stamp,
3677
exclude=tree.safe_relpath_files(exclude),
3679
except PointlessCommit:
3680
raise errors.BzrCommandError(gettext("No changes to commit."
3681
" Please 'bzr add' the files you want to commit, or use"
3682
" --unchanged to force an empty commit."))
3683
except ConflictsInTree:
3684
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3685
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3687
except StrictCommitFailed:
3688
raise errors.BzrCommandError(gettext("Commit refused because there are"
3689
" unknown files in the working tree."))
3690
except errors.BoundBranchOutOfDate, e:
3691
e.extra_help = (gettext("\n"
3692
'To commit to master branch, run update and then commit.\n'
3693
'You can also pass --local to commit to continue working '
3698
class cmd_check(Command):
3699
__doc__ = """Validate working tree structure, branch consistency and repository history.
3701
This command checks various invariants about branch and repository storage
3702
to detect data corruption or bzr bugs.
3704
The working tree and branch checks will only give output if a problem is
3705
detected. The output fields of the repository check are:
3708
This is just the number of revisions checked. It doesn't
3712
This is just the number of versionedfiles checked. It
3713
doesn't indicate a problem.
3715
unreferenced ancestors
3716
Texts that are ancestors of other texts, but
3717
are not properly referenced by the revision ancestry. This is a
3718
subtle problem that Bazaar can work around.
3721
This is the total number of unique file contents
3722
seen in the checked revisions. It does not indicate a problem.
3725
This is the total number of repeated texts seen
3726
in the checked revisions. Texts can be repeated when their file
3727
entries are modified, but the file contents are not. It does not
3730
If no restrictions are specified, all Bazaar data that is found at the given
3731
location will be checked.
3735
Check the tree and branch at 'foo'::
3737
bzr check --tree --branch foo
3739
Check only the repository at 'bar'::
3741
bzr check --repo bar
3743
Check everything at 'baz'::
3748
_see_also = ['reconcile']
3749
takes_args = ['path?']
3750
takes_options = ['verbose',
3751
Option('branch', help="Check the branch related to the"
3752
" current directory."),
3753
Option('repo', help="Check the repository related to the"
3754
" current directory."),
3755
Option('tree', help="Check the working tree related to"
3756
" the current directory.")]
3758
def run(self, path=None, verbose=False, branch=False, repo=False,
3760
from bzrlib.check import check_dwim
3763
if not branch and not repo and not tree:
3764
branch = repo = tree = True
3765
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3768
class cmd_upgrade(Command):
3769
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3771
When the default format has changed after a major new release of
3772
Bazaar, you may be informed during certain operations that you
3773
should upgrade. Upgrading to a newer format may improve performance
3774
or make new features available. It may however limit interoperability
3775
with older repositories or with older versions of Bazaar.
3777
If you wish to upgrade to a particular format rather than the
3778
current default, that can be specified using the --format option.
3779
As a consequence, you can use the upgrade command this way to
3780
"downgrade" to an earlier format, though some conversions are
3781
a one way process (e.g. changing from the 1.x default to the
3782
2.x default) so downgrading is not always possible.
3784
A backup.bzr.~#~ directory is created at the start of the conversion
3785
process (where # is a number). By default, this is left there on
3786
completion. If the conversion fails, delete the new .bzr directory
3787
and rename this one back in its place. Use the --clean option to ask
3788
for the backup.bzr directory to be removed on successful conversion.
3789
Alternatively, you can delete it by hand if everything looks good
3792
If the location given is a shared repository, dependent branches
3793
are also converted provided the repository converts successfully.
3794
If the conversion of a branch fails, remaining branches are still
3797
For more information on upgrades, see the Bazaar Upgrade Guide,
3798
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3801
_see_also = ['check', 'reconcile', 'formats']
3802
takes_args = ['url?']
3804
RegistryOption('format',
3805
help='Upgrade to a specific format. See "bzr help'
3806
' formats" for details.',
3807
lazy_registry=('bzrlib.controldir', 'format_registry'),
3808
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3809
value_switches=True, title='Branch format'),
3811
help='Remove the backup.bzr directory if successful.'),
3813
help="Show what would be done, but don't actually do anything."),
3816
def run(self, url='.', format=None, clean=False, dry_run=False):
3817
from bzrlib.upgrade import upgrade
3818
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3820
if len(exceptions) == 1:
3821
# Compatibility with historical behavior
3827
class cmd_whoami(Command):
3828
__doc__ = """Show or set bzr user id.
3831
Show the email of the current user::
3835
Set the current user::
3837
bzr whoami "Frank Chu <fchu@example.com>"
3839
takes_options = [ 'directory',
3841
help='Display email address only.'),
3843
help='Set identity for the current branch instead of '
3846
takes_args = ['name?']
3847
encoding_type = 'replace'
3850
def run(self, email=False, branch=False, name=None, directory=None):
3852
if directory is None:
3853
# use branch if we're inside one; otherwise global config
3855
c = Branch.open_containing(u'.')[0].get_config_stack()
3856
except errors.NotBranchError:
3857
c = _mod_config.GlobalStack()
3859
c = Branch.open(directory).get_config_stack()
3860
identity = c.get('email')
3862
self.outf.write(_mod_config.extract_email_address(identity)
3865
self.outf.write(identity + '\n')
3869
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3872
# display a warning if an email address isn't included in the given name.
3874
_mod_config.extract_email_address(name)
3875
except errors.NoEmailInUsername, e:
3876
warning('"%s" does not seem to contain an email address. '
3877
'This is allowed, but not recommended.', name)
3879
# use global config unless --branch given
3881
if directory is None:
3882
c = Branch.open_containing(u'.')[0].get_config_stack()
3884
c = Branch.open(directory).get_config_stack()
3886
c = _mod_config.GlobalStack()
3887
c.set('email', name)
3890
class cmd_nick(Command):
3891
__doc__ = """Print or set the branch nickname.
3893
If unset, the colocated branch name is used for colocated branches, and
3894
the branch directory name is used for other branches. To print the
3895
current nickname, execute with no argument.
3897
Bound branches use the nickname of its master branch unless it is set
3901
_see_also = ['info']
3902
takes_args = ['nickname?']
3903
takes_options = ['directory']
3904
def run(self, nickname=None, directory=u'.'):
3905
branch = Branch.open_containing(directory)[0]
3906
if nickname is None:
3907
self.printme(branch)
3909
branch.nick = nickname
3912
def printme(self, branch):
3913
self.outf.write('%s\n' % branch.nick)
3916
class cmd_alias(Command):
3917
__doc__ = """Set/unset and display aliases.
3920
Show the current aliases::
3924
Show the alias specified for 'll'::
3928
Set an alias for 'll'::
3930
bzr alias ll="log --line -r-10..-1"
3932
To remove an alias for 'll'::
3934
bzr alias --remove ll
3937
takes_args = ['name?']
3939
Option('remove', help='Remove the alias.'),
3942
def run(self, name=None, remove=False):
3944
self.remove_alias(name)
3946
self.print_aliases()
3948
equal_pos = name.find('=')
3950
self.print_alias(name)
3952
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3954
def remove_alias(self, alias_name):
3955
if alias_name is None:
3956
raise errors.BzrCommandError(gettext(
3957
'bzr alias --remove expects an alias to remove.'))
3958
# If alias is not found, print something like:
3959
# unalias: foo: not found
3960
c = _mod_config.GlobalConfig()
3961
c.unset_alias(alias_name)
3964
def print_aliases(self):
3965
"""Print out the defined aliases in a similar format to bash."""
3966
aliases = _mod_config.GlobalConfig().get_aliases()
3967
for key, value in sorted(aliases.iteritems()):
3968
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3971
def print_alias(self, alias_name):
3972
from bzrlib.commands import get_alias
3973
alias = get_alias(alias_name)
3975
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3978
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3980
def set_alias(self, alias_name, alias_command):
3981
"""Save the alias in the global config."""
3982
c = _mod_config.GlobalConfig()
3983
c.set_alias(alias_name, alias_command)
3986
class cmd_selftest(Command):
3987
__doc__ = """Run internal test suite.
3989
If arguments are given, they are regular expressions that say which tests
3990
should run. Tests matching any expression are run, and other tests are
3993
Alternatively if --first is given, matching tests are run first and then
3994
all other tests are run. This is useful if you have been working in a
3995
particular area, but want to make sure nothing else was broken.
3997
If --exclude is given, tests that match that regular expression are
3998
excluded, regardless of whether they match --first or not.
4000
To help catch accidential dependencies between tests, the --randomize
4001
option is useful. In most cases, the argument used is the word 'now'.
4002
Note that the seed used for the random number generator is displayed
4003
when this option is used. The seed can be explicitly passed as the
4004
argument to this option if required. This enables reproduction of the
4005
actual ordering used if and when an order sensitive problem is encountered.
4007
If --list-only is given, the tests that would be run are listed. This is
4008
useful when combined with --first, --exclude and/or --randomize to
4009
understand their impact. The test harness reports "Listed nn tests in ..."
4010
instead of "Ran nn tests in ..." when list mode is enabled.
4012
If the global option '--no-plugins' is given, plugins are not loaded
4013
before running the selftests. This has two effects: features provided or
4014
modified by plugins will not be tested, and tests provided by plugins will
4017
Tests that need working space on disk use a common temporary directory,
4018
typically inside $TMPDIR or /tmp.
4020
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
4021
into a pdb postmortem session.
4023
The --coverage=DIRNAME global option produces a report with covered code
4027
Run only tests relating to 'ignore'::
4031
Disable plugins and list tests as they're run::
4033
bzr --no-plugins selftest -v
4035
# NB: this is used from the class without creating an instance, which is
4036
# why it does not have a self parameter.
4037
def get_transport_type(typestring):
4038
"""Parse and return a transport specifier."""
4039
if typestring == "sftp":
4040
from bzrlib.tests import stub_sftp
4041
return stub_sftp.SFTPAbsoluteServer
4042
elif typestring == "memory":
4043
from bzrlib.tests import test_server
4044
return memory.MemoryServer
4045
elif typestring == "fakenfs":
4046
from bzrlib.tests import test_server
4047
return test_server.FakeNFSServer
4048
msg = "No known transport type %s. Supported types are: sftp\n" %\
4050
raise errors.BzrCommandError(msg)
4053
takes_args = ['testspecs*']
4054
takes_options = ['verbose',
4056
help='Stop when one test fails.',
4060
help='Use a different transport by default '
4061
'throughout the test suite.',
4062
type=get_transport_type),
4064
help='Run the benchmarks rather than selftests.',
4066
Option('lsprof-timed',
4067
help='Generate lsprof output for benchmarked'
4068
' sections of code.'),
4069
Option('lsprof-tests',
4070
help='Generate lsprof output for each test.'),
4072
help='Run all tests, but run specified tests first.',
4076
help='List the tests instead of running them.'),
4077
RegistryOption('parallel',
4078
help="Run the test suite in parallel.",
4079
lazy_registry=('bzrlib.tests', 'parallel_registry'),
4080
value_switches=False,
4082
Option('randomize', type=str, argname="SEED",
4083
help='Randomize the order of tests using the given'
4084
' seed or "now" for the current time.'),
4085
ListOption('exclude', type=str, argname="PATTERN",
4087
help='Exclude tests that match this regular'
4090
help='Output test progress via subunit.'),
4091
Option('strict', help='Fail on missing dependencies or '
4093
Option('load-list', type=str, argname='TESTLISTFILE',
4094
help='Load a test id list from a text file.'),
4095
ListOption('debugflag', type=str, short_name='E',
4096
help='Turn on a selftest debug flag.'),
4097
ListOption('starting-with', type=str, argname='TESTID',
4098
param_name='starting_with', short_name='s',
4100
'Load only the tests starting with TESTID.'),
4102
help="By default we disable fsync and fdatasync"
4103
" while running the test suite.")
4105
encoding_type = 'replace'
4108
Command.__init__(self)
4109
self.additional_selftest_args = {}
4111
def run(self, testspecs_list=None, verbose=False, one=False,
4112
transport=None, benchmark=None,
4114
first=False, list_only=False,
4115
randomize=None, exclude=None, strict=False,
4116
load_list=None, debugflag=None, starting_with=None, subunit=False,
4117
parallel=None, lsprof_tests=False,
4120
# During selftest, disallow proxying, as it can cause severe
4121
# performance penalties and is only needed for thread
4122
# safety. The selftest command is assumed to not use threads
4123
# too heavily. The call should be as early as possible, as
4124
# error reporting for past duplicate imports won't have useful
4126
lazy_import.disallow_proxying()
4128
from bzrlib import tests
4130
if testspecs_list is not None:
4131
pattern = '|'.join(testspecs_list)
4136
from bzrlib.tests import SubUnitBzrRunner
4138
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4139
"needs to be installed to use --subunit."))
4140
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4141
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4142
# stdout, which would corrupt the subunit stream.
4143
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4144
# following code can be deleted when it's sufficiently deployed
4145
# -- vila/mgz 20100514
4146
if (sys.platform == "win32"
4147
and getattr(sys.stdout, 'fileno', None) is not None):
4149
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4151
self.additional_selftest_args.setdefault(
4152
'suite_decorators', []).append(parallel)
4154
raise errors.BzrCommandError(gettext(
4155
"--benchmark is no longer supported from bzr 2.2; "
4156
"use bzr-usertest instead"))
4157
test_suite_factory = None
4159
exclude_pattern = None
4161
exclude_pattern = '(' + '|'.join(exclude) + ')'
4163
self._disable_fsync()
4164
selftest_kwargs = {"verbose": verbose,
4166
"stop_on_failure": one,
4167
"transport": transport,
4168
"test_suite_factory": test_suite_factory,
4169
"lsprof_timed": lsprof_timed,
4170
"lsprof_tests": lsprof_tests,
4171
"matching_tests_first": first,
4172
"list_only": list_only,
4173
"random_seed": randomize,
4174
"exclude_pattern": exclude_pattern,
4176
"load_list": load_list,
4177
"debug_flags": debugflag,
4178
"starting_with": starting_with
4180
selftest_kwargs.update(self.additional_selftest_args)
4182
# Make deprecation warnings visible, unless -Werror is set
4183
cleanup = symbol_versioning.activate_deprecation_warnings(
4186
result = tests.selftest(**selftest_kwargs)
4189
return int(not result)
4191
def _disable_fsync(self):
4192
"""Change the 'os' functionality to not synchronize."""
4193
self._orig_fsync = getattr(os, 'fsync', None)
4194
if self._orig_fsync is not None:
4195
os.fsync = lambda filedes: None
4196
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4197
if self._orig_fdatasync is not None:
4198
os.fdatasync = lambda filedes: None
4201
class cmd_version(Command):
4202
__doc__ = """Show version of bzr."""
4204
encoding_type = 'replace'
4206
Option("short", help="Print just the version number."),
4210
def run(self, short=False):
4211
from bzrlib.version import show_version
4213
self.outf.write(bzrlib.version_string + '\n')
4215
show_version(to_file=self.outf)
4218
class cmd_rocks(Command):
4219
__doc__ = """Statement of optimism."""
4225
self.outf.write(gettext("It sure does!\n"))
4228
class cmd_find_merge_base(Command):
4229
__doc__ = """Find and print a base revision for merging two branches."""
4230
# TODO: Options to specify revisions on either side, as if
4231
# merging only part of the history.
4232
takes_args = ['branch', 'other']
4236
def run(self, branch, other):
4237
from bzrlib.revision import ensure_null
4239
branch1 = Branch.open_containing(branch)[0]
4240
branch2 = Branch.open_containing(other)[0]
4241
self.add_cleanup(branch1.lock_read().unlock)
4242
self.add_cleanup(branch2.lock_read().unlock)
4243
last1 = ensure_null(branch1.last_revision())
4244
last2 = ensure_null(branch2.last_revision())
4246
graph = branch1.repository.get_graph(branch2.repository)
4247
base_rev_id = graph.find_unique_lca(last1, last2)
4249
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4252
class cmd_merge(Command):
4253
__doc__ = """Perform a three-way merge.
4255
The source of the merge can be specified either in the form of a branch,
4256
or in the form of a path to a file containing a merge directive generated
4257
with bzr send. If neither is specified, the default is the upstream branch
4258
or the branch most recently merged using --remember. The source of the
4259
merge may also be specified in the form of a path to a file in another
4260
branch: in this case, only the modifications to that file are merged into
4261
the current working tree.
4263
When merging from a branch, by default bzr will try to merge in all new
4264
work from the other branch, automatically determining an appropriate base
4265
revision. If this fails, you may need to give an explicit base.
4267
To pick a different ending revision, pass "--revision OTHER". bzr will
4268
try to merge in all new work up to and including revision OTHER.
4270
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4271
through OTHER, excluding BASE but including OTHER, will be merged. If this
4272
causes some revisions to be skipped, i.e. if the destination branch does
4273
not already contain revision BASE, such a merge is commonly referred to as
4274
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4275
cherrypicks. The changes look like a normal commit, and the history of the
4276
changes from the other branch is not stored in the commit.
4278
Revision numbers are always relative to the source branch.
4280
Merge will do its best to combine the changes in two branches, but there
4281
are some kinds of problems only a human can fix. When it encounters those,
4282
it will mark a conflict. A conflict means that you need to fix something,
4283
before you can commit.
4285
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4287
If there is no default branch set, the first merge will set it (use
4288
--no-remember to avoid setting it). After that, you can omit the branch
4289
to use the default. To change the default, use --remember. The value will
4290
only be saved if the remote location can be accessed.
4292
The results of the merge are placed into the destination working
4293
directory, where they can be reviewed (with bzr diff), tested, and then
4294
committed to record the result of the merge.
4296
merge refuses to run if there are any uncommitted changes, unless
4297
--force is given. If --force is given, then the changes from the source
4298
will be merged with the current working tree, including any uncommitted
4299
changes in the tree. The --force option can also be used to create a
4300
merge revision which has more than two parents.
4302
If one would like to merge changes from the working tree of the other
4303
branch without merging any committed revisions, the --uncommitted option
4306
To select only some changes to merge, use "merge -i", which will prompt
4307
you to apply each diff hunk and file change, similar to "shelve".
4310
To merge all new revisions from bzr.dev::
4312
bzr merge ../bzr.dev
4314
To merge changes up to and including revision 82 from bzr.dev::
4316
bzr merge -r 82 ../bzr.dev
4318
To merge the changes introduced by 82, without previous changes::
4320
bzr merge -r 81..82 ../bzr.dev
4322
To apply a merge directive contained in /tmp/merge::
4324
bzr merge /tmp/merge
4326
To create a merge revision with three parents from two branches
4327
feature1a and feature1b:
4329
bzr merge ../feature1a
4330
bzr merge ../feature1b --force
4331
bzr commit -m 'revision with three parents'
4334
encoding_type = 'exact'
4335
_see_also = ['update', 'remerge', 'status-flags', 'send']
4336
takes_args = ['location?']
4341
help='Merge even if the destination tree has uncommitted changes.'),
4345
Option('show-base', help="Show base revision text in "
4347
Option('uncommitted', help='Apply uncommitted changes'
4348
' from a working copy, instead of branch changes.'),
4349
Option('pull', help='If the destination is already'
4350
' completely merged into the source, pull from the'
4351
' source rather than merging. When this happens,'
4352
' you do not need to commit the result.'),
4353
custom_help('directory',
4354
help='Branch to merge into, '
4355
'rather than the one containing the working directory.'),
4356
Option('preview', help='Instead of merging, show a diff of the'
4358
Option('interactive', help='Select changes interactively.',
4362
def run(self, location=None, revision=None, force=False,
4363
merge_type=None, show_base=False, reprocess=None, remember=None,
4364
uncommitted=False, pull=False,
4369
if merge_type is None:
4370
merge_type = _mod_merge.Merge3Merger
4372
if directory is None: directory = u'.'
4373
possible_transports = []
4375
allow_pending = True
4376
verified = 'inapplicable'
4378
tree = WorkingTree.open_containing(directory)[0]
4379
if tree.branch.revno() == 0:
4380
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4381
'https://bugs.launchpad.net/bzr/+bug/308562'))
4384
basis_tree = tree.revision_tree(tree.last_revision())
4385
except errors.NoSuchRevision:
4386
basis_tree = tree.basis_tree()
4388
# die as quickly as possible if there are uncommitted changes
4390
if tree.has_changes():
4391
raise errors.UncommittedChanges(tree)
4393
view_info = _get_view_info_for_change_reporter(tree)
4394
change_reporter = delta._ChangeReporter(
4395
unversioned_filter=tree.is_ignored, view_info=view_info)
4396
pb = ui.ui_factory.nested_progress_bar()
4397
self.add_cleanup(pb.finished)
4398
self.add_cleanup(tree.lock_write().unlock)
4399
if location is not None:
4401
mergeable = bundle.read_mergeable_from_url(location,
4402
possible_transports=possible_transports)
4403
except errors.NotABundle:
4407
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4408
' with bundles or merge directives.'))
4410
if revision is not None:
4411
raise errors.BzrCommandError(gettext(
4412
'Cannot use -r with merge directives or bundles'))
4413
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4416
if merger is None and uncommitted:
4417
if revision is not None and len(revision) > 0:
4418
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4419
' --revision at the same time.'))
4420
merger = self.get_merger_from_uncommitted(tree, location, None)
4421
allow_pending = False
4424
merger, allow_pending = self._get_merger_from_branch(tree,
4425
location, revision, remember, possible_transports, None)
4427
merger.merge_type = merge_type
4428
merger.reprocess = reprocess
4429
merger.show_base = show_base
4430
self.sanity_check_merger(merger)
4431
if (merger.base_rev_id == merger.other_rev_id and
4432
merger.other_rev_id is not None):
4433
# check if location is a nonexistent file (and not a branch) to
4434
# disambiguate the 'Nothing to do'
4435
if merger.interesting_files:
4436
if not merger.other_tree.has_filename(
4437
merger.interesting_files[0]):
4438
note(gettext("merger: ") + str(merger))
4439
raise errors.PathsDoNotExist([location])
4440
note(gettext('Nothing to do.'))
4442
if pull and not preview:
4443
if merger.interesting_files is not None:
4444
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4445
if (merger.base_rev_id == tree.last_revision()):
4446
result = tree.pull(merger.other_branch, False,
4447
merger.other_rev_id)
4448
result.report(self.outf)
4450
if merger.this_basis is None:
4451
raise errors.BzrCommandError(gettext(
4452
"This branch has no commits."
4453
" (perhaps you would prefer 'bzr pull')"))
4455
return self._do_preview(merger)
4457
return self._do_interactive(merger)
4459
return self._do_merge(merger, change_reporter, allow_pending,
4462
def _get_preview(self, merger):
4463
tree_merger = merger.make_merger()
4464
tt = tree_merger.make_preview_transform()
4465
self.add_cleanup(tt.finalize)
4466
result_tree = tt.get_preview_tree()
4469
def _do_preview(self, merger):
4470
from bzrlib.diff import show_diff_trees
4471
result_tree = self._get_preview(merger)
4472
path_encoding = osutils.get_diff_header_encoding()
4473
show_diff_trees(merger.this_tree, result_tree, self.outf,
4474
old_label='', new_label='',
4475
path_encoding=path_encoding)
4477
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4478
merger.change_reporter = change_reporter
4479
conflict_count = merger.do_merge()
4481
merger.set_pending()
4482
if verified == 'failed':
4483
warning('Preview patch does not match changes')
4484
if conflict_count != 0:
4489
def _do_interactive(self, merger):
4490
"""Perform an interactive merge.
4492
This works by generating a preview tree of the merge, then using
4493
Shelver to selectively remove the differences between the working tree
4494
and the preview tree.
4496
from bzrlib import shelf_ui
4497
result_tree = self._get_preview(merger)
4498
writer = bzrlib.option.diff_writer_registry.get()
4499
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4500
reporter=shelf_ui.ApplyReporter(),
4501
diff_writer=writer(sys.stdout))
4507
def sanity_check_merger(self, merger):
4508
if (merger.show_base and
4509
not merger.merge_type is _mod_merge.Merge3Merger):
4510
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4511
" merge type. %s") % merger.merge_type)
4512
if merger.reprocess is None:
4513
if merger.show_base:
4514
merger.reprocess = False
4516
# Use reprocess if the merger supports it
4517
merger.reprocess = merger.merge_type.supports_reprocess
4518
if merger.reprocess and not merger.merge_type.supports_reprocess:
4519
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4520
" for merge type %s.") %
4522
if merger.reprocess and merger.show_base:
4523
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4526
def _get_merger_from_branch(self, tree, location, revision, remember,
4527
possible_transports, pb):
4528
"""Produce a merger from a location, assuming it refers to a branch."""
4529
from bzrlib.tag import _merge_tags_if_possible
4530
# find the branch locations
4531
other_loc, user_location = self._select_branch_location(tree, location,
4533
if revision is not None and len(revision) == 2:
4534
base_loc, _unused = self._select_branch_location(tree,
4535
location, revision, 0)
4537
base_loc = other_loc
4539
other_branch, other_path = Branch.open_containing(other_loc,
4540
possible_transports)
4541
if base_loc == other_loc:
4542
base_branch = other_branch
4544
base_branch, base_path = Branch.open_containing(base_loc,
4545
possible_transports)
4546
# Find the revision ids
4547
other_revision_id = None
4548
base_revision_id = None
4549
if revision is not None:
4550
if len(revision) >= 1:
4551
other_revision_id = revision[-1].as_revision_id(other_branch)
4552
if len(revision) == 2:
4553
base_revision_id = revision[0].as_revision_id(base_branch)
4554
if other_revision_id is None:
4555
other_revision_id = _mod_revision.ensure_null(
4556
other_branch.last_revision())
4557
# Remember where we merge from. We need to remember if:
4558
# - user specify a location (and we don't merge from the parent
4560
# - user ask to remember or there is no previous location set to merge
4561
# from and user didn't ask to *not* remember
4562
if (user_location is not None
4564
or (remember is None
4565
and tree.branch.get_submit_branch() is None)))):
4566
tree.branch.set_submit_branch(other_branch.base)
4567
# Merge tags (but don't set them in the master branch yet, the user
4568
# might revert this merge). Commit will propagate them.
4569
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4570
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4571
other_revision_id, base_revision_id, other_branch, base_branch)
4572
if other_path != '':
4573
allow_pending = False
4574
merger.interesting_files = [other_path]
4576
allow_pending = True
4577
return merger, allow_pending
4579
def get_merger_from_uncommitted(self, tree, location, pb):
4580
"""Get a merger for uncommitted changes.
4582
:param tree: The tree the merger should apply to.
4583
:param location: The location containing uncommitted changes.
4584
:param pb: The progress bar to use for showing progress.
4586
location = self._select_branch_location(tree, location)[0]
4587
other_tree, other_path = WorkingTree.open_containing(location)
4588
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4589
if other_path != '':
4590
merger.interesting_files = [other_path]
4593
def _select_branch_location(self, tree, user_location, revision=None,
4595
"""Select a branch location, according to possible inputs.
4597
If provided, branches from ``revision`` are preferred. (Both
4598
``revision`` and ``index`` must be supplied.)
4600
Otherwise, the ``location`` parameter is used. If it is None, then the
4601
``submit`` or ``parent`` location is used, and a note is printed.
4603
:param tree: The working tree to select a branch for merging into
4604
:param location: The location entered by the user
4605
:param revision: The revision parameter to the command
4606
:param index: The index to use for the revision parameter. Negative
4607
indices are permitted.
4608
:return: (selected_location, user_location). The default location
4609
will be the user-entered location.
4611
if (revision is not None and index is not None
4612
and revision[index] is not None):
4613
branch = revision[index].get_branch()
4614
if branch is not None:
4615
return branch, branch
4616
if user_location is None:
4617
location = self._get_remembered(tree, 'Merging from')
4619
location = user_location
4620
return location, user_location
4622
def _get_remembered(self, tree, verb_string):
4623
"""Use tree.branch's parent if none was supplied.
4625
Report if the remembered location was used.
4627
stored_location = tree.branch.get_submit_branch()
4628
stored_location_type = "submit"
4629
if stored_location is None:
4630
stored_location = tree.branch.get_parent()
4631
stored_location_type = "parent"
4632
mutter("%s", stored_location)
4633
if stored_location is None:
4634
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4635
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4636
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4637
stored_location_type, display_url))
4638
return stored_location
4641
class cmd_remerge(Command):
4642
__doc__ = """Redo a merge.
4644
Use this if you want to try a different merge technique while resolving
4645
conflicts. Some merge techniques are better than others, and remerge
4646
lets you try different ones on different files.
4648
The options for remerge have the same meaning and defaults as the ones for
4649
merge. The difference is that remerge can (only) be run when there is a
4650
pending merge, and it lets you specify particular files.
4653
Re-do the merge of all conflicted files, and show the base text in
4654
conflict regions, in addition to the usual THIS and OTHER texts::
4656
bzr remerge --show-base
4658
Re-do the merge of "foobar", using the weave merge algorithm, with
4659
additional processing to reduce the size of conflict regions::
4661
bzr remerge --merge-type weave --reprocess foobar
4663
takes_args = ['file*']
4668
help="Show base revision text in conflicts."),
4671
def run(self, file_list=None, merge_type=None, show_base=False,
4673
from bzrlib.conflicts import restore
4674
if merge_type is None:
4675
merge_type = _mod_merge.Merge3Merger
4676
tree, file_list = WorkingTree.open_containing_paths(file_list)
4677
self.add_cleanup(tree.lock_write().unlock)
4678
parents = tree.get_parent_ids()
4679
if len(parents) != 2:
4680
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4681
" merges. Not cherrypicking or"
4683
repository = tree.branch.repository
4684
interesting_ids = None
4686
conflicts = tree.conflicts()
4687
if file_list is not None:
4688
interesting_ids = set()
4689
for filename in file_list:
4690
file_id = tree.path2id(filename)
4692
raise errors.NotVersionedError(filename)
4693
interesting_ids.add(file_id)
4694
if tree.kind(file_id) != "directory":
4697
for name, ie in tree.inventory.iter_entries(file_id):
4698
interesting_ids.add(ie.file_id)
4699
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4701
# Remerge only supports resolving contents conflicts
4702
allowed_conflicts = ('text conflict', 'contents conflict')
4703
restore_files = [c.path for c in conflicts
4704
if c.typestring in allowed_conflicts]
4705
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4706
tree.set_conflicts(ConflictList(new_conflicts))
4707
if file_list is not None:
4708
restore_files = file_list
4709
for filename in restore_files:
4711
restore(tree.abspath(filename))
4712
except errors.NotConflicted:
4714
# Disable pending merges, because the file texts we are remerging
4715
# have not had those merges performed. If we use the wrong parents
4716
# list, we imply that the working tree text has seen and rejected
4717
# all the changes from the other tree, when in fact those changes
4718
# have not yet been seen.
4719
tree.set_parent_ids(parents[:1])
4721
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4722
merger.interesting_ids = interesting_ids
4723
merger.merge_type = merge_type
4724
merger.show_base = show_base
4725
merger.reprocess = reprocess
4726
conflicts = merger.do_merge()
4728
tree.set_parent_ids(parents)
4735
class cmd_revert(Command):
4736
__doc__ = """Revert files to a previous revision.
4738
Giving a list of files will revert only those files. Otherwise, all files
4739
will be reverted. If the revision is not specified with '--revision', the
4740
last committed revision is used.
4742
To remove only some changes, without reverting to a prior version, use
4743
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4744
will remove the changes introduced by the second last commit (-2), without
4745
affecting the changes introduced by the last commit (-1). To remove
4746
certain changes on a hunk-by-hunk basis, see the shelve command.
4748
By default, any files that have been manually changed will be backed up
4749
first. (Files changed only by merge are not backed up.) Backup files have
4750
'.~#~' appended to their name, where # is a number.
4752
When you provide files, you can use their current pathname or the pathname
4753
from the target revision. So you can use revert to "undelete" a file by
4754
name. If you name a directory, all the contents of that directory will be
4757
If you have newly added files since the target revision, they will be
4758
removed. If the files to be removed have been changed, backups will be
4759
created as above. Directories containing unknown files will not be
4762
The working tree contains a list of revisions that have been merged but
4763
not yet committed. These revisions will be included as additional parents
4764
of the next commit. Normally, using revert clears that list as well as
4765
reverting the files. If any files are specified, revert leaves the list
4766
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4767
.`` in the tree root to revert all files but keep the recorded merges,
4768
and ``bzr revert --forget-merges`` to clear the pending merge list without
4769
reverting any files.
4771
Using "bzr revert --forget-merges", it is possible to apply all of the
4772
changes from a branch in a single revision. To do this, perform the merge
4773
as desired. Then doing revert with the "--forget-merges" option will keep
4774
the content of the tree as it was, but it will clear the list of pending
4775
merges. The next commit will then contain all of the changes that are
4776
present in the other branch, but without any other parent revisions.
4777
Because this technique forgets where these changes originated, it may
4778
cause additional conflicts on later merges involving the same source and
4782
_see_also = ['cat', 'export', 'merge', 'shelve']
4785
Option('no-backup', "Do not save backups of reverted files."),
4786
Option('forget-merges',
4787
'Remove pending merge marker, without changing any files.'),
4789
takes_args = ['file*']
4791
def run(self, revision=None, no_backup=False, file_list=None,
4792
forget_merges=None):
4793
tree, file_list = WorkingTree.open_containing_paths(file_list)
4794
self.add_cleanup(tree.lock_tree_write().unlock)
4796
tree.set_parent_ids(tree.get_parent_ids()[:1])
4798
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4801
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4802
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4803
tree.revert(file_list, rev_tree, not no_backup, None,
4804
report_changes=True)
4807
class cmd_assert_fail(Command):
4808
__doc__ = """Test reporting of assertion failures"""
4809
# intended just for use in testing
4814
raise AssertionError("always fails")
4817
class cmd_help(Command):
4818
__doc__ = """Show help on a command or other topic.
4821
_see_also = ['topics']
4823
Option('long', 'Show help on all commands.'),
4825
takes_args = ['topic?']
4826
aliases = ['?', '--help', '-?', '-h']
4829
def run(self, topic=None, long=False):
4831
if topic is None and long:
4833
bzrlib.help.help(topic)
4836
class cmd_shell_complete(Command):
4837
__doc__ = """Show appropriate completions for context.
4839
For a list of all available commands, say 'bzr shell-complete'.
4841
takes_args = ['context?']
4846
def run(self, context=None):
4847
from bzrlib import shellcomplete
4848
shellcomplete.shellcomplete(context)
4851
class cmd_missing(Command):
4852
__doc__ = """Show unmerged/unpulled revisions between two branches.
4854
OTHER_BRANCH may be local or remote.
4856
To filter on a range of revisions, you can use the command -r begin..end
4857
-r revision requests a specific revision, -r ..end or -r begin.. are
4861
1 - some missing revisions
4862
0 - no missing revisions
4866
Determine the missing revisions between this and the branch at the
4867
remembered pull location::
4871
Determine the missing revisions between this and another branch::
4873
bzr missing http://server/branch
4875
Determine the missing revisions up to a specific revision on the other
4878
bzr missing -r ..-10
4880
Determine the missing revisions up to a specific revision on this
4883
bzr missing --my-revision ..-10
4886
_see_also = ['merge', 'pull']
4887
takes_args = ['other_branch?']
4890
Option('reverse', 'Reverse the order of revisions.'),
4892
'Display changes in the local branch only.'),
4893
Option('this' , 'Same as --mine-only.'),
4894
Option('theirs-only',
4895
'Display changes in the remote branch only.'),
4896
Option('other', 'Same as --theirs-only.'),
4900
custom_help('revision',
4901
help='Filter on other branch revisions (inclusive). '
4902
'See "help revisionspec" for details.'),
4903
Option('my-revision',
4904
type=_parse_revision_str,
4905
help='Filter on local branch revisions (inclusive). '
4906
'See "help revisionspec" for details.'),
4907
Option('include-merged',
4908
'Show all revisions in addition to the mainline ones.'),
4909
Option('include-merges', hidden=True,
4910
help='Historical alias for --include-merged.'),
4912
encoding_type = 'replace'
4915
def run(self, other_branch=None, reverse=False, mine_only=False,
4917
log_format=None, long=False, short=False, line=False,
4918
show_ids=False, verbose=False, this=False, other=False,
4919
include_merged=None, revision=None, my_revision=None,
4921
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4922
from bzrlib.missing import find_unmerged, iter_log_revisions
4927
if symbol_versioning.deprecated_passed(include_merges):
4928
ui.ui_factory.show_user_warning(
4929
'deprecated_command_option',
4930
deprecated_name='--include-merges',
4931
recommended_name='--include-merged',
4932
deprecated_in_version='2.5',
4933
command=self.invoked_as)
4934
if include_merged is None:
4935
include_merged = include_merges
4937
raise errors.BzrCommandError(gettext(
4938
'{0} and {1} are mutually exclusive').format(
4939
'--include-merges', '--include-merged'))
4940
if include_merged is None:
4941
include_merged = False
4946
# TODO: We should probably check that we don't have mine-only and
4947
# theirs-only set, but it gets complicated because we also have
4948
# this and other which could be used.
4955
local_branch = Branch.open_containing(directory)[0]
4956
self.add_cleanup(local_branch.lock_read().unlock)
4958
parent = local_branch.get_parent()
4959
if other_branch is None:
4960
other_branch = parent
4961
if other_branch is None:
4962
raise errors.BzrCommandError(gettext("No peer location known"
4964
display_url = urlutils.unescape_for_display(parent,
4966
message(gettext("Using saved parent location: {0}\n").format(
4969
remote_branch = Branch.open(other_branch)
4970
if remote_branch.base == local_branch.base:
4971
remote_branch = local_branch
4973
self.add_cleanup(remote_branch.lock_read().unlock)
4975
local_revid_range = _revision_range_to_revid_range(
4976
_get_revision_range(my_revision, local_branch,
4979
remote_revid_range = _revision_range_to_revid_range(
4980
_get_revision_range(revision,
4981
remote_branch, self.name()))
4983
local_extra, remote_extra = find_unmerged(
4984
local_branch, remote_branch, restrict,
4985
backward=not reverse,
4986
include_merged=include_merged,
4987
local_revid_range=local_revid_range,
4988
remote_revid_range=remote_revid_range)
4990
if log_format is None:
4991
registry = log.log_formatter_registry
4992
log_format = registry.get_default(local_branch)
4993
lf = log_format(to_file=self.outf,
4995
show_timezone='original')
4998
if local_extra and not theirs_only:
4999
message(ngettext("You have %d extra revision:\n",
5000
"You have %d extra revisions:\n",
5003
for revision in iter_log_revisions(local_extra,
5004
local_branch.repository,
5006
lf.log_revision(revision)
5007
printed_local = True
5010
printed_local = False
5012
if remote_extra and not mine_only:
5013
if printed_local is True:
5015
message(ngettext("You are missing %d revision:\n",
5016
"You are missing %d revisions:\n",
5017
len(remote_extra)) %
5019
for revision in iter_log_revisions(remote_extra,
5020
remote_branch.repository,
5022
lf.log_revision(revision)
5025
if mine_only and not local_extra:
5026
# We checked local, and found nothing extra
5027
message(gettext('This branch has no new revisions.\n'))
5028
elif theirs_only and not remote_extra:
5029
# We checked remote, and found nothing extra
5030
message(gettext('Other branch has no new revisions.\n'))
5031
elif not (mine_only or theirs_only or local_extra or
5033
# We checked both branches, and neither one had extra
5035
message(gettext("Branches are up to date.\n"))
5037
if not status_code and parent is None and other_branch is not None:
5038
self.add_cleanup(local_branch.lock_write().unlock)
5039
# handle race conditions - a parent might be set while we run.
5040
if local_branch.get_parent() is None:
5041
local_branch.set_parent(remote_branch.base)
5045
class cmd_pack(Command):
5046
__doc__ = """Compress the data within a repository.
5048
This operation compresses the data within a bazaar repository. As
5049
bazaar supports automatic packing of repository, this operation is
5050
normally not required to be done manually.
5052
During the pack operation, bazaar takes a backup of existing repository
5053
data, i.e. pack files. This backup is eventually removed by bazaar
5054
automatically when it is safe to do so. To save disk space by removing
5055
the backed up pack files, the --clean-obsolete-packs option may be
5058
Warning: If you use --clean-obsolete-packs and your machine crashes
5059
during or immediately after repacking, you may be left with a state
5060
where the deletion has been written to disk but the new packs have not
5061
been. In this case the repository may be unusable.
5064
_see_also = ['repositories']
5065
takes_args = ['branch_or_repo?']
5067
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5070
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5071
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5073
branch = dir.open_branch()
5074
repository = branch.repository
5075
except errors.NotBranchError:
5076
repository = dir.open_repository()
5077
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5080
class cmd_plugins(Command):
5081
__doc__ = """List the installed plugins.
5083
This command displays the list of installed plugins including
5084
version of plugin and a short description of each.
5086
--verbose shows the path where each plugin is located.
5088
A plugin is an external component for Bazaar that extends the
5089
revision control system, by adding or replacing code in Bazaar.
5090
Plugins can do a variety of things, including overriding commands,
5091
adding new commands, providing additional network transports and
5092
customizing log output.
5094
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5095
for further information on plugins including where to find them and how to
5096
install them. Instructions are also provided there on how to write new
5097
plugins using the Python programming language.
5099
takes_options = ['verbose']
5102
def run(self, verbose=False):
5103
from bzrlib import plugin
5104
# Don't give writelines a generator as some codecs don't like that
5105
self.outf.writelines(
5106
list(plugin.describe_plugins(show_paths=verbose)))
5109
class cmd_testament(Command):
5110
__doc__ = """Show testament (signing-form) of a revision."""
5113
Option('long', help='Produce long-format testament.'),
5115
help='Produce a strict-format testament.')]
5116
takes_args = ['branch?']
5117
encoding_type = 'exact'
5119
def run(self, branch=u'.', revision=None, long=False, strict=False):
5120
from bzrlib.testament import Testament, StrictTestament
5122
testament_class = StrictTestament
5124
testament_class = Testament
5126
b = Branch.open_containing(branch)[0]
5128
b = Branch.open(branch)
5129
self.add_cleanup(b.lock_read().unlock)
5130
if revision is None:
5131
rev_id = b.last_revision()
5133
rev_id = revision[0].as_revision_id(b)
5134
t = testament_class.from_revision(b.repository, rev_id)
5136
self.outf.writelines(t.as_text_lines())
5138
self.outf.write(t.as_short_text())
5141
class cmd_annotate(Command):
5142
__doc__ = """Show the origin of each line in a file.
5144
This prints out the given file with an annotation on the left side
5145
indicating which revision, author and date introduced the change.
5147
If the origin is the same for a run of consecutive lines, it is
5148
shown only at the top, unless the --all option is given.
5150
# TODO: annotate directories; showing when each file was last changed
5151
# TODO: if the working copy is modified, show annotations on that
5152
# with new uncommitted lines marked
5153
aliases = ['ann', 'blame', 'praise']
5154
takes_args = ['filename']
5155
takes_options = [Option('all', help='Show annotations on all lines.'),
5156
Option('long', help='Show commit date in annotations.'),
5161
encoding_type = 'exact'
5164
def run(self, filename, all=False, long=False, revision=None,
5165
show_ids=False, directory=None):
5166
from bzrlib.annotate import (
5169
wt, branch, relpath = \
5170
_open_directory_or_containing_tree_or_branch(filename, directory)
5172
self.add_cleanup(wt.lock_read().unlock)
5174
self.add_cleanup(branch.lock_read().unlock)
5175
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5176
self.add_cleanup(tree.lock_read().unlock)
5177
if wt is not None and revision is None:
5178
file_id = wt.path2id(relpath)
5180
file_id = tree.path2id(relpath)
5182
raise errors.NotVersionedError(filename)
5183
if wt is not None and revision is None:
5184
# If there is a tree and we're not annotating historical
5185
# versions, annotate the working tree's content.
5186
annotate_file_tree(wt, file_id, self.outf, long, all,
5189
annotate_file_tree(tree, file_id, self.outf, long, all,
5190
show_ids=show_ids, branch=branch)
5193
class cmd_re_sign(Command):
5194
__doc__ = """Create a digital signature for an existing revision."""
5195
# TODO be able to replace existing ones.
5197
hidden = True # is this right ?
5198
takes_args = ['revision_id*']
5199
takes_options = ['directory', 'revision']
5201
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5202
if revision_id_list is not None and revision is not None:
5203
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5204
if revision_id_list is None and revision is None:
5205
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5206
b = WorkingTree.open_containing(directory)[0].branch
5207
self.add_cleanup(b.lock_write().unlock)
5208
return self._run(b, revision_id_list, revision)
5210
def _run(self, b, revision_id_list, revision):
5211
import bzrlib.gpg as gpg
5212
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5213
if revision_id_list is not None:
5214
b.repository.start_write_group()
5216
for revision_id in revision_id_list:
5217
b.repository.sign_revision(revision_id, gpg_strategy)
5219
b.repository.abort_write_group()
5222
b.repository.commit_write_group()
5223
elif revision is not None:
5224
if len(revision) == 1:
5225
revno, rev_id = revision[0].in_history(b)
5226
b.repository.start_write_group()
5228
b.repository.sign_revision(rev_id, gpg_strategy)
5230
b.repository.abort_write_group()
5233
b.repository.commit_write_group()
5234
elif len(revision) == 2:
5235
# are they both on rh- if so we can walk between them
5236
# might be nice to have a range helper for arbitrary
5237
# revision paths. hmm.
5238
from_revno, from_revid = revision[0].in_history(b)
5239
to_revno, to_revid = revision[1].in_history(b)
5240
if to_revid is None:
5241
to_revno = b.revno()
5242
if from_revno is None or to_revno is None:
5243
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5244
b.repository.start_write_group()
5246
for revno in range(from_revno, to_revno + 1):
5247
b.repository.sign_revision(b.get_rev_id(revno),
5250
b.repository.abort_write_group()
5253
b.repository.commit_write_group()
5255
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5258
class cmd_bind(Command):
5259
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5260
If no branch is supplied, rebind to the last bound location.
5262
Once converted into a checkout, commits must succeed on the master branch
5263
before they will be applied to the local branch.
5265
Bound branches use the nickname of its master branch unless it is set
5266
locally, in which case binding will update the local nickname to be
5270
_see_also = ['checkouts', 'unbind']
5271
takes_args = ['location?']
5272
takes_options = ['directory']
5274
def run(self, location=None, directory=u'.'):
5275
b, relpath = Branch.open_containing(directory)
5276
if location is None:
5278
location = b.get_old_bound_location()
5279
except errors.UpgradeRequired:
5280
raise errors.BzrCommandError(gettext('No location supplied. '
5281
'This format does not remember old locations.'))
5283
if location is None:
5284
if b.get_bound_location() is not None:
5285
raise errors.BzrCommandError(gettext('Branch is already bound'))
5287
raise errors.BzrCommandError(gettext('No location supplied '
5288
'and no previous location known'))
5289
b_other = Branch.open(location)
5292
except errors.DivergedBranches:
5293
raise errors.BzrCommandError(gettext('These branches have diverged.'
5294
' Try merging, and then bind again.'))
5295
if b.get_config().has_explicit_nickname():
5296
b.nick = b_other.nick
5299
class cmd_unbind(Command):
5300
__doc__ = """Convert the current checkout into a regular branch.
5302
After unbinding, the local branch is considered independent and subsequent
5303
commits will be local only.
5306
_see_also = ['checkouts', 'bind']
5308
takes_options = ['directory']
5310
def run(self, directory=u'.'):
5311
b, relpath = Branch.open_containing(directory)
5313
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5316
class cmd_uncommit(Command):
5317
__doc__ = """Remove the last committed revision.
5319
--verbose will print out what is being removed.
5320
--dry-run will go through all the motions, but not actually
5323
If --revision is specified, uncommit revisions to leave the branch at the
5324
specified revision. For example, "bzr uncommit -r 15" will leave the
5325
branch at revision 15.
5327
Uncommit leaves the working tree ready for a new commit. The only change
5328
it may make is to restore any pending merges that were present before
5332
# TODO: jam 20060108 Add an option to allow uncommit to remove
5333
# unreferenced information in 'branch-as-repository' branches.
5334
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5335
# information in shared branches as well.
5336
_see_also = ['commit']
5337
takes_options = ['verbose', 'revision',
5338
Option('dry-run', help='Don\'t actually make changes.'),
5339
Option('force', help='Say yes to all questions.'),
5341
help='Keep tags that point to removed revisions.'),
5343
help="Only remove the commits from the local branch"
5344
" when in a checkout."
5347
takes_args = ['location?']
5349
encoding_type = 'replace'
5351
def run(self, location=None, dry_run=False, verbose=False,
5352
revision=None, force=False, local=False, keep_tags=False):
5353
if location is None:
5355
control, relpath = controldir.ControlDir.open_containing(location)
5357
tree = control.open_workingtree()
5359
except (errors.NoWorkingTree, errors.NotLocalUrl):
5361
b = control.open_branch()
5363
if tree is not None:
5364
self.add_cleanup(tree.lock_write().unlock)
5366
self.add_cleanup(b.lock_write().unlock)
5367
return self._run(b, tree, dry_run, verbose, revision, force,
5370
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5372
from bzrlib.log import log_formatter, show_log
5373
from bzrlib.uncommit import uncommit
5375
last_revno, last_rev_id = b.last_revision_info()
5378
if revision is None:
5380
rev_id = last_rev_id
5382
# 'bzr uncommit -r 10' actually means uncommit
5383
# so that the final tree is at revno 10.
5384
# but bzrlib.uncommit.uncommit() actually uncommits
5385
# the revisions that are supplied.
5386
# So we need to offset it by one
5387
revno = revision[0].in_history(b).revno + 1
5388
if revno <= last_revno:
5389
rev_id = b.get_rev_id(revno)
5391
if rev_id is None or _mod_revision.is_null(rev_id):
5392
self.outf.write(gettext('No revisions to uncommit.\n'))
5395
lf = log_formatter('short',
5397
show_timezone='original')
5402
direction='forward',
5403
start_revision=revno,
5404
end_revision=last_revno)
5407
self.outf.write(gettext('Dry-run, pretending to remove'
5408
' the above revisions.\n'))
5410
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5413
if not ui.ui_factory.confirm_action(
5414
gettext(u'Uncommit these revisions'),
5415
'bzrlib.builtins.uncommit',
5417
self.outf.write(gettext('Canceled\n'))
5420
mutter('Uncommitting from {%s} to {%s}',
5421
last_rev_id, rev_id)
5422
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5423
revno=revno, local=local, keep_tags=keep_tags)
5424
self.outf.write(gettext('You can restore the old tip by running:\n'
5425
' bzr pull . -r revid:%s\n') % last_rev_id)
5428
class cmd_break_lock(Command):
5429
__doc__ = """Break a dead lock.
5431
This command breaks a lock on a repository, branch, working directory or
5434
CAUTION: Locks should only be broken when you are sure that the process
5435
holding the lock has been stopped.
5437
You can get information on what locks are open via the 'bzr info
5438
[location]' command.
5442
bzr break-lock bzr+ssh://example.com/bzr/foo
5443
bzr break-lock --conf ~/.bazaar
5446
takes_args = ['location?']
5449
help='LOCATION is the directory where the config lock is.'),
5451
help='Do not ask for confirmation before breaking the lock.'),
5454
def run(self, location=None, config=False, force=False):
5455
if location is None:
5458
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5460
{'bzrlib.lockdir.break': True})
5462
conf = _mod_config.LockableConfig(file_name=location)
5465
control, relpath = controldir.ControlDir.open_containing(location)
5467
control.break_lock()
5468
except NotImplementedError:
5472
class cmd_wait_until_signalled(Command):
5473
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5475
This just prints a line to signal when it is ready, then blocks on stdin.
5481
sys.stdout.write("running\n")
5483
sys.stdin.readline()
5486
class cmd_serve(Command):
5487
__doc__ = """Run the bzr server."""
5489
aliases = ['server']
5493
help='Serve on stdin/out for use from inetd or sshd.'),
5494
RegistryOption('protocol',
5495
help="Protocol to serve.",
5496
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5497
value_switches=True),
5499
help='Listen for connections on nominated port of the form '
5500
'[hostname:]portnumber. Passing 0 as the port number will '
5501
'result in a dynamically allocated port. The default port '
5502
'depends on the protocol.',
5504
custom_help('directory',
5505
help='Serve contents of this directory.'),
5506
Option('allow-writes',
5507
help='By default the server is a readonly server. Supplying '
5508
'--allow-writes enables write access to the contents of '
5509
'the served directory and below. Note that ``bzr serve`` '
5510
'does not perform authentication, so unless some form of '
5511
'external authentication is arranged supplying this '
5512
'option leads to global uncontrolled write access to your '
5515
Option('client-timeout', type=float,
5516
help='Override the default idle client timeout (5min).'),
5519
def get_host_and_port(self, port):
5520
"""Return the host and port to run the smart server on.
5522
If 'port' is None, None will be returned for the host and port.
5524
If 'port' has a colon in it, the string before the colon will be
5525
interpreted as the host.
5527
:param port: A string of the port to run the server on.
5528
:return: A tuple of (host, port), where 'host' is a host name or IP,
5529
and port is an integer TCP/IP port.
5532
if port is not None:
5534
host, port = port.split(':')
5538
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5539
protocol=None, client_timeout=None):
5540
from bzrlib import transport
5541
if directory is None:
5542
directory = os.getcwd()
5543
if protocol is None:
5544
protocol = transport.transport_server_registry.get()
5545
host, port = self.get_host_and_port(port)
5546
url = transport.location_to_url(directory)
5547
if not allow_writes:
5548
url = 'readonly+' + url
5549
t = transport.get_transport_from_url(url)
5551
protocol(t, host, port, inet, client_timeout)
5552
except TypeError, e:
5553
# We use symbol_versioning.deprecated_in just so that people
5554
# grepping can find it here.
5555
# symbol_versioning.deprecated_in((2, 5, 0))
5556
symbol_versioning.warn(
5557
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5558
'Most likely it needs to be updated to support a'
5559
' "timeout" parameter (added in bzr 2.5.0)'
5560
% (e, protocol.__module__, protocol),
5562
protocol(t, host, port, inet)
5565
class cmd_join(Command):
5566
__doc__ = """Combine a tree into its containing tree.
5568
This command requires the target tree to be in a rich-root format.
5570
The TREE argument should be an independent tree, inside another tree, but
5571
not part of it. (Such trees can be produced by "bzr split", but also by
5572
running "bzr branch" with the target inside a tree.)
5574
The result is a combined tree, with the subtree no longer an independent
5575
part. This is marked as a merge of the subtree into the containing tree,
5576
and all history is preserved.
5579
_see_also = ['split']
5580
takes_args = ['tree']
5582
Option('reference', help='Join by reference.', hidden=True),
5585
def run(self, tree, reference=False):
5586
sub_tree = WorkingTree.open(tree)
5587
parent_dir = osutils.dirname(sub_tree.basedir)
5588
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5589
repo = containing_tree.branch.repository
5590
if not repo.supports_rich_root():
5591
raise errors.BzrCommandError(gettext(
5592
"Can't join trees because %s doesn't support rich root data.\n"
5593
"You can use bzr upgrade on the repository.")
5597
containing_tree.add_reference(sub_tree)
5598
except errors.BadReferenceTarget, e:
5599
# XXX: Would be better to just raise a nicely printable
5600
# exception from the real origin. Also below. mbp 20070306
5601
raise errors.BzrCommandError(
5602
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5605
containing_tree.subsume(sub_tree)
5606
except errors.BadSubsumeSource, e:
5607
raise errors.BzrCommandError(
5608
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5611
class cmd_split(Command):
5612
__doc__ = """Split a subdirectory of a tree into a separate tree.
5614
This command will produce a target tree in a format that supports
5615
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5616
converted into earlier formats like 'dirstate-tags'.
5618
The TREE argument should be a subdirectory of a working tree. That
5619
subdirectory will be converted into an independent tree, with its own
5620
branch. Commits in the top-level tree will not apply to the new subtree.
5623
_see_also = ['join']
5624
takes_args = ['tree']
5626
def run(self, tree):
5627
containing_tree, subdir = WorkingTree.open_containing(tree)
5628
sub_id = containing_tree.path2id(subdir)
5630
raise errors.NotVersionedError(subdir)
5632
containing_tree.extract(sub_id)
5633
except errors.RootNotRich:
5634
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5637
class cmd_merge_directive(Command):
5638
__doc__ = """Generate a merge directive for auto-merge tools.
5640
A directive requests a merge to be performed, and also provides all the
5641
information necessary to do so. This means it must either include a
5642
revision bundle, or the location of a branch containing the desired
5645
A submit branch (the location to merge into) must be supplied the first
5646
time the command is issued. After it has been supplied once, it will
5647
be remembered as the default.
5649
A public branch is optional if a revision bundle is supplied, but required
5650
if --diff or --plain is specified. It will be remembered as the default
5651
after the first use.
5654
takes_args = ['submit_branch?', 'public_branch?']
5658
_see_also = ['send']
5662
RegistryOption.from_kwargs('patch-type',
5663
'The type of patch to include in the directive.',
5665
value_switches=True,
5667
bundle='Bazaar revision bundle (default).',
5668
diff='Normal unified diff.',
5669
plain='No patch, just directive.'),
5670
Option('sign', help='GPG-sign the directive.'), 'revision',
5671
Option('mail-to', type=str,
5672
help='Instead of printing the directive, email to this address.'),
5673
Option('message', type=str, short_name='m',
5674
help='Message to use when committing this merge.')
5677
encoding_type = 'exact'
5679
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5680
sign=False, revision=None, mail_to=None, message=None,
5682
from bzrlib.revision import ensure_null, NULL_REVISION
5683
include_patch, include_bundle = {
5684
'plain': (False, False),
5685
'diff': (True, False),
5686
'bundle': (True, True),
5688
branch = Branch.open(directory)
5689
stored_submit_branch = branch.get_submit_branch()
5690
if submit_branch is None:
5691
submit_branch = stored_submit_branch
5693
if stored_submit_branch is None:
5694
branch.set_submit_branch(submit_branch)
5695
if submit_branch is None:
5696
submit_branch = branch.get_parent()
5697
if submit_branch is None:
5698
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5700
stored_public_branch = branch.get_public_branch()
5701
if public_branch is None:
5702
public_branch = stored_public_branch
5703
elif stored_public_branch is None:
5704
branch.set_public_branch(public_branch)
5705
if not include_bundle and public_branch is None:
5706
raise errors.BzrCommandError(gettext('No public branch specified or'
5708
base_revision_id = None
5709
if revision is not None:
5710
if len(revision) > 2:
5711
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5712
'at most two one revision identifiers'))
5713
revision_id = revision[-1].as_revision_id(branch)
5714
if len(revision) == 2:
5715
base_revision_id = revision[0].as_revision_id(branch)
5717
revision_id = branch.last_revision()
5718
revision_id = ensure_null(revision_id)
5719
if revision_id == NULL_REVISION:
5720
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5721
directive = merge_directive.MergeDirective2.from_objects(
5722
branch.repository, revision_id, time.time(),
5723
osutils.local_time_offset(), submit_branch,
5724
public_branch=public_branch, include_patch=include_patch,
5725
include_bundle=include_bundle, message=message,
5726
base_revision_id=base_revision_id)
5729
self.outf.write(directive.to_signed(branch))
5731
self.outf.writelines(directive.to_lines())
5733
message = directive.to_email(mail_to, branch, sign)
5734
s = SMTPConnection(branch.get_config_stack())
5735
s.send_email(message)
5738
class cmd_send(Command):
5739
__doc__ = """Mail or create a merge-directive for submitting changes.
5741
A merge directive provides many things needed for requesting merges:
5743
* A machine-readable description of the merge to perform
5745
* An optional patch that is a preview of the changes requested
5747
* An optional bundle of revision data, so that the changes can be applied
5748
directly from the merge directive, without retrieving data from a
5751
`bzr send` creates a compact data set that, when applied using bzr
5752
merge, has the same effect as merging from the source branch.
5754
By default the merge directive is self-contained and can be applied to any
5755
branch containing submit_branch in its ancestory without needing access to
5758
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5759
revisions, but only a structured request to merge from the
5760
public_location. In that case the public_branch is needed and it must be
5761
up-to-date and accessible to the recipient. The public_branch is always
5762
included if known, so that people can check it later.
5764
The submit branch defaults to the parent of the source branch, but can be
5765
overridden. Both submit branch and public branch will be remembered in
5766
branch.conf the first time they are used for a particular branch. The
5767
source branch defaults to that containing the working directory, but can
5768
be changed using --from.
5770
Both the submit branch and the public branch follow the usual behavior with
5771
respect to --remember: If there is no default location set, the first send
5772
will set it (use --no-remember to avoid setting it). After that, you can
5773
omit the location to use the default. To change the default, use
5774
--remember. The value will only be saved if the location can be accessed.
5776
In order to calculate those changes, bzr must analyse the submit branch.
5777
Therefore it is most efficient for the submit branch to be a local mirror.
5778
If a public location is known for the submit_branch, that location is used
5779
in the merge directive.
5781
The default behaviour is to send the merge directive by mail, unless -o is
5782
given, in which case it is sent to a file.
5784
Mail is sent using your preferred mail program. This should be transparent
5785
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5786
If the preferred client can't be found (or used), your editor will be used.
5788
To use a specific mail program, set the mail_client configuration option.
5789
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5790
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5791
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5792
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5795
If mail is being sent, a to address is required. This can be supplied
5796
either on the commandline, by setting the submit_to configuration
5797
option in the branch itself or the child_submit_to configuration option
5798
in the submit branch.
5800
Two formats are currently supported: "4" uses revision bundle format 4 and
5801
merge directive format 2. It is significantly faster and smaller than
5802
older formats. It is compatible with Bazaar 0.19 and later. It is the
5803
default. "0.9" uses revision bundle format 0.9 and merge directive
5804
format 1. It is compatible with Bazaar 0.12 - 0.18.
5806
The merge directives created by bzr send may be applied using bzr merge or
5807
bzr pull by specifying a file containing a merge directive as the location.
5809
bzr send makes extensive use of public locations to map local locations into
5810
URLs that can be used by other people. See `bzr help configuration` to
5811
set them, and use `bzr info` to display them.
5814
encoding_type = 'exact'
5816
_see_also = ['merge', 'pull']
5818
takes_args = ['submit_branch?', 'public_branch?']
5822
help='Do not include a bundle in the merge directive.'),
5823
Option('no-patch', help='Do not include a preview patch in the merge'
5826
help='Remember submit and public branch.'),
5828
help='Branch to generate the submission from, '
5829
'rather than the one containing the working directory.',
5832
Option('output', short_name='o',
5833
help='Write merge directive to this file or directory; '
5834
'use - for stdout.',
5837
help='Refuse to send if there are uncommitted changes in'
5838
' the working tree, --no-strict disables the check.'),
5839
Option('mail-to', help='Mail the request to this address.',
5843
Option('body', help='Body for the email.', type=unicode),
5844
RegistryOption('format',
5845
help='Use the specified output format.',
5846
lazy_registry=('bzrlib.send', 'format_registry')),
5849
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5850
no_patch=False, revision=None, remember=None, output=None,
5851
format=None, mail_to=None, message=None, body=None,
5852
strict=None, **kwargs):
5853
from bzrlib.send import send
5854
return send(submit_branch, revision, public_branch, remember,
5855
format, no_bundle, no_patch, output,
5856
kwargs.get('from', '.'), mail_to, message, body,
5861
class cmd_bundle_revisions(cmd_send):
5862
__doc__ = """Create a merge-directive for submitting changes.
5864
A merge directive provides many things needed for requesting merges:
5866
* A machine-readable description of the merge to perform
5868
* An optional patch that is a preview of the changes requested
5870
* An optional bundle of revision data, so that the changes can be applied
5871
directly from the merge directive, without retrieving data from a
5874
If --no-bundle is specified, then public_branch is needed (and must be
5875
up-to-date), so that the receiver can perform the merge using the
5876
public_branch. The public_branch is always included if known, so that
5877
people can check it later.
5879
The submit branch defaults to the parent, but can be overridden. Both
5880
submit branch and public branch will be remembered if supplied.
5882
If a public_branch is known for the submit_branch, that public submit
5883
branch is used in the merge instructions. This means that a local mirror
5884
can be used as your actual submit branch, once you have set public_branch
5887
Two formats are currently supported: "4" uses revision bundle format 4 and
5888
merge directive format 2. It is significantly faster and smaller than
5889
older formats. It is compatible with Bazaar 0.19 and later. It is the
5890
default. "0.9" uses revision bundle format 0.9 and merge directive
5891
format 1. It is compatible with Bazaar 0.12 - 0.18.
5896
help='Do not include a bundle in the merge directive.'),
5897
Option('no-patch', help='Do not include a preview patch in the merge'
5900
help='Remember submit and public branch.'),
5902
help='Branch to generate the submission from, '
5903
'rather than the one containing the working directory.',
5906
Option('output', short_name='o', help='Write directive to this file.',
5909
help='Refuse to bundle revisions if there are uncommitted'
5910
' changes in the working tree, --no-strict disables the check.'),
5912
RegistryOption('format',
5913
help='Use the specified output format.',
5914
lazy_registry=('bzrlib.send', 'format_registry')),
5916
aliases = ['bundle']
5918
_see_also = ['send', 'merge']
5922
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5923
no_patch=False, revision=None, remember=False, output=None,
5924
format=None, strict=None, **kwargs):
5927
from bzrlib.send import send
5928
return send(submit_branch, revision, public_branch, remember,
5929
format, no_bundle, no_patch, output,
5930
kwargs.get('from', '.'), None, None, None,
5931
self.outf, strict=strict)
5934
class cmd_tag(Command):
5935
__doc__ = """Create, remove or modify a tag naming a revision.
5937
Tags give human-meaningful names to revisions. Commands that take a -r
5938
(--revision) option can be given -rtag:X, where X is any previously
5941
Tags are stored in the branch. Tags are copied from one branch to another
5942
along when you branch, push, pull or merge.
5944
It is an error to give a tag name that already exists unless you pass
5945
--force, in which case the tag is moved to point to the new revision.
5947
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5948
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5950
If no tag name is specified it will be determined through the
5951
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5952
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5956
_see_also = ['commit', 'tags']
5957
takes_args = ['tag_name?']
5960
help='Delete this tag rather than placing it.',
5962
custom_help('directory',
5963
help='Branch in which to place the tag.'),
5965
help='Replace existing tags.',
5970
def run(self, tag_name=None,
5976
branch, relpath = Branch.open_containing(directory)
5977
self.add_cleanup(branch.lock_write().unlock)
5979
if tag_name is None:
5980
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5981
branch.tags.delete_tag(tag_name)
5982
note(gettext('Deleted tag %s.') % tag_name)
5985
if len(revision) != 1:
5986
raise errors.BzrCommandError(gettext(
5987
"Tags can only be placed on a single revision, "
5989
revision_id = revision[0].as_revision_id(branch)
5991
revision_id = branch.last_revision()
5992
if tag_name is None:
5993
tag_name = branch.automatic_tag_name(revision_id)
5994
if tag_name is None:
5995
raise errors.BzrCommandError(gettext(
5996
"Please specify a tag name."))
5998
existing_target = branch.tags.lookup_tag(tag_name)
5999
except errors.NoSuchTag:
6000
existing_target = None
6001
if not force and existing_target not in (None, revision_id):
6002
raise errors.TagAlreadyExists(tag_name)
6003
if existing_target == revision_id:
6004
note(gettext('Tag %s already exists for that revision.') % tag_name)
6006
branch.tags.set_tag(tag_name, revision_id)
6007
if existing_target is None:
6008
note(gettext('Created tag %s.') % tag_name)
6010
note(gettext('Updated tag %s.') % tag_name)
6013
class cmd_tags(Command):
6014
__doc__ = """List tags.
6016
This command shows a table of tag names and the revisions they reference.
6021
custom_help('directory',
6022
help='Branch whose tags should be displayed.'),
6023
RegistryOption('sort',
6024
'Sort tags by different criteria.', title='Sorting',
6025
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
6032
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6033
from bzrlib.tag import tag_sort_methods
6034
branch, relpath = Branch.open_containing(directory)
6036
tags = branch.tags.get_tag_dict().items()
6040
self.add_cleanup(branch.lock_read().unlock)
6042
# Restrict to the specified range
6043
tags = self._tags_for_range(branch, revision)
6045
sort = tag_sort_methods.get()
6048
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6049
for index, (tag, revid) in enumerate(tags):
6051
revno = branch.revision_id_to_dotted_revno(revid)
6052
if isinstance(revno, tuple):
6053
revno = '.'.join(map(str, revno))
6054
except (errors.NoSuchRevision,
6055
errors.GhostRevisionsHaveNoRevno,
6056
errors.UnsupportedOperation):
6057
# Bad tag data/merges can lead to tagged revisions
6058
# which are not in this branch. Fail gracefully ...
6060
tags[index] = (tag, revno)
6062
for tag, revspec in tags:
6063
self.outf.write('%-20s %s\n' % (tag, revspec))
6065
def _tags_for_range(self, branch, revision):
6067
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6068
revid1, revid2 = rev1.rev_id, rev2.rev_id
6069
# _get_revision_range will always set revid2 if it's not specified.
6070
# If revid1 is None, it means we want to start from the branch
6071
# origin which is always a valid ancestor. If revid1 == revid2, the
6072
# ancestry check is useless.
6073
if revid1 and revid1 != revid2:
6074
# FIXME: We really want to use the same graph than
6075
# branch.iter_merge_sorted_revisions below, but this is not
6076
# easily available -- vila 2011-09-23
6077
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6078
# We don't want to output anything in this case...
6080
# only show revisions between revid1 and revid2 (inclusive)
6081
tagged_revids = branch.tags.get_reverse_tag_dict()
6083
for r in branch.iter_merge_sorted_revisions(
6084
start_revision_id=revid2, stop_revision_id=revid1,
6085
stop_rule='include'):
6086
revid_tags = tagged_revids.get(r[0], None)
6088
found.extend([(tag, r[0]) for tag in revid_tags])
6092
class cmd_reconfigure(Command):
6093
__doc__ = """Reconfigure the type of a bzr directory.
6095
A target configuration must be specified.
6097
For checkouts, the bind-to location will be auto-detected if not specified.
6098
The order of preference is
6099
1. For a lightweight checkout, the current bound location.
6100
2. For branches that used to be checkouts, the previously-bound location.
6101
3. The push location.
6102
4. The parent location.
6103
If none of these is available, --bind-to must be specified.
6106
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6107
takes_args = ['location?']
6109
RegistryOption.from_kwargs(
6112
help='The relation between branch and tree.',
6113
value_switches=True, enum_switch=False,
6114
branch='Reconfigure to be an unbound branch with no working tree.',
6115
tree='Reconfigure to be an unbound branch with a working tree.',
6116
checkout='Reconfigure to be a bound branch with a working tree.',
6117
lightweight_checkout='Reconfigure to be a lightweight'
6118
' checkout (with no local history).',
6120
RegistryOption.from_kwargs(
6122
title='Repository type',
6123
help='Location fo the repository.',
6124
value_switches=True, enum_switch=False,
6125
standalone='Reconfigure to be a standalone branch '
6126
'(i.e. stop using shared repository).',
6127
use_shared='Reconfigure to use a shared repository.',
6129
RegistryOption.from_kwargs(
6131
title='Trees in Repository',
6132
help='Whether new branches in the repository have trees.',
6133
value_switches=True, enum_switch=False,
6134
with_trees='Reconfigure repository to create '
6135
'working trees on branches by default.',
6136
with_no_trees='Reconfigure repository to not create '
6137
'working trees on branches by default.'
6139
Option('bind-to', help='Branch to bind checkout to.', type=str),
6141
help='Perform reconfiguration even if local changes'
6143
Option('stacked-on',
6144
help='Reconfigure a branch to be stacked on another branch.',
6148
help='Reconfigure a branch to be unstacked. This '
6149
'may require copying substantial data into it.',
6153
def run(self, location=None, bind_to=None, force=False,
6154
tree_type=None, repository_type=None, repository_trees=None,
6155
stacked_on=None, unstacked=None):
6156
directory = controldir.ControlDir.open(location)
6157
if stacked_on and unstacked:
6158
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6159
elif stacked_on is not None:
6160
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6162
reconfigure.ReconfigureUnstacked().apply(directory)
6163
# At the moment you can use --stacked-on and a different
6164
# reconfiguration shape at the same time; there seems no good reason
6166
if (tree_type is None and
6167
repository_type is None and
6168
repository_trees is None):
6169
if stacked_on or unstacked:
6172
raise errors.BzrCommandError(gettext('No target configuration '
6174
reconfiguration = None
6175
if tree_type == 'branch':
6176
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6177
elif tree_type == 'tree':
6178
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6179
elif tree_type == 'checkout':
6180
reconfiguration = reconfigure.Reconfigure.to_checkout(
6182
elif tree_type == 'lightweight-checkout':
6183
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6186
reconfiguration.apply(force)
6187
reconfiguration = None
6188
if repository_type == 'use-shared':
6189
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6190
elif repository_type == 'standalone':
6191
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6193
reconfiguration.apply(force)
6194
reconfiguration = None
6195
if repository_trees == 'with-trees':
6196
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6198
elif repository_trees == 'with-no-trees':
6199
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6202
reconfiguration.apply(force)
6203
reconfiguration = None
6206
class cmd_switch(Command):
6207
__doc__ = """Set the branch of a checkout and update.
6209
For lightweight checkouts, this changes the branch being referenced.
6210
For heavyweight checkouts, this checks that there are no local commits
6211
versus the current bound branch, then it makes the local branch a mirror
6212
of the new location and binds to it.
6214
In both cases, the working tree is updated and uncommitted changes
6215
are merged. The user can commit or revert these as they desire.
6217
Pending merges need to be committed or reverted before using switch.
6219
The path to the branch to switch to can be specified relative to the parent
6220
directory of the current branch. For example, if you are currently in a
6221
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6224
Bound branches use the nickname of its master branch unless it is set
6225
locally, in which case switching will update the local nickname to be
6229
takes_args = ['to_location?']
6230
takes_options = ['directory',
6232
help='Switch even if local commits will be lost.'),
6234
Option('create-branch', short_name='b',
6235
help='Create the target branch from this one before'
6236
' switching to it.'),
6239
def run(self, to_location=None, force=False, create_branch=False,
6240
revision=None, directory=u'.'):
6241
from bzrlib import switch
6242
tree_location = directory
6243
revision = _get_one_revision('switch', revision)
6244
possible_transports = []
6245
control_dir = controldir.ControlDir.open_containing(tree_location,
6246
possible_transports=possible_transports)[0]
6247
if to_location is None:
6248
if revision is None:
6249
raise errors.BzrCommandError(gettext('You must supply either a'
6250
' revision or a location'))
6251
to_location = tree_location
6253
branch = control_dir.open_branch(
6254
possible_transports=possible_transports)
6255
had_explicit_nick = branch.get_config().has_explicit_nickname()
6256
except errors.NotBranchError:
6258
had_explicit_nick = False
6261
raise errors.BzrCommandError(
6262
gettext('cannot create branch without source branch'))
6263
to_location = lookup_new_sibling_branch(control_dir, to_location,
6264
possible_transports=possible_transports)
6265
to_branch = branch.bzrdir.sprout(to_location,
6266
possible_transports=possible_transports,
6267
source_branch=branch).open_branch()
6270
to_branch = Branch.open(to_location,
6271
possible_transports=possible_transports)
6272
except errors.NotBranchError:
6273
to_branch = open_sibling_branch(control_dir, to_location,
6274
possible_transports=possible_transports)
6275
if revision is not None:
6276
revision = revision.as_revision_id(to_branch)
6277
switch.switch(control_dir, to_branch, force, revision_id=revision)
6278
if had_explicit_nick:
6279
branch = control_dir.open_branch() #get the new branch!
6280
branch.nick = to_branch.nick
6281
note(gettext('Switched to branch: %s'),
6282
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6286
class cmd_view(Command):
6287
__doc__ = """Manage filtered views.
6289
Views provide a mask over the tree so that users can focus on
6290
a subset of a tree when doing their work. After creating a view,
6291
commands that support a list of files - status, diff, commit, etc -
6292
effectively have that list of files implicitly given each time.
6293
An explicit list of files can still be given but those files
6294
must be within the current view.
6296
In most cases, a view has a short life-span: it is created to make
6297
a selected change and is deleted once that change is committed.
6298
At other times, you may wish to create one or more named views
6299
and switch between them.
6301
To disable the current view without deleting it, you can switch to
6302
the pseudo view called ``off``. This can be useful when you need
6303
to see the whole tree for an operation or two (e.g. merge) but
6304
want to switch back to your view after that.
6307
To define the current view::
6309
bzr view file1 dir1 ...
6311
To list the current view::
6315
To delete the current view::
6319
To disable the current view without deleting it::
6321
bzr view --switch off
6323
To define a named view and switch to it::
6325
bzr view --name view-name file1 dir1 ...
6327
To list a named view::
6329
bzr view --name view-name
6331
To delete a named view::
6333
bzr view --name view-name --delete
6335
To switch to a named view::
6337
bzr view --switch view-name
6339
To list all views defined::
6343
To delete all views::
6345
bzr view --delete --all
6349
takes_args = ['file*']
6352
help='Apply list or delete action to all views.',
6355
help='Delete the view.',
6358
help='Name of the view to define, list or delete.',
6362
help='Name of the view to switch to.',
6367
def run(self, file_list,
6373
tree, file_list = WorkingTree.open_containing_paths(file_list,
6375
current_view, view_dict = tree.views.get_view_info()
6380
raise errors.BzrCommandError(gettext(
6381
"Both --delete and a file list specified"))
6383
raise errors.BzrCommandError(gettext(
6384
"Both --delete and --switch specified"))
6386
tree.views.set_view_info(None, {})
6387
self.outf.write(gettext("Deleted all views.\n"))
6389
raise errors.BzrCommandError(gettext("No current view to delete"))
6391
tree.views.delete_view(name)
6392
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6395
raise errors.BzrCommandError(gettext(
6396
"Both --switch and a file list specified"))
6398
raise errors.BzrCommandError(gettext(
6399
"Both --switch and --all specified"))
6400
elif switch == 'off':
6401
if current_view is None:
6402
raise errors.BzrCommandError(gettext("No current view to disable"))
6403
tree.views.set_view_info(None, view_dict)
6404
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6406
tree.views.set_view_info(switch, view_dict)
6407
view_str = views.view_display_str(tree.views.lookup_view())
6408
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6411
self.outf.write(gettext('Views defined:\n'))
6412
for view in sorted(view_dict):
6413
if view == current_view:
6417
view_str = views.view_display_str(view_dict[view])
6418
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6420
self.outf.write(gettext('No views defined.\n'))
6423
# No name given and no current view set
6426
raise errors.BzrCommandError(gettext(
6427
"Cannot change the 'off' pseudo view"))
6428
tree.views.set_view(name, sorted(file_list))
6429
view_str = views.view_display_str(tree.views.lookup_view())
6430
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6434
# No name given and no current view set
6435
self.outf.write(gettext('No current view.\n'))
6437
view_str = views.view_display_str(tree.views.lookup_view(name))
6438
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6441
class cmd_hooks(Command):
6442
__doc__ = """Show hooks."""
6447
for hook_key in sorted(hooks.known_hooks.keys()):
6448
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6449
self.outf.write("%s:\n" % type(some_hooks).__name__)
6450
for hook_name, hook_point in sorted(some_hooks.items()):
6451
self.outf.write(" %s:\n" % (hook_name,))
6452
found_hooks = list(hook_point)
6454
for hook in found_hooks:
6455
self.outf.write(" %s\n" %
6456
(some_hooks.get_hook_name(hook),))
6458
self.outf.write(gettext(" <no hooks installed>\n"))
6461
class cmd_remove_branch(Command):
6462
__doc__ = """Remove a branch.
6464
This will remove the branch from the specified location but
6465
will keep any working tree or repository in place.
6469
Remove the branch at repo/trunk::
6471
bzr remove-branch repo/trunk
6475
takes_args = ["location?"]
6477
takes_options = ['directory',
6478
Option('force', help='Remove branch even if it is the active branch.')]
6480
aliases = ["rmbranch"]
6482
def run(self, directory=None, location=None, force=False):
6483
br = open_nearby_branch(near=directory, location=location)
6484
if not force and br.bzrdir.has_workingtree():
6486
active_branch = br.bzrdir.open_branch(name="")
6487
except errors.NotBranchError:
6488
active_branch = None
6489
if (active_branch is not None and
6490
br.control_url == active_branch.control_url):
6491
raise errors.BzrCommandError(
6492
gettext("Branch is active. Use --force to remove it."))
6493
br.bzrdir.destroy_branch(br.name)
6496
class cmd_shelve(Command):
6497
__doc__ = """Temporarily set aside some changes from the current tree.
6499
Shelve allows you to temporarily put changes you've made "on the shelf",
6500
ie. out of the way, until a later time when you can bring them back from
6501
the shelf with the 'unshelve' command. The changes are stored alongside
6502
your working tree, and so they aren't propagated along with your branch nor
6503
will they survive its deletion.
6505
If shelve --list is specified, previously-shelved changes are listed.
6507
Shelve is intended to help separate several sets of changes that have
6508
been inappropriately mingled. If you just want to get rid of all changes
6509
and you don't need to restore them later, use revert. If you want to
6510
shelve all text changes at once, use shelve --all.
6512
If filenames are specified, only the changes to those files will be
6513
shelved. Other files will be left untouched.
6515
If a revision is specified, changes since that revision will be shelved.
6517
You can put multiple items on the shelf, and by default, 'unshelve' will
6518
restore the most recently shelved changes.
6520
For complicated changes, it is possible to edit the changes in a separate
6521
editor program to decide what the file remaining in the working copy
6522
should look like. To do this, add the configuration option
6524
change_editor = PROGRAM @new_path @old_path
6526
where @new_path is replaced with the path of the new version of the
6527
file and @old_path is replaced with the path of the old version of
6528
the file. The PROGRAM should save the new file with the desired
6529
contents of the file in the working tree.
6533
takes_args = ['file*']
6538
Option('all', help='Shelve all changes.'),
6540
RegistryOption('writer', 'Method to use for writing diffs.',
6541
bzrlib.option.diff_writer_registry,
6542
value_switches=True, enum_switch=False),
6544
Option('list', help='List shelved changes.'),
6546
help='Destroy removed changes instead of shelving them.'),
6548
_see_also = ['unshelve', 'configuration']
6550
def run(self, revision=None, all=False, file_list=None, message=None,
6551
writer=None, list=False, destroy=False, directory=None):
6553
return self.run_for_list(directory=directory)
6554
from bzrlib.shelf_ui import Shelver
6556
writer = bzrlib.option.diff_writer_registry.get()
6558
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6559
file_list, message, destroy=destroy, directory=directory)
6564
except errors.UserAbort:
6567
def run_for_list(self, directory=None):
6568
if directory is None:
6570
tree = WorkingTree.open_containing(directory)[0]
6571
self.add_cleanup(tree.lock_read().unlock)
6572
manager = tree.get_shelf_manager()
6573
shelves = manager.active_shelves()
6574
if len(shelves) == 0:
6575
note(gettext('No shelved changes.'))
6577
for shelf_id in reversed(shelves):
6578
message = manager.get_metadata(shelf_id).get('message')
6580
message = '<no message>'
6581
self.outf.write('%3d: %s\n' % (shelf_id, message))
6585
class cmd_unshelve(Command):
6586
__doc__ = """Restore shelved changes.
6588
By default, the most recently shelved changes are restored. However if you
6589
specify a shelf by id those changes will be restored instead. This works
6590
best when the changes don't depend on each other.
6593
takes_args = ['shelf_id?']
6596
RegistryOption.from_kwargs(
6597
'action', help="The action to perform.",
6598
enum_switch=False, value_switches=True,
6599
apply="Apply changes and remove from the shelf.",
6600
dry_run="Show changes, but do not apply or remove them.",
6601
preview="Instead of unshelving the changes, show the diff that "
6602
"would result from unshelving.",
6603
delete_only="Delete changes without applying them.",
6604
keep="Apply changes but don't delete them.",
6607
_see_also = ['shelve']
6609
def run(self, shelf_id=None, action='apply', directory=u'.'):
6610
from bzrlib.shelf_ui import Unshelver
6611
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6615
unshelver.tree.unlock()
6618
class cmd_clean_tree(Command):
6619
__doc__ = """Remove unwanted files from working tree.
6621
By default, only unknown files, not ignored files, are deleted. Versioned
6622
files are never deleted.
6624
Another class is 'detritus', which includes files emitted by bzr during
6625
normal operations and selftests. (The value of these files decreases with
6628
If no options are specified, unknown files are deleted. Otherwise, option
6629
flags are respected, and may be combined.
6631
To check what clean-tree will do, use --dry-run.
6633
takes_options = ['directory',
6634
Option('ignored', help='Delete all ignored files.'),
6635
Option('detritus', help='Delete conflict files, merge and revert'
6636
' backups, and failed selftest dirs.'),
6638
help='Delete files unknown to bzr (default).'),
6639
Option('dry-run', help='Show files to delete instead of'
6641
Option('force', help='Do not prompt before deleting.')]
6642
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6643
force=False, directory=u'.'):
6644
from bzrlib.clean_tree import clean_tree
6645
if not (unknown or ignored or detritus):
6649
clean_tree(directory, unknown=unknown, ignored=ignored,
6650
detritus=detritus, dry_run=dry_run, no_prompt=force)
6653
class cmd_reference(Command):
6654
__doc__ = """list, view and set branch locations for nested trees.
6656
If no arguments are provided, lists the branch locations for nested trees.
6657
If one argument is provided, display the branch location for that tree.
6658
If two arguments are provided, set the branch location for that tree.
6663
takes_args = ['path?', 'location?']
6665
def run(self, path=None, location=None):
6667
if path is not None:
6669
tree, branch, relpath =(
6670
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6671
if path is not None:
6674
tree = branch.basis_tree()
6676
info = branch._get_all_reference_info().iteritems()
6677
self._display_reference_info(tree, branch, info)
6679
file_id = tree.path2id(path)
6681
raise errors.NotVersionedError(path)
6682
if location is None:
6683
info = [(file_id, branch.get_reference_info(file_id))]
6684
self._display_reference_info(tree, branch, info)
6686
branch.set_reference_info(file_id, path, location)
6688
def _display_reference_info(self, tree, branch, info):
6690
for file_id, (path, location) in info:
6692
path = tree.id2path(file_id)
6693
except errors.NoSuchId:
6695
ref_list.append((path, location))
6696
for path, location in sorted(ref_list):
6697
self.outf.write('%s %s\n' % (path, location))
6700
class cmd_export_pot(Command):
6701
__doc__ = """Export command helps and error messages in po format."""
6704
takes_options = [Option('plugin',
6705
help='Export help text from named command '\
6706
'(defaults to all built in commands).',
6708
Option('include-duplicates',
6709
help='Output multiple copies of the same msgid '
6710
'string if it appears more than once.'),
6713
def run(self, plugin=None, include_duplicates=False):
6714
from bzrlib.export_pot import export_pot
6715
export_pot(self.outf, plugin, include_duplicates)
6718
def _register_lazy_builtins():
6719
# register lazy builtins from other modules; called at startup and should
6720
# be only called once.
6721
for (name, aliases, module_name) in [
6722
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6723
('cmd_config', [], 'bzrlib.config'),
6724
('cmd_dpush', [], 'bzrlib.foreign'),
6725
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6726
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6727
('cmd_conflicts', [], 'bzrlib.conflicts'),
6728
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6729
('cmd_verify_signatures', [],
6730
'bzrlib.commit_signature_commands'),
6731
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6733
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
