1
# Copyright (C) 2005-2012 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
19
from __future__ import absolute_import
25
from bzrlib import lazy_import
26
lazy_import.lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
59
from bzrlib.branch import Branch
60
from bzrlib.conflicts import ConflictList
61
from bzrlib.transport import memory
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
63
from bzrlib.smtp_connection import SMTPConnection
64
from bzrlib.workingtree import WorkingTree
65
from bzrlib.i18n import gettext, ngettext
68
from bzrlib.commands import (
70
builtin_command_registry,
73
from bzrlib.option import (
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
86
def _get_branch_location(control_dir, possible_transports=None):
87
"""Return location of branch for this control dir."""
89
target = control_dir.get_branch_reference()
90
except errors.NotBranchError:
91
return control_dir.root_transport.base
92
if target is not None:
94
this_branch = control_dir.open_branch(
95
possible_transports=possible_transports)
96
# This may be a heavy checkout, where we want the master branch
97
master_location = this_branch.get_bound_location()
98
if master_location is not None:
99
return master_location
100
# If not, use a local sibling
101
return this_branch.base
104
def _is_colocated(control_dir, possible_transports=None):
105
"""Check if the branch in control_dir is colocated.
107
:param control_dir: Control directory
108
:return: Tuple with boolean indicating whether the branch is colocated
109
and the full URL to the actual branch
111
# This path is meant to be relative to the existing branch
112
this_url = _get_branch_location(control_dir,
113
possible_transports=possible_transports)
114
# Perhaps the target control dir supports colocated branches?
116
root = controldir.ControlDir.open(this_url,
117
possible_transports=possible_transports)
118
except errors.NotBranchError:
119
return (False, this_url)
122
wt = control_dir.open_workingtree()
123
except (errors.NoWorkingTree, errors.NotLocalUrl):
124
return (False, this_url)
127
root._format.colocated_branches and
128
control_dir.control_url == root.control_url,
132
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
133
"""Lookup the location for a new sibling branch.
135
:param control_dir: Control directory to find sibling branches from
136
:param location: Name of the new branch
137
:return: Full location to the new branch
139
location = directory_service.directories.dereference(location)
140
if '/' not in location and '\\' not in location:
141
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
144
return urlutils.join_segment_parameters(this_url,
145
{"branch": urlutils.escape(location)})
147
return urlutils.join(this_url, '..', urlutils.escape(location))
151
def open_sibling_branch(control_dir, location, possible_transports=None):
152
"""Open a branch, possibly a sibling of another.
154
:param control_dir: Control directory relative to which to lookup the
156
:param location: Location to look up
157
:return: branch to open
160
# Perhaps it's a colocated branch?
161
return control_dir.open_branch(location,
162
possible_transports=possible_transports)
163
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
164
this_url = _get_branch_location(control_dir)
167
this_url, '..', urlutils.escape(location)))
170
def open_nearby_branch(near=None, location=None, possible_transports=None):
171
"""Open a nearby branch.
173
:param near: Optional location of container from which to open branch
174
:param location: Location of the branch
175
:return: Branch instance
181
return Branch.open(location,
182
possible_transports=possible_transports)
183
except errors.NotBranchError:
185
cdir = controldir.ControlDir.open(near,
186
possible_transports=possible_transports)
187
return open_sibling_branch(cdir, location,
188
possible_transports=possible_transports)
191
def iter_sibling_branches(control_dir, possible_transports=None):
192
"""Iterate over the siblings of a branch.
194
:param control_dir: Control directory for which to look up the siblings
195
:return: Iterator over tuples with branch name and branch object
199
reference = control_dir.get_branch_reference()
200
except errors.NotBranchError:
201
# There is no active branch, just return the colocated branches.
202
for name, branch in control_dir.get_branches().iteritems():
205
if reference is not None:
206
ref_branch = Branch.open(reference,
207
possible_transports=possible_transports)
210
if ref_branch is None or ref_branch.name:
211
if ref_branch is not None:
212
control_dir = ref_branch.bzrdir
213
for name, branch in control_dir.get_branches().iteritems():
216
repo = ref_branch.bzrdir.find_repository()
217
for branch in repo.find_branches(using=True):
218
name = urlutils.relative_url(repo.user_url,
219
branch.user_url).rstrip("/")
223
def tree_files_for_add(file_list):
225
Return a tree and list of absolute paths from a file list.
227
Similar to tree_files, but add handles files a bit differently, so it a
228
custom implementation. In particular, MutableTreeTree.smart_add expects
229
absolute paths, which it immediately converts to relative paths.
231
# FIXME Would be nice to just return the relative paths like
232
# internal_tree_files does, but there are a large number of unit tests
233
# that assume the current interface to mutabletree.smart_add
235
tree, relpath = WorkingTree.open_containing(file_list[0])
236
if tree.supports_views():
237
view_files = tree.views.lookup_view()
239
for filename in file_list:
240
if not osutils.is_inside_any(view_files, filename):
241
raise errors.FileOutsideView(filename, view_files)
242
file_list = file_list[:]
243
file_list[0] = tree.abspath(relpath)
245
tree = WorkingTree.open_containing(u'.')[0]
246
if tree.supports_views():
247
view_files = tree.views.lookup_view()
249
file_list = view_files
250
view_str = views.view_display_str(view_files)
251
note(gettext("Ignoring files outside view. View is %s") % view_str)
252
return tree, file_list
255
def _get_one_revision(command_name, revisions):
256
if revisions is None:
258
if len(revisions) != 1:
259
raise errors.BzrCommandError(gettext(
260
'bzr %s --revision takes exactly one revision identifier') % (
265
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
266
"""Get a revision tree. Not suitable for commands that change the tree.
268
Specifically, the basis tree in dirstate trees is coupled to the dirstate
269
and doing a commit/uncommit/pull will at best fail due to changing the
272
If tree is passed in, it should be already locked, for lifetime management
273
of the trees internal cached state.
277
if revisions is None:
279
rev_tree = tree.basis_tree()
281
rev_tree = branch.basis_tree()
283
revision = _get_one_revision(command_name, revisions)
284
rev_tree = revision.as_tree(branch)
288
def _get_view_info_for_change_reporter(tree):
289
"""Get the view information from a tree for change reporting."""
292
current_view = tree.views.get_view_info()[0]
293
if current_view is not None:
294
view_info = (current_view, tree.views.lookup_view())
295
except errors.ViewsNotSupported:
300
def _open_directory_or_containing_tree_or_branch(filename, directory):
301
"""Open the tree or branch containing the specified file, unless
302
the --directory option is used to specify a different branch."""
303
if directory is not None:
304
return (None, Branch.open(directory), filename)
305
return controldir.ControlDir.open_containing_tree_or_branch(filename)
308
# TODO: Make sure no commands unconditionally use the working directory as a
309
# branch. If a filename argument is used, the first of them should be used to
310
# specify the branch. (Perhaps this can be factored out into some kind of
311
# Argument class, representing a file in a branch, where the first occurrence
314
class cmd_status(Command):
315
__doc__ = """Display status summary.
317
This reports on versioned and unknown files, reporting them
318
grouped by state. Possible states are:
321
Versioned in the working copy but not in the previous revision.
324
Versioned in the previous revision but removed or deleted
328
Path of this file changed from the previous revision;
329
the text may also have changed. This includes files whose
330
parent directory was renamed.
333
Text has changed since the previous revision.
336
File kind has been changed (e.g. from file to directory).
339
Not versioned and not matching an ignore pattern.
341
Additionally for directories, symlinks and files with a changed
342
executable bit, Bazaar indicates their type using a trailing
343
character: '/', '@' or '*' respectively. These decorations can be
344
disabled using the '--no-classify' option.
346
To see ignored files use 'bzr ignored'. For details on the
347
changes to file texts, use 'bzr diff'.
349
Note that --short or -S gives status flags for each item, similar
350
to Subversion's status command. To get output similar to svn -q,
353
If no arguments are specified, the status of the entire working
354
directory is shown. Otherwise, only the status of the specified
355
files or directories is reported. If a directory is given, status
356
is reported for everything inside that directory.
358
Before merges are committed, the pending merge tip revisions are
359
shown. To see all pending merge revisions, use the -v option.
360
To skip the display of pending merge information altogether, use
361
the no-pending option or specify a file/directory.
363
To compare the working directory to a specific revision, pass a
364
single revision to the revision argument.
366
To see which files have changed in a specific revision, or between
367
two revisions, pass a revision range to the revision argument.
368
This will produce the same results as calling 'bzr diff --summarize'.
371
# TODO: --no-recurse/-N, --recurse options
373
takes_args = ['file*']
374
takes_options = ['show-ids', 'revision', 'change', 'verbose',
375
Option('short', help='Use short status indicators.',
377
Option('versioned', help='Only show versioned files.',
379
Option('no-pending', help='Don\'t show pending merges.',
381
Option('no-classify',
382
help='Do not mark object type using indicator.',
385
aliases = ['st', 'stat']
387
encoding_type = 'replace'
388
_see_also = ['diff', 'revert', 'status-flags']
391
def run(self, show_ids=False, file_list=None, revision=None, short=False,
392
versioned=False, no_pending=False, verbose=False,
394
from bzrlib.status import show_tree_status
396
if revision and len(revision) > 2:
397
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
398
' one or two revision specifiers'))
400
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
401
# Avoid asking for specific files when that is not needed.
402
if relfile_list == ['']:
404
# Don't disable pending merges for full trees other than '.'.
405
if file_list == ['.']:
407
# A specific path within a tree was given.
408
elif relfile_list is not None:
410
show_tree_status(tree, show_ids=show_ids,
411
specific_files=relfile_list, revision=revision,
412
to_file=self.outf, short=short, versioned=versioned,
413
show_pending=(not no_pending), verbose=verbose,
414
classify=not no_classify)
417
class cmd_cat_revision(Command):
418
__doc__ = """Write out metadata for a revision.
420
The revision to print can either be specified by a specific
421
revision identifier, or you can use --revision.
425
takes_args = ['revision_id?']
426
takes_options = ['directory', 'revision']
427
# cat-revision is more for frontends so should be exact
430
def print_revision(self, revisions, revid):
431
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
432
record = stream.next()
433
if record.storage_kind == 'absent':
434
raise errors.NoSuchRevision(revisions, revid)
435
revtext = record.get_bytes_as('fulltext')
436
self.outf.write(revtext.decode('utf-8'))
439
def run(self, revision_id=None, revision=None, directory=u'.'):
440
if revision_id is not None and revision is not None:
441
raise errors.BzrCommandError(gettext('You can only supply one of'
442
' revision_id or --revision'))
443
if revision_id is None and revision is None:
444
raise errors.BzrCommandError(gettext('You must supply either'
445
' --revision or a revision_id'))
447
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
449
revisions = b.repository.revisions
450
if revisions is None:
451
raise errors.BzrCommandError(gettext('Repository %r does not support '
452
'access to raw revision texts'))
454
b.repository.lock_read()
456
# TODO: jam 20060112 should cat-revision always output utf-8?
457
if revision_id is not None:
458
revision_id = osutils.safe_revision_id(revision_id, warn=False)
460
self.print_revision(revisions, revision_id)
461
except errors.NoSuchRevision:
462
msg = gettext("The repository {0} contains no revision {1}.").format(
463
b.repository.base, revision_id)
464
raise errors.BzrCommandError(msg)
465
elif revision is not None:
468
raise errors.BzrCommandError(
469
gettext('You cannot specify a NULL revision.'))
470
rev_id = rev.as_revision_id(b)
471
self.print_revision(revisions, rev_id)
473
b.repository.unlock()
476
class cmd_dump_btree(Command):
477
__doc__ = """Dump the contents of a btree index file to stdout.
479
PATH is a btree index file, it can be any URL. This includes things like
480
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
482
By default, the tuples stored in the index file will be displayed. With
483
--raw, we will uncompress the pages, but otherwise display the raw bytes
487
# TODO: Do we want to dump the internal nodes as well?
488
# TODO: It would be nice to be able to dump the un-parsed information,
489
# rather than only going through iter_all_entries. However, this is
490
# good enough for a start
492
encoding_type = 'exact'
493
takes_args = ['path']
494
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
495
' rather than the parsed tuples.'),
498
def run(self, path, raw=False):
499
dirname, basename = osutils.split(path)
500
t = transport.get_transport(dirname)
502
self._dump_raw_bytes(t, basename)
504
self._dump_entries(t, basename)
506
def _get_index_and_bytes(self, trans, basename):
507
"""Create a BTreeGraphIndex and raw bytes."""
508
bt = btree_index.BTreeGraphIndex(trans, basename, None)
509
bytes = trans.get_bytes(basename)
510
bt._file = cStringIO.StringIO(bytes)
511
bt._size = len(bytes)
514
def _dump_raw_bytes(self, trans, basename):
517
# We need to parse at least the root node.
518
# This is because the first page of every row starts with an
519
# uncompressed header.
520
bt, bytes = self._get_index_and_bytes(trans, basename)
521
for page_idx, page_start in enumerate(xrange(0, len(bytes),
522
btree_index._PAGE_SIZE)):
523
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
524
page_bytes = bytes[page_start:page_end]
526
self.outf.write('Root node:\n')
527
header_end, data = bt._parse_header_from_bytes(page_bytes)
528
self.outf.write(page_bytes[:header_end])
530
self.outf.write('\nPage %d\n' % (page_idx,))
531
if len(page_bytes) == 0:
532
self.outf.write('(empty)\n');
534
decomp_bytes = zlib.decompress(page_bytes)
535
self.outf.write(decomp_bytes)
536
self.outf.write('\n')
538
def _dump_entries(self, trans, basename):
540
st = trans.stat(basename)
541
except errors.TransportNotPossible:
542
# We can't stat, so we'll fake it because we have to do the 'get()'
544
bt, _ = self._get_index_and_bytes(trans, basename)
546
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
547
for node in bt.iter_all_entries():
548
# Node is made up of:
549
# (index, key, value, [references])
553
refs_as_tuples = None
555
refs_as_tuples = static_tuple.as_tuples(refs)
556
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
557
self.outf.write('%s\n' % (as_tuple,))
560
class cmd_remove_tree(Command):
561
__doc__ = """Remove the working tree from a given branch/checkout.
563
Since a lightweight checkout is little more than a working tree
564
this will refuse to run against one.
566
To re-create the working tree, use "bzr checkout".
568
_see_also = ['checkout', 'working-trees']
569
takes_args = ['location*']
572
help='Remove the working tree even if it has '
573
'uncommitted or shelved changes.'),
576
def run(self, location_list, force=False):
577
if not location_list:
580
for location in location_list:
581
d = controldir.ControlDir.open(location)
584
working = d.open_workingtree()
585
except errors.NoWorkingTree:
586
raise errors.BzrCommandError(gettext("No working tree to remove"))
587
except errors.NotLocalUrl:
588
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
589
" of a remote path"))
591
if (working.has_changes()):
592
raise errors.UncommittedChanges(working)
593
if working.get_shelf_manager().last_shelf() is not None:
594
raise errors.ShelvedChanges(working)
596
if working.user_url != working.branch.user_url:
597
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
598
" from a lightweight checkout"))
600
d.destroy_workingtree()
603
class cmd_repair_workingtree(Command):
604
__doc__ = """Reset the working tree state file.
606
This is not meant to be used normally, but more as a way to recover from
607
filesystem corruption, etc. This rebuilds the working inventory back to a
608
'known good' state. Any new modifications (adding a file, renaming, etc)
609
will be lost, though modified files will still be detected as such.
611
Most users will want something more like "bzr revert" or "bzr update"
612
unless the state file has become corrupted.
614
By default this attempts to recover the current state by looking at the
615
headers of the state file. If the state file is too corrupted to even do
616
that, you can supply --revision to force the state of the tree.
619
takes_options = ['revision', 'directory',
621
help='Reset the tree even if it doesn\'t appear to be'
626
def run(self, revision=None, directory='.', force=False):
627
tree, _ = WorkingTree.open_containing(directory)
628
self.add_cleanup(tree.lock_tree_write().unlock)
632
except errors.BzrError:
633
pass # There seems to be a real error here, so we'll reset
636
raise errors.BzrCommandError(gettext(
637
'The tree does not appear to be corrupt. You probably'
638
' want "bzr revert" instead. Use "--force" if you are'
639
' sure you want to reset the working tree.'))
643
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
645
tree.reset_state(revision_ids)
646
except errors.BzrError, e:
647
if revision_ids is None:
648
extra = (gettext(', the header appears corrupt, try passing -r -1'
649
' to set the state to the last commit'))
652
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
655
class cmd_revno(Command):
656
__doc__ = """Show current revision number.
658
This is equal to the number of revisions on this branch.
662
takes_args = ['location?']
664
Option('tree', help='Show revno of working tree.'),
669
def run(self, tree=False, location=u'.', revision=None):
670
if revision is not None and tree:
671
raise errors.BzrCommandError(gettext("--tree and --revision can "
672
"not be used together"))
676
wt = WorkingTree.open_containing(location)[0]
677
self.add_cleanup(wt.lock_read().unlock)
678
except (errors.NoWorkingTree, errors.NotLocalUrl):
679
raise errors.NoWorkingTree(location)
681
revid = wt.last_revision()
683
b = Branch.open_containing(location)[0]
684
self.add_cleanup(b.lock_read().unlock)
686
if len(revision) != 1:
687
raise errors.BzrCommandError(gettext(
688
"Revision numbers only make sense for single "
689
"revisions, not ranges"))
690
revid = revision[0].as_revision_id(b)
692
revid = b.last_revision()
694
revno_t = b.revision_id_to_dotted_revno(revid)
695
except errors.NoSuchRevision:
697
revno = ".".join(str(n) for n in revno_t)
699
self.outf.write(revno + '\n')
702
class cmd_revision_info(Command):
703
__doc__ = """Show revision number and revision id for a given revision identifier.
706
takes_args = ['revision_info*']
709
custom_help('directory',
710
help='Branch to examine, '
711
'rather than the one containing the working directory.'),
712
Option('tree', help='Show revno of working tree.'),
716
def run(self, revision=None, directory=u'.', tree=False,
717
revision_info_list=[]):
720
wt = WorkingTree.open_containing(directory)[0]
722
self.add_cleanup(wt.lock_read().unlock)
723
except (errors.NoWorkingTree, errors.NotLocalUrl):
725
b = Branch.open_containing(directory)[0]
726
self.add_cleanup(b.lock_read().unlock)
728
if revision is not None:
729
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
730
if revision_info_list is not None:
731
for rev_str in revision_info_list:
732
rev_spec = RevisionSpec.from_string(rev_str)
733
revision_ids.append(rev_spec.as_revision_id(b))
734
# No arguments supplied, default to the last revision
735
if len(revision_ids) == 0:
738
raise errors.NoWorkingTree(directory)
739
revision_ids.append(wt.last_revision())
741
revision_ids.append(b.last_revision())
745
for revision_id in revision_ids:
747
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
748
revno = '.'.join(str(i) for i in dotted_revno)
749
except errors.NoSuchRevision:
751
maxlen = max(maxlen, len(revno))
752
revinfos.append([revno, revision_id])
756
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
759
class cmd_add(Command):
760
__doc__ = """Add specified files or directories.
762
In non-recursive mode, all the named items are added, regardless
763
of whether they were previously ignored. A warning is given if
764
any of the named files are already versioned.
766
In recursive mode (the default), files are treated the same way
767
but the behaviour for directories is different. Directories that
768
are already versioned do not give a warning. All directories,
769
whether already versioned or not, are searched for files or
770
subdirectories that are neither versioned or ignored, and these
771
are added. This search proceeds recursively into versioned
772
directories. If no names are given '.' is assumed.
774
A warning will be printed when nested trees are encountered,
775
unless they are explicitly ignored.
777
Therefore simply saying 'bzr add' will version all files that
778
are currently unknown.
780
Adding a file whose parent directory is not versioned will
781
implicitly add the parent, and so on up to the root. This means
782
you should never need to explicitly add a directory, they'll just
783
get added when you add a file in the directory.
785
--dry-run will show which files would be added, but not actually
788
--file-ids-from will try to use the file ids from the supplied path.
789
It looks up ids trying to find a matching parent directory with the
790
same filename, and then by pure path. This option is rarely needed
791
but can be useful when adding the same logical file into two
792
branches that will be merged later (without showing the two different
793
adds as a conflict). It is also useful when merging another project
794
into a subdirectory of this one.
796
Any files matching patterns in the ignore list will not be added
797
unless they are explicitly mentioned.
799
In recursive mode, files larger than the configuration option
800
add.maximum_file_size will be skipped. Named items are never skipped due
803
takes_args = ['file*']
806
help="Don't recursively add the contents of directories.",
809
help="Show what would be done, but don't actually do anything."),
811
Option('file-ids-from',
813
help='Lookup file ids from this tree.'),
815
encoding_type = 'replace'
816
_see_also = ['remove', 'ignore']
818
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
823
if file_ids_from is not None:
825
base_tree, base_path = WorkingTree.open_containing(
827
except errors.NoWorkingTree:
828
base_branch, base_path = Branch.open_containing(
830
base_tree = base_branch.basis_tree()
832
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
833
to_file=self.outf, should_print=(not is_quiet()))
835
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
836
should_print=(not is_quiet()))
839
self.add_cleanup(base_tree.lock_read().unlock)
840
tree, file_list = tree_files_for_add(file_list)
841
added, ignored = tree.smart_add(file_list, not
842
no_recurse, action=action, save=not dry_run)
846
for glob in sorted(ignored.keys()):
847
for path in ignored[glob]:
849
gettext("ignored {0} matching \"{1}\"\n").format(
853
class cmd_mkdir(Command):
854
__doc__ = """Create a new versioned directory.
856
This is equivalent to creating the directory and then adding it.
859
takes_args = ['dir+']
863
help='No error if existing, make parent directories as needed.',
867
encoding_type = 'replace'
870
def add_file_with_parents(cls, wt, relpath):
871
if wt.path2id(relpath) is not None:
873
cls.add_file_with_parents(wt, osutils.dirname(relpath))
877
def add_file_single(cls, wt, relpath):
880
def run(self, dir_list, parents=False):
882
add_file = self.add_file_with_parents
884
add_file = self.add_file_single
886
wt, relpath = WorkingTree.open_containing(dir)
891
if e.errno != errno.EEXIST:
895
add_file(wt, relpath)
897
self.outf.write(gettext('added %s\n') % dir)
900
class cmd_relpath(Command):
901
__doc__ = """Show path of a file relative to root"""
903
takes_args = ['filename']
907
def run(self, filename):
908
# TODO: jam 20050106 Can relpath return a munged path if
909
# sys.stdout encoding cannot represent it?
910
tree, relpath = WorkingTree.open_containing(filename)
911
self.outf.write(relpath)
912
self.outf.write('\n')
915
class cmd_inventory(Command):
916
__doc__ = """Show inventory of the current working copy or a revision.
918
It is possible to limit the output to a particular entry
919
type using the --kind option. For example: --kind file.
921
It is also possible to restrict the list of files to a specific
922
set. For example: bzr inventory --show-ids this/file
931
help='List entries of a particular kind: file, directory, symlink.',
934
takes_args = ['file*']
937
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
938
if kind and kind not in ['file', 'directory', 'symlink']:
939
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
941
revision = _get_one_revision('inventory', revision)
942
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
943
self.add_cleanup(work_tree.lock_read().unlock)
944
if revision is not None:
945
tree = revision.as_tree(work_tree.branch)
947
extra_trees = [work_tree]
948
self.add_cleanup(tree.lock_read().unlock)
953
self.add_cleanup(tree.lock_read().unlock)
954
if file_list is not None:
955
file_ids = tree.paths2ids(file_list, trees=extra_trees,
956
require_versioned=True)
957
# find_ids_across_trees may include some paths that don't
959
entries = tree.iter_entries_by_dir(specific_file_ids=file_ids)
961
entries = tree.iter_entries_by_dir()
963
for path, entry in sorted(entries):
964
if kind and kind != entry.kind:
969
self.outf.write('%-50s %s\n' % (path, entry.file_id))
971
self.outf.write(path)
972
self.outf.write('\n')
975
class cmd_mv(Command):
976
__doc__ = """Move or rename a file.
979
bzr mv OLDNAME NEWNAME
981
bzr mv SOURCE... DESTINATION
983
If the last argument is a versioned directory, all the other names
984
are moved into it. Otherwise, there must be exactly two arguments
985
and the file is changed to a new name.
987
If OLDNAME does not exist on the filesystem but is versioned and
988
NEWNAME does exist on the filesystem but is not versioned, mv
989
assumes that the file has been manually moved and only updates
990
its internal inventory to reflect that change.
991
The same is valid when moving many SOURCE files to a DESTINATION.
993
Files cannot be moved between branches.
996
takes_args = ['names*']
997
takes_options = [Option("after", help="Move only the bzr identifier"
998
" of the file, because the file has already been moved."),
999
Option('auto', help='Automatically guess renames.'),
1000
Option('dry-run', help='Avoid making changes when guessing renames.'),
1002
aliases = ['move', 'rename']
1003
encoding_type = 'replace'
1005
def run(self, names_list, after=False, auto=False, dry_run=False):
1007
return self.run_auto(names_list, after, dry_run)
1009
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1010
if names_list is None:
1012
if len(names_list) < 2:
1013
raise errors.BzrCommandError(gettext("missing file argument"))
1014
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1015
for file_name in rel_names[0:-1]:
1017
raise errors.BzrCommandError(gettext("can not move root of branch"))
1018
self.add_cleanup(tree.lock_tree_write().unlock)
1019
self._run(tree, names_list, rel_names, after)
1021
def run_auto(self, names_list, after, dry_run):
1022
if names_list is not None and len(names_list) > 1:
1023
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1026
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1028
work_tree, file_list = WorkingTree.open_containing_paths(
1029
names_list, default_directory='.')
1030
self.add_cleanup(work_tree.lock_tree_write().unlock)
1031
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1033
def _run(self, tree, names_list, rel_names, after):
1034
into_existing = osutils.isdir(names_list[-1])
1035
if into_existing and len(names_list) == 2:
1037
# a. case-insensitive filesystem and change case of dir
1038
# b. move directory after the fact (if the source used to be
1039
# a directory, but now doesn't exist in the working tree
1040
# and the target is an existing directory, just rename it)
1041
if (not tree.case_sensitive
1042
and rel_names[0].lower() == rel_names[1].lower()):
1043
into_existing = False
1045
# 'fix' the case of a potential 'from'
1046
from_id = tree.path2id(
1047
tree.get_canonical_inventory_path(rel_names[0]))
1048
if (not osutils.lexists(names_list[0]) and
1049
from_id and tree.stored_kind(from_id) == "directory"):
1050
into_existing = False
1053
# move into existing directory
1054
# All entries reference existing inventory items, so fix them up
1055
# for cicp file-systems.
1056
rel_names = tree.get_canonical_inventory_paths(rel_names)
1057
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1059
self.outf.write("%s => %s\n" % (src, dest))
1061
if len(names_list) != 2:
1062
raise errors.BzrCommandError(gettext('to mv multiple files the'
1063
' destination must be a versioned'
1066
# for cicp file-systems: the src references an existing inventory
1068
src = tree.get_canonical_inventory_path(rel_names[0])
1069
# Find the canonical version of the destination: In all cases, the
1070
# parent of the target must be in the inventory, so we fetch the
1071
# canonical version from there (we do not always *use* the
1072
# canonicalized tail portion - we may be attempting to rename the
1074
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1075
dest_parent = osutils.dirname(canon_dest)
1076
spec_tail = osutils.basename(rel_names[1])
1077
# For a CICP file-system, we need to avoid creating 2 inventory
1078
# entries that differ only by case. So regardless of the case
1079
# we *want* to use (ie, specified by the user or the file-system),
1080
# we must always choose to use the case of any existing inventory
1081
# items. The only exception to this is when we are attempting a
1082
# case-only rename (ie, canonical versions of src and dest are
1084
dest_id = tree.path2id(canon_dest)
1085
if dest_id is None or tree.path2id(src) == dest_id:
1086
# No existing item we care about, so work out what case we
1087
# are actually going to use.
1089
# If 'after' is specified, the tail must refer to a file on disk.
1091
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1093
# pathjoin with an empty tail adds a slash, which breaks
1095
dest_parent_fq = tree.basedir
1097
dest_tail = osutils.canonical_relpath(
1099
osutils.pathjoin(dest_parent_fq, spec_tail))
1101
# not 'after', so case as specified is used
1102
dest_tail = spec_tail
1104
# Use the existing item so 'mv' fails with AlreadyVersioned.
1105
dest_tail = os.path.basename(canon_dest)
1106
dest = osutils.pathjoin(dest_parent, dest_tail)
1107
mutter("attempting to move %s => %s", src, dest)
1108
tree.rename_one(src, dest, after=after)
1110
self.outf.write("%s => %s\n" % (src, dest))
1113
class cmd_pull(Command):
1114
__doc__ = """Turn this branch into a mirror of another branch.
1116
By default, this command only works on branches that have not diverged.
1117
Branches are considered diverged if the destination branch's most recent
1118
commit is one that has not been merged (directly or indirectly) into the
1121
If branches have diverged, you can use 'bzr merge' to integrate the changes
1122
from one into the other. Once one branch has merged, the other should
1123
be able to pull it again.
1125
If you want to replace your local changes and just want your branch to
1126
match the remote one, use pull --overwrite. This will work even if the two
1127
branches have diverged.
1129
If there is no default location set, the first pull will set it (use
1130
--no-remember to avoid setting it). After that, you can omit the
1131
location to use the default. To change the default, use --remember. The
1132
value will only be saved if the remote location can be accessed.
1134
The --verbose option will display the revisions pulled using the log_format
1135
configuration option. You can use a different format by overriding it with
1136
-Olog_format=<other_format>.
1138
Note: The location can be specified either in the form of a branch,
1139
or in the form of a path to a file containing a merge directive generated
1143
_see_also = ['push', 'update', 'status-flags', 'send']
1144
takes_options = ['remember', 'overwrite', 'revision',
1145
custom_help('verbose',
1146
help='Show logs of pulled revisions.'),
1147
custom_help('directory',
1148
help='Branch to pull into, '
1149
'rather than the one containing the working directory.'),
1151
help="Perform a local pull in a bound "
1152
"branch. Local pulls are not applied to "
1153
"the master branch."
1156
help="Show base revision text in conflicts."),
1157
Option('overwrite-tags',
1158
help="Overwrite tags only."),
1160
takes_args = ['location?']
1161
encoding_type = 'replace'
1163
def run(self, location=None, remember=None, overwrite=False,
1164
revision=None, verbose=False,
1165
directory=None, local=False,
1166
show_base=False, overwrite_tags=False):
1169
overwrite = ["history", "tags"]
1170
elif overwrite_tags:
1171
overwrite = ["tags"]
1174
# FIXME: too much stuff is in the command class
1177
if directory is None:
1180
tree_to = WorkingTree.open_containing(directory)[0]
1181
branch_to = tree_to.branch
1182
self.add_cleanup(tree_to.lock_write().unlock)
1183
except errors.NoWorkingTree:
1185
branch_to = Branch.open_containing(directory)[0]
1186
self.add_cleanup(branch_to.lock_write().unlock)
1188
warning(gettext("No working tree, ignoring --show-base"))
1190
if local and not branch_to.get_bound_location():
1191
raise errors.LocalRequiresBoundBranch()
1193
possible_transports = []
1194
if location is not None:
1196
mergeable = bundle.read_mergeable_from_url(location,
1197
possible_transports=possible_transports)
1198
except errors.NotABundle:
1201
stored_loc = branch_to.get_parent()
1202
if location is None:
1203
if stored_loc is None:
1204
raise errors.BzrCommandError(gettext("No pull location known or"
1207
display_url = urlutils.unescape_for_display(stored_loc,
1210
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1211
location = stored_loc
1213
revision = _get_one_revision('pull', revision)
1214
if mergeable is not None:
1215
if revision is not None:
1216
raise errors.BzrCommandError(gettext(
1217
'Cannot use -r with merge directives or bundles'))
1218
mergeable.install_revisions(branch_to.repository)
1219
base_revision_id, revision_id, verified = \
1220
mergeable.get_merge_request(branch_to.repository)
1221
branch_from = branch_to
1223
branch_from = Branch.open(location,
1224
possible_transports=possible_transports)
1225
self.add_cleanup(branch_from.lock_read().unlock)
1226
# Remembers if asked explicitly or no previous location is set
1228
or (remember is None and branch_to.get_parent() is None)):
1229
# FIXME: This shouldn't be done before the pull
1230
# succeeds... -- vila 2012-01-02
1231
branch_to.set_parent(branch_from.base)
1233
if revision is not None:
1234
revision_id = revision.as_revision_id(branch_from)
1236
if tree_to is not None:
1237
view_info = _get_view_info_for_change_reporter(tree_to)
1238
change_reporter = delta._ChangeReporter(
1239
unversioned_filter=tree_to.is_ignored,
1240
view_info=view_info)
1241
result = tree_to.pull(
1242
branch_from, overwrite, revision_id, change_reporter,
1243
local=local, show_base=show_base)
1245
result = branch_to.pull(
1246
branch_from, overwrite, revision_id, local=local)
1248
result.report(self.outf)
1249
if verbose and result.old_revid != result.new_revid:
1250
log.show_branch_change(
1251
branch_to, self.outf, result.old_revno,
1253
if getattr(result, 'tag_conflicts', None):
1259
class cmd_push(Command):
1260
__doc__ = """Update a mirror of this branch.
1262
The target branch will not have its working tree populated because this
1263
is both expensive, and is not supported on remote file systems.
1265
Some smart servers or protocols *may* put the working tree in place in
1268
This command only works on branches that have not diverged. Branches are
1269
considered diverged if the destination branch's most recent commit is one
1270
that has not been merged (directly or indirectly) by the source branch.
1272
If branches have diverged, you can use 'bzr push --overwrite' to replace
1273
the other branch completely, discarding its unmerged changes.
1275
If you want to ensure you have the different changes in the other branch,
1276
do a merge (see bzr help merge) from the other branch, and commit that.
1277
After that you will be able to do a push without '--overwrite'.
1279
If there is no default push location set, the first push will set it (use
1280
--no-remember to avoid setting it). After that, you can omit the
1281
location to use the default. To change the default, use --remember. The
1282
value will only be saved if the remote location can be accessed.
1284
The --verbose option will display the revisions pushed using the log_format
1285
configuration option. You can use a different format by overriding it with
1286
-Olog_format=<other_format>.
1289
_see_also = ['pull', 'update', 'working-trees']
1290
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1291
Option('create-prefix',
1292
help='Create the path leading up to the branch '
1293
'if it does not already exist.'),
1294
custom_help('directory',
1295
help='Branch to push from, '
1296
'rather than the one containing the working directory.'),
1297
Option('use-existing-dir',
1298
help='By default push will fail if the target'
1299
' directory exists, but does not already'
1300
' have a control directory. This flag will'
1301
' allow push to proceed.'),
1303
help='Create a stacked branch that references the public location '
1304
'of the parent branch.'),
1305
Option('stacked-on',
1306
help='Create a stacked branch that refers to another branch '
1307
'for the commit history. Only the work not present in the '
1308
'referenced branch is included in the branch created.',
1311
help='Refuse to push if there are uncommitted changes in'
1312
' the working tree, --no-strict disables the check.'),
1314
help="Don't populate the working tree, even for protocols"
1315
" that support it."),
1316
Option('overwrite-tags',
1317
help="Overwrite tags only."),
1319
takes_args = ['location?']
1320
encoding_type = 'replace'
1322
def run(self, location=None, remember=None, overwrite=False,
1323
create_prefix=False, verbose=False, revision=None,
1324
use_existing_dir=False, directory=None, stacked_on=None,
1325
stacked=False, strict=None, no_tree=False,
1326
overwrite_tags=False):
1327
from bzrlib.push import _show_push_branch
1330
overwrite = ["history", "tags"]
1331
elif overwrite_tags:
1332
overwrite = ["tags"]
1336
if directory is None:
1338
# Get the source branch
1340
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1341
# Get the tip's revision_id
1342
revision = _get_one_revision('push', revision)
1343
if revision is not None:
1344
revision_id = revision.in_history(br_from).rev_id
1347
if tree is not None and revision_id is None:
1348
tree.check_changed_or_out_of_date(
1349
strict, 'push_strict',
1350
more_error='Use --no-strict to force the push.',
1351
more_warning='Uncommitted changes will not be pushed.')
1352
# Get the stacked_on branch, if any
1353
if stacked_on is not None:
1354
stacked_on = urlutils.normalize_url(stacked_on)
1356
parent_url = br_from.get_parent()
1358
parent = Branch.open(parent_url)
1359
stacked_on = parent.get_public_branch()
1361
# I considered excluding non-http url's here, thus forcing
1362
# 'public' branches only, but that only works for some
1363
# users, so it's best to just depend on the user spotting an
1364
# error by the feedback given to them. RBC 20080227.
1365
stacked_on = parent_url
1367
raise errors.BzrCommandError(gettext(
1368
"Could not determine branch to refer to."))
1370
# Get the destination location
1371
if location is None:
1372
stored_loc = br_from.get_push_location()
1373
if stored_loc is None:
1374
parent_loc = br_from.get_parent()
1376
raise errors.BzrCommandError(gettext(
1377
"No push location known or specified. To push to the "
1378
"parent branch (at %s), use 'bzr push :parent'." %
1379
urlutils.unescape_for_display(parent_loc,
1380
self.outf.encoding)))
1382
raise errors.BzrCommandError(gettext(
1383
"No push location known or specified."))
1385
display_url = urlutils.unescape_for_display(stored_loc,
1387
note(gettext("Using saved push location: %s") % display_url)
1388
location = stored_loc
1390
_show_push_branch(br_from, revision_id, location, self.outf,
1391
verbose=verbose, overwrite=overwrite, remember=remember,
1392
stacked_on=stacked_on, create_prefix=create_prefix,
1393
use_existing_dir=use_existing_dir, no_tree=no_tree)
1396
class cmd_branch(Command):
1397
__doc__ = """Create a new branch that is a copy of an existing branch.
1399
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1400
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1401
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1402
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1403
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1406
To retrieve the branch as of a particular revision, supply the --revision
1407
parameter, as in "branch foo/bar -r 5".
1409
The synonyms 'clone' and 'get' for this command are deprecated.
1412
_see_also = ['checkout']
1413
takes_args = ['from_location', 'to_location?']
1414
takes_options = ['revision',
1415
Option('hardlink', help='Hard-link working tree files where possible.'),
1416
Option('files-from', type=str,
1417
help="Get file contents from this tree."),
1419
help="Create a branch without a working-tree."),
1421
help="Switch the checkout in the current directory "
1422
"to the new branch."),
1424
help='Create a stacked branch referring to the source branch. '
1425
'The new branch will depend on the availability of the source '
1426
'branch for all operations.'),
1427
Option('standalone',
1428
help='Do not use a shared repository, even if available.'),
1429
Option('use-existing-dir',
1430
help='By default branch will fail if the target'
1431
' directory exists, but does not already'
1432
' have a control directory. This flag will'
1433
' allow branch to proceed.'),
1435
help="Bind new branch to from location."),
1437
aliases = ['get', 'clone']
1439
def run(self, from_location, to_location=None, revision=None,
1440
hardlink=False, stacked=False, standalone=False, no_tree=False,
1441
use_existing_dir=False, switch=False, bind=False,
1443
from bzrlib import switch as _mod_switch
1444
from bzrlib.tag import _merge_tags_if_possible
1445
if self.invoked_as in ['get', 'clone']:
1446
ui.ui_factory.show_user_warning(
1447
'deprecated_command',
1448
deprecated_name=self.invoked_as,
1449
recommended_name='branch',
1450
deprecated_in_version='2.4')
1451
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1453
if not (hardlink or files_from):
1454
# accelerator_tree is usually slower because you have to read N
1455
# files (no readahead, lots of seeks, etc), but allow the user to
1456
# explicitly request it
1457
accelerator_tree = None
1458
if files_from is not None and files_from != from_location:
1459
accelerator_tree = WorkingTree.open(files_from)
1460
revision = _get_one_revision('branch', revision)
1461
self.add_cleanup(br_from.lock_read().unlock)
1462
if revision is not None:
1463
revision_id = revision.as_revision_id(br_from)
1465
# FIXME - wt.last_revision, fallback to branch, fall back to
1466
# None or perhaps NULL_REVISION to mean copy nothing
1468
revision_id = br_from.last_revision()
1469
if to_location is None:
1470
to_location = getattr(br_from, "name", None)
1472
to_location = urlutils.derive_to_location(from_location)
1473
to_transport = transport.get_transport(to_location)
1475
to_transport.mkdir('.')
1476
except errors.FileExists:
1478
to_dir = controldir.ControlDir.open_from_transport(
1480
except errors.NotBranchError:
1481
if not use_existing_dir:
1482
raise errors.BzrCommandError(gettext('Target directory "%s" '
1483
'already exists.') % to_location)
1488
to_dir.open_branch()
1489
except errors.NotBranchError:
1492
raise errors.AlreadyBranchError(to_location)
1493
except errors.NoSuchFile:
1494
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1500
# preserve whatever source format we have.
1501
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1502
possible_transports=[to_transport],
1503
accelerator_tree=accelerator_tree,
1504
hardlink=hardlink, stacked=stacked,
1505
force_new_repo=standalone,
1506
create_tree_if_local=not no_tree,
1507
source_branch=br_from)
1508
branch = to_dir.open_branch(
1509
possible_transports=[
1510
br_from.bzrdir.root_transport, to_transport])
1511
except errors.NoSuchRevision:
1512
to_transport.delete_tree('.')
1513
msg = gettext("The branch {0} has no revision {1}.").format(
1514
from_location, revision)
1515
raise errors.BzrCommandError(msg)
1518
to_repo = to_dir.open_repository()
1519
except errors.NoRepositoryPresent:
1520
to_repo = to_dir.create_repository()
1521
to_repo.fetch(br_from.repository, revision_id=revision_id)
1522
branch = br_from.sprout(to_dir, revision_id=revision_id)
1523
_merge_tags_if_possible(br_from, branch)
1524
# If the source branch is stacked, the new branch may
1525
# be stacked whether we asked for that explicitly or not.
1526
# We therefore need a try/except here and not just 'if stacked:'
1528
note(gettext('Created new stacked branch referring to %s.') %
1529
branch.get_stacked_on_url())
1530
except (errors.NotStacked, errors.UnstackableBranchFormat,
1531
errors.UnstackableRepositoryFormat), e:
1532
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1534
# Bind to the parent
1535
parent_branch = Branch.open(from_location)
1536
branch.bind(parent_branch)
1537
note(gettext('New branch bound to %s') % from_location)
1539
# Switch to the new branch
1540
wt, _ = WorkingTree.open_containing('.')
1541
_mod_switch.switch(wt.bzrdir, branch)
1542
note(gettext('Switched to branch: %s'),
1543
urlutils.unescape_for_display(branch.base, 'utf-8'))
1546
class cmd_branches(Command):
1547
__doc__ = """List the branches available at the current location.
1549
This command will print the names of all the branches at the current
1553
takes_args = ['location?']
1555
Option('recursive', short_name='R',
1556
help='Recursively scan for branches rather than '
1557
'just looking in the specified location.')]
1559
def run(self, location=".", recursive=False):
1561
t = transport.get_transport(location)
1562
if not t.listable():
1563
raise errors.BzrCommandError(
1564
"Can't scan this type of location.")
1565
for b in controldir.ControlDir.find_branches(t):
1566
self.outf.write("%s\n" % urlutils.unescape_for_display(
1567
urlutils.relative_url(t.base, b.base),
1568
self.outf.encoding).rstrip("/"))
1570
dir = controldir.ControlDir.open_containing(location)[0]
1572
active_branch = dir.open_branch(name="")
1573
except errors.NotBranchError:
1574
active_branch = None
1576
for name, branch in iter_sibling_branches(dir):
1579
active = (active_branch is not None and
1580
active_branch.base == branch.base)
1581
names[name] = active
1582
# Only mention the current branch explicitly if it's not
1583
# one of the colocated branches
1584
if not any(names.values()) and active_branch is not None:
1585
self.outf.write("* %s\n" % gettext("(default)"))
1586
for name in sorted(names.keys()):
1587
active = names[name]
1592
self.outf.write("%s %s\n" % (
1593
prefix, name.encode(self.outf.encoding)))
1596
class cmd_checkout(Command):
1597
__doc__ = """Create a new checkout of an existing branch.
1599
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1600
the branch found in '.'. This is useful if you have removed the working tree
1601
or if it was never created - i.e. if you pushed the branch to its current
1602
location using SFTP.
1604
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1605
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1606
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1607
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1608
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1611
To retrieve the branch as of a particular revision, supply the --revision
1612
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1613
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1617
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1618
takes_args = ['branch_location?', 'to_location?']
1619
takes_options = ['revision',
1620
Option('lightweight',
1621
help="Perform a lightweight checkout. Lightweight "
1622
"checkouts depend on access to the branch for "
1623
"every operation. Normal checkouts can perform "
1624
"common operations like diff and status without "
1625
"such access, and also support local commits."
1627
Option('files-from', type=str,
1628
help="Get file contents from this tree."),
1630
help='Hard-link working tree files where possible.'
1635
def run(self, branch_location=None, to_location=None, revision=None,
1636
lightweight=False, files_from=None, hardlink=False):
1637
if branch_location is None:
1638
branch_location = osutils.getcwd()
1639
to_location = branch_location
1640
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1642
if not (hardlink or files_from):
1643
# accelerator_tree is usually slower because you have to read N
1644
# files (no readahead, lots of seeks, etc), but allow the user to
1645
# explicitly request it
1646
accelerator_tree = None
1647
revision = _get_one_revision('checkout', revision)
1648
if files_from is not None and files_from != branch_location:
1649
accelerator_tree = WorkingTree.open(files_from)
1650
if revision is not None:
1651
revision_id = revision.as_revision_id(source)
1654
if to_location is None:
1655
to_location = urlutils.derive_to_location(branch_location)
1656
# if the source and to_location are the same,
1657
# and there is no working tree,
1658
# then reconstitute a branch
1659
if (osutils.abspath(to_location) ==
1660
osutils.abspath(branch_location)):
1662
source.bzrdir.open_workingtree()
1663
except errors.NoWorkingTree:
1664
source.bzrdir.create_workingtree(revision_id)
1666
source.create_checkout(to_location, revision_id, lightweight,
1667
accelerator_tree, hardlink)
1670
class cmd_renames(Command):
1671
__doc__ = """Show list of renamed files.
1673
# TODO: Option to show renames between two historical versions.
1675
# TODO: Only show renames under dir, rather than in the whole branch.
1676
_see_also = ['status']
1677
takes_args = ['dir?']
1680
def run(self, dir=u'.'):
1681
tree = WorkingTree.open_containing(dir)[0]
1682
self.add_cleanup(tree.lock_read().unlock)
1683
old_tree = tree.basis_tree()
1684
self.add_cleanup(old_tree.lock_read().unlock)
1686
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1687
for f, paths, c, v, p, n, k, e in iterator:
1688
if paths[0] == paths[1]:
1692
renames.append(paths)
1694
for old_name, new_name in renames:
1695
self.outf.write("%s => %s\n" % (old_name, new_name))
1698
class cmd_update(Command):
1699
__doc__ = """Update a working tree to a new revision.
1701
This will perform a merge of the destination revision (the tip of the
1702
branch, or the specified revision) into the working tree, and then make
1703
that revision the basis revision for the working tree.
1705
You can use this to visit an older revision, or to update a working tree
1706
that is out of date from its branch.
1708
If there are any uncommitted changes in the tree, they will be carried
1709
across and remain as uncommitted changes after the update. To discard
1710
these changes, use 'bzr revert'. The uncommitted changes may conflict
1711
with the changes brought in by the change in basis revision.
1713
If the tree's branch is bound to a master branch, bzr will also update
1714
the branch from the master.
1716
You cannot update just a single file or directory, because each Bazaar
1717
working tree has just a single basis revision. If you want to restore a
1718
file that has been removed locally, use 'bzr revert' instead of 'bzr
1719
update'. If you want to restore a file to its state in a previous
1720
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1721
out the old content of that file to a new location.
1723
The 'dir' argument, if given, must be the location of the root of a
1724
working tree to update. By default, the working tree that contains the
1725
current working directory is used.
1728
_see_also = ['pull', 'working-trees', 'status-flags']
1729
takes_args = ['dir?']
1730
takes_options = ['revision',
1732
help="Show base revision text in conflicts."),
1736
def run(self, dir=None, revision=None, show_base=None):
1737
if revision is not None and len(revision) != 1:
1738
raise errors.BzrCommandError(gettext(
1739
"bzr update --revision takes exactly one revision"))
1741
tree = WorkingTree.open_containing('.')[0]
1743
tree, relpath = WorkingTree.open_containing(dir)
1746
raise errors.BzrCommandError(gettext(
1747
"bzr update can only update a whole tree, "
1748
"not a file or subdirectory"))
1749
branch = tree.branch
1750
possible_transports = []
1751
master = branch.get_master_branch(
1752
possible_transports=possible_transports)
1753
if master is not None:
1754
branch_location = master.base
1757
branch_location = tree.branch.base
1758
tree.lock_tree_write()
1759
self.add_cleanup(tree.unlock)
1760
# get rid of the final '/' and be ready for display
1761
branch_location = urlutils.unescape_for_display(
1762
branch_location.rstrip('/'),
1764
existing_pending_merges = tree.get_parent_ids()[1:]
1768
# may need to fetch data into a heavyweight checkout
1769
# XXX: this may take some time, maybe we should display a
1771
old_tip = branch.update(possible_transports)
1772
if revision is not None:
1773
revision_id = revision[0].as_revision_id(branch)
1775
revision_id = branch.last_revision()
1776
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1777
revno = branch.revision_id_to_dotted_revno(revision_id)
1778
note(gettext("Tree is up to date at revision {0} of branch {1}"
1779
).format('.'.join(map(str, revno)), branch_location))
1781
view_info = _get_view_info_for_change_reporter(tree)
1782
change_reporter = delta._ChangeReporter(
1783
unversioned_filter=tree.is_ignored,
1784
view_info=view_info)
1786
conflicts = tree.update(
1788
possible_transports=possible_transports,
1789
revision=revision_id,
1791
show_base=show_base)
1792
except errors.NoSuchRevision, e:
1793
raise errors.BzrCommandError(gettext(
1794
"branch has no revision %s\n"
1795
"bzr update --revision only works"
1796
" for a revision in the branch history")
1798
revno = tree.branch.revision_id_to_dotted_revno(
1799
_mod_revision.ensure_null(tree.last_revision()))
1800
note(gettext('Updated to revision {0} of branch {1}').format(
1801
'.'.join(map(str, revno)), branch_location))
1802
parent_ids = tree.get_parent_ids()
1803
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1804
note(gettext('Your local commits will now show as pending merges with '
1805
"'bzr status', and can be committed with 'bzr commit'."))
1812
class cmd_info(Command):
1813
__doc__ = """Show information about a working tree, branch or repository.
1815
This command will show all known locations and formats associated to the
1816
tree, branch or repository.
1818
In verbose mode, statistical information is included with each report.
1819
To see extended statistic information, use a verbosity level of 2 or
1820
higher by specifying the verbose option multiple times, e.g. -vv.
1822
Branches and working trees will also report any missing revisions.
1826
Display information on the format and related locations:
1830
Display the above together with extended format information and
1831
basic statistics (like the number of files in the working tree and
1832
number of revisions in the branch and repository):
1836
Display the above together with number of committers to the branch:
1840
_see_also = ['revno', 'working-trees', 'repositories']
1841
takes_args = ['location?']
1842
takes_options = ['verbose']
1843
encoding_type = 'replace'
1846
def run(self, location=None, verbose=False):
1848
noise_level = get_verbosity_level()
1851
from bzrlib.info import show_bzrdir_info
1852
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1853
verbose=noise_level, outfile=self.outf)
1856
class cmd_remove(Command):
1857
__doc__ = """Remove files or directories.
1859
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1860
delete them if they can easily be recovered using revert otherwise they
1861
will be backed up (adding an extension of the form .~#~). If no options or
1862
parameters are given Bazaar will scan for files that are being tracked by
1863
Bazaar but missing in your tree and stop tracking them for you.
1865
takes_args = ['file*']
1866
takes_options = ['verbose',
1867
Option('new', help='Only remove files that have never been committed.'),
1868
RegistryOption.from_kwargs('file-deletion-strategy',
1869
'The file deletion mode to be used.',
1870
title='Deletion Strategy', value_switches=True, enum_switch=False,
1871
safe='Backup changed files (default).',
1872
keep='Delete from bzr but leave the working copy.',
1873
no_backup='Don\'t backup changed files.'),
1875
aliases = ['rm', 'del']
1876
encoding_type = 'replace'
1878
def run(self, file_list, verbose=False, new=False,
1879
file_deletion_strategy='safe'):
1881
tree, file_list = WorkingTree.open_containing_paths(file_list)
1883
if file_list is not None:
1884
file_list = [f for f in file_list]
1886
self.add_cleanup(tree.lock_write().unlock)
1887
# Heuristics should probably all move into tree.remove_smart or
1890
added = tree.changes_from(tree.basis_tree(),
1891
specific_files=file_list).added
1892
file_list = sorted([f[0] for f in added], reverse=True)
1893
if len(file_list) == 0:
1894
raise errors.BzrCommandError(gettext('No matching files.'))
1895
elif file_list is None:
1896
# missing files show up in iter_changes(basis) as
1897
# versioned-with-no-kind.
1899
for change in tree.iter_changes(tree.basis_tree()):
1900
# Find paths in the working tree that have no kind:
1901
if change[1][1] is not None and change[6][1] is None:
1902
missing.append(change[1][1])
1903
file_list = sorted(missing, reverse=True)
1904
file_deletion_strategy = 'keep'
1905
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1906
keep_files=file_deletion_strategy=='keep',
1907
force=(file_deletion_strategy=='no-backup'))
1910
class cmd_file_id(Command):
1911
__doc__ = """Print file_id of a particular file or directory.
1913
The file_id is assigned when the file is first added and remains the
1914
same through all revisions where the file exists, even when it is
1919
_see_also = ['inventory', 'ls']
1920
takes_args = ['filename']
1923
def run(self, filename):
1924
tree, relpath = WorkingTree.open_containing(filename)
1925
i = tree.path2id(relpath)
1927
raise errors.NotVersionedError(filename)
1929
self.outf.write(i + '\n')
1932
class cmd_file_path(Command):
1933
__doc__ = """Print path of file_ids to a file or directory.
1935
This prints one line for each directory down to the target,
1936
starting at the branch root.
1940
takes_args = ['filename']
1943
def run(self, filename):
1944
tree, relpath = WorkingTree.open_containing(filename)
1945
fid = tree.path2id(relpath)
1947
raise errors.NotVersionedError(filename)
1948
segments = osutils.splitpath(relpath)
1949
for pos in range(1, len(segments) + 1):
1950
path = osutils.joinpath(segments[:pos])
1951
self.outf.write("%s\n" % tree.path2id(path))
1954
class cmd_reconcile(Command):
1955
__doc__ = """Reconcile bzr metadata in a branch.
1957
This can correct data mismatches that may have been caused by
1958
previous ghost operations or bzr upgrades. You should only
1959
need to run this command if 'bzr check' or a bzr developer
1960
advises you to run it.
1962
If a second branch is provided, cross-branch reconciliation is
1963
also attempted, which will check that data like the tree root
1964
id which was not present in very early bzr versions is represented
1965
correctly in both branches.
1967
At the same time it is run it may recompress data resulting in
1968
a potential saving in disk space or performance gain.
1970
The branch *MUST* be on a listable system such as local disk or sftp.
1973
_see_also = ['check']
1974
takes_args = ['branch?']
1976
Option('canonicalize-chks',
1977
help='Make sure CHKs are in canonical form (repairs '
1982
def run(self, branch=".", canonicalize_chks=False):
1983
from bzrlib.reconcile import reconcile
1984
dir = controldir.ControlDir.open(branch)
1985
reconcile(dir, canonicalize_chks=canonicalize_chks)
1988
class cmd_revision_history(Command):
1989
__doc__ = """Display the list of revision ids on a branch."""
1992
takes_args = ['location?']
1997
def run(self, location="."):
1998
branch = Branch.open_containing(location)[0]
1999
self.add_cleanup(branch.lock_read().unlock)
2000
graph = branch.repository.get_graph()
2001
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
2002
[_mod_revision.NULL_REVISION]))
2003
for revid in reversed(history):
2004
self.outf.write(revid)
2005
self.outf.write('\n')
2008
class cmd_ancestry(Command):
2009
__doc__ = """List all revisions merged into this branch."""
2011
_see_also = ['log', 'revision-history']
2012
takes_args = ['location?']
2017
def run(self, location="."):
2019
wt = WorkingTree.open_containing(location)[0]
2020
except errors.NoWorkingTree:
2021
b = Branch.open(location)
2022
last_revision = b.last_revision()
2025
last_revision = wt.last_revision()
2027
self.add_cleanup(b.repository.lock_read().unlock)
2028
graph = b.repository.get_graph()
2029
revisions = [revid for revid, parents in
2030
graph.iter_ancestry([last_revision])]
2031
for revision_id in reversed(revisions):
2032
if _mod_revision.is_null(revision_id):
2034
self.outf.write(revision_id + '\n')
2037
class cmd_init(Command):
2038
__doc__ = """Make a directory into a versioned branch.
2040
Use this to create an empty branch, or before importing an
2043
If there is a repository in a parent directory of the location, then
2044
the history of the branch will be stored in the repository. Otherwise
2045
init creates a standalone branch which carries its own history
2046
in the .bzr directory.
2048
If there is already a branch at the location but it has no working tree,
2049
the tree can be populated with 'bzr checkout'.
2051
Recipe for importing a tree of files::
2057
bzr commit -m "imported project"
2060
_see_also = ['init-repository', 'branch', 'checkout']
2061
takes_args = ['location?']
2063
Option('create-prefix',
2064
help='Create the path leading up to the branch '
2065
'if it does not already exist.'),
2066
RegistryOption('format',
2067
help='Specify a format for this branch. '
2068
'See "help formats".',
2069
lazy_registry=('bzrlib.controldir', 'format_registry'),
2070
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2071
value_switches=True,
2072
title="Branch format",
2074
Option('append-revisions-only',
2075
help='Never change revnos or the existing log.'
2076
' Append revisions to it only.'),
2078
'Create a branch without a working tree.')
2080
def run(self, location=None, format=None, append_revisions_only=False,
2081
create_prefix=False, no_tree=False):
2083
format = controldir.format_registry.make_bzrdir('default')
2084
if location is None:
2087
to_transport = transport.get_transport(location)
2089
# The path has to exist to initialize a
2090
# branch inside of it.
2091
# Just using os.mkdir, since I don't
2092
# believe that we want to create a bunch of
2093
# locations if the user supplies an extended path
2095
to_transport.ensure_base()
2096
except errors.NoSuchFile:
2097
if not create_prefix:
2098
raise errors.BzrCommandError(gettext("Parent directory of %s"
2100
"\nYou may supply --create-prefix to create all"
2101
" leading parent directories.")
2103
to_transport.create_prefix()
2106
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
2107
except errors.NotBranchError:
2108
# really a NotBzrDir error...
2109
create_branch = controldir.ControlDir.create_branch_convenience
2111
force_new_tree = False
2113
force_new_tree = None
2114
branch = create_branch(to_transport.base, format=format,
2115
possible_transports=[to_transport],
2116
force_new_tree=force_new_tree)
2117
a_bzrdir = branch.bzrdir
2119
from bzrlib.transport.local import LocalTransport
2120
if a_bzrdir.has_branch():
2121
if (isinstance(to_transport, LocalTransport)
2122
and not a_bzrdir.has_workingtree()):
2123
raise errors.BranchExistsWithoutWorkingTree(location)
2124
raise errors.AlreadyBranchError(location)
2125
branch = a_bzrdir.create_branch()
2126
if not no_tree and not a_bzrdir.has_workingtree():
2127
a_bzrdir.create_workingtree()
2128
if append_revisions_only:
2130
branch.set_append_revisions_only(True)
2131
except errors.UpgradeRequired:
2132
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2133
' to append-revisions-only. Try --default.'))
2135
from bzrlib.info import describe_layout, describe_format
2137
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2138
except (errors.NoWorkingTree, errors.NotLocalUrl):
2140
repository = branch.repository
2141
layout = describe_layout(repository, branch, tree).lower()
2142
format = describe_format(a_bzrdir, repository, branch, tree)
2143
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2145
if repository.is_shared():
2146
#XXX: maybe this can be refactored into transport.path_or_url()
2147
url = repository.bzrdir.root_transport.external_url()
2149
url = urlutils.local_path_from_url(url)
2150
except errors.InvalidURL:
2152
self.outf.write(gettext("Using shared repository: %s\n") % url)
2155
class cmd_init_repository(Command):
2156
__doc__ = """Create a shared repository for branches to share storage space.
2158
New branches created under the repository directory will store their
2159
revisions in the repository, not in the branch directory. For branches
2160
with shared history, this reduces the amount of storage needed and
2161
speeds up the creation of new branches.
2163
If the --no-trees option is given then the branches in the repository
2164
will not have working trees by default. They will still exist as
2165
directories on disk, but they will not have separate copies of the
2166
files at a certain revision. This can be useful for repositories that
2167
store branches which are interacted with through checkouts or remote
2168
branches, such as on a server.
2171
Create a shared repository holding just branches::
2173
bzr init-repo --no-trees repo
2176
Make a lightweight checkout elsewhere::
2178
bzr checkout --lightweight repo/trunk trunk-checkout
2183
_see_also = ['init', 'branch', 'checkout', 'repositories']
2184
takes_args = ["location"]
2185
takes_options = [RegistryOption('format',
2186
help='Specify a format for this repository. See'
2187
' "bzr help formats" for details.',
2188
lazy_registry=('bzrlib.controldir', 'format_registry'),
2189
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2190
value_switches=True, title='Repository format'),
2192
help='Branches in the repository will default to'
2193
' not having a working tree.'),
2195
aliases = ["init-repo"]
2197
def run(self, location, format=None, no_trees=False):
2199
format = controldir.format_registry.make_bzrdir('default')
2201
if location is None:
2204
to_transport = transport.get_transport(location)
2206
(repo, newdir, require_stacking, repository_policy) = (
2207
format.initialize_on_transport_ex(to_transport,
2208
create_prefix=True, make_working_trees=not no_trees,
2209
shared_repo=True, force_new_repo=True,
2210
use_existing_dir=True,
2211
repo_format_name=format.repository_format.get_format_string()))
2213
from bzrlib.info import show_bzrdir_info
2214
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2217
class cmd_diff(Command):
2218
__doc__ = """Show differences in the working tree, between revisions or branches.
2220
If no arguments are given, all changes for the current tree are listed.
2221
If files are given, only the changes in those files are listed.
2222
Remote and multiple branches can be compared by using the --old and
2223
--new options. If not provided, the default for both is derived from
2224
the first argument, if any, or the current tree if no arguments are
2227
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2228
produces patches suitable for "patch -p1".
2230
Note that when using the -r argument with a range of revisions, the
2231
differences are computed between the two specified revisions. That
2232
is, the command does not show the changes introduced by the first
2233
revision in the range. This differs from the interpretation of
2234
revision ranges used by "bzr log" which includes the first revision
2239
2 - unrepresentable changes
2244
Shows the difference in the working tree versus the last commit::
2248
Difference between the working tree and revision 1::
2252
Difference between revision 3 and revision 1::
2256
Difference between revision 3 and revision 1 for branch xxx::
2260
The changes introduced by revision 2 (equivalent to -r1..2)::
2264
To see the changes introduced by revision X::
2268
Note that in the case of a merge, the -c option shows the changes
2269
compared to the left hand parent. To see the changes against
2270
another parent, use::
2272
bzr diff -r<chosen_parent>..X
2274
The changes between the current revision and the previous revision
2275
(equivalent to -c-1 and -r-2..-1)
2279
Show just the differences for file NEWS::
2283
Show the differences in working tree xxx for file NEWS::
2287
Show the differences from branch xxx to this working tree:
2291
Show the differences between two branches for file NEWS::
2293
bzr diff --old xxx --new yyy NEWS
2295
Same as 'bzr diff' but prefix paths with old/ and new/::
2297
bzr diff --prefix old/:new/
2299
Show the differences using a custom diff program with options::
2301
bzr diff --using /usr/bin/diff --diff-options -wu
2303
_see_also = ['status']
2304
takes_args = ['file*']
2306
Option('diff-options', type=str,
2307
help='Pass these options to the external diff program.'),
2308
Option('prefix', type=str,
2310
help='Set prefixes added to old and new filenames, as '
2311
'two values separated by a colon. (eg "old/:new/").'),
2313
help='Branch/tree to compare from.',
2317
help='Branch/tree to compare to.',
2323
help='Use this command to compare files.',
2326
RegistryOption('format',
2328
help='Diff format to use.',
2329
lazy_registry=('bzrlib.diff', 'format_registry'),
2330
title='Diff format'),
2332
help='How many lines of context to show.',
2336
aliases = ['di', 'dif']
2337
encoding_type = 'exact'
2340
def run(self, revision=None, file_list=None, diff_options=None,
2341
prefix=None, old=None, new=None, using=None, format=None,
2343
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2346
if (prefix is None) or (prefix == '0'):
2354
old_label, new_label = prefix.split(":")
2356
raise errors.BzrCommandError(gettext(
2357
'--prefix expects two values separated by a colon'
2358
' (eg "old/:new/")'))
2360
if revision and len(revision) > 2:
2361
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2362
' one or two revision specifiers'))
2364
if using is not None and format is not None:
2365
raise errors.BzrCommandError(gettext(
2366
'{0} and {1} are mutually exclusive').format(
2367
'--using', '--format'))
2369
(old_tree, new_tree,
2370
old_branch, new_branch,
2371
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2372
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2373
# GNU diff on Windows uses ANSI encoding for filenames
2374
path_encoding = osutils.get_diff_header_encoding()
2375
return show_diff_trees(old_tree, new_tree, sys.stdout,
2376
specific_files=specific_files,
2377
external_diff_options=diff_options,
2378
old_label=old_label, new_label=new_label,
2379
extra_trees=extra_trees,
2380
path_encoding=path_encoding,
2381
using=using, context=context,
2385
class cmd_deleted(Command):
2386
__doc__ = """List files deleted in the working tree.
2388
# TODO: Show files deleted since a previous revision, or
2389
# between two revisions.
2390
# TODO: Much more efficient way to do this: read in new
2391
# directories with readdir, rather than stating each one. Same
2392
# level of effort but possibly much less IO. (Or possibly not,
2393
# if the directories are very large...)
2394
_see_also = ['status', 'ls']
2395
takes_options = ['directory', 'show-ids']
2398
def run(self, show_ids=False, directory=u'.'):
2399
tree = WorkingTree.open_containing(directory)[0]
2400
self.add_cleanup(tree.lock_read().unlock)
2401
old = tree.basis_tree()
2402
self.add_cleanup(old.lock_read().unlock)
2403
for path, ie in old.iter_entries_by_dir():
2404
if not tree.has_id(ie.file_id):
2405
self.outf.write(path)
2407
self.outf.write(' ')
2408
self.outf.write(ie.file_id)
2409
self.outf.write('\n')
2412
class cmd_modified(Command):
2413
__doc__ = """List files modified in working tree.
2417
_see_also = ['status', 'ls']
2418
takes_options = ['directory', 'null']
2421
def run(self, null=False, directory=u'.'):
2422
tree = WorkingTree.open_containing(directory)[0]
2423
self.add_cleanup(tree.lock_read().unlock)
2424
td = tree.changes_from(tree.basis_tree())
2426
for path, id, kind, text_modified, meta_modified in td.modified:
2428
self.outf.write(path + '\0')
2430
self.outf.write(osutils.quotefn(path) + '\n')
2433
class cmd_added(Command):
2434
__doc__ = """List files added in working tree.
2438
_see_also = ['status', 'ls']
2439
takes_options = ['directory', 'null']
2442
def run(self, null=False, directory=u'.'):
2443
wt = WorkingTree.open_containing(directory)[0]
2444
self.add_cleanup(wt.lock_read().unlock)
2445
basis = wt.basis_tree()
2446
self.add_cleanup(basis.lock_read().unlock)
2447
root_id = wt.get_root_id()
2448
for file_id in wt.all_file_ids():
2449
if basis.has_id(file_id):
2451
if root_id == file_id:
2453
path = wt.id2path(file_id)
2454
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2457
self.outf.write(path + '\0')
2459
self.outf.write(osutils.quotefn(path) + '\n')
2462
class cmd_root(Command):
2463
__doc__ = """Show the tree root directory.
2465
The root is the nearest enclosing directory with a .bzr control
2468
takes_args = ['filename?']
2470
def run(self, filename=None):
2471
"""Print the branch root."""
2472
tree = WorkingTree.open_containing(filename)[0]
2473
self.outf.write(tree.basedir + '\n')
2476
def _parse_limit(limitstring):
2478
return int(limitstring)
2480
msg = gettext("The limit argument must be an integer.")
2481
raise errors.BzrCommandError(msg)
2484
def _parse_levels(s):
2488
msg = gettext("The levels argument must be an integer.")
2489
raise errors.BzrCommandError(msg)
2492
class cmd_log(Command):
2493
__doc__ = """Show historical log for a branch or subset of a branch.
2495
log is bzr's default tool for exploring the history of a branch.
2496
The branch to use is taken from the first parameter. If no parameters
2497
are given, the branch containing the working directory is logged.
2498
Here are some simple examples::
2500
bzr log log the current branch
2501
bzr log foo.py log a file in its branch
2502
bzr log http://server/branch log a branch on a server
2504
The filtering, ordering and information shown for each revision can
2505
be controlled as explained below. By default, all revisions are
2506
shown sorted (topologically) so that newer revisions appear before
2507
older ones and descendants always appear before ancestors. If displayed,
2508
merged revisions are shown indented under the revision in which they
2513
The log format controls how information about each revision is
2514
displayed. The standard log formats are called ``long``, ``short``
2515
and ``line``. The default is long. See ``bzr help log-formats``
2516
for more details on log formats.
2518
The following options can be used to control what information is
2521
-l N display a maximum of N revisions
2522
-n N display N levels of revisions (0 for all, 1 for collapsed)
2523
-v display a status summary (delta) for each revision
2524
-p display a diff (patch) for each revision
2525
--show-ids display revision-ids (and file-ids), not just revnos
2527
Note that the default number of levels to display is a function of the
2528
log format. If the -n option is not used, the standard log formats show
2529
just the top level (mainline).
2531
Status summaries are shown using status flags like A, M, etc. To see
2532
the changes explained using words like ``added`` and ``modified``
2533
instead, use the -vv option.
2537
To display revisions from oldest to newest, use the --forward option.
2538
In most cases, using this option will have little impact on the total
2539
time taken to produce a log, though --forward does not incrementally
2540
display revisions like --reverse does when it can.
2542
:Revision filtering:
2544
The -r option can be used to specify what revision or range of revisions
2545
to filter against. The various forms are shown below::
2547
-rX display revision X
2548
-rX.. display revision X and later
2549
-r..Y display up to and including revision Y
2550
-rX..Y display from X to Y inclusive
2552
See ``bzr help revisionspec`` for details on how to specify X and Y.
2553
Some common examples are given below::
2555
-r-1 show just the tip
2556
-r-10.. show the last 10 mainline revisions
2557
-rsubmit:.. show what's new on this branch
2558
-rancestor:path.. show changes since the common ancestor of this
2559
branch and the one at location path
2560
-rdate:yesterday.. show changes since yesterday
2562
When logging a range of revisions using -rX..Y, log starts at
2563
revision Y and searches back in history through the primary
2564
("left-hand") parents until it finds X. When logging just the
2565
top level (using -n1), an error is reported if X is not found
2566
along the way. If multi-level logging is used (-n0), X may be
2567
a nested merge revision and the log will be truncated accordingly.
2571
If parameters are given and the first one is not a branch, the log
2572
will be filtered to show only those revisions that changed the
2573
nominated files or directories.
2575
Filenames are interpreted within their historical context. To log a
2576
deleted file, specify a revision range so that the file existed at
2577
the end or start of the range.
2579
Historical context is also important when interpreting pathnames of
2580
renamed files/directories. Consider the following example:
2582
* revision 1: add tutorial.txt
2583
* revision 2: modify tutorial.txt
2584
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2588
* ``bzr log guide.txt`` will log the file added in revision 1
2590
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2592
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2593
the original file in revision 2.
2595
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2596
was no file called guide.txt in revision 2.
2598
Renames are always followed by log. By design, there is no need to
2599
explicitly ask for this (and no way to stop logging a file back
2600
until it was last renamed).
2604
The --match option can be used for finding revisions that match a
2605
regular expression in a commit message, committer, author or bug.
2606
Specifying the option several times will match any of the supplied
2607
expressions. --match-author, --match-bugs, --match-committer and
2608
--match-message can be used to only match a specific field.
2612
GUI tools and IDEs are often better at exploring history than command
2613
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2614
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2615
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2616
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2618
You may find it useful to add the aliases below to ``bazaar.conf``::
2622
top = log -l10 --line
2625
``bzr tip`` will then show the latest revision while ``bzr top``
2626
will show the last 10 mainline revisions. To see the details of a
2627
particular revision X, ``bzr show -rX``.
2629
If you are interested in looking deeper into a particular merge X,
2630
use ``bzr log -n0 -rX``.
2632
``bzr log -v`` on a branch with lots of history is currently
2633
very slow. A fix for this issue is currently under development.
2634
With or without that fix, it is recommended that a revision range
2635
be given when using the -v option.
2637
bzr has a generic full-text matching plugin, bzr-search, that can be
2638
used to find revisions matching user names, commit messages, etc.
2639
Among other features, this plugin can find all revisions containing
2640
a list of words but not others.
2642
When exploring non-mainline history on large projects with deep
2643
history, the performance of log can be greatly improved by installing
2644
the historycache plugin. This plugin buffers historical information
2645
trading disk space for faster speed.
2647
takes_args = ['file*']
2648
_see_also = ['log-formats', 'revisionspec']
2651
help='Show from oldest to newest.'),
2653
custom_help('verbose',
2654
help='Show files changed in each revision.'),
2658
type=bzrlib.option._parse_revision_str,
2660
help='Show just the specified revision.'
2661
' See also "help revisionspec".'),
2663
RegistryOption('authors',
2664
'What names to list as authors - first, all or committer.',
2666
lazy_registry=('bzrlib.log', 'author_list_registry'),
2670
help='Number of levels to display - 0 for all, 1 for flat.',
2672
type=_parse_levels),
2674
help='Show revisions whose message matches this '
2675
'regular expression.',
2680
help='Limit the output to the first N revisions.',
2685
help='Show changes made in each revision as a patch.'),
2686
Option('include-merged',
2687
help='Show merged revisions like --levels 0 does.'),
2688
Option('include-merges', hidden=True,
2689
help='Historical alias for --include-merged.'),
2690
Option('omit-merges',
2691
help='Do not report commits with more than one parent.'),
2692
Option('exclude-common-ancestry',
2693
help='Display only the revisions that are not part'
2694
' of both ancestries (require -rX..Y).'
2696
Option('signatures',
2697
help='Show digital signature validity.'),
2700
help='Show revisions whose properties match this '
2703
ListOption('match-message',
2704
help='Show revisions whose message matches this '
2707
ListOption('match-committer',
2708
help='Show revisions whose committer matches this '
2711
ListOption('match-author',
2712
help='Show revisions whose authors match this '
2715
ListOption('match-bugs',
2716
help='Show revisions whose bugs match this '
2720
encoding_type = 'replace'
2723
def run(self, file_list=None, timezone='original',
2734
include_merged=None,
2736
exclude_common_ancestry=False,
2740
match_committer=None,
2744
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2746
from bzrlib.log import (
2748
make_log_request_dict,
2749
_get_info_for_log_files,
2751
direction = (forward and 'forward') or 'reverse'
2752
if symbol_versioning.deprecated_passed(include_merges):
2753
ui.ui_factory.show_user_warning(
2754
'deprecated_command_option',
2755
deprecated_name='--include-merges',
2756
recommended_name='--include-merged',
2757
deprecated_in_version='2.5',
2758
command=self.invoked_as)
2759
if include_merged is None:
2760
include_merged = include_merges
2762
raise errors.BzrCommandError(gettext(
2763
'{0} and {1} are mutually exclusive').format(
2764
'--include-merges', '--include-merged'))
2765
if include_merged is None:
2766
include_merged = False
2767
if (exclude_common_ancestry
2768
and (revision is None or len(revision) != 2)):
2769
raise errors.BzrCommandError(gettext(
2770
'--exclude-common-ancestry requires -r with two revisions'))
2775
raise errors.BzrCommandError(gettext(
2776
'{0} and {1} are mutually exclusive').format(
2777
'--levels', '--include-merged'))
2779
if change is not None:
2781
raise errors.RangeInChangeOption()
2782
if revision is not None:
2783
raise errors.BzrCommandError(gettext(
2784
'{0} and {1} are mutually exclusive').format(
2785
'--revision', '--change'))
2790
filter_by_dir = False
2792
# find the file ids to log and check for directory filtering
2793
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2794
revision, file_list, self.add_cleanup)
2795
for relpath, file_id, kind in file_info_list:
2797
raise errors.BzrCommandError(gettext(
2798
"Path unknown at end or start of revision range: %s") %
2800
# If the relpath is the top of the tree, we log everything
2805
file_ids.append(file_id)
2806
filter_by_dir = filter_by_dir or (
2807
kind in ['directory', 'tree-reference'])
2810
# FIXME ? log the current subdir only RBC 20060203
2811
if revision is not None \
2812
and len(revision) > 0 and revision[0].get_branch():
2813
location = revision[0].get_branch()
2816
dir, relpath = controldir.ControlDir.open_containing(location)
2817
b = dir.open_branch()
2818
self.add_cleanup(b.lock_read().unlock)
2819
rev1, rev2 = _get_revision_range(revision, b, self.name())
2821
if b.get_config_stack().get('validate_signatures_in_log'):
2825
if not gpg.GPGStrategy.verify_signatures_available():
2826
raise errors.GpgmeNotInstalled(None)
2828
# Decide on the type of delta & diff filtering to use
2829
# TODO: add an --all-files option to make this configurable & consistent
2837
diff_type = 'partial'
2841
# Build the log formatter
2842
if log_format is None:
2843
log_format = log.log_formatter_registry.get_default(b)
2844
# Make a non-encoding output to include the diffs - bug 328007
2845
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2846
lf = log_format(show_ids=show_ids, to_file=self.outf,
2847
to_exact_file=unencoded_output,
2848
show_timezone=timezone,
2849
delta_format=get_verbosity_level(),
2851
show_advice=levels is None,
2852
author_list_handler=authors)
2854
# Choose the algorithm for doing the logging. It's annoying
2855
# having multiple code paths like this but necessary until
2856
# the underlying repository format is faster at generating
2857
# deltas or can provide everything we need from the indices.
2858
# The default algorithm - match-using-deltas - works for
2859
# multiple files and directories and is faster for small
2860
# amounts of history (200 revisions say). However, it's too
2861
# slow for logging a single file in a repository with deep
2862
# history, i.e. > 10K revisions. In the spirit of "do no
2863
# evil when adding features", we continue to use the
2864
# original algorithm - per-file-graph - for the "single
2865
# file that isn't a directory without showing a delta" case.
2866
partial_history = revision and b.repository._format.supports_chks
2867
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2868
or delta_type or partial_history)
2872
match_dict[''] = match
2874
match_dict['message'] = match_message
2876
match_dict['committer'] = match_committer
2878
match_dict['author'] = match_author
2880
match_dict['bugs'] = match_bugs
2882
# Build the LogRequest and execute it
2883
if len(file_ids) == 0:
2885
rqst = make_log_request_dict(
2886
direction=direction, specific_fileids=file_ids,
2887
start_revision=rev1, end_revision=rev2, limit=limit,
2888
message_search=message, delta_type=delta_type,
2889
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2890
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2891
signature=signatures, omit_merges=omit_merges,
2893
Logger(b, rqst).show(lf)
2896
def _get_revision_range(revisionspec_list, branch, command_name):
2897
"""Take the input of a revision option and turn it into a revision range.
2899
It returns RevisionInfo objects which can be used to obtain the rev_id's
2900
of the desired revisions. It does some user input validations.
2902
if revisionspec_list is None:
2905
elif len(revisionspec_list) == 1:
2906
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2907
elif len(revisionspec_list) == 2:
2908
start_spec = revisionspec_list[0]
2909
end_spec = revisionspec_list[1]
2910
if end_spec.get_branch() != start_spec.get_branch():
2911
# b is taken from revision[0].get_branch(), and
2912
# show_log will use its revision_history. Having
2913
# different branches will lead to weird behaviors.
2914
raise errors.BzrCommandError(gettext(
2915
"bzr %s doesn't accept two revisions in different"
2916
" branches.") % command_name)
2917
if start_spec.spec is None:
2918
# Avoid loading all the history.
2919
rev1 = RevisionInfo(branch, None, None)
2921
rev1 = start_spec.in_history(branch)
2922
# Avoid loading all of history when we know a missing
2923
# end of range means the last revision ...
2924
if end_spec.spec is None:
2925
last_revno, last_revision_id = branch.last_revision_info()
2926
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2928
rev2 = end_spec.in_history(branch)
2930
raise errors.BzrCommandError(gettext(
2931
'bzr %s --revision takes one or two values.') % command_name)
2935
def _revision_range_to_revid_range(revision_range):
2938
if revision_range[0] is not None:
2939
rev_id1 = revision_range[0].rev_id
2940
if revision_range[1] is not None:
2941
rev_id2 = revision_range[1].rev_id
2942
return rev_id1, rev_id2
2944
def get_log_format(long=False, short=False, line=False, default='long'):
2945
log_format = default
2949
log_format = 'short'
2955
class cmd_touching_revisions(Command):
2956
__doc__ = """Return revision-ids which affected a particular file.
2958
A more user-friendly interface is "bzr log FILE".
2962
takes_args = ["filename"]
2965
def run(self, filename):
2966
tree, relpath = WorkingTree.open_containing(filename)
2967
file_id = tree.path2id(relpath)
2969
self.add_cleanup(b.lock_read().unlock)
2970
touching_revs = log.find_touching_revisions(b, file_id)
2971
for revno, revision_id, what in touching_revs:
2972
self.outf.write("%6d %s\n" % (revno, what))
2975
class cmd_ls(Command):
2976
__doc__ = """List files in a tree.
2979
_see_also = ['status', 'cat']
2980
takes_args = ['path?']
2984
Option('recursive', short_name='R',
2985
help='Recurse into subdirectories.'),
2987
help='Print paths relative to the root of the branch.'),
2988
Option('unknown', short_name='u',
2989
help='Print unknown files.'),
2990
Option('versioned', help='Print versioned files.',
2992
Option('ignored', short_name='i',
2993
help='Print ignored files.'),
2994
Option('kind', short_name='k',
2995
help='List entries of a particular kind: file, directory, symlink.',
3002
def run(self, revision=None, verbose=False,
3003
recursive=False, from_root=False,
3004
unknown=False, versioned=False, ignored=False,
3005
null=False, kind=None, show_ids=False, path=None, directory=None):
3007
if kind and kind not in ('file', 'directory', 'symlink'):
3008
raise errors.BzrCommandError(gettext('invalid kind specified'))
3010
if verbose and null:
3011
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
3012
all = not (unknown or versioned or ignored)
3014
selection = {'I':ignored, '?':unknown, 'V':versioned}
3020
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3023
tree, branch, relpath = \
3024
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3026
# Calculate the prefix to use
3030
prefix = relpath + '/'
3031
elif fs_path != '.' and not fs_path.endswith('/'):
3032
prefix = fs_path + '/'
3034
if revision is not None or tree is None:
3035
tree = _get_one_revision_tree('ls', revision, branch=branch)
3038
if isinstance(tree, WorkingTree) and tree.supports_views():
3039
view_files = tree.views.lookup_view()
3042
view_str = views.view_display_str(view_files)
3043
note(gettext("Ignoring files outside view. View is %s") % view_str)
3045
self.add_cleanup(tree.lock_read().unlock)
3046
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3047
from_dir=relpath, recursive=recursive):
3048
# Apply additional masking
3049
if not all and not selection[fc]:
3051
if kind is not None and fkind != kind:
3056
fullpath = osutils.pathjoin(relpath, fp)
3059
views.check_path_in_view(tree, fullpath)
3060
except errors.FileOutsideView:
3065
fp = osutils.pathjoin(prefix, fp)
3066
kindch = entry.kind_character()
3067
outstring = fp + kindch
3068
ui.ui_factory.clear_term()
3070
outstring = '%-8s %s' % (fc, outstring)
3071
if show_ids and fid is not None:
3072
outstring = "%-50s %s" % (outstring, fid)
3073
self.outf.write(outstring + '\n')
3075
self.outf.write(fp + '\0')
3078
self.outf.write(fid)
3079
self.outf.write('\0')
3087
self.outf.write('%-50s %s\n' % (outstring, my_id))
3089
self.outf.write(outstring + '\n')
3092
class cmd_unknowns(Command):
3093
__doc__ = """List unknown files.
3098
takes_options = ['directory']
3101
def run(self, directory=u'.'):
3102
for f in WorkingTree.open_containing(directory)[0].unknowns():
3103
self.outf.write(osutils.quotefn(f) + '\n')
3106
class cmd_ignore(Command):
3107
__doc__ = """Ignore specified files or patterns.
3109
See ``bzr help patterns`` for details on the syntax of patterns.
3111
If a .bzrignore file does not exist, the ignore command
3112
will create one and add the specified files or patterns to the newly
3113
created file. The ignore command will also automatically add the
3114
.bzrignore file to be versioned. Creating a .bzrignore file without
3115
the use of the ignore command will require an explicit add command.
3117
To remove patterns from the ignore list, edit the .bzrignore file.
3118
After adding, editing or deleting that file either indirectly by
3119
using this command or directly by using an editor, be sure to commit
3122
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3123
the global ignore file can be found in the application data directory as
3124
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3125
Global ignores are not touched by this command. The global ignore file
3126
can be edited directly using an editor.
3128
Patterns prefixed with '!' are exceptions to ignore patterns and take
3129
precedence over regular ignores. Such exceptions are used to specify
3130
files that should be versioned which would otherwise be ignored.
3132
Patterns prefixed with '!!' act as regular ignore patterns, but have
3133
precedence over the '!' exception patterns.
3137
* Ignore patterns containing shell wildcards must be quoted from
3140
* Ignore patterns starting with "#" act as comments in the ignore file.
3141
To ignore patterns that begin with that character, use the "RE:" prefix.
3144
Ignore the top level Makefile::
3146
bzr ignore ./Makefile
3148
Ignore .class files in all directories...::
3150
bzr ignore "*.class"
3152
...but do not ignore "special.class"::
3154
bzr ignore "!special.class"
3156
Ignore files whose name begins with the "#" character::
3160
Ignore .o files under the lib directory::
3162
bzr ignore "lib/**/*.o"
3164
Ignore .o files under the lib directory::
3166
bzr ignore "RE:lib/.*\.o"
3168
Ignore everything but the "debian" toplevel directory::
3170
bzr ignore "RE:(?!debian/).*"
3172
Ignore everything except the "local" toplevel directory,
3173
but always ignore autosave files ending in ~, even under local/::
3176
bzr ignore "!./local"
3180
_see_also = ['status', 'ignored', 'patterns']
3181
takes_args = ['name_pattern*']
3182
takes_options = ['directory',
3183
Option('default-rules',
3184
help='Display the default ignore rules that bzr uses.')
3187
def run(self, name_pattern_list=None, default_rules=None,
3189
from bzrlib import ignores
3190
if default_rules is not None:
3191
# dump the default rules and exit
3192
for pattern in ignores.USER_DEFAULTS:
3193
self.outf.write("%s\n" % pattern)
3195
if not name_pattern_list:
3196
raise errors.BzrCommandError(gettext("ignore requires at least one "
3197
"NAME_PATTERN or --default-rules."))
3198
name_pattern_list = [globbing.normalize_pattern(p)
3199
for p in name_pattern_list]
3201
bad_patterns_count = 0
3202
for p in name_pattern_list:
3203
if not globbing.Globster.is_pattern_valid(p):
3204
bad_patterns_count += 1
3205
bad_patterns += ('\n %s' % p)
3207
msg = (ngettext('Invalid ignore pattern found. %s',
3208
'Invalid ignore patterns found. %s',
3209
bad_patterns_count) % bad_patterns)
3210
ui.ui_factory.show_error(msg)
3211
raise errors.InvalidPattern('')
3212
for name_pattern in name_pattern_list:
3213
if (name_pattern[0] == '/' or
3214
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3215
raise errors.BzrCommandError(gettext(
3216
"NAME_PATTERN should not be an absolute path"))
3217
tree, relpath = WorkingTree.open_containing(directory)
3218
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3219
ignored = globbing.Globster(name_pattern_list)
3221
self.add_cleanup(tree.lock_read().unlock)
3222
for entry in tree.list_files():
3226
if ignored.match(filename):
3227
matches.append(filename)
3228
if len(matches) > 0:
3229
self.outf.write(gettext("Warning: the following files are version "
3230
"controlled and match your ignore pattern:\n%s"
3231
"\nThese files will continue to be version controlled"
3232
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3235
class cmd_ignored(Command):
3236
__doc__ = """List ignored files and the patterns that matched them.
3238
List all the ignored files and the ignore pattern that caused the file to
3241
Alternatively, to list just the files::
3246
encoding_type = 'replace'
3247
_see_also = ['ignore', 'ls']
3248
takes_options = ['directory']
3251
def run(self, directory=u'.'):
3252
tree = WorkingTree.open_containing(directory)[0]
3253
self.add_cleanup(tree.lock_read().unlock)
3254
for path, file_class, kind, file_id, entry in tree.list_files():
3255
if file_class != 'I':
3257
## XXX: Slightly inefficient since this was already calculated
3258
pat = tree.is_ignored(path)
3259
self.outf.write('%-50s %s\n' % (path, pat))
3262
class cmd_lookup_revision(Command):
3263
__doc__ = """Lookup the revision-id from a revision-number
3266
bzr lookup-revision 33
3269
takes_args = ['revno']
3270
takes_options = ['directory']
3273
def run(self, revno, directory=u'.'):
3277
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3279
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3280
self.outf.write("%s\n" % revid)
3283
class cmd_export(Command):
3284
__doc__ = """Export current or past revision to a destination directory or archive.
3286
If no revision is specified this exports the last committed revision.
3288
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3289
given, try to find the format with the extension. If no extension
3290
is found exports to a directory (equivalent to --format=dir).
3292
If root is supplied, it will be used as the root directory inside
3293
container formats (tar, zip, etc). If it is not supplied it will default
3294
to the exported filename. The root option has no effect for 'dir' format.
3296
If branch is omitted then the branch containing the current working
3297
directory will be used.
3299
Note: Export of tree with non-ASCII filenames to zip is not supported.
3301
================= =========================
3302
Supported formats Autodetected by extension
3303
================= =========================
3306
tbz2 .tar.bz2, .tbz2
3309
================= =========================
3312
takes_args = ['dest', 'branch_or_subdir?']
3313
takes_options = ['directory',
3315
help="Type of file to export to.",
3318
Option('filters', help='Apply content filters to export the '
3319
'convenient form.'),
3322
help="Name of the root directory inside the exported file."),
3323
Option('per-file-timestamps',
3324
help='Set modification time of files to that of the last '
3325
'revision in which it was changed.'),
3326
Option('uncommitted',
3327
help='Export the working tree contents rather than that of the '
3330
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3331
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3333
from bzrlib.export import export
3335
if branch_or_subdir is None:
3336
branch_or_subdir = directory
3338
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3340
if tree is not None:
3341
self.add_cleanup(tree.lock_read().unlock)
3345
raise errors.BzrCommandError(
3346
gettext("--uncommitted requires a working tree"))
3349
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3351
export(export_tree, dest, format, root, subdir, filtered=filters,
3352
per_file_timestamps=per_file_timestamps)
3353
except errors.NoSuchExportFormat, e:
3354
raise errors.BzrCommandError(
3355
gettext('Unsupported export format: %s') % e.format)
3358
class cmd_cat(Command):
3359
__doc__ = """Write the contents of a file as of a given revision to standard output.
3361
If no revision is nominated, the last revision is used.
3363
Note: Take care to redirect standard output when using this command on a
3368
takes_options = ['directory',
3369
Option('name-from-revision', help='The path name in the old tree.'),
3370
Option('filters', help='Apply content filters to display the '
3371
'convenience form.'),
3374
takes_args = ['filename']
3375
encoding_type = 'exact'
3378
def run(self, filename, revision=None, name_from_revision=False,
3379
filters=False, directory=None):
3380
if revision is not None and len(revision) != 1:
3381
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3382
" one revision specifier"))
3383
tree, branch, relpath = \
3384
_open_directory_or_containing_tree_or_branch(filename, directory)
3385
self.add_cleanup(branch.lock_read().unlock)
3386
return self._run(tree, branch, relpath, filename, revision,
3387
name_from_revision, filters)
3389
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3392
tree = b.basis_tree()
3393
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3394
self.add_cleanup(rev_tree.lock_read().unlock)
3396
old_file_id = rev_tree.path2id(relpath)
3398
# TODO: Split out this code to something that generically finds the
3399
# best id for a path across one or more trees; it's like
3400
# find_ids_across_trees but restricted to find just one. -- mbp
3402
if name_from_revision:
3403
# Try in revision if requested
3404
if old_file_id is None:
3405
raise errors.BzrCommandError(gettext(
3406
"{0!r} is not present in revision {1}").format(
3407
filename, rev_tree.get_revision_id()))
3409
actual_file_id = old_file_id
3411
cur_file_id = tree.path2id(relpath)
3412
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3413
actual_file_id = cur_file_id
3414
elif old_file_id is not None:
3415
actual_file_id = old_file_id
3417
raise errors.BzrCommandError(gettext(
3418
"{0!r} is not present in revision {1}").format(
3419
filename, rev_tree.get_revision_id()))
3421
from bzrlib.filter_tree import ContentFilterTree
3422
filter_tree = ContentFilterTree(rev_tree,
3423
rev_tree._content_filter_stack)
3424
content = filter_tree.get_file_text(actual_file_id)
3426
content = rev_tree.get_file_text(actual_file_id)
3428
self.outf.write(content)
3431
class cmd_local_time_offset(Command):
3432
__doc__ = """Show the offset in seconds from GMT to local time."""
3436
self.outf.write("%s\n" % osutils.local_time_offset())
3440
class cmd_commit(Command):
3441
__doc__ = """Commit changes into a new revision.
3443
An explanatory message needs to be given for each commit. This is
3444
often done by using the --message option (getting the message from the
3445
command line) or by using the --file option (getting the message from
3446
a file). If neither of these options is given, an editor is opened for
3447
the user to enter the message. To see the changed files in the
3448
boilerplate text loaded into the editor, use the --show-diff option.
3450
By default, the entire tree is committed and the person doing the
3451
commit is assumed to be the author. These defaults can be overridden
3456
If selected files are specified, only changes to those files are
3457
committed. If a directory is specified then the directory and
3458
everything within it is committed.
3460
When excludes are given, they take precedence over selected files.
3461
For example, to commit only changes within foo, but not changes
3464
bzr commit foo -x foo/bar
3466
A selective commit after a merge is not yet supported.
3470
If the author of the change is not the same person as the committer,
3471
you can specify the author's name using the --author option. The
3472
name should be in the same format as a committer-id, e.g.
3473
"John Doe <jdoe@example.com>". If there is more than one author of
3474
the change you can specify the option multiple times, once for each
3479
A common mistake is to forget to add a new file or directory before
3480
running the commit command. The --strict option checks for unknown
3481
files and aborts the commit if any are found. More advanced pre-commit
3482
checks can be implemented by defining hooks. See ``bzr help hooks``
3487
If you accidentially commit the wrong changes or make a spelling
3488
mistake in the commit message say, you can use the uncommit command
3489
to undo it. See ``bzr help uncommit`` for details.
3491
Hooks can also be configured to run after a commit. This allows you
3492
to trigger updates to external systems like bug trackers. The --fixes
3493
option can be used to record the association between a revision and
3494
one or more bugs. See ``bzr help bugs`` for details.
3497
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3498
takes_args = ['selected*']
3500
ListOption('exclude', type=str, short_name='x',
3501
help="Do not consider changes made to a given path."),
3502
Option('message', type=unicode,
3504
help="Description of the new revision."),
3507
help='Commit even if nothing has changed.'),
3508
Option('file', type=str,
3511
help='Take commit message from this file.'),
3513
help="Refuse to commit if there are unknown "
3514
"files in the working tree."),
3515
Option('commit-time', type=str,
3516
help="Manually set a commit time using commit date "
3517
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3518
ListOption('fixes', type=str,
3519
help="Mark a bug as being fixed by this revision "
3520
"(see \"bzr help bugs\")."),
3521
ListOption('author', type=unicode,
3522
help="Set the author's name, if it's different "
3523
"from the committer."),
3525
help="Perform a local commit in a bound "
3526
"branch. Local commits are not pushed to "
3527
"the master branch until a normal commit "
3530
Option('show-diff', short_name='p',
3531
help='When no message is supplied, show the diff along'
3532
' with the status summary in the message editor.'),
3534
help='When committing to a foreign version control '
3535
'system do not push data that can not be natively '
3538
aliases = ['ci', 'checkin']
3540
def _iter_bug_fix_urls(self, fixes, branch):
3541
default_bugtracker = None
3542
# Configure the properties for bug fixing attributes.
3543
for fixed_bug in fixes:
3544
tokens = fixed_bug.split(':')
3545
if len(tokens) == 1:
3546
if default_bugtracker is None:
3547
branch_config = branch.get_config_stack()
3548
default_bugtracker = branch_config.get(
3550
if default_bugtracker is None:
3551
raise errors.BzrCommandError(gettext(
3552
"No tracker specified for bug %s. Use the form "
3553
"'tracker:id' or specify a default bug tracker "
3554
"using the `bugtracker` option.\nSee "
3555
"\"bzr help bugs\" for more information on this "
3556
"feature. Commit refused.") % fixed_bug)
3557
tag = default_bugtracker
3559
elif len(tokens) != 2:
3560
raise errors.BzrCommandError(gettext(
3561
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3562
"See \"bzr help bugs\" for more information on this "
3563
"feature.\nCommit refused.") % fixed_bug)
3565
tag, bug_id = tokens
3567
yield bugtracker.get_bug_url(tag, branch, bug_id)
3568
except errors.UnknownBugTrackerAbbreviation:
3569
raise errors.BzrCommandError(gettext(
3570
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3571
except errors.MalformedBugIdentifier, e:
3572
raise errors.BzrCommandError(gettext(
3573
"%s\nCommit refused.") % (str(e),))
3575
def run(self, message=None, file=None, verbose=False, selected_list=None,
3576
unchanged=False, strict=False, local=False, fixes=None,
3577
author=None, show_diff=False, exclude=None, commit_time=None,
3579
from bzrlib.errors import (
3584
from bzrlib.msgeditor import (
3585
edit_commit_message_encoded,
3586
generate_commit_message_template,
3587
make_commit_message_template_encoded,
3591
commit_stamp = offset = None
3592
if commit_time is not None:
3594
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3595
except ValueError, e:
3596
raise errors.BzrCommandError(gettext(
3597
"Could not parse --commit-time: " + str(e)))
3601
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3602
if selected_list == ['']:
3603
# workaround - commit of root of tree should be exactly the same
3604
# as just default commit in that tree, and succeed even though
3605
# selected-file merge commit is not done yet
3610
bug_property = bugtracker.encode_fixes_bug_urls(
3611
self._iter_bug_fix_urls(fixes, tree.branch))
3613
properties['bugs'] = bug_property
3615
if local and not tree.branch.get_bound_location():
3616
raise errors.LocalRequiresBoundBranch()
3618
if message is not None:
3620
file_exists = osutils.lexists(message)
3621
except UnicodeError:
3622
# The commit message contains unicode characters that can't be
3623
# represented in the filesystem encoding, so that can't be a
3628
'The commit message is a file name: "%(f)s".\n'
3629
'(use --file "%(f)s" to take commit message from that file)'
3631
ui.ui_factory.show_warning(warning_msg)
3633
message = message.replace('\r\n', '\n')
3634
message = message.replace('\r', '\n')
3636
raise errors.BzrCommandError(gettext(
3637
"please specify either --message or --file"))
3639
def get_message(commit_obj):
3640
"""Callback to get commit message"""
3644
my_message = f.read().decode(osutils.get_user_encoding())
3647
elif message is not None:
3648
my_message = message
3650
# No message supplied: make one up.
3651
# text is the status of the tree
3652
text = make_commit_message_template_encoded(tree,
3653
selected_list, diff=show_diff,
3654
output_encoding=osutils.get_user_encoding())
3655
# start_message is the template generated from hooks
3656
# XXX: Warning - looks like hooks return unicode,
3657
# make_commit_message_template_encoded returns user encoding.
3658
# We probably want to be using edit_commit_message instead to
3660
my_message = set_commit_message(commit_obj)
3661
if my_message is None:
3662
start_message = generate_commit_message_template(commit_obj)
3663
my_message = edit_commit_message_encoded(text,
3664
start_message=start_message)
3665
if my_message is None:
3666
raise errors.BzrCommandError(gettext("please specify a commit"
3667
" message with either --message or --file"))
3668
if my_message == "":
3669
raise errors.BzrCommandError(gettext("Empty commit message specified."
3670
" Please specify a commit message with either"
3671
" --message or --file or leave a blank message"
3672
" with --message \"\"."))
3675
# The API permits a commit with a filter of [] to mean 'select nothing'
3676
# but the command line should not do that.
3677
if not selected_list:
3678
selected_list = None
3680
tree.commit(message_callback=get_message,
3681
specific_files=selected_list,
3682
allow_pointless=unchanged, strict=strict, local=local,
3683
reporter=None, verbose=verbose, revprops=properties,
3684
authors=author, timestamp=commit_stamp,
3686
exclude=tree.safe_relpath_files(exclude),
3688
except PointlessCommit:
3689
raise errors.BzrCommandError(gettext("No changes to commit."
3690
" Please 'bzr add' the files you want to commit, or use"
3691
" --unchanged to force an empty commit."))
3692
except ConflictsInTree:
3693
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3694
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3696
except StrictCommitFailed:
3697
raise errors.BzrCommandError(gettext("Commit refused because there are"
3698
" unknown files in the working tree."))
3699
except errors.BoundBranchOutOfDate, e:
3700
e.extra_help = (gettext("\n"
3701
'To commit to master branch, run update and then commit.\n'
3702
'You can also pass --local to commit to continue working '
3707
class cmd_check(Command):
3708
__doc__ = """Validate working tree structure, branch consistency and repository history.
3710
This command checks various invariants about branch and repository storage
3711
to detect data corruption or bzr bugs.
3713
The working tree and branch checks will only give output if a problem is
3714
detected. The output fields of the repository check are:
3717
This is just the number of revisions checked. It doesn't
3721
This is just the number of versionedfiles checked. It
3722
doesn't indicate a problem.
3724
unreferenced ancestors
3725
Texts that are ancestors of other texts, but
3726
are not properly referenced by the revision ancestry. This is a
3727
subtle problem that Bazaar can work around.
3730
This is the total number of unique file contents
3731
seen in the checked revisions. It does not indicate a problem.
3734
This is the total number of repeated texts seen
3735
in the checked revisions. Texts can be repeated when their file
3736
entries are modified, but the file contents are not. It does not
3739
If no restrictions are specified, all Bazaar data that is found at the given
3740
location will be checked.
3744
Check the tree and branch at 'foo'::
3746
bzr check --tree --branch foo
3748
Check only the repository at 'bar'::
3750
bzr check --repo bar
3752
Check everything at 'baz'::
3757
_see_also = ['reconcile']
3758
takes_args = ['path?']
3759
takes_options = ['verbose',
3760
Option('branch', help="Check the branch related to the"
3761
" current directory."),
3762
Option('repo', help="Check the repository related to the"
3763
" current directory."),
3764
Option('tree', help="Check the working tree related to"
3765
" the current directory.")]
3767
def run(self, path=None, verbose=False, branch=False, repo=False,
3769
from bzrlib.check import check_dwim
3772
if not branch and not repo and not tree:
3773
branch = repo = tree = True
3774
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3777
class cmd_upgrade(Command):
3778
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3780
When the default format has changed after a major new release of
3781
Bazaar, you may be informed during certain operations that you
3782
should upgrade. Upgrading to a newer format may improve performance
3783
or make new features available. It may however limit interoperability
3784
with older repositories or with older versions of Bazaar.
3786
If you wish to upgrade to a particular format rather than the
3787
current default, that can be specified using the --format option.
3788
As a consequence, you can use the upgrade command this way to
3789
"downgrade" to an earlier format, though some conversions are
3790
a one way process (e.g. changing from the 1.x default to the
3791
2.x default) so downgrading is not always possible.
3793
A backup.bzr.~#~ directory is created at the start of the conversion
3794
process (where # is a number). By default, this is left there on
3795
completion. If the conversion fails, delete the new .bzr directory
3796
and rename this one back in its place. Use the --clean option to ask
3797
for the backup.bzr directory to be removed on successful conversion.
3798
Alternatively, you can delete it by hand if everything looks good
3801
If the location given is a shared repository, dependent branches
3802
are also converted provided the repository converts successfully.
3803
If the conversion of a branch fails, remaining branches are still
3806
For more information on upgrades, see the Bazaar Upgrade Guide,
3807
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3810
_see_also = ['check', 'reconcile', 'formats']
3811
takes_args = ['url?']
3813
RegistryOption('format',
3814
help='Upgrade to a specific format. See "bzr help'
3815
' formats" for details.',
3816
lazy_registry=('bzrlib.controldir', 'format_registry'),
3817
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3818
value_switches=True, title='Branch format'),
3820
help='Remove the backup.bzr directory if successful.'),
3822
help="Show what would be done, but don't actually do anything."),
3825
def run(self, url='.', format=None, clean=False, dry_run=False):
3826
from bzrlib.upgrade import upgrade
3827
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3829
if len(exceptions) == 1:
3830
# Compatibility with historical behavior
3836
class cmd_whoami(Command):
3837
__doc__ = """Show or set bzr user id.
3840
Show the email of the current user::
3844
Set the current user::
3846
bzr whoami "Frank Chu <fchu@example.com>"
3848
takes_options = [ 'directory',
3850
help='Display email address only.'),
3852
help='Set identity for the current branch instead of '
3855
takes_args = ['name?']
3856
encoding_type = 'replace'
3859
def run(self, email=False, branch=False, name=None, directory=None):
3861
if directory is None:
3862
# use branch if we're inside one; otherwise global config
3864
c = Branch.open_containing(u'.')[0].get_config_stack()
3865
except errors.NotBranchError:
3866
c = _mod_config.GlobalStack()
3868
c = Branch.open(directory).get_config_stack()
3869
identity = c.get('email')
3871
self.outf.write(_mod_config.extract_email_address(identity)
3874
self.outf.write(identity + '\n')
3878
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3881
# display a warning if an email address isn't included in the given name.
3883
_mod_config.extract_email_address(name)
3884
except errors.NoEmailInUsername, e:
3885
warning('"%s" does not seem to contain an email address. '
3886
'This is allowed, but not recommended.', name)
3888
# use global config unless --branch given
3890
if directory is None:
3891
c = Branch.open_containing(u'.')[0].get_config_stack()
3893
b = Branch.open(directory)
3894
self.add_cleanup(b.lock_write().unlock)
3895
c = b.get_config_stack()
3897
c = _mod_config.GlobalStack()
3898
c.set('email', name)
3901
class cmd_nick(Command):
3902
__doc__ = """Print or set the branch nickname.
3904
If unset, the colocated branch name is used for colocated branches, and
3905
the branch directory name is used for other branches. To print the
3906
current nickname, execute with no argument.
3908
Bound branches use the nickname of its master branch unless it is set
3912
_see_also = ['info']
3913
takes_args = ['nickname?']
3914
takes_options = ['directory']
3915
def run(self, nickname=None, directory=u'.'):
3916
branch = Branch.open_containing(directory)[0]
3917
if nickname is None:
3918
self.printme(branch)
3920
branch.nick = nickname
3923
def printme(self, branch):
3924
self.outf.write('%s\n' % branch.nick)
3927
class cmd_alias(Command):
3928
__doc__ = """Set/unset and display aliases.
3931
Show the current aliases::
3935
Show the alias specified for 'll'::
3939
Set an alias for 'll'::
3941
bzr alias ll="log --line -r-10..-1"
3943
To remove an alias for 'll'::
3945
bzr alias --remove ll
3948
takes_args = ['name?']
3950
Option('remove', help='Remove the alias.'),
3953
def run(self, name=None, remove=False):
3955
self.remove_alias(name)
3957
self.print_aliases()
3959
equal_pos = name.find('=')
3961
self.print_alias(name)
3963
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3965
def remove_alias(self, alias_name):
3966
if alias_name is None:
3967
raise errors.BzrCommandError(gettext(
3968
'bzr alias --remove expects an alias to remove.'))
3969
# If alias is not found, print something like:
3970
# unalias: foo: not found
3971
c = _mod_config.GlobalConfig()
3972
c.unset_alias(alias_name)
3975
def print_aliases(self):
3976
"""Print out the defined aliases in a similar format to bash."""
3977
aliases = _mod_config.GlobalConfig().get_aliases()
3978
for key, value in sorted(aliases.iteritems()):
3979
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3982
def print_alias(self, alias_name):
3983
from bzrlib.commands import get_alias
3984
alias = get_alias(alias_name)
3986
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3989
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3991
def set_alias(self, alias_name, alias_command):
3992
"""Save the alias in the global config."""
3993
c = _mod_config.GlobalConfig()
3994
c.set_alias(alias_name, alias_command)
3997
class cmd_selftest(Command):
3998
__doc__ = """Run internal test suite.
4000
If arguments are given, they are regular expressions that say which tests
4001
should run. Tests matching any expression are run, and other tests are
4004
Alternatively if --first is given, matching tests are run first and then
4005
all other tests are run. This is useful if you have been working in a
4006
particular area, but want to make sure nothing else was broken.
4008
If --exclude is given, tests that match that regular expression are
4009
excluded, regardless of whether they match --first or not.
4011
To help catch accidential dependencies between tests, the --randomize
4012
option is useful. In most cases, the argument used is the word 'now'.
4013
Note that the seed used for the random number generator is displayed
4014
when this option is used. The seed can be explicitly passed as the
4015
argument to this option if required. This enables reproduction of the
4016
actual ordering used if and when an order sensitive problem is encountered.
4018
If --list-only is given, the tests that would be run are listed. This is
4019
useful when combined with --first, --exclude and/or --randomize to
4020
understand their impact. The test harness reports "Listed nn tests in ..."
4021
instead of "Ran nn tests in ..." when list mode is enabled.
4023
If the global option '--no-plugins' is given, plugins are not loaded
4024
before running the selftests. This has two effects: features provided or
4025
modified by plugins will not be tested, and tests provided by plugins will
4028
Tests that need working space on disk use a common temporary directory,
4029
typically inside $TMPDIR or /tmp.
4031
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
4032
into a pdb postmortem session.
4034
The --coverage=DIRNAME global option produces a report with covered code
4038
Run only tests relating to 'ignore'::
4042
Disable plugins and list tests as they're run::
4044
bzr --no-plugins selftest -v
4046
# NB: this is used from the class without creating an instance, which is
4047
# why it does not have a self parameter.
4048
def get_transport_type(typestring):
4049
"""Parse and return a transport specifier."""
4050
if typestring == "sftp":
4051
from bzrlib.tests import stub_sftp
4052
return stub_sftp.SFTPAbsoluteServer
4053
elif typestring == "memory":
4054
from bzrlib.tests import test_server
4055
return memory.MemoryServer
4056
elif typestring == "fakenfs":
4057
from bzrlib.tests import test_server
4058
return test_server.FakeNFSServer
4059
msg = "No known transport type %s. Supported types are: sftp\n" %\
4061
raise errors.BzrCommandError(msg)
4064
takes_args = ['testspecs*']
4065
takes_options = ['verbose',
4067
help='Stop when one test fails.',
4071
help='Use a different transport by default '
4072
'throughout the test suite.',
4073
type=get_transport_type),
4075
help='Run the benchmarks rather than selftests.',
4077
Option('lsprof-timed',
4078
help='Generate lsprof output for benchmarked'
4079
' sections of code.'),
4080
Option('lsprof-tests',
4081
help='Generate lsprof output for each test.'),
4083
help='Run all tests, but run specified tests first.',
4087
help='List the tests instead of running them.'),
4088
RegistryOption('parallel',
4089
help="Run the test suite in parallel.",
4090
lazy_registry=('bzrlib.tests', 'parallel_registry'),
4091
value_switches=False,
4093
Option('randomize', type=str, argname="SEED",
4094
help='Randomize the order of tests using the given'
4095
' seed or "now" for the current time.'),
4096
ListOption('exclude', type=str, argname="PATTERN",
4098
help='Exclude tests that match this regular'
4101
help='Output test progress via subunit.'),
4102
Option('strict', help='Fail on missing dependencies or '
4104
Option('load-list', type=str, argname='TESTLISTFILE',
4105
help='Load a test id list from a text file.'),
4106
ListOption('debugflag', type=str, short_name='E',
4107
help='Turn on a selftest debug flag.'),
4108
ListOption('starting-with', type=str, argname='TESTID',
4109
param_name='starting_with', short_name='s',
4111
'Load only the tests starting with TESTID.'),
4113
help="By default we disable fsync and fdatasync"
4114
" while running the test suite.")
4116
encoding_type = 'replace'
4119
Command.__init__(self)
4120
self.additional_selftest_args = {}
4122
def run(self, testspecs_list=None, verbose=False, one=False,
4123
transport=None, benchmark=None,
4125
first=False, list_only=False,
4126
randomize=None, exclude=None, strict=False,
4127
load_list=None, debugflag=None, starting_with=None, subunit=False,
4128
parallel=None, lsprof_tests=False,
4131
# During selftest, disallow proxying, as it can cause severe
4132
# performance penalties and is only needed for thread
4133
# safety. The selftest command is assumed to not use threads
4134
# too heavily. The call should be as early as possible, as
4135
# error reporting for past duplicate imports won't have useful
4137
lazy_import.disallow_proxying()
4139
from bzrlib import tests
4141
if testspecs_list is not None:
4142
pattern = '|'.join(testspecs_list)
4147
from bzrlib.tests import SubUnitBzrRunner
4149
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4150
"needs to be installed to use --subunit."))
4151
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4152
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4153
# stdout, which would corrupt the subunit stream.
4154
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4155
# following code can be deleted when it's sufficiently deployed
4156
# -- vila/mgz 20100514
4157
if (sys.platform == "win32"
4158
and getattr(sys.stdout, 'fileno', None) is not None):
4160
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4162
self.additional_selftest_args.setdefault(
4163
'suite_decorators', []).append(parallel)
4165
raise errors.BzrCommandError(gettext(
4166
"--benchmark is no longer supported from bzr 2.2; "
4167
"use bzr-usertest instead"))
4168
test_suite_factory = None
4170
exclude_pattern = None
4172
exclude_pattern = '(' + '|'.join(exclude) + ')'
4174
self._disable_fsync()
4175
selftest_kwargs = {"verbose": verbose,
4177
"stop_on_failure": one,
4178
"transport": transport,
4179
"test_suite_factory": test_suite_factory,
4180
"lsprof_timed": lsprof_timed,
4181
"lsprof_tests": lsprof_tests,
4182
"matching_tests_first": first,
4183
"list_only": list_only,
4184
"random_seed": randomize,
4185
"exclude_pattern": exclude_pattern,
4187
"load_list": load_list,
4188
"debug_flags": debugflag,
4189
"starting_with": starting_with
4191
selftest_kwargs.update(self.additional_selftest_args)
4193
# Make deprecation warnings visible, unless -Werror is set
4194
cleanup = symbol_versioning.activate_deprecation_warnings(
4197
result = tests.selftest(**selftest_kwargs)
4200
return int(not result)
4202
def _disable_fsync(self):
4203
"""Change the 'os' functionality to not synchronize."""
4204
self._orig_fsync = getattr(os, 'fsync', None)
4205
if self._orig_fsync is not None:
4206
os.fsync = lambda filedes: None
4207
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4208
if self._orig_fdatasync is not None:
4209
os.fdatasync = lambda filedes: None
4212
class cmd_version(Command):
4213
__doc__ = """Show version of bzr."""
4215
encoding_type = 'replace'
4217
Option("short", help="Print just the version number."),
4221
def run(self, short=False):
4222
from bzrlib.version import show_version
4224
self.outf.write(bzrlib.version_string + '\n')
4226
show_version(to_file=self.outf)
4229
class cmd_rocks(Command):
4230
__doc__ = """Statement of optimism."""
4236
self.outf.write(gettext("It sure does!\n"))
4239
class cmd_find_merge_base(Command):
4240
__doc__ = """Find and print a base revision for merging two branches."""
4241
# TODO: Options to specify revisions on either side, as if
4242
# merging only part of the history.
4243
takes_args = ['branch', 'other']
4247
def run(self, branch, other):
4248
from bzrlib.revision import ensure_null
4250
branch1 = Branch.open_containing(branch)[0]
4251
branch2 = Branch.open_containing(other)[0]
4252
self.add_cleanup(branch1.lock_read().unlock)
4253
self.add_cleanup(branch2.lock_read().unlock)
4254
last1 = ensure_null(branch1.last_revision())
4255
last2 = ensure_null(branch2.last_revision())
4257
graph = branch1.repository.get_graph(branch2.repository)
4258
base_rev_id = graph.find_unique_lca(last1, last2)
4260
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4263
class cmd_merge(Command):
4264
__doc__ = """Perform a three-way merge.
4266
The source of the merge can be specified either in the form of a branch,
4267
or in the form of a path to a file containing a merge directive generated
4268
with bzr send. If neither is specified, the default is the upstream branch
4269
or the branch most recently merged using --remember. The source of the
4270
merge may also be specified in the form of a path to a file in another
4271
branch: in this case, only the modifications to that file are merged into
4272
the current working tree.
4274
When merging from a branch, by default bzr will try to merge in all new
4275
work from the other branch, automatically determining an appropriate base
4276
revision. If this fails, you may need to give an explicit base.
4278
To pick a different ending revision, pass "--revision OTHER". bzr will
4279
try to merge in all new work up to and including revision OTHER.
4281
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4282
through OTHER, excluding BASE but including OTHER, will be merged. If this
4283
causes some revisions to be skipped, i.e. if the destination branch does
4284
not already contain revision BASE, such a merge is commonly referred to as
4285
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4286
cherrypicks. The changes look like a normal commit, and the history of the
4287
changes from the other branch is not stored in the commit.
4289
Revision numbers are always relative to the source branch.
4291
Merge will do its best to combine the changes in two branches, but there
4292
are some kinds of problems only a human can fix. When it encounters those,
4293
it will mark a conflict. A conflict means that you need to fix something,
4294
before you can commit.
4296
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4298
If there is no default branch set, the first merge will set it (use
4299
--no-remember to avoid setting it). After that, you can omit the branch
4300
to use the default. To change the default, use --remember. The value will
4301
only be saved if the remote location can be accessed.
4303
The results of the merge are placed into the destination working
4304
directory, where they can be reviewed (with bzr diff), tested, and then
4305
committed to record the result of the merge.
4307
merge refuses to run if there are any uncommitted changes, unless
4308
--force is given. If --force is given, then the changes from the source
4309
will be merged with the current working tree, including any uncommitted
4310
changes in the tree. The --force option can also be used to create a
4311
merge revision which has more than two parents.
4313
If one would like to merge changes from the working tree of the other
4314
branch without merging any committed revisions, the --uncommitted option
4317
To select only some changes to merge, use "merge -i", which will prompt
4318
you to apply each diff hunk and file change, similar to "shelve".
4321
To merge all new revisions from bzr.dev::
4323
bzr merge ../bzr.dev
4325
To merge changes up to and including revision 82 from bzr.dev::
4327
bzr merge -r 82 ../bzr.dev
4329
To merge the changes introduced by 82, without previous changes::
4331
bzr merge -r 81..82 ../bzr.dev
4333
To apply a merge directive contained in /tmp/merge::
4335
bzr merge /tmp/merge
4337
To create a merge revision with three parents from two branches
4338
feature1a and feature1b:
4340
bzr merge ../feature1a
4341
bzr merge ../feature1b --force
4342
bzr commit -m 'revision with three parents'
4345
encoding_type = 'exact'
4346
_see_also = ['update', 'remerge', 'status-flags', 'send']
4347
takes_args = ['location?']
4352
help='Merge even if the destination tree has uncommitted changes.'),
4356
Option('show-base', help="Show base revision text in "
4358
Option('uncommitted', help='Apply uncommitted changes'
4359
' from a working copy, instead of branch changes.'),
4360
Option('pull', help='If the destination is already'
4361
' completely merged into the source, pull from the'
4362
' source rather than merging. When this happens,'
4363
' you do not need to commit the result.'),
4364
custom_help('directory',
4365
help='Branch to merge into, '
4366
'rather than the one containing the working directory.'),
4367
Option('preview', help='Instead of merging, show a diff of the'
4369
Option('interactive', help='Select changes interactively.',
4373
def run(self, location=None, revision=None, force=False,
4374
merge_type=None, show_base=False, reprocess=None, remember=None,
4375
uncommitted=False, pull=False,
4380
if merge_type is None:
4381
merge_type = _mod_merge.Merge3Merger
4383
if directory is None: directory = u'.'
4384
possible_transports = []
4386
allow_pending = True
4387
verified = 'inapplicable'
4389
tree = WorkingTree.open_containing(directory)[0]
4390
if tree.branch.revno() == 0:
4391
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4392
'https://bugs.launchpad.net/bzr/+bug/308562'))
4395
basis_tree = tree.revision_tree(tree.last_revision())
4396
except errors.NoSuchRevision:
4397
basis_tree = tree.basis_tree()
4399
# die as quickly as possible if there are uncommitted changes
4401
if tree.has_changes():
4402
raise errors.UncommittedChanges(tree)
4404
view_info = _get_view_info_for_change_reporter(tree)
4405
change_reporter = delta._ChangeReporter(
4406
unversioned_filter=tree.is_ignored, view_info=view_info)
4407
pb = ui.ui_factory.nested_progress_bar()
4408
self.add_cleanup(pb.finished)
4409
self.add_cleanup(tree.lock_write().unlock)
4410
if location is not None:
4412
mergeable = bundle.read_mergeable_from_url(location,
4413
possible_transports=possible_transports)
4414
except errors.NotABundle:
4418
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4419
' with bundles or merge directives.'))
4421
if revision is not None:
4422
raise errors.BzrCommandError(gettext(
4423
'Cannot use -r with merge directives or bundles'))
4424
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4427
if merger is None and uncommitted:
4428
if revision is not None and len(revision) > 0:
4429
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4430
' --revision at the same time.'))
4431
merger = self.get_merger_from_uncommitted(tree, location, None)
4432
allow_pending = False
4435
merger, allow_pending = self._get_merger_from_branch(tree,
4436
location, revision, remember, possible_transports, None)
4438
merger.merge_type = merge_type
4439
merger.reprocess = reprocess
4440
merger.show_base = show_base
4441
self.sanity_check_merger(merger)
4442
if (merger.base_rev_id == merger.other_rev_id and
4443
merger.other_rev_id is not None):
4444
# check if location is a nonexistent file (and not a branch) to
4445
# disambiguate the 'Nothing to do'
4446
if merger.interesting_files:
4447
if not merger.other_tree.has_filename(
4448
merger.interesting_files[0]):
4449
note(gettext("merger: ") + str(merger))
4450
raise errors.PathsDoNotExist([location])
4451
note(gettext('Nothing to do.'))
4453
if pull and not preview:
4454
if merger.interesting_files is not None:
4455
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4456
if (merger.base_rev_id == tree.last_revision()):
4457
result = tree.pull(merger.other_branch, False,
4458
merger.other_rev_id)
4459
result.report(self.outf)
4461
if merger.this_basis is None:
4462
raise errors.BzrCommandError(gettext(
4463
"This branch has no commits."
4464
" (perhaps you would prefer 'bzr pull')"))
4466
return self._do_preview(merger)
4468
return self._do_interactive(merger)
4470
return self._do_merge(merger, change_reporter, allow_pending,
4473
def _get_preview(self, merger):
4474
tree_merger = merger.make_merger()
4475
tt = tree_merger.make_preview_transform()
4476
self.add_cleanup(tt.finalize)
4477
result_tree = tt.get_preview_tree()
4480
def _do_preview(self, merger):
4481
from bzrlib.diff import show_diff_trees
4482
result_tree = self._get_preview(merger)
4483
path_encoding = osutils.get_diff_header_encoding()
4484
show_diff_trees(merger.this_tree, result_tree, self.outf,
4485
old_label='', new_label='',
4486
path_encoding=path_encoding)
4488
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4489
merger.change_reporter = change_reporter
4490
conflict_count = merger.do_merge()
4492
merger.set_pending()
4493
if verified == 'failed':
4494
warning('Preview patch does not match changes')
4495
if conflict_count != 0:
4500
def _do_interactive(self, merger):
4501
"""Perform an interactive merge.
4503
This works by generating a preview tree of the merge, then using
4504
Shelver to selectively remove the differences between the working tree
4505
and the preview tree.
4507
from bzrlib import shelf_ui
4508
result_tree = self._get_preview(merger)
4509
writer = bzrlib.option.diff_writer_registry.get()
4510
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4511
reporter=shelf_ui.ApplyReporter(),
4512
diff_writer=writer(sys.stdout))
4518
def sanity_check_merger(self, merger):
4519
if (merger.show_base and
4520
not merger.merge_type is _mod_merge.Merge3Merger):
4521
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4522
" merge type. %s") % merger.merge_type)
4523
if merger.reprocess is None:
4524
if merger.show_base:
4525
merger.reprocess = False
4527
# Use reprocess if the merger supports it
4528
merger.reprocess = merger.merge_type.supports_reprocess
4529
if merger.reprocess and not merger.merge_type.supports_reprocess:
4530
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4531
" for merge type %s.") %
4533
if merger.reprocess and merger.show_base:
4534
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4537
def _get_merger_from_branch(self, tree, location, revision, remember,
4538
possible_transports, pb):
4539
"""Produce a merger from a location, assuming it refers to a branch."""
4540
from bzrlib.tag import _merge_tags_if_possible
4541
# find the branch locations
4542
other_loc, user_location = self._select_branch_location(tree, location,
4544
if revision is not None and len(revision) == 2:
4545
base_loc, _unused = self._select_branch_location(tree,
4546
location, revision, 0)
4548
base_loc = other_loc
4550
other_branch, other_path = Branch.open_containing(other_loc,
4551
possible_transports)
4552
if base_loc == other_loc:
4553
base_branch = other_branch
4555
base_branch, base_path = Branch.open_containing(base_loc,
4556
possible_transports)
4557
# Find the revision ids
4558
other_revision_id = None
4559
base_revision_id = None
4560
if revision is not None:
4561
if len(revision) >= 1:
4562
other_revision_id = revision[-1].as_revision_id(other_branch)
4563
if len(revision) == 2:
4564
base_revision_id = revision[0].as_revision_id(base_branch)
4565
if other_revision_id is None:
4566
other_revision_id = _mod_revision.ensure_null(
4567
other_branch.last_revision())
4568
# Remember where we merge from. We need to remember if:
4569
# - user specify a location (and we don't merge from the parent
4571
# - user ask to remember or there is no previous location set to merge
4572
# from and user didn't ask to *not* remember
4573
if (user_location is not None
4575
or (remember is None
4576
and tree.branch.get_submit_branch() is None)))):
4577
tree.branch.set_submit_branch(other_branch.base)
4578
# Merge tags (but don't set them in the master branch yet, the user
4579
# might revert this merge). Commit will propagate them.
4580
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4581
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4582
other_revision_id, base_revision_id, other_branch, base_branch)
4583
if other_path != '':
4584
allow_pending = False
4585
merger.interesting_files = [other_path]
4587
allow_pending = True
4588
return merger, allow_pending
4590
def get_merger_from_uncommitted(self, tree, location, pb):
4591
"""Get a merger for uncommitted changes.
4593
:param tree: The tree the merger should apply to.
4594
:param location: The location containing uncommitted changes.
4595
:param pb: The progress bar to use for showing progress.
4597
location = self._select_branch_location(tree, location)[0]
4598
other_tree, other_path = WorkingTree.open_containing(location)
4599
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4600
if other_path != '':
4601
merger.interesting_files = [other_path]
4604
def _select_branch_location(self, tree, user_location, revision=None,
4606
"""Select a branch location, according to possible inputs.
4608
If provided, branches from ``revision`` are preferred. (Both
4609
``revision`` and ``index`` must be supplied.)
4611
Otherwise, the ``location`` parameter is used. If it is None, then the
4612
``submit`` or ``parent`` location is used, and a note is printed.
4614
:param tree: The working tree to select a branch for merging into
4615
:param location: The location entered by the user
4616
:param revision: The revision parameter to the command
4617
:param index: The index to use for the revision parameter. Negative
4618
indices are permitted.
4619
:return: (selected_location, user_location). The default location
4620
will be the user-entered location.
4622
if (revision is not None and index is not None
4623
and revision[index] is not None):
4624
branch = revision[index].get_branch()
4625
if branch is not None:
4626
return branch, branch
4627
if user_location is None:
4628
location = self._get_remembered(tree, 'Merging from')
4630
location = user_location
4631
return location, user_location
4633
def _get_remembered(self, tree, verb_string):
4634
"""Use tree.branch's parent if none was supplied.
4636
Report if the remembered location was used.
4638
stored_location = tree.branch.get_submit_branch()
4639
stored_location_type = "submit"
4640
if stored_location is None:
4641
stored_location = tree.branch.get_parent()
4642
stored_location_type = "parent"
4643
mutter("%s", stored_location)
4644
if stored_location is None:
4645
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4646
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4647
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4648
stored_location_type, display_url))
4649
return stored_location
4652
class cmd_remerge(Command):
4653
__doc__ = """Redo a merge.
4655
Use this if you want to try a different merge technique while resolving
4656
conflicts. Some merge techniques are better than others, and remerge
4657
lets you try different ones on different files.
4659
The options for remerge have the same meaning and defaults as the ones for
4660
merge. The difference is that remerge can (only) be run when there is a
4661
pending merge, and it lets you specify particular files.
4664
Re-do the merge of all conflicted files, and show the base text in
4665
conflict regions, in addition to the usual THIS and OTHER texts::
4667
bzr remerge --show-base
4669
Re-do the merge of "foobar", using the weave merge algorithm, with
4670
additional processing to reduce the size of conflict regions::
4672
bzr remerge --merge-type weave --reprocess foobar
4674
takes_args = ['file*']
4679
help="Show base revision text in conflicts."),
4682
def run(self, file_list=None, merge_type=None, show_base=False,
4684
from bzrlib.conflicts import restore
4685
if merge_type is None:
4686
merge_type = _mod_merge.Merge3Merger
4687
tree, file_list = WorkingTree.open_containing_paths(file_list)
4688
self.add_cleanup(tree.lock_write().unlock)
4689
parents = tree.get_parent_ids()
4690
if len(parents) != 2:
4691
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4692
" merges. Not cherrypicking or"
4694
repository = tree.branch.repository
4695
interesting_ids = None
4697
conflicts = tree.conflicts()
4698
if file_list is not None:
4699
interesting_ids = set()
4700
for filename in file_list:
4701
file_id = tree.path2id(filename)
4703
raise errors.NotVersionedError(filename)
4704
interesting_ids.add(file_id)
4705
if tree.kind(file_id) != "directory":
4708
# FIXME: Support nested trees
4709
for name, ie in tree.root_inventory.iter_entries(file_id):
4710
interesting_ids.add(ie.file_id)
4711
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4713
# Remerge only supports resolving contents conflicts
4714
allowed_conflicts = ('text conflict', 'contents conflict')
4715
restore_files = [c.path for c in conflicts
4716
if c.typestring in allowed_conflicts]
4717
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4718
tree.set_conflicts(ConflictList(new_conflicts))
4719
if file_list is not None:
4720
restore_files = file_list
4721
for filename in restore_files:
4723
restore(tree.abspath(filename))
4724
except errors.NotConflicted:
4726
# Disable pending merges, because the file texts we are remerging
4727
# have not had those merges performed. If we use the wrong parents
4728
# list, we imply that the working tree text has seen and rejected
4729
# all the changes from the other tree, when in fact those changes
4730
# have not yet been seen.
4731
tree.set_parent_ids(parents[:1])
4733
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4734
merger.interesting_ids = interesting_ids
4735
merger.merge_type = merge_type
4736
merger.show_base = show_base
4737
merger.reprocess = reprocess
4738
conflicts = merger.do_merge()
4740
tree.set_parent_ids(parents)
4747
class cmd_revert(Command):
4749
Set files in the working tree back to the contents of a previous revision.
4751
Giving a list of files will revert only those files. Otherwise, all files
4752
will be reverted. If the revision is not specified with '--revision', the
4753
working tree basis revision is used. A revert operation affects only the
4754
working tree, not any revision history like the branch and repository or
4755
the working tree basis revision.
4757
To remove only some changes, without reverting to a prior version, use
4758
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4759
will remove the changes introduced by the second last commit (-2), without
4760
affecting the changes introduced by the last commit (-1). To remove
4761
certain changes on a hunk-by-hunk basis, see the shelve command.
4762
To update the branch to a specific revision or the latest revision and
4763
update the working tree accordingly while preserving local changes, see the
4766
Uncommitted changes to files that are reverted will be discarded.
4767
Howver, by default, any files that have been manually changed will be
4768
backed up first. (Files changed only by merge are not backed up.) Backup
4769
files have '.~#~' appended to their name, where # is a number.
4771
When you provide files, you can use their current pathname or the pathname
4772
from the target revision. So you can use revert to "undelete" a file by
4773
name. If you name a directory, all the contents of that directory will be
4776
If you have newly added files since the target revision, they will be
4777
removed. If the files to be removed have been changed, backups will be
4778
created as above. Directories containing unknown files will not be
4781
The working tree contains a list of revisions that have been merged but
4782
not yet committed. These revisions will be included as additional parents
4783
of the next commit. Normally, using revert clears that list as well as
4784
reverting the files. If any files are specified, revert leaves the list
4785
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4786
.`` in the tree root to revert all files but keep the recorded merges,
4787
and ``bzr revert --forget-merges`` to clear the pending merge list without
4788
reverting any files.
4790
Using "bzr revert --forget-merges", it is possible to apply all of the
4791
changes from a branch in a single revision. To do this, perform the merge
4792
as desired. Then doing revert with the "--forget-merges" option will keep
4793
the content of the tree as it was, but it will clear the list of pending
4794
merges. The next commit will then contain all of the changes that are
4795
present in the other branch, but without any other parent revisions.
4796
Because this technique forgets where these changes originated, it may
4797
cause additional conflicts on later merges involving the same source and
4801
_see_also = ['cat', 'export', 'merge', 'shelve']
4804
Option('no-backup', "Do not save backups of reverted files."),
4805
Option('forget-merges',
4806
'Remove pending merge marker, without changing any files.'),
4808
takes_args = ['file*']
4810
def run(self, revision=None, no_backup=False, file_list=None,
4811
forget_merges=None):
4812
tree, file_list = WorkingTree.open_containing_paths(file_list)
4813
self.add_cleanup(tree.lock_tree_write().unlock)
4815
tree.set_parent_ids(tree.get_parent_ids()[:1])
4817
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4820
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4821
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4822
tree.revert(file_list, rev_tree, not no_backup, None,
4823
report_changes=True)
4826
class cmd_assert_fail(Command):
4827
__doc__ = """Test reporting of assertion failures"""
4828
# intended just for use in testing
4833
raise AssertionError("always fails")
4836
class cmd_help(Command):
4837
__doc__ = """Show help on a command or other topic.
4840
_see_also = ['topics']
4842
Option('long', 'Show help on all commands.'),
4844
takes_args = ['topic?']
4845
aliases = ['?', '--help', '-?', '-h']
4848
def run(self, topic=None, long=False):
4850
if topic is None and long:
4852
bzrlib.help.help(topic)
4855
class cmd_shell_complete(Command):
4856
__doc__ = """Show appropriate completions for context.
4858
For a list of all available commands, say 'bzr shell-complete'.
4860
takes_args = ['context?']
4865
def run(self, context=None):
4866
from bzrlib import shellcomplete
4867
shellcomplete.shellcomplete(context)
4870
class cmd_missing(Command):
4871
__doc__ = """Show unmerged/unpulled revisions between two branches.
4873
OTHER_BRANCH may be local or remote.
4875
To filter on a range of revisions, you can use the command -r begin..end
4876
-r revision requests a specific revision, -r ..end or -r begin.. are
4880
1 - some missing revisions
4881
0 - no missing revisions
4885
Determine the missing revisions between this and the branch at the
4886
remembered pull location::
4890
Determine the missing revisions between this and another branch::
4892
bzr missing http://server/branch
4894
Determine the missing revisions up to a specific revision on the other
4897
bzr missing -r ..-10
4899
Determine the missing revisions up to a specific revision on this
4902
bzr missing --my-revision ..-10
4905
_see_also = ['merge', 'pull']
4906
takes_args = ['other_branch?']
4909
Option('reverse', 'Reverse the order of revisions.'),
4911
'Display changes in the local branch only.'),
4912
Option('this' , 'Same as --mine-only.'),
4913
Option('theirs-only',
4914
'Display changes in the remote branch only.'),
4915
Option('other', 'Same as --theirs-only.'),
4919
custom_help('revision',
4920
help='Filter on other branch revisions (inclusive). '
4921
'See "help revisionspec" for details.'),
4922
Option('my-revision',
4923
type=_parse_revision_str,
4924
help='Filter on local branch revisions (inclusive). '
4925
'See "help revisionspec" for details.'),
4926
Option('include-merged',
4927
'Show all revisions in addition to the mainline ones.'),
4928
Option('include-merges', hidden=True,
4929
help='Historical alias for --include-merged.'),
4931
encoding_type = 'replace'
4934
def run(self, other_branch=None, reverse=False, mine_only=False,
4936
log_format=None, long=False, short=False, line=False,
4937
show_ids=False, verbose=False, this=False, other=False,
4938
include_merged=None, revision=None, my_revision=None,
4940
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4941
from bzrlib.missing import find_unmerged, iter_log_revisions
4946
if symbol_versioning.deprecated_passed(include_merges):
4947
ui.ui_factory.show_user_warning(
4948
'deprecated_command_option',
4949
deprecated_name='--include-merges',
4950
recommended_name='--include-merged',
4951
deprecated_in_version='2.5',
4952
command=self.invoked_as)
4953
if include_merged is None:
4954
include_merged = include_merges
4956
raise errors.BzrCommandError(gettext(
4957
'{0} and {1} are mutually exclusive').format(
4958
'--include-merges', '--include-merged'))
4959
if include_merged is None:
4960
include_merged = False
4965
# TODO: We should probably check that we don't have mine-only and
4966
# theirs-only set, but it gets complicated because we also have
4967
# this and other which could be used.
4974
local_branch = Branch.open_containing(directory)[0]
4975
self.add_cleanup(local_branch.lock_read().unlock)
4977
parent = local_branch.get_parent()
4978
if other_branch is None:
4979
other_branch = parent
4980
if other_branch is None:
4981
raise errors.BzrCommandError(gettext("No peer location known"
4983
display_url = urlutils.unescape_for_display(parent,
4985
message(gettext("Using saved parent location: {0}\n").format(
4988
remote_branch = Branch.open(other_branch)
4989
if remote_branch.base == local_branch.base:
4990
remote_branch = local_branch
4992
self.add_cleanup(remote_branch.lock_read().unlock)
4994
local_revid_range = _revision_range_to_revid_range(
4995
_get_revision_range(my_revision, local_branch,
4998
remote_revid_range = _revision_range_to_revid_range(
4999
_get_revision_range(revision,
5000
remote_branch, self.name()))
5002
local_extra, remote_extra = find_unmerged(
5003
local_branch, remote_branch, restrict,
5004
backward=not reverse,
5005
include_merged=include_merged,
5006
local_revid_range=local_revid_range,
5007
remote_revid_range=remote_revid_range)
5009
if log_format is None:
5010
registry = log.log_formatter_registry
5011
log_format = registry.get_default(local_branch)
5012
lf = log_format(to_file=self.outf,
5014
show_timezone='original')
5017
if local_extra and not theirs_only:
5018
message(ngettext("You have %d extra revision:\n",
5019
"You have %d extra revisions:\n",
5023
if local_branch.supports_tags():
5024
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5025
for revision in iter_log_revisions(local_extra,
5026
local_branch.repository,
5029
lf.log_revision(revision)
5030
printed_local = True
5033
printed_local = False
5035
if remote_extra and not mine_only:
5036
if printed_local is True:
5038
message(ngettext("You are missing %d revision:\n",
5039
"You are missing %d revisions:\n",
5040
len(remote_extra)) %
5042
if remote_branch.supports_tags():
5043
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5044
for revision in iter_log_revisions(remote_extra,
5045
remote_branch.repository,
5048
lf.log_revision(revision)
5051
if mine_only and not local_extra:
5052
# We checked local, and found nothing extra
5053
message(gettext('This branch has no new revisions.\n'))
5054
elif theirs_only and not remote_extra:
5055
# We checked remote, and found nothing extra
5056
message(gettext('Other branch has no new revisions.\n'))
5057
elif not (mine_only or theirs_only or local_extra or
5059
# We checked both branches, and neither one had extra
5061
message(gettext("Branches are up to date.\n"))
5063
if not status_code and parent is None and other_branch is not None:
5064
self.add_cleanup(local_branch.lock_write().unlock)
5065
# handle race conditions - a parent might be set while we run.
5066
if local_branch.get_parent() is None:
5067
local_branch.set_parent(remote_branch.base)
5071
class cmd_pack(Command):
5072
__doc__ = """Compress the data within a repository.
5074
This operation compresses the data within a bazaar repository. As
5075
bazaar supports automatic packing of repository, this operation is
5076
normally not required to be done manually.
5078
During the pack operation, bazaar takes a backup of existing repository
5079
data, i.e. pack files. This backup is eventually removed by bazaar
5080
automatically when it is safe to do so. To save disk space by removing
5081
the backed up pack files, the --clean-obsolete-packs option may be
5084
Warning: If you use --clean-obsolete-packs and your machine crashes
5085
during or immediately after repacking, you may be left with a state
5086
where the deletion has been written to disk but the new packs have not
5087
been. In this case the repository may be unusable.
5090
_see_also = ['repositories']
5091
takes_args = ['branch_or_repo?']
5093
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5096
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5097
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5099
branch = dir.open_branch()
5100
repository = branch.repository
5101
except errors.NotBranchError:
5102
repository = dir.open_repository()
5103
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5106
class cmd_plugins(Command):
5107
__doc__ = """List the installed plugins.
5109
This command displays the list of installed plugins including
5110
version of plugin and a short description of each.
5112
--verbose shows the path where each plugin is located.
5114
A plugin is an external component for Bazaar that extends the
5115
revision control system, by adding or replacing code in Bazaar.
5116
Plugins can do a variety of things, including overriding commands,
5117
adding new commands, providing additional network transports and
5118
customizing log output.
5120
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5121
for further information on plugins including where to find them and how to
5122
install them. Instructions are also provided there on how to write new
5123
plugins using the Python programming language.
5125
takes_options = ['verbose']
5128
def run(self, verbose=False):
5129
from bzrlib import plugin
5130
# Don't give writelines a generator as some codecs don't like that
5131
self.outf.writelines(
5132
list(plugin.describe_plugins(show_paths=verbose)))
5135
class cmd_testament(Command):
5136
__doc__ = """Show testament (signing-form) of a revision."""
5139
Option('long', help='Produce long-format testament.'),
5141
help='Produce a strict-format testament.')]
5142
takes_args = ['branch?']
5143
encoding_type = 'exact'
5145
def run(self, branch=u'.', revision=None, long=False, strict=False):
5146
from bzrlib.testament import Testament, StrictTestament
5148
testament_class = StrictTestament
5150
testament_class = Testament
5152
b = Branch.open_containing(branch)[0]
5154
b = Branch.open(branch)
5155
self.add_cleanup(b.lock_read().unlock)
5156
if revision is None:
5157
rev_id = b.last_revision()
5159
rev_id = revision[0].as_revision_id(b)
5160
t = testament_class.from_revision(b.repository, rev_id)
5162
self.outf.writelines(t.as_text_lines())
5164
self.outf.write(t.as_short_text())
5167
class cmd_annotate(Command):
5168
__doc__ = """Show the origin of each line in a file.
5170
This prints out the given file with an annotation on the left side
5171
indicating which revision, author and date introduced the change.
5173
If the origin is the same for a run of consecutive lines, it is
5174
shown only at the top, unless the --all option is given.
5176
# TODO: annotate directories; showing when each file was last changed
5177
# TODO: if the working copy is modified, show annotations on that
5178
# with new uncommitted lines marked
5179
aliases = ['ann', 'blame', 'praise']
5180
takes_args = ['filename']
5181
takes_options = [Option('all', help='Show annotations on all lines.'),
5182
Option('long', help='Show commit date in annotations.'),
5187
encoding_type = 'exact'
5190
def run(self, filename, all=False, long=False, revision=None,
5191
show_ids=False, directory=None):
5192
from bzrlib.annotate import (
5195
wt, branch, relpath = \
5196
_open_directory_or_containing_tree_or_branch(filename, directory)
5198
self.add_cleanup(wt.lock_read().unlock)
5200
self.add_cleanup(branch.lock_read().unlock)
5201
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5202
self.add_cleanup(tree.lock_read().unlock)
5203
if wt is not None and revision is None:
5204
file_id = wt.path2id(relpath)
5206
file_id = tree.path2id(relpath)
5208
raise errors.NotVersionedError(filename)
5209
if wt is not None and revision is None:
5210
# If there is a tree and we're not annotating historical
5211
# versions, annotate the working tree's content.
5212
annotate_file_tree(wt, file_id, self.outf, long, all,
5215
annotate_file_tree(tree, file_id, self.outf, long, all,
5216
show_ids=show_ids, branch=branch)
5219
class cmd_re_sign(Command):
5220
__doc__ = """Create a digital signature for an existing revision."""
5221
# TODO be able to replace existing ones.
5223
hidden = True # is this right ?
5224
takes_args = ['revision_id*']
5225
takes_options = ['directory', 'revision']
5227
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5228
if revision_id_list is not None and revision is not None:
5229
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5230
if revision_id_list is None and revision is None:
5231
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5232
b = WorkingTree.open_containing(directory)[0].branch
5233
self.add_cleanup(b.lock_write().unlock)
5234
return self._run(b, revision_id_list, revision)
5236
def _run(self, b, revision_id_list, revision):
5237
import bzrlib.gpg as gpg
5238
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5239
if revision_id_list is not None:
5240
b.repository.start_write_group()
5242
for revision_id in revision_id_list:
5243
b.repository.sign_revision(revision_id, gpg_strategy)
5245
b.repository.abort_write_group()
5248
b.repository.commit_write_group()
5249
elif revision is not None:
5250
if len(revision) == 1:
5251
revno, rev_id = revision[0].in_history(b)
5252
b.repository.start_write_group()
5254
b.repository.sign_revision(rev_id, gpg_strategy)
5256
b.repository.abort_write_group()
5259
b.repository.commit_write_group()
5260
elif len(revision) == 2:
5261
# are they both on rh- if so we can walk between them
5262
# might be nice to have a range helper for arbitrary
5263
# revision paths. hmm.
5264
from_revno, from_revid = revision[0].in_history(b)
5265
to_revno, to_revid = revision[1].in_history(b)
5266
if to_revid is None:
5267
to_revno = b.revno()
5268
if from_revno is None or to_revno is None:
5269
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5270
b.repository.start_write_group()
5272
for revno in range(from_revno, to_revno + 1):
5273
b.repository.sign_revision(b.get_rev_id(revno),
5276
b.repository.abort_write_group()
5279
b.repository.commit_write_group()
5281
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5284
class cmd_bind(Command):
5285
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5286
If no branch is supplied, rebind to the last bound location.
5288
Once converted into a checkout, commits must succeed on the master branch
5289
before they will be applied to the local branch.
5291
Bound branches use the nickname of its master branch unless it is set
5292
locally, in which case binding will update the local nickname to be
5296
_see_also = ['checkouts', 'unbind']
5297
takes_args = ['location?']
5298
takes_options = ['directory']
5300
def run(self, location=None, directory=u'.'):
5301
b, relpath = Branch.open_containing(directory)
5302
if location is None:
5304
location = b.get_old_bound_location()
5305
except errors.UpgradeRequired:
5306
raise errors.BzrCommandError(gettext('No location supplied. '
5307
'This format does not remember old locations.'))
5309
if location is None:
5310
if b.get_bound_location() is not None:
5311
raise errors.BzrCommandError(
5312
gettext('Branch is already bound'))
5314
raise errors.BzrCommandError(
5315
gettext('No location supplied'
5316
' and no previous location known'))
5317
b_other = Branch.open(location)
5320
except errors.DivergedBranches:
5321
raise errors.BzrCommandError(gettext('These branches have diverged.'
5322
' Try merging, and then bind again.'))
5323
if b.get_config().has_explicit_nickname():
5324
b.nick = b_other.nick
5327
class cmd_unbind(Command):
5328
__doc__ = """Convert the current checkout into a regular branch.
5330
After unbinding, the local branch is considered independent and subsequent
5331
commits will be local only.
5334
_see_also = ['checkouts', 'bind']
5336
takes_options = ['directory']
5338
def run(self, directory=u'.'):
5339
b, relpath = Branch.open_containing(directory)
5341
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5344
class cmd_uncommit(Command):
5345
__doc__ = """Remove the last committed revision.
5347
--verbose will print out what is being removed.
5348
--dry-run will go through all the motions, but not actually
5351
If --revision is specified, uncommit revisions to leave the branch at the
5352
specified revision. For example, "bzr uncommit -r 15" will leave the
5353
branch at revision 15.
5355
Uncommit leaves the working tree ready for a new commit. The only change
5356
it may make is to restore any pending merges that were present before
5360
# TODO: jam 20060108 Add an option to allow uncommit to remove
5361
# unreferenced information in 'branch-as-repository' branches.
5362
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5363
# information in shared branches as well.
5364
_see_also = ['commit']
5365
takes_options = ['verbose', 'revision',
5366
Option('dry-run', help='Don\'t actually make changes.'),
5367
Option('force', help='Say yes to all questions.'),
5369
help='Keep tags that point to removed revisions.'),
5371
help="Only remove the commits from the local branch"
5372
" when in a checkout."
5375
takes_args = ['location?']
5377
encoding_type = 'replace'
5379
def run(self, location=None, dry_run=False, verbose=False,
5380
revision=None, force=False, local=False, keep_tags=False):
5381
if location is None:
5383
control, relpath = controldir.ControlDir.open_containing(location)
5385
tree = control.open_workingtree()
5387
except (errors.NoWorkingTree, errors.NotLocalUrl):
5389
b = control.open_branch()
5391
if tree is not None:
5392
self.add_cleanup(tree.lock_write().unlock)
5394
self.add_cleanup(b.lock_write().unlock)
5395
return self._run(b, tree, dry_run, verbose, revision, force,
5398
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5400
from bzrlib.log import log_formatter, show_log
5401
from bzrlib.uncommit import uncommit
5403
last_revno, last_rev_id = b.last_revision_info()
5406
if revision is None:
5408
rev_id = last_rev_id
5410
# 'bzr uncommit -r 10' actually means uncommit
5411
# so that the final tree is at revno 10.
5412
# but bzrlib.uncommit.uncommit() actually uncommits
5413
# the revisions that are supplied.
5414
# So we need to offset it by one
5415
revno = revision[0].in_history(b).revno + 1
5416
if revno <= last_revno:
5417
rev_id = b.get_rev_id(revno)
5419
if rev_id is None or _mod_revision.is_null(rev_id):
5420
self.outf.write(gettext('No revisions to uncommit.\n'))
5423
lf = log_formatter('short',
5425
show_timezone='original')
5430
direction='forward',
5431
start_revision=revno,
5432
end_revision=last_revno)
5435
self.outf.write(gettext('Dry-run, pretending to remove'
5436
' the above revisions.\n'))
5438
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5441
if not ui.ui_factory.confirm_action(
5442
gettext(u'Uncommit these revisions'),
5443
'bzrlib.builtins.uncommit',
5445
self.outf.write(gettext('Canceled\n'))
5448
mutter('Uncommitting from {%s} to {%s}',
5449
last_rev_id, rev_id)
5450
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5451
revno=revno, local=local, keep_tags=keep_tags)
5452
self.outf.write(gettext('You can restore the old tip by running:\n'
5453
' bzr pull . -r revid:%s\n') % last_rev_id)
5456
class cmd_break_lock(Command):
5457
__doc__ = """Break a dead lock.
5459
This command breaks a lock on a repository, branch, working directory or
5462
CAUTION: Locks should only be broken when you are sure that the process
5463
holding the lock has been stopped.
5465
You can get information on what locks are open via the 'bzr info
5466
[location]' command.
5470
bzr break-lock bzr+ssh://example.com/bzr/foo
5471
bzr break-lock --conf ~/.bazaar
5474
takes_args = ['location?']
5477
help='LOCATION is the directory where the config lock is.'),
5479
help='Do not ask for confirmation before breaking the lock.'),
5482
def run(self, location=None, config=False, force=False):
5483
if location is None:
5486
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5488
{'bzrlib.lockdir.break': True})
5490
conf = _mod_config.LockableConfig(file_name=location)
5493
control, relpath = controldir.ControlDir.open_containing(location)
5495
control.break_lock()
5496
except NotImplementedError:
5500
class cmd_wait_until_signalled(Command):
5501
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5503
This just prints a line to signal when it is ready, then blocks on stdin.
5509
sys.stdout.write("running\n")
5511
sys.stdin.readline()
5514
class cmd_serve(Command):
5515
__doc__ = """Run the bzr server."""
5517
aliases = ['server']
5521
help='Serve on stdin/out for use from inetd or sshd.'),
5522
RegistryOption('protocol',
5523
help="Protocol to serve.",
5524
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5525
value_switches=True),
5527
help='Listen for connections on nominated address.', type=str),
5529
help='Listen for connections on nominated port. Passing 0 as '
5530
'the port number will result in a dynamically allocated '
5531
'port. The default port depends on the protocol.',
5533
custom_help('directory',
5534
help='Serve contents of this directory.'),
5535
Option('allow-writes',
5536
help='By default the server is a readonly server. Supplying '
5537
'--allow-writes enables write access to the contents of '
5538
'the served directory and below. Note that ``bzr serve`` '
5539
'does not perform authentication, so unless some form of '
5540
'external authentication is arranged supplying this '
5541
'option leads to global uncontrolled write access to your '
5544
Option('client-timeout', type=float,
5545
help='Override the default idle client timeout (5min).'),
5548
def run(self, listen=None, port=None, inet=False, directory=None,
5549
allow_writes=False, protocol=None, client_timeout=None):
5550
from bzrlib import transport
5551
if directory is None:
5552
directory = os.getcwd()
5553
if protocol is None:
5554
protocol = transport.transport_server_registry.get()
5555
url = transport.location_to_url(directory)
5556
if not allow_writes:
5557
url = 'readonly+' + url
5558
t = transport.get_transport_from_url(url)
5559
protocol(t, listen, port, inet, client_timeout)
5562
class cmd_join(Command):
5563
__doc__ = """Combine a tree into its containing tree.
5565
This command requires the target tree to be in a rich-root format.
5567
The TREE argument should be an independent tree, inside another tree, but
5568
not part of it. (Such trees can be produced by "bzr split", but also by
5569
running "bzr branch" with the target inside a tree.)
5571
The result is a combined tree, with the subtree no longer an independent
5572
part. This is marked as a merge of the subtree into the containing tree,
5573
and all history is preserved.
5576
_see_also = ['split']
5577
takes_args = ['tree']
5579
Option('reference', help='Join by reference.', hidden=True),
5582
def run(self, tree, reference=False):
5583
sub_tree = WorkingTree.open(tree)
5584
parent_dir = osutils.dirname(sub_tree.basedir)
5585
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5586
repo = containing_tree.branch.repository
5587
if not repo.supports_rich_root():
5588
raise errors.BzrCommandError(gettext(
5589
"Can't join trees because %s doesn't support rich root data.\n"
5590
"You can use bzr upgrade on the repository.")
5594
containing_tree.add_reference(sub_tree)
5595
except errors.BadReferenceTarget, e:
5596
# XXX: Would be better to just raise a nicely printable
5597
# exception from the real origin. Also below. mbp 20070306
5598
raise errors.BzrCommandError(
5599
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5602
containing_tree.subsume(sub_tree)
5603
except errors.BadSubsumeSource, e:
5604
raise errors.BzrCommandError(
5605
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5608
class cmd_split(Command):
5609
__doc__ = """Split a subdirectory of a tree into a separate tree.
5611
This command will produce a target tree in a format that supports
5612
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5613
converted into earlier formats like 'dirstate-tags'.
5615
The TREE argument should be a subdirectory of a working tree. That
5616
subdirectory will be converted into an independent tree, with its own
5617
branch. Commits in the top-level tree will not apply to the new subtree.
5620
_see_also = ['join']
5621
takes_args = ['tree']
5623
def run(self, tree):
5624
containing_tree, subdir = WorkingTree.open_containing(tree)
5625
sub_id = containing_tree.path2id(subdir)
5627
raise errors.NotVersionedError(subdir)
5629
containing_tree.extract(sub_id)
5630
except errors.RootNotRich:
5631
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5634
class cmd_merge_directive(Command):
5635
__doc__ = """Generate a merge directive for auto-merge tools.
5637
A directive requests a merge to be performed, and also provides all the
5638
information necessary to do so. This means it must either include a
5639
revision bundle, or the location of a branch containing the desired
5642
A submit branch (the location to merge into) must be supplied the first
5643
time the command is issued. After it has been supplied once, it will
5644
be remembered as the default.
5646
A public branch is optional if a revision bundle is supplied, but required
5647
if --diff or --plain is specified. It will be remembered as the default
5648
after the first use.
5651
takes_args = ['submit_branch?', 'public_branch?']
5655
_see_also = ['send']
5659
RegistryOption.from_kwargs('patch-type',
5660
'The type of patch to include in the directive.',
5662
value_switches=True,
5664
bundle='Bazaar revision bundle (default).',
5665
diff='Normal unified diff.',
5666
plain='No patch, just directive.'),
5667
Option('sign', help='GPG-sign the directive.'), 'revision',
5668
Option('mail-to', type=str,
5669
help='Instead of printing the directive, email to this address.'),
5670
Option('message', type=str, short_name='m',
5671
help='Message to use when committing this merge.')
5674
encoding_type = 'exact'
5676
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5677
sign=False, revision=None, mail_to=None, message=None,
5679
from bzrlib.revision import ensure_null, NULL_REVISION
5680
include_patch, include_bundle = {
5681
'plain': (False, False),
5682
'diff': (True, False),
5683
'bundle': (True, True),
5685
branch = Branch.open(directory)
5686
stored_submit_branch = branch.get_submit_branch()
5687
if submit_branch is None:
5688
submit_branch = stored_submit_branch
5690
if stored_submit_branch is None:
5691
branch.set_submit_branch(submit_branch)
5692
if submit_branch is None:
5693
submit_branch = branch.get_parent()
5694
if submit_branch is None:
5695
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5697
stored_public_branch = branch.get_public_branch()
5698
if public_branch is None:
5699
public_branch = stored_public_branch
5700
elif stored_public_branch is None:
5701
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5702
branch.set_public_branch(public_branch)
5703
if not include_bundle and public_branch is None:
5704
raise errors.BzrCommandError(gettext('No public branch specified or'
5706
base_revision_id = None
5707
if revision is not None:
5708
if len(revision) > 2:
5709
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5710
'at most two one revision identifiers'))
5711
revision_id = revision[-1].as_revision_id(branch)
5712
if len(revision) == 2:
5713
base_revision_id = revision[0].as_revision_id(branch)
5715
revision_id = branch.last_revision()
5716
revision_id = ensure_null(revision_id)
5717
if revision_id == NULL_REVISION:
5718
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5719
directive = merge_directive.MergeDirective2.from_objects(
5720
branch.repository, revision_id, time.time(),
5721
osutils.local_time_offset(), submit_branch,
5722
public_branch=public_branch, include_patch=include_patch,
5723
include_bundle=include_bundle, message=message,
5724
base_revision_id=base_revision_id)
5727
self.outf.write(directive.to_signed(branch))
5729
self.outf.writelines(directive.to_lines())
5731
message = directive.to_email(mail_to, branch, sign)
5732
s = SMTPConnection(branch.get_config_stack())
5733
s.send_email(message)
5736
class cmd_send(Command):
5737
__doc__ = """Mail or create a merge-directive for submitting changes.
5739
A merge directive provides many things needed for requesting merges:
5741
* A machine-readable description of the merge to perform
5743
* An optional patch that is a preview of the changes requested
5745
* An optional bundle of revision data, so that the changes can be applied
5746
directly from the merge directive, without retrieving data from a
5749
`bzr send` creates a compact data set that, when applied using bzr
5750
merge, has the same effect as merging from the source branch.
5752
By default the merge directive is self-contained and can be applied to any
5753
branch containing submit_branch in its ancestory without needing access to
5756
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5757
revisions, but only a structured request to merge from the
5758
public_location. In that case the public_branch is needed and it must be
5759
up-to-date and accessible to the recipient. The public_branch is always
5760
included if known, so that people can check it later.
5762
The submit branch defaults to the parent of the source branch, but can be
5763
overridden. Both submit branch and public branch will be remembered in
5764
branch.conf the first time they are used for a particular branch. The
5765
source branch defaults to that containing the working directory, but can
5766
be changed using --from.
5768
Both the submit branch and the public branch follow the usual behavior with
5769
respect to --remember: If there is no default location set, the first send
5770
will set it (use --no-remember to avoid setting it). After that, you can
5771
omit the location to use the default. To change the default, use
5772
--remember. The value will only be saved if the location can be accessed.
5774
In order to calculate those changes, bzr must analyse the submit branch.
5775
Therefore it is most efficient for the submit branch to be a local mirror.
5776
If a public location is known for the submit_branch, that location is used
5777
in the merge directive.
5779
The default behaviour is to send the merge directive by mail, unless -o is
5780
given, in which case it is sent to a file.
5782
Mail is sent using your preferred mail program. This should be transparent
5783
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5784
If the preferred client can't be found (or used), your editor will be used.
5786
To use a specific mail program, set the mail_client configuration option.
5787
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5788
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5789
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5790
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5793
If mail is being sent, a to address is required. This can be supplied
5794
either on the commandline, by setting the submit_to configuration
5795
option in the branch itself or the child_submit_to configuration option
5796
in the submit branch.
5798
Two formats are currently supported: "4" uses revision bundle format 4 and
5799
merge directive format 2. It is significantly faster and smaller than
5800
older formats. It is compatible with Bazaar 0.19 and later. It is the
5801
default. "0.9" uses revision bundle format 0.9 and merge directive
5802
format 1. It is compatible with Bazaar 0.12 - 0.18.
5804
The merge directives created by bzr send may be applied using bzr merge or
5805
bzr pull by specifying a file containing a merge directive as the location.
5807
bzr send makes extensive use of public locations to map local locations into
5808
URLs that can be used by other people. See `bzr help configuration` to
5809
set them, and use `bzr info` to display them.
5812
encoding_type = 'exact'
5814
_see_also = ['merge', 'pull']
5816
takes_args = ['submit_branch?', 'public_branch?']
5820
help='Do not include a bundle in the merge directive.'),
5821
Option('no-patch', help='Do not include a preview patch in the merge'
5824
help='Remember submit and public branch.'),
5826
help='Branch to generate the submission from, '
5827
'rather than the one containing the working directory.',
5830
Option('output', short_name='o',
5831
help='Write merge directive to this file or directory; '
5832
'use - for stdout.',
5835
help='Refuse to send if there are uncommitted changes in'
5836
' the working tree, --no-strict disables the check.'),
5837
Option('mail-to', help='Mail the request to this address.',
5841
Option('body', help='Body for the email.', type=unicode),
5842
RegistryOption('format',
5843
help='Use the specified output format.',
5844
lazy_registry=('bzrlib.send', 'format_registry')),
5847
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5848
no_patch=False, revision=None, remember=None, output=None,
5849
format=None, mail_to=None, message=None, body=None,
5850
strict=None, **kwargs):
5851
from bzrlib.send import send
5852
return send(submit_branch, revision, public_branch, remember,
5853
format, no_bundle, no_patch, output,
5854
kwargs.get('from', '.'), mail_to, message, body,
5859
class cmd_bundle_revisions(cmd_send):
5860
__doc__ = """Create a merge-directive for submitting changes.
5862
A merge directive provides many things needed for requesting merges:
5864
* A machine-readable description of the merge to perform
5866
* An optional patch that is a preview of the changes requested
5868
* An optional bundle of revision data, so that the changes can be applied
5869
directly from the merge directive, without retrieving data from a
5872
If --no-bundle is specified, then public_branch is needed (and must be
5873
up-to-date), so that the receiver can perform the merge using the
5874
public_branch. The public_branch is always included if known, so that
5875
people can check it later.
5877
The submit branch defaults to the parent, but can be overridden. Both
5878
submit branch and public branch will be remembered if supplied.
5880
If a public_branch is known for the submit_branch, that public submit
5881
branch is used in the merge instructions. This means that a local mirror
5882
can be used as your actual submit branch, once you have set public_branch
5885
Two formats are currently supported: "4" uses revision bundle format 4 and
5886
merge directive format 2. It is significantly faster and smaller than
5887
older formats. It is compatible with Bazaar 0.19 and later. It is the
5888
default. "0.9" uses revision bundle format 0.9 and merge directive
5889
format 1. It is compatible with Bazaar 0.12 - 0.18.
5894
help='Do not include a bundle in the merge directive.'),
5895
Option('no-patch', help='Do not include a preview patch in the merge'
5898
help='Remember submit and public branch.'),
5900
help='Branch to generate the submission from, '
5901
'rather than the one containing the working directory.',
5904
Option('output', short_name='o', help='Write directive to this file.',
5907
help='Refuse to bundle revisions if there are uncommitted'
5908
' changes in the working tree, --no-strict disables the check.'),
5910
RegistryOption('format',
5911
help='Use the specified output format.',
5912
lazy_registry=('bzrlib.send', 'format_registry')),
5914
aliases = ['bundle']
5916
_see_also = ['send', 'merge']
5920
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5921
no_patch=False, revision=None, remember=False, output=None,
5922
format=None, strict=None, **kwargs):
5925
from bzrlib.send import send
5926
return send(submit_branch, revision, public_branch, remember,
5927
format, no_bundle, no_patch, output,
5928
kwargs.get('from', '.'), None, None, None,
5929
self.outf, strict=strict)
5932
class cmd_tag(Command):
5933
__doc__ = """Create, remove or modify a tag naming a revision.
5935
Tags give human-meaningful names to revisions. Commands that take a -r
5936
(--revision) option can be given -rtag:X, where X is any previously
5939
Tags are stored in the branch. Tags are copied from one branch to another
5940
along when you branch, push, pull or merge.
5942
It is an error to give a tag name that already exists unless you pass
5943
--force, in which case the tag is moved to point to the new revision.
5945
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5946
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5948
If no tag name is specified it will be determined through the
5949
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5950
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5954
_see_also = ['commit', 'tags']
5955
takes_args = ['tag_name?']
5958
help='Delete this tag rather than placing it.',
5960
custom_help('directory',
5961
help='Branch in which to place the tag.'),
5963
help='Replace existing tags.',
5968
def run(self, tag_name=None,
5974
branch, relpath = Branch.open_containing(directory)
5975
self.add_cleanup(branch.lock_write().unlock)
5977
if tag_name is None:
5978
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5979
branch.tags.delete_tag(tag_name)
5980
note(gettext('Deleted tag %s.') % tag_name)
5983
if len(revision) != 1:
5984
raise errors.BzrCommandError(gettext(
5985
"Tags can only be placed on a single revision, "
5987
revision_id = revision[0].as_revision_id(branch)
5989
revision_id = branch.last_revision()
5990
if tag_name is None:
5991
tag_name = branch.automatic_tag_name(revision_id)
5992
if tag_name is None:
5993
raise errors.BzrCommandError(gettext(
5994
"Please specify a tag name."))
5996
existing_target = branch.tags.lookup_tag(tag_name)
5997
except errors.NoSuchTag:
5998
existing_target = None
5999
if not force and existing_target not in (None, revision_id):
6000
raise errors.TagAlreadyExists(tag_name)
6001
if existing_target == revision_id:
6002
note(gettext('Tag %s already exists for that revision.') % tag_name)
6004
branch.tags.set_tag(tag_name, revision_id)
6005
if existing_target is None:
6006
note(gettext('Created tag %s.') % tag_name)
6008
note(gettext('Updated tag %s.') % tag_name)
6011
class cmd_tags(Command):
6012
__doc__ = """List tags.
6014
This command shows a table of tag names and the revisions they reference.
6019
custom_help('directory',
6020
help='Branch whose tags should be displayed.'),
6021
RegistryOption('sort',
6022
'Sort tags by different criteria.', title='Sorting',
6023
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
6030
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6031
from bzrlib.tag import tag_sort_methods
6032
branch, relpath = Branch.open_containing(directory)
6034
tags = branch.tags.get_tag_dict().items()
6038
self.add_cleanup(branch.lock_read().unlock)
6040
# Restrict to the specified range
6041
tags = self._tags_for_range(branch, revision)
6043
sort = tag_sort_methods.get()
6046
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6047
for index, (tag, revid) in enumerate(tags):
6049
revno = branch.revision_id_to_dotted_revno(revid)
6050
if isinstance(revno, tuple):
6051
revno = '.'.join(map(str, revno))
6052
except (errors.NoSuchRevision,
6053
errors.GhostRevisionsHaveNoRevno,
6054
errors.UnsupportedOperation):
6055
# Bad tag data/merges can lead to tagged revisions
6056
# which are not in this branch. Fail gracefully ...
6058
tags[index] = (tag, revno)
6060
for tag, revspec in tags:
6061
self.outf.write('%-20s %s\n' % (tag, revspec))
6063
def _tags_for_range(self, branch, revision):
6065
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6066
revid1, revid2 = rev1.rev_id, rev2.rev_id
6067
# _get_revision_range will always set revid2 if it's not specified.
6068
# If revid1 is None, it means we want to start from the branch
6069
# origin which is always a valid ancestor. If revid1 == revid2, the
6070
# ancestry check is useless.
6071
if revid1 and revid1 != revid2:
6072
# FIXME: We really want to use the same graph than
6073
# branch.iter_merge_sorted_revisions below, but this is not
6074
# easily available -- vila 2011-09-23
6075
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6076
# We don't want to output anything in this case...
6078
# only show revisions between revid1 and revid2 (inclusive)
6079
tagged_revids = branch.tags.get_reverse_tag_dict()
6081
for r in branch.iter_merge_sorted_revisions(
6082
start_revision_id=revid2, stop_revision_id=revid1,
6083
stop_rule='include'):
6084
revid_tags = tagged_revids.get(r[0], None)
6086
found.extend([(tag, r[0]) for tag in revid_tags])
6090
class cmd_reconfigure(Command):
6091
__doc__ = """Reconfigure the type of a bzr directory.
6093
A target configuration must be specified.
6095
For checkouts, the bind-to location will be auto-detected if not specified.
6096
The order of preference is
6097
1. For a lightweight checkout, the current bound location.
6098
2. For branches that used to be checkouts, the previously-bound location.
6099
3. The push location.
6100
4. The parent location.
6101
If none of these is available, --bind-to must be specified.
6104
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6105
takes_args = ['location?']
6107
RegistryOption.from_kwargs(
6110
help='The relation between branch and tree.',
6111
value_switches=True, enum_switch=False,
6112
branch='Reconfigure to be an unbound branch with no working tree.',
6113
tree='Reconfigure to be an unbound branch with a working tree.',
6114
checkout='Reconfigure to be a bound branch with a working tree.',
6115
lightweight_checkout='Reconfigure to be a lightweight'
6116
' checkout (with no local history).',
6118
RegistryOption.from_kwargs(
6120
title='Repository type',
6121
help='Location fo the repository.',
6122
value_switches=True, enum_switch=False,
6123
standalone='Reconfigure to be a standalone branch '
6124
'(i.e. stop using shared repository).',
6125
use_shared='Reconfigure to use a shared repository.',
6127
RegistryOption.from_kwargs(
6129
title='Trees in Repository',
6130
help='Whether new branches in the repository have trees.',
6131
value_switches=True, enum_switch=False,
6132
with_trees='Reconfigure repository to create '
6133
'working trees on branches by default.',
6134
with_no_trees='Reconfigure repository to not create '
6135
'working trees on branches by default.'
6137
Option('bind-to', help='Branch to bind checkout to.', type=str),
6139
help='Perform reconfiguration even if local changes'
6141
Option('stacked-on',
6142
help='Reconfigure a branch to be stacked on another branch.',
6146
help='Reconfigure a branch to be unstacked. This '
6147
'may require copying substantial data into it.',
6151
def run(self, location=None, bind_to=None, force=False,
6152
tree_type=None, repository_type=None, repository_trees=None,
6153
stacked_on=None, unstacked=None):
6154
directory = controldir.ControlDir.open(location)
6155
if stacked_on and unstacked:
6156
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6157
elif stacked_on is not None:
6158
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6160
reconfigure.ReconfigureUnstacked().apply(directory)
6161
# At the moment you can use --stacked-on and a different
6162
# reconfiguration shape at the same time; there seems no good reason
6164
if (tree_type is None and
6165
repository_type is None and
6166
repository_trees is None):
6167
if stacked_on or unstacked:
6170
raise errors.BzrCommandError(gettext('No target configuration '
6172
reconfiguration = None
6173
if tree_type == 'branch':
6174
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6175
elif tree_type == 'tree':
6176
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6177
elif tree_type == 'checkout':
6178
reconfiguration = reconfigure.Reconfigure.to_checkout(
6180
elif tree_type == 'lightweight-checkout':
6181
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6184
reconfiguration.apply(force)
6185
reconfiguration = None
6186
if repository_type == 'use-shared':
6187
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6188
elif repository_type == 'standalone':
6189
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6191
reconfiguration.apply(force)
6192
reconfiguration = None
6193
if repository_trees == 'with-trees':
6194
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6196
elif repository_trees == 'with-no-trees':
6197
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6200
reconfiguration.apply(force)
6201
reconfiguration = None
6204
class cmd_switch(Command):
6205
__doc__ = """Set the branch of a checkout and update.
6207
For lightweight checkouts, this changes the branch being referenced.
6208
For heavyweight checkouts, this checks that there are no local commits
6209
versus the current bound branch, then it makes the local branch a mirror
6210
of the new location and binds to it.
6212
In both cases, the working tree is updated and uncommitted changes
6213
are merged. The user can commit or revert these as they desire.
6215
Pending merges need to be committed or reverted before using switch.
6217
The path to the branch to switch to can be specified relative to the parent
6218
directory of the current branch. For example, if you are currently in a
6219
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6222
Bound branches use the nickname of its master branch unless it is set
6223
locally, in which case switching will update the local nickname to be
6227
takes_args = ['to_location?']
6228
takes_options = ['directory',
6230
help='Switch even if local commits will be lost.'),
6232
Option('create-branch', short_name='b',
6233
help='Create the target branch from this one before'
6234
' switching to it.'),
6236
help='Store and restore uncommitted changes in the'
6240
def run(self, to_location=None, force=False, create_branch=False,
6241
revision=None, directory=u'.', store=False):
6242
from bzrlib import switch
6243
tree_location = directory
6244
revision = _get_one_revision('switch', revision)
6245
possible_transports = []
6246
control_dir = controldir.ControlDir.open_containing(tree_location,
6247
possible_transports=possible_transports)[0]
6248
if to_location is None:
6249
if revision is None:
6250
raise errors.BzrCommandError(gettext('You must supply either a'
6251
' revision or a location'))
6252
to_location = tree_location
6254
branch = control_dir.open_branch(
6255
possible_transports=possible_transports)
6256
had_explicit_nick = branch.get_config().has_explicit_nickname()
6257
except errors.NotBranchError:
6259
had_explicit_nick = False
6262
raise errors.BzrCommandError(
6263
gettext('cannot create branch without source branch'))
6264
to_location = lookup_new_sibling_branch(control_dir, to_location,
6265
possible_transports=possible_transports)
6266
to_branch = branch.bzrdir.sprout(to_location,
6267
possible_transports=possible_transports,
6268
source_branch=branch).open_branch()
6271
to_branch = Branch.open(to_location,
6272
possible_transports=possible_transports)
6273
except errors.NotBranchError:
6274
to_branch = open_sibling_branch(control_dir, to_location,
6275
possible_transports=possible_transports)
6276
if revision is not None:
6277
revision = revision.as_revision_id(to_branch)
6278
switch.switch(control_dir, to_branch, force, revision_id=revision,
6279
store_uncommitted=store)
6280
if had_explicit_nick:
6281
branch = control_dir.open_branch() #get the new branch!
6282
branch.nick = to_branch.nick
6283
note(gettext('Switched to branch: %s'),
6284
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6288
class cmd_view(Command):
6289
__doc__ = """Manage filtered views.
6291
Views provide a mask over the tree so that users can focus on
6292
a subset of a tree when doing their work. After creating a view,
6293
commands that support a list of files - status, diff, commit, etc -
6294
effectively have that list of files implicitly given each time.
6295
An explicit list of files can still be given but those files
6296
must be within the current view.
6298
In most cases, a view has a short life-span: it is created to make
6299
a selected change and is deleted once that change is committed.
6300
At other times, you may wish to create one or more named views
6301
and switch between them.
6303
To disable the current view without deleting it, you can switch to
6304
the pseudo view called ``off``. This can be useful when you need
6305
to see the whole tree for an operation or two (e.g. merge) but
6306
want to switch back to your view after that.
6309
To define the current view::
6311
bzr view file1 dir1 ...
6313
To list the current view::
6317
To delete the current view::
6321
To disable the current view without deleting it::
6323
bzr view --switch off
6325
To define a named view and switch to it::
6327
bzr view --name view-name file1 dir1 ...
6329
To list a named view::
6331
bzr view --name view-name
6333
To delete a named view::
6335
bzr view --name view-name --delete
6337
To switch to a named view::
6339
bzr view --switch view-name
6341
To list all views defined::
6345
To delete all views::
6347
bzr view --delete --all
6351
takes_args = ['file*']
6354
help='Apply list or delete action to all views.',
6357
help='Delete the view.',
6360
help='Name of the view to define, list or delete.',
6364
help='Name of the view to switch to.',
6369
def run(self, file_list,
6375
tree, file_list = WorkingTree.open_containing_paths(file_list,
6377
current_view, view_dict = tree.views.get_view_info()
6382
raise errors.BzrCommandError(gettext(
6383
"Both --delete and a file list specified"))
6385
raise errors.BzrCommandError(gettext(
6386
"Both --delete and --switch specified"))
6388
tree.views.set_view_info(None, {})
6389
self.outf.write(gettext("Deleted all views.\n"))
6391
raise errors.BzrCommandError(gettext("No current view to delete"))
6393
tree.views.delete_view(name)
6394
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6397
raise errors.BzrCommandError(gettext(
6398
"Both --switch and a file list specified"))
6400
raise errors.BzrCommandError(gettext(
6401
"Both --switch and --all specified"))
6402
elif switch == 'off':
6403
if current_view is None:
6404
raise errors.BzrCommandError(gettext("No current view to disable"))
6405
tree.views.set_view_info(None, view_dict)
6406
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6408
tree.views.set_view_info(switch, view_dict)
6409
view_str = views.view_display_str(tree.views.lookup_view())
6410
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6413
self.outf.write(gettext('Views defined:\n'))
6414
for view in sorted(view_dict):
6415
if view == current_view:
6419
view_str = views.view_display_str(view_dict[view])
6420
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6422
self.outf.write(gettext('No views defined.\n'))
6425
# No name given and no current view set
6428
raise errors.BzrCommandError(gettext(
6429
"Cannot change the 'off' pseudo view"))
6430
tree.views.set_view(name, sorted(file_list))
6431
view_str = views.view_display_str(tree.views.lookup_view())
6432
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6436
# No name given and no current view set
6437
self.outf.write(gettext('No current view.\n'))
6439
view_str = views.view_display_str(tree.views.lookup_view(name))
6440
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6443
class cmd_hooks(Command):
6444
__doc__ = """Show hooks."""
6449
for hook_key in sorted(hooks.known_hooks.keys()):
6450
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6451
self.outf.write("%s:\n" % type(some_hooks).__name__)
6452
for hook_name, hook_point in sorted(some_hooks.items()):
6453
self.outf.write(" %s:\n" % (hook_name,))
6454
found_hooks = list(hook_point)
6456
for hook in found_hooks:
6457
self.outf.write(" %s\n" %
6458
(some_hooks.get_hook_name(hook),))
6460
self.outf.write(gettext(" <no hooks installed>\n"))
6463
class cmd_remove_branch(Command):
6464
__doc__ = """Remove a branch.
6466
This will remove the branch from the specified location but
6467
will keep any working tree or repository in place.
6471
Remove the branch at repo/trunk::
6473
bzr remove-branch repo/trunk
6477
takes_args = ["location?"]
6479
takes_options = ['directory',
6480
Option('force', help='Remove branch even if it is the active branch.')]
6482
aliases = ["rmbranch"]
6484
def run(self, directory=None, location=None, force=False):
6485
br = open_nearby_branch(near=directory, location=location)
6486
if not force and br.bzrdir.has_workingtree():
6488
active_branch = br.bzrdir.open_branch(name="")
6489
except errors.NotBranchError:
6490
active_branch = None
6491
if (active_branch is not None and
6492
br.control_url == active_branch.control_url):
6493
raise errors.BzrCommandError(
6494
gettext("Branch is active. Use --force to remove it."))
6495
br.bzrdir.destroy_branch(br.name)
6498
class cmd_shelve(Command):
6499
__doc__ = """Temporarily set aside some changes from the current tree.
6501
Shelve allows you to temporarily put changes you've made "on the shelf",
6502
ie. out of the way, until a later time when you can bring them back from
6503
the shelf with the 'unshelve' command. The changes are stored alongside
6504
your working tree, and so they aren't propagated along with your branch nor
6505
will they survive its deletion.
6507
If shelve --list is specified, previously-shelved changes are listed.
6509
Shelve is intended to help separate several sets of changes that have
6510
been inappropriately mingled. If you just want to get rid of all changes
6511
and you don't need to restore them later, use revert. If you want to
6512
shelve all text changes at once, use shelve --all.
6514
If filenames are specified, only the changes to those files will be
6515
shelved. Other files will be left untouched.
6517
If a revision is specified, changes since that revision will be shelved.
6519
You can put multiple items on the shelf, and by default, 'unshelve' will
6520
restore the most recently shelved changes.
6522
For complicated changes, it is possible to edit the changes in a separate
6523
editor program to decide what the file remaining in the working copy
6524
should look like. To do this, add the configuration option
6526
change_editor = PROGRAM @new_path @old_path
6528
where @new_path is replaced with the path of the new version of the
6529
file and @old_path is replaced with the path of the old version of
6530
the file. The PROGRAM should save the new file with the desired
6531
contents of the file in the working tree.
6535
takes_args = ['file*']
6540
Option('all', help='Shelve all changes.'),
6542
RegistryOption('writer', 'Method to use for writing diffs.',
6543
bzrlib.option.diff_writer_registry,
6544
value_switches=True, enum_switch=False),
6546
Option('list', help='List shelved changes.'),
6548
help='Destroy removed changes instead of shelving them.'),
6550
_see_also = ['unshelve', 'configuration']
6552
def run(self, revision=None, all=False, file_list=None, message=None,
6553
writer=None, list=False, destroy=False, directory=None):
6555
return self.run_for_list(directory=directory)
6556
from bzrlib.shelf_ui import Shelver
6558
writer = bzrlib.option.diff_writer_registry.get()
6560
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6561
file_list, message, destroy=destroy, directory=directory)
6566
except errors.UserAbort:
6569
def run_for_list(self, directory=None):
6570
if directory is None:
6572
tree = WorkingTree.open_containing(directory)[0]
6573
self.add_cleanup(tree.lock_read().unlock)
6574
manager = tree.get_shelf_manager()
6575
shelves = manager.active_shelves()
6576
if len(shelves) == 0:
6577
note(gettext('No shelved changes.'))
6579
for shelf_id in reversed(shelves):
6580
message = manager.get_metadata(shelf_id).get('message')
6582
message = '<no message>'
6583
self.outf.write('%3d: %s\n' % (shelf_id, message))
6587
class cmd_unshelve(Command):
6588
__doc__ = """Restore shelved changes.
6590
By default, the most recently shelved changes are restored. However if you
6591
specify a shelf by id those changes will be restored instead. This works
6592
best when the changes don't depend on each other.
6595
takes_args = ['shelf_id?']
6598
RegistryOption.from_kwargs(
6599
'action', help="The action to perform.",
6600
enum_switch=False, value_switches=True,
6601
apply="Apply changes and remove from the shelf.",
6602
dry_run="Show changes, but do not apply or remove them.",
6603
preview="Instead of unshelving the changes, show the diff that "
6604
"would result from unshelving.",
6605
delete_only="Delete changes without applying them.",
6606
keep="Apply changes but don't delete them.",
6609
_see_also = ['shelve']
6611
def run(self, shelf_id=None, action='apply', directory=u'.'):
6612
from bzrlib.shelf_ui import Unshelver
6613
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6617
unshelver.tree.unlock()
6620
class cmd_clean_tree(Command):
6621
__doc__ = """Remove unwanted files from working tree.
6623
By default, only unknown files, not ignored files, are deleted. Versioned
6624
files are never deleted.
6626
Another class is 'detritus', which includes files emitted by bzr during
6627
normal operations and selftests. (The value of these files decreases with
6630
If no options are specified, unknown files are deleted. Otherwise, option
6631
flags are respected, and may be combined.
6633
To check what clean-tree will do, use --dry-run.
6635
takes_options = ['directory',
6636
Option('ignored', help='Delete all ignored files.'),
6637
Option('detritus', help='Delete conflict files, merge and revert'
6638
' backups, and failed selftest dirs.'),
6640
help='Delete files unknown to bzr (default).'),
6641
Option('dry-run', help='Show files to delete instead of'
6643
Option('force', help='Do not prompt before deleting.')]
6644
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6645
force=False, directory=u'.'):
6646
from bzrlib.clean_tree import clean_tree
6647
if not (unknown or ignored or detritus):
6651
clean_tree(directory, unknown=unknown, ignored=ignored,
6652
detritus=detritus, dry_run=dry_run, no_prompt=force)
6655
class cmd_reference(Command):
6656
__doc__ = """list, view and set branch locations for nested trees.
6658
If no arguments are provided, lists the branch locations for nested trees.
6659
If one argument is provided, display the branch location for that tree.
6660
If two arguments are provided, set the branch location for that tree.
6665
takes_args = ['path?', 'location?']
6667
def run(self, path=None, location=None):
6669
if path is not None:
6671
tree, branch, relpath =(
6672
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6673
if path is not None:
6676
tree = branch.basis_tree()
6678
info = branch._get_all_reference_info().iteritems()
6679
self._display_reference_info(tree, branch, info)
6681
file_id = tree.path2id(path)
6683
raise errors.NotVersionedError(path)
6684
if location is None:
6685
info = [(file_id, branch.get_reference_info(file_id))]
6686
self._display_reference_info(tree, branch, info)
6688
branch.set_reference_info(file_id, path, location)
6690
def _display_reference_info(self, tree, branch, info):
6692
for file_id, (path, location) in info:
6694
path = tree.id2path(file_id)
6695
except errors.NoSuchId:
6697
ref_list.append((path, location))
6698
for path, location in sorted(ref_list):
6699
self.outf.write('%s %s\n' % (path, location))
6702
class cmd_export_pot(Command):
6703
__doc__ = """Export command helps and error messages in po format."""
6706
takes_options = [Option('plugin',
6707
help='Export help text from named command '\
6708
'(defaults to all built in commands).',
6710
Option('include-duplicates',
6711
help='Output multiple copies of the same msgid '
6712
'string if it appears more than once.'),
6715
def run(self, plugin=None, include_duplicates=False):
6716
from bzrlib.export_pot import export_pot
6717
export_pot(self.outf, plugin, include_duplicates)
6720
def _register_lazy_builtins():
6721
# register lazy builtins from other modules; called at startup and should
6722
# be only called once.
6723
for (name, aliases, module_name) in [
6724
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6725
('cmd_config', [], 'bzrlib.config'),
6726
('cmd_dpush', [], 'bzrlib.foreign'),
6727
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6728
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6729
('cmd_conflicts', [], 'bzrlib.conflicts'),
6730
('cmd_ping', [], 'bzrlib.smart.ping'),
6731
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6732
('cmd_verify_signatures', [], 'bzrlib.commit_signature_commands'),
6733
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6735
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
