1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
19
from __future__ import absolute_import
25
from bzrlib import lazy_import
26
lazy_import.lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
59
from bzrlib.branch import Branch
60
from bzrlib.conflicts import ConflictList
61
from bzrlib.transport import memory
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
63
from bzrlib.smtp_connection import SMTPConnection
64
from bzrlib.workingtree import WorkingTree
65
from bzrlib.i18n import gettext, ngettext
68
from bzrlib.commands import (
70
builtin_command_registry,
73
from bzrlib.option import (
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
86
def _get_branch_location(control_dir):
87
"""Return location of branch for this control dir."""
89
this_branch = control_dir.open_branch()
90
# This may be a heavy checkout, where we want the master branch
91
master_location = this_branch.get_bound_location()
92
if master_location is not None:
93
return master_location
94
# If not, use a local sibling
95
return this_branch.base
96
except errors.NotBranchError:
97
format = control_dir.find_branch_format()
98
if getattr(format, 'get_reference', None) is not None:
99
return format.get_reference(control_dir)
101
return control_dir.root_transport.base
104
def lookup_new_sibling_branch(control_dir, location):
105
"""Lookup the location for a new sibling branch.
107
:param control_dir: Control directory relative to which to look up
109
:param location: Name of the new branch
110
:return: Full location to the new branch
112
location = directory_service.directories.dereference(location)
113
if '/' not in location and '\\' not in location:
114
# This path is meant to be relative to the existing branch
115
this_url = _get_branch_location(control_dir)
116
# Perhaps the target control dir supports colocated branches?
118
root = controldir.ControlDir.open(this_url,
119
possible_transports=[control_dir.user_transport])
120
except errors.NotBranchError:
123
colocated = root._format.colocated_branches
126
return urlutils.join_segment_parameters(this_url,
127
{"branch": urlutils.escape(location)})
129
return urlutils.join(this_url, '..', urlutils.escape(location))
133
def lookup_sibling_branch(control_dir, location):
134
"""Lookup sibling branch.
136
:param control_dir: Control directory relative to which to lookup the
138
:param location: Location to look up
139
:return: branch to open
142
# Perhaps it's a colocated branch?
143
return control_dir.open_branch(location)
144
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
146
return Branch.open(location)
147
except errors.NotBranchError:
148
this_url = _get_branch_location(control_dir)
151
this_url, '..', urlutils.escape(location)))
154
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
def tree_files(file_list, default_branch=u'.', canonicalize=True,
157
return internal_tree_files(file_list, default_branch, canonicalize,
161
def tree_files_for_add(file_list):
163
Return a tree and list of absolute paths from a file list.
165
Similar to tree_files, but add handles files a bit differently, so it a
166
custom implementation. In particular, MutableTreeTree.smart_add expects
167
absolute paths, which it immediately converts to relative paths.
169
# FIXME Would be nice to just return the relative paths like
170
# internal_tree_files does, but there are a large number of unit tests
171
# that assume the current interface to mutabletree.smart_add
173
tree, relpath = WorkingTree.open_containing(file_list[0])
174
if tree.supports_views():
175
view_files = tree.views.lookup_view()
177
for filename in file_list:
178
if not osutils.is_inside_any(view_files, filename):
179
raise errors.FileOutsideView(filename, view_files)
180
file_list = file_list[:]
181
file_list[0] = tree.abspath(relpath)
183
tree = WorkingTree.open_containing(u'.')[0]
184
if tree.supports_views():
185
view_files = tree.views.lookup_view()
187
file_list = view_files
188
view_str = views.view_display_str(view_files)
189
note(gettext("Ignoring files outside view. View is %s") % view_str)
190
return tree, file_list
193
def _get_one_revision(command_name, revisions):
194
if revisions is None:
196
if len(revisions) != 1:
197
raise errors.BzrCommandError(gettext(
198
'bzr %s --revision takes exactly one revision identifier') % (
203
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
204
"""Get a revision tree. Not suitable for commands that change the tree.
206
Specifically, the basis tree in dirstate trees is coupled to the dirstate
207
and doing a commit/uncommit/pull will at best fail due to changing the
210
If tree is passed in, it should be already locked, for lifetime management
211
of the trees internal cached state.
215
if revisions is None:
217
rev_tree = tree.basis_tree()
219
rev_tree = branch.basis_tree()
221
revision = _get_one_revision(command_name, revisions)
222
rev_tree = revision.as_tree(branch)
226
# XXX: Bad function name; should possibly also be a class method of
227
# WorkingTree rather than a function.
228
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
229
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
231
"""Convert command-line paths to a WorkingTree and relative paths.
233
Deprecated: use WorkingTree.open_containing_paths instead.
235
This is typically used for command-line processors that take one or
236
more filenames, and infer the workingtree that contains them.
238
The filenames given are not required to exist.
240
:param file_list: Filenames to convert.
242
:param default_branch: Fallback tree path to use if file_list is empty or
245
:param apply_view: if True and a view is set, apply it or check that
246
specified files are within it
248
:return: workingtree, [relative_paths]
250
return WorkingTree.open_containing_paths(
251
file_list, default_directory='.',
256
def _get_view_info_for_change_reporter(tree):
257
"""Get the view information from a tree for change reporting."""
260
current_view = tree.views.get_view_info()[0]
261
if current_view is not None:
262
view_info = (current_view, tree.views.lookup_view())
263
except errors.ViewsNotSupported:
268
def _open_directory_or_containing_tree_or_branch(filename, directory):
269
"""Open the tree or branch containing the specified file, unless
270
the --directory option is used to specify a different branch."""
271
if directory is not None:
272
return (None, Branch.open(directory), filename)
273
return controldir.ControlDir.open_containing_tree_or_branch(filename)
276
# TODO: Make sure no commands unconditionally use the working directory as a
277
# branch. If a filename argument is used, the first of them should be used to
278
# specify the branch. (Perhaps this can be factored out into some kind of
279
# Argument class, representing a file in a branch, where the first occurrence
282
class cmd_status(Command):
283
__doc__ = """Display status summary.
285
This reports on versioned and unknown files, reporting them
286
grouped by state. Possible states are:
289
Versioned in the working copy but not in the previous revision.
292
Versioned in the previous revision but removed or deleted
296
Path of this file changed from the previous revision;
297
the text may also have changed. This includes files whose
298
parent directory was renamed.
301
Text has changed since the previous revision.
304
File kind has been changed (e.g. from file to directory).
307
Not versioned and not matching an ignore pattern.
309
Additionally for directories, symlinks and files with a changed
310
executable bit, Bazaar indicates their type using a trailing
311
character: '/', '@' or '*' respectively. These decorations can be
312
disabled using the '--no-classify' option.
314
To see ignored files use 'bzr ignored'. For details on the
315
changes to file texts, use 'bzr diff'.
317
Note that --short or -S gives status flags for each item, similar
318
to Subversion's status command. To get output similar to svn -q,
321
If no arguments are specified, the status of the entire working
322
directory is shown. Otherwise, only the status of the specified
323
files or directories is reported. If a directory is given, status
324
is reported for everything inside that directory.
326
Before merges are committed, the pending merge tip revisions are
327
shown. To see all pending merge revisions, use the -v option.
328
To skip the display of pending merge information altogether, use
329
the no-pending option or specify a file/directory.
331
To compare the working directory to a specific revision, pass a
332
single revision to the revision argument.
334
To see which files have changed in a specific revision, or between
335
two revisions, pass a revision range to the revision argument.
336
This will produce the same results as calling 'bzr diff --summarize'.
339
# TODO: --no-recurse, --recurse options
341
takes_args = ['file*']
342
takes_options = ['show-ids', 'revision', 'change', 'verbose',
343
Option('short', help='Use short status indicators.',
345
Option('versioned', help='Only show versioned files.',
347
Option('no-pending', help='Don\'t show pending merges.',
349
Option('no-classify',
350
help='Do not mark object type using indicator.',
353
aliases = ['st', 'stat']
355
encoding_type = 'replace'
356
_see_also = ['diff', 'revert', 'status-flags']
359
def run(self, show_ids=False, file_list=None, revision=None, short=False,
360
versioned=False, no_pending=False, verbose=False,
362
from bzrlib.status import show_tree_status
364
if revision and len(revision) > 2:
365
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
366
' one or two revision specifiers'))
368
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
369
# Avoid asking for specific files when that is not needed.
370
if relfile_list == ['']:
372
# Don't disable pending merges for full trees other than '.'.
373
if file_list == ['.']:
375
# A specific path within a tree was given.
376
elif relfile_list is not None:
378
show_tree_status(tree, show_ids=show_ids,
379
specific_files=relfile_list, revision=revision,
380
to_file=self.outf, short=short, versioned=versioned,
381
show_pending=(not no_pending), verbose=verbose,
382
classify=not no_classify)
385
class cmd_cat_revision(Command):
386
__doc__ = """Write out metadata for a revision.
388
The revision to print can either be specified by a specific
389
revision identifier, or you can use --revision.
393
takes_args = ['revision_id?']
394
takes_options = ['directory', 'revision']
395
# cat-revision is more for frontends so should be exact
398
def print_revision(self, revisions, revid):
399
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
400
record = stream.next()
401
if record.storage_kind == 'absent':
402
raise errors.NoSuchRevision(revisions, revid)
403
revtext = record.get_bytes_as('fulltext')
404
self.outf.write(revtext.decode('utf-8'))
407
def run(self, revision_id=None, revision=None, directory=u'.'):
408
if revision_id is not None and revision is not None:
409
raise errors.BzrCommandError(gettext('You can only supply one of'
410
' revision_id or --revision'))
411
if revision_id is None and revision is None:
412
raise errors.BzrCommandError(gettext('You must supply either'
413
' --revision or a revision_id'))
415
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
417
revisions = b.repository.revisions
418
if revisions is None:
419
raise errors.BzrCommandError(gettext('Repository %r does not support '
420
'access to raw revision texts'))
422
b.repository.lock_read()
424
# TODO: jam 20060112 should cat-revision always output utf-8?
425
if revision_id is not None:
426
revision_id = osutils.safe_revision_id(revision_id, warn=False)
428
self.print_revision(revisions, revision_id)
429
except errors.NoSuchRevision:
430
msg = gettext("The repository {0} contains no revision {1}.").format(
431
b.repository.base, revision_id)
432
raise errors.BzrCommandError(msg)
433
elif revision is not None:
436
raise errors.BzrCommandError(
437
gettext('You cannot specify a NULL revision.'))
438
rev_id = rev.as_revision_id(b)
439
self.print_revision(revisions, rev_id)
441
b.repository.unlock()
444
class cmd_dump_btree(Command):
445
__doc__ = """Dump the contents of a btree index file to stdout.
447
PATH is a btree index file, it can be any URL. This includes things like
448
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
450
By default, the tuples stored in the index file will be displayed. With
451
--raw, we will uncompress the pages, but otherwise display the raw bytes
455
# TODO: Do we want to dump the internal nodes as well?
456
# TODO: It would be nice to be able to dump the un-parsed information,
457
# rather than only going through iter_all_entries. However, this is
458
# good enough for a start
460
encoding_type = 'exact'
461
takes_args = ['path']
462
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
463
' rather than the parsed tuples.'),
466
def run(self, path, raw=False):
467
dirname, basename = osutils.split(path)
468
t = transport.get_transport(dirname)
470
self._dump_raw_bytes(t, basename)
472
self._dump_entries(t, basename)
474
def _get_index_and_bytes(self, trans, basename):
475
"""Create a BTreeGraphIndex and raw bytes."""
476
bt = btree_index.BTreeGraphIndex(trans, basename, None)
477
bytes = trans.get_bytes(basename)
478
bt._file = cStringIO.StringIO(bytes)
479
bt._size = len(bytes)
482
def _dump_raw_bytes(self, trans, basename):
485
# We need to parse at least the root node.
486
# This is because the first page of every row starts with an
487
# uncompressed header.
488
bt, bytes = self._get_index_and_bytes(trans, basename)
489
for page_idx, page_start in enumerate(xrange(0, len(bytes),
490
btree_index._PAGE_SIZE)):
491
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
492
page_bytes = bytes[page_start:page_end]
494
self.outf.write('Root node:\n')
495
header_end, data = bt._parse_header_from_bytes(page_bytes)
496
self.outf.write(page_bytes[:header_end])
498
self.outf.write('\nPage %d\n' % (page_idx,))
499
if len(page_bytes) == 0:
500
self.outf.write('(empty)\n');
502
decomp_bytes = zlib.decompress(page_bytes)
503
self.outf.write(decomp_bytes)
504
self.outf.write('\n')
506
def _dump_entries(self, trans, basename):
508
st = trans.stat(basename)
509
except errors.TransportNotPossible:
510
# We can't stat, so we'll fake it because we have to do the 'get()'
512
bt, _ = self._get_index_and_bytes(trans, basename)
514
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
515
for node in bt.iter_all_entries():
516
# Node is made up of:
517
# (index, key, value, [references])
521
refs_as_tuples = None
523
refs_as_tuples = static_tuple.as_tuples(refs)
524
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
525
self.outf.write('%s\n' % (as_tuple,))
528
class cmd_remove_tree(Command):
529
__doc__ = """Remove the working tree from a given branch/checkout.
531
Since a lightweight checkout is little more than a working tree
532
this will refuse to run against one.
534
To re-create the working tree, use "bzr checkout".
536
_see_also = ['checkout', 'working-trees']
537
takes_args = ['location*']
540
help='Remove the working tree even if it has '
541
'uncommitted or shelved changes.'),
544
def run(self, location_list, force=False):
545
if not location_list:
548
for location in location_list:
549
d = controldir.ControlDir.open(location)
552
working = d.open_workingtree()
553
except errors.NoWorkingTree:
554
raise errors.BzrCommandError(gettext("No working tree to remove"))
555
except errors.NotLocalUrl:
556
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
557
" of a remote path"))
559
if (working.has_changes()):
560
raise errors.UncommittedChanges(working)
561
if working.get_shelf_manager().last_shelf() is not None:
562
raise errors.ShelvedChanges(working)
564
if working.user_url != working.branch.user_url:
565
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
566
" from a lightweight checkout"))
568
d.destroy_workingtree()
571
class cmd_repair_workingtree(Command):
572
__doc__ = """Reset the working tree state file.
574
This is not meant to be used normally, but more as a way to recover from
575
filesystem corruption, etc. This rebuilds the working inventory back to a
576
'known good' state. Any new modifications (adding a file, renaming, etc)
577
will be lost, though modified files will still be detected as such.
579
Most users will want something more like "bzr revert" or "bzr update"
580
unless the state file has become corrupted.
582
By default this attempts to recover the current state by looking at the
583
headers of the state file. If the state file is too corrupted to even do
584
that, you can supply --revision to force the state of the tree.
587
takes_options = ['revision', 'directory',
589
help='Reset the tree even if it doesn\'t appear to be'
594
def run(self, revision=None, directory='.', force=False):
595
tree, _ = WorkingTree.open_containing(directory)
596
self.add_cleanup(tree.lock_tree_write().unlock)
600
except errors.BzrError:
601
pass # There seems to be a real error here, so we'll reset
604
raise errors.BzrCommandError(gettext(
605
'The tree does not appear to be corrupt. You probably'
606
' want "bzr revert" instead. Use "--force" if you are'
607
' sure you want to reset the working tree.'))
611
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
613
tree.reset_state(revision_ids)
614
except errors.BzrError, e:
615
if revision_ids is None:
616
extra = (gettext(', the header appears corrupt, try passing -r -1'
617
' to set the state to the last commit'))
620
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
623
class cmd_revno(Command):
624
__doc__ = """Show current revision number.
626
This is equal to the number of revisions on this branch.
630
takes_args = ['location?']
632
Option('tree', help='Show revno of working tree.'),
637
def run(self, tree=False, location=u'.', revision=None):
638
if revision is not None and tree:
639
raise errors.BzrCommandError(gettext("--tree and --revision can "
640
"not be used together"))
644
wt = WorkingTree.open_containing(location)[0]
645
self.add_cleanup(wt.lock_read().unlock)
646
except (errors.NoWorkingTree, errors.NotLocalUrl):
647
raise errors.NoWorkingTree(location)
649
revid = wt.last_revision()
651
b = Branch.open_containing(location)[0]
652
self.add_cleanup(b.lock_read().unlock)
654
if len(revision) != 1:
655
raise errors.BzrCommandError(gettext(
656
"Tags can only be placed on a single revision, "
658
revid = revision[0].as_revision_id(b)
660
revid = b.last_revision()
662
revno_t = b.revision_id_to_dotted_revno(revid)
663
except errors.NoSuchRevision:
665
revno = ".".join(str(n) for n in revno_t)
667
self.outf.write(revno + '\n')
670
class cmd_revision_info(Command):
671
__doc__ = """Show revision number and revision id for a given revision identifier.
674
takes_args = ['revision_info*']
677
custom_help('directory',
678
help='Branch to examine, '
679
'rather than the one containing the working directory.'),
680
Option('tree', help='Show revno of working tree.'),
684
def run(self, revision=None, directory=u'.', tree=False,
685
revision_info_list=[]):
688
wt = WorkingTree.open_containing(directory)[0]
690
self.add_cleanup(wt.lock_read().unlock)
691
except (errors.NoWorkingTree, errors.NotLocalUrl):
693
b = Branch.open_containing(directory)[0]
694
self.add_cleanup(b.lock_read().unlock)
696
if revision is not None:
697
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
698
if revision_info_list is not None:
699
for rev_str in revision_info_list:
700
rev_spec = RevisionSpec.from_string(rev_str)
701
revision_ids.append(rev_spec.as_revision_id(b))
702
# No arguments supplied, default to the last revision
703
if len(revision_ids) == 0:
706
raise errors.NoWorkingTree(directory)
707
revision_ids.append(wt.last_revision())
709
revision_ids.append(b.last_revision())
713
for revision_id in revision_ids:
715
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
716
revno = '.'.join(str(i) for i in dotted_revno)
717
except errors.NoSuchRevision:
719
maxlen = max(maxlen, len(revno))
720
revinfos.append([revno, revision_id])
724
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
727
class cmd_add(Command):
728
__doc__ = """Add specified files or directories.
730
In non-recursive mode, all the named items are added, regardless
731
of whether they were previously ignored. A warning is given if
732
any of the named files are already versioned.
734
In recursive mode (the default), files are treated the same way
735
but the behaviour for directories is different. Directories that
736
are already versioned do not give a warning. All directories,
737
whether already versioned or not, are searched for files or
738
subdirectories that are neither versioned or ignored, and these
739
are added. This search proceeds recursively into versioned
740
directories. If no names are given '.' is assumed.
742
A warning will be printed when nested trees are encountered,
743
unless they are explicitly ignored.
745
Therefore simply saying 'bzr add' will version all files that
746
are currently unknown.
748
Adding a file whose parent directory is not versioned will
749
implicitly add the parent, and so on up to the root. This means
750
you should never need to explicitly add a directory, they'll just
751
get added when you add a file in the directory.
753
--dry-run will show which files would be added, but not actually
756
--file-ids-from will try to use the file ids from the supplied path.
757
It looks up ids trying to find a matching parent directory with the
758
same filename, and then by pure path. This option is rarely needed
759
but can be useful when adding the same logical file into two
760
branches that will be merged later (without showing the two different
761
adds as a conflict). It is also useful when merging another project
762
into a subdirectory of this one.
764
Any files matching patterns in the ignore list will not be added
765
unless they are explicitly mentioned.
767
In recursive mode, files larger than the configuration option
768
add.maximum_file_size will be skipped. Named items are never skipped due
771
takes_args = ['file*']
774
help="Don't recursively add the contents of directories."),
776
help="Show what would be done, but don't actually do anything."),
778
Option('file-ids-from',
780
help='Lookup file ids from this tree.'),
782
encoding_type = 'replace'
783
_see_also = ['remove', 'ignore']
785
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
790
if file_ids_from is not None:
792
base_tree, base_path = WorkingTree.open_containing(
794
except errors.NoWorkingTree:
795
base_branch, base_path = Branch.open_containing(
797
base_tree = base_branch.basis_tree()
799
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
800
to_file=self.outf, should_print=(not is_quiet()))
802
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
803
should_print=(not is_quiet()))
806
self.add_cleanup(base_tree.lock_read().unlock)
807
tree, file_list = tree_files_for_add(file_list)
808
added, ignored = tree.smart_add(file_list, not
809
no_recurse, action=action, save=not dry_run)
813
for glob in sorted(ignored.keys()):
814
for path in ignored[glob]:
816
gettext("ignored {0} matching \"{1}\"\n").format(
820
class cmd_mkdir(Command):
821
__doc__ = """Create a new versioned directory.
823
This is equivalent to creating the directory and then adding it.
826
takes_args = ['dir+']
830
help='No error if existing, make parent directories as needed.',
834
encoding_type = 'replace'
837
def add_file_with_parents(cls, wt, relpath):
838
if wt.path2id(relpath) is not None:
840
cls.add_file_with_parents(wt, osutils.dirname(relpath))
844
def add_file_single(cls, wt, relpath):
847
def run(self, dir_list, parents=False):
849
add_file = self.add_file_with_parents
851
add_file = self.add_file_single
853
wt, relpath = WorkingTree.open_containing(dir)
858
if e.errno != errno.EEXIST:
862
add_file(wt, relpath)
864
self.outf.write(gettext('added %s\n') % dir)
867
class cmd_relpath(Command):
868
__doc__ = """Show path of a file relative to root"""
870
takes_args = ['filename']
874
def run(self, filename):
875
# TODO: jam 20050106 Can relpath return a munged path if
876
# sys.stdout encoding cannot represent it?
877
tree, relpath = WorkingTree.open_containing(filename)
878
self.outf.write(relpath)
879
self.outf.write('\n')
882
class cmd_inventory(Command):
883
__doc__ = """Show inventory of the current working copy or a revision.
885
It is possible to limit the output to a particular entry
886
type using the --kind option. For example: --kind file.
888
It is also possible to restrict the list of files to a specific
889
set. For example: bzr inventory --show-ids this/file
898
help='List entries of a particular kind: file, directory, symlink.',
901
takes_args = ['file*']
904
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
905
if kind and kind not in ['file', 'directory', 'symlink']:
906
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
908
revision = _get_one_revision('inventory', revision)
909
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
910
self.add_cleanup(work_tree.lock_read().unlock)
911
if revision is not None:
912
tree = revision.as_tree(work_tree.branch)
914
extra_trees = [work_tree]
915
self.add_cleanup(tree.lock_read().unlock)
920
if file_list is not None:
921
file_ids = tree.paths2ids(file_list, trees=extra_trees,
922
require_versioned=True)
923
# find_ids_across_trees may include some paths that don't
926
(tree.id2path(file_id), tree.inventory[file_id])
927
for file_id in file_ids if tree.has_id(file_id))
929
entries = tree.inventory.entries()
932
for path, entry in entries:
933
if kind and kind != entry.kind:
936
self.outf.write('%-50s %s\n' % (path, entry.file_id))
938
self.outf.write(path)
939
self.outf.write('\n')
942
class cmd_mv(Command):
943
__doc__ = """Move or rename a file.
946
bzr mv OLDNAME NEWNAME
948
bzr mv SOURCE... DESTINATION
950
If the last argument is a versioned directory, all the other names
951
are moved into it. Otherwise, there must be exactly two arguments
952
and the file is changed to a new name.
954
If OLDNAME does not exist on the filesystem but is versioned and
955
NEWNAME does exist on the filesystem but is not versioned, mv
956
assumes that the file has been manually moved and only updates
957
its internal inventory to reflect that change.
958
The same is valid when moving many SOURCE files to a DESTINATION.
960
Files cannot be moved between branches.
963
takes_args = ['names*']
964
takes_options = [Option("after", help="Move only the bzr identifier"
965
" of the file, because the file has already been moved."),
966
Option('auto', help='Automatically guess renames.'),
967
Option('dry-run', help='Avoid making changes when guessing renames.'),
969
aliases = ['move', 'rename']
970
encoding_type = 'replace'
972
def run(self, names_list, after=False, auto=False, dry_run=False):
974
return self.run_auto(names_list, after, dry_run)
976
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
977
if names_list is None:
979
if len(names_list) < 2:
980
raise errors.BzrCommandError(gettext("missing file argument"))
981
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
982
for file_name in rel_names[0:-1]:
984
raise errors.BzrCommandError(gettext("can not move root of branch"))
985
self.add_cleanup(tree.lock_tree_write().unlock)
986
self._run(tree, names_list, rel_names, after)
988
def run_auto(self, names_list, after, dry_run):
989
if names_list is not None and len(names_list) > 1:
990
raise errors.BzrCommandError(gettext('Only one path may be specified to'
993
raise errors.BzrCommandError(gettext('--after cannot be specified with'
995
work_tree, file_list = WorkingTree.open_containing_paths(
996
names_list, default_directory='.')
997
self.add_cleanup(work_tree.lock_tree_write().unlock)
998
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1000
def _run(self, tree, names_list, rel_names, after):
1001
into_existing = osutils.isdir(names_list[-1])
1002
if into_existing and len(names_list) == 2:
1004
# a. case-insensitive filesystem and change case of dir
1005
# b. move directory after the fact (if the source used to be
1006
# a directory, but now doesn't exist in the working tree
1007
# and the target is an existing directory, just rename it)
1008
if (not tree.case_sensitive
1009
and rel_names[0].lower() == rel_names[1].lower()):
1010
into_existing = False
1012
inv = tree.inventory
1013
# 'fix' the case of a potential 'from'
1014
from_id = tree.path2id(
1015
tree.get_canonical_inventory_path(rel_names[0]))
1016
if (not osutils.lexists(names_list[0]) and
1017
from_id and inv.get_file_kind(from_id) == "directory"):
1018
into_existing = False
1021
# move into existing directory
1022
# All entries reference existing inventory items, so fix them up
1023
# for cicp file-systems.
1024
rel_names = tree.get_canonical_inventory_paths(rel_names)
1025
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1027
self.outf.write("%s => %s\n" % (src, dest))
1029
if len(names_list) != 2:
1030
raise errors.BzrCommandError(gettext('to mv multiple files the'
1031
' destination must be a versioned'
1034
# for cicp file-systems: the src references an existing inventory
1036
src = tree.get_canonical_inventory_path(rel_names[0])
1037
# Find the canonical version of the destination: In all cases, the
1038
# parent of the target must be in the inventory, so we fetch the
1039
# canonical version from there (we do not always *use* the
1040
# canonicalized tail portion - we may be attempting to rename the
1042
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1043
dest_parent = osutils.dirname(canon_dest)
1044
spec_tail = osutils.basename(rel_names[1])
1045
# For a CICP file-system, we need to avoid creating 2 inventory
1046
# entries that differ only by case. So regardless of the case
1047
# we *want* to use (ie, specified by the user or the file-system),
1048
# we must always choose to use the case of any existing inventory
1049
# items. The only exception to this is when we are attempting a
1050
# case-only rename (ie, canonical versions of src and dest are
1052
dest_id = tree.path2id(canon_dest)
1053
if dest_id is None or tree.path2id(src) == dest_id:
1054
# No existing item we care about, so work out what case we
1055
# are actually going to use.
1057
# If 'after' is specified, the tail must refer to a file on disk.
1059
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1061
# pathjoin with an empty tail adds a slash, which breaks
1063
dest_parent_fq = tree.basedir
1065
dest_tail = osutils.canonical_relpath(
1067
osutils.pathjoin(dest_parent_fq, spec_tail))
1069
# not 'after', so case as specified is used
1070
dest_tail = spec_tail
1072
# Use the existing item so 'mv' fails with AlreadyVersioned.
1073
dest_tail = os.path.basename(canon_dest)
1074
dest = osutils.pathjoin(dest_parent, dest_tail)
1075
mutter("attempting to move %s => %s", src, dest)
1076
tree.rename_one(src, dest, after=after)
1078
self.outf.write("%s => %s\n" % (src, dest))
1081
class cmd_pull(Command):
1082
__doc__ = """Turn this branch into a mirror of another branch.
1084
By default, this command only works on branches that have not diverged.
1085
Branches are considered diverged if the destination branch's most recent
1086
commit is one that has not been merged (directly or indirectly) into the
1089
If branches have diverged, you can use 'bzr merge' to integrate the changes
1090
from one into the other. Once one branch has merged, the other should
1091
be able to pull it again.
1093
If you want to replace your local changes and just want your branch to
1094
match the remote one, use pull --overwrite. This will work even if the two
1095
branches have diverged.
1097
If there is no default location set, the first pull will set it (use
1098
--no-remember to avoid setting it). After that, you can omit the
1099
location to use the default. To change the default, use --remember. The
1100
value will only be saved if the remote location can be accessed.
1102
The --verbose option will display the revisions pulled using the log_format
1103
configuration option. You can use a different format by overriding it with
1104
-Olog_format=<other_format>.
1106
Note: The location can be specified either in the form of a branch,
1107
or in the form of a path to a file containing a merge directive generated
1111
_see_also = ['push', 'update', 'status-flags', 'send']
1112
takes_options = ['remember', 'overwrite', 'revision',
1113
custom_help('verbose',
1114
help='Show logs of pulled revisions.'),
1115
custom_help('directory',
1116
help='Branch to pull into, '
1117
'rather than the one containing the working directory.'),
1119
help="Perform a local pull in a bound "
1120
"branch. Local pulls are not applied to "
1121
"the master branch."
1124
help="Show base revision text in conflicts.")
1126
takes_args = ['location?']
1127
encoding_type = 'replace'
1129
def run(self, location=None, remember=None, overwrite=False,
1130
revision=None, verbose=False,
1131
directory=None, local=False,
1133
# FIXME: too much stuff is in the command class
1136
if directory is None:
1139
tree_to = WorkingTree.open_containing(directory)[0]
1140
branch_to = tree_to.branch
1141
self.add_cleanup(tree_to.lock_write().unlock)
1142
except errors.NoWorkingTree:
1144
branch_to = Branch.open_containing(directory)[0]
1145
self.add_cleanup(branch_to.lock_write().unlock)
1147
if tree_to is None and show_base:
1148
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1150
if local and not branch_to.get_bound_location():
1151
raise errors.LocalRequiresBoundBranch()
1153
possible_transports = []
1154
if location is not None:
1156
mergeable = bundle.read_mergeable_from_url(location,
1157
possible_transports=possible_transports)
1158
except errors.NotABundle:
1161
stored_loc = branch_to.get_parent()
1162
if location is None:
1163
if stored_loc is None:
1164
raise errors.BzrCommandError(gettext("No pull location known or"
1167
display_url = urlutils.unescape_for_display(stored_loc,
1170
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1171
location = stored_loc
1173
revision = _get_one_revision('pull', revision)
1174
if mergeable is not None:
1175
if revision is not None:
1176
raise errors.BzrCommandError(gettext(
1177
'Cannot use -r with merge directives or bundles'))
1178
mergeable.install_revisions(branch_to.repository)
1179
base_revision_id, revision_id, verified = \
1180
mergeable.get_merge_request(branch_to.repository)
1181
branch_from = branch_to
1183
branch_from = Branch.open(location,
1184
possible_transports=possible_transports)
1185
self.add_cleanup(branch_from.lock_read().unlock)
1186
# Remembers if asked explicitly or no previous location is set
1188
or (remember is None and branch_to.get_parent() is None)):
1189
branch_to.set_parent(branch_from.base)
1191
if revision is not None:
1192
revision_id = revision.as_revision_id(branch_from)
1194
if tree_to is not None:
1195
view_info = _get_view_info_for_change_reporter(tree_to)
1196
change_reporter = delta._ChangeReporter(
1197
unversioned_filter=tree_to.is_ignored,
1198
view_info=view_info)
1199
result = tree_to.pull(
1200
branch_from, overwrite, revision_id, change_reporter,
1201
local=local, show_base=show_base)
1203
result = branch_to.pull(
1204
branch_from, overwrite, revision_id, local=local)
1206
result.report(self.outf)
1207
if verbose and result.old_revid != result.new_revid:
1208
log.show_branch_change(
1209
branch_to, self.outf, result.old_revno,
1211
if getattr(result, 'tag_conflicts', None):
1217
class cmd_push(Command):
1218
__doc__ = """Update a mirror of this branch.
1220
The target branch will not have its working tree populated because this
1221
is both expensive, and is not supported on remote file systems.
1223
Some smart servers or protocols *may* put the working tree in place in
1226
This command only works on branches that have not diverged. Branches are
1227
considered diverged if the destination branch's most recent commit is one
1228
that has not been merged (directly or indirectly) by the source branch.
1230
If branches have diverged, you can use 'bzr push --overwrite' to replace
1231
the other branch completely, discarding its unmerged changes.
1233
If you want to ensure you have the different changes in the other branch,
1234
do a merge (see bzr help merge) from the other branch, and commit that.
1235
After that you will be able to do a push without '--overwrite'.
1237
If there is no default push location set, the first push will set it (use
1238
--no-remember to avoid setting it). After that, you can omit the
1239
location to use the default. To change the default, use --remember. The
1240
value will only be saved if the remote location can be accessed.
1242
The --verbose option will display the revisions pushed using the log_format
1243
configuration option. You can use a different format by overriding it with
1244
-Olog_format=<other_format>.
1247
_see_also = ['pull', 'update', 'working-trees']
1248
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1249
Option('create-prefix',
1250
help='Create the path leading up to the branch '
1251
'if it does not already exist.'),
1252
custom_help('directory',
1253
help='Branch to push from, '
1254
'rather than the one containing the working directory.'),
1255
Option('use-existing-dir',
1256
help='By default push will fail if the target'
1257
' directory exists, but does not already'
1258
' have a control directory. This flag will'
1259
' allow push to proceed.'),
1261
help='Create a stacked branch that references the public location '
1262
'of the parent branch.'),
1263
Option('stacked-on',
1264
help='Create a stacked branch that refers to another branch '
1265
'for the commit history. Only the work not present in the '
1266
'referenced branch is included in the branch created.',
1269
help='Refuse to push if there are uncommitted changes in'
1270
' the working tree, --no-strict disables the check.'),
1272
help="Don't populate the working tree, even for protocols"
1273
" that support it."),
1275
takes_args = ['location?']
1276
encoding_type = 'replace'
1278
def run(self, location=None, remember=None, overwrite=False,
1279
create_prefix=False, verbose=False, revision=None,
1280
use_existing_dir=False, directory=None, stacked_on=None,
1281
stacked=False, strict=None, no_tree=False):
1282
from bzrlib.push import _show_push_branch
1284
if directory is None:
1286
# Get the source branch
1288
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1289
# Get the tip's revision_id
1290
revision = _get_one_revision('push', revision)
1291
if revision is not None:
1292
revision_id = revision.in_history(br_from).rev_id
1295
if tree is not None and revision_id is None:
1296
tree.check_changed_or_out_of_date(
1297
strict, 'push_strict',
1298
more_error='Use --no-strict to force the push.',
1299
more_warning='Uncommitted changes will not be pushed.')
1300
# Get the stacked_on branch, if any
1301
if stacked_on is not None:
1302
stacked_on = urlutils.normalize_url(stacked_on)
1304
parent_url = br_from.get_parent()
1306
parent = Branch.open(parent_url)
1307
stacked_on = parent.get_public_branch()
1309
# I considered excluding non-http url's here, thus forcing
1310
# 'public' branches only, but that only works for some
1311
# users, so it's best to just depend on the user spotting an
1312
# error by the feedback given to them. RBC 20080227.
1313
stacked_on = parent_url
1315
raise errors.BzrCommandError(gettext(
1316
"Could not determine branch to refer to."))
1318
# Get the destination location
1319
if location is None:
1320
stored_loc = br_from.get_push_location()
1321
if stored_loc is None:
1322
parent_loc = br_from.get_parent()
1324
raise errors.BzrCommandError(gettext(
1325
"No push location known or specified. To push to the "
1326
"parent branch (at %s), use 'bzr push :parent'." %
1327
urlutils.unescape_for_display(parent_loc,
1328
self.outf.encoding)))
1330
raise errors.BzrCommandError(gettext(
1331
"No push location known or specified."))
1333
display_url = urlutils.unescape_for_display(stored_loc,
1335
note(gettext("Using saved push location: %s") % display_url)
1336
location = stored_loc
1338
_show_push_branch(br_from, revision_id, location, self.outf,
1339
verbose=verbose, overwrite=overwrite, remember=remember,
1340
stacked_on=stacked_on, create_prefix=create_prefix,
1341
use_existing_dir=use_existing_dir, no_tree=no_tree)
1344
class cmd_branch(Command):
1345
__doc__ = """Create a new branch that is a copy of an existing branch.
1347
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1348
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1349
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1350
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1351
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1354
To retrieve the branch as of a particular revision, supply the --revision
1355
parameter, as in "branch foo/bar -r 5".
1357
The synonyms 'clone' and 'get' for this command are deprecated.
1360
_see_also = ['checkout']
1361
takes_args = ['from_location', 'to_location?']
1362
takes_options = ['revision',
1363
Option('hardlink', help='Hard-link working tree files where possible.'),
1364
Option('files-from', type=str,
1365
help="Get file contents from this tree."),
1367
help="Create a branch without a working-tree."),
1369
help="Switch the checkout in the current directory "
1370
"to the new branch."),
1372
help='Create a stacked branch referring to the source branch. '
1373
'The new branch will depend on the availability of the source '
1374
'branch for all operations.'),
1375
Option('standalone',
1376
help='Do not use a shared repository, even if available.'),
1377
Option('use-existing-dir',
1378
help='By default branch will fail if the target'
1379
' directory exists, but does not already'
1380
' have a control directory. This flag will'
1381
' allow branch to proceed.'),
1383
help="Bind new branch to from location."),
1385
aliases = ['get', 'clone']
1387
def run(self, from_location, to_location=None, revision=None,
1388
hardlink=False, stacked=False, standalone=False, no_tree=False,
1389
use_existing_dir=False, switch=False, bind=False,
1391
from bzrlib import switch as _mod_switch
1392
from bzrlib.tag import _merge_tags_if_possible
1393
if self.invoked_as in ['get', 'clone']:
1394
ui.ui_factory.show_user_warning(
1395
'deprecated_command',
1396
deprecated_name=self.invoked_as,
1397
recommended_name='branch',
1398
deprecated_in_version='2.4')
1399
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1401
if not (hardlink or files_from):
1402
# accelerator_tree is usually slower because you have to read N
1403
# files (no readahead, lots of seeks, etc), but allow the user to
1404
# explicitly request it
1405
accelerator_tree = None
1406
if files_from is not None and files_from != from_location:
1407
accelerator_tree = WorkingTree.open(files_from)
1408
revision = _get_one_revision('branch', revision)
1409
self.add_cleanup(br_from.lock_read().unlock)
1410
if revision is not None:
1411
revision_id = revision.as_revision_id(br_from)
1413
# FIXME - wt.last_revision, fallback to branch, fall back to
1414
# None or perhaps NULL_REVISION to mean copy nothing
1416
revision_id = br_from.last_revision()
1417
if to_location is None:
1418
to_location = getattr(br_from, "name", None)
1419
if to_location is None:
1420
to_location = urlutils.derive_to_location(from_location)
1421
to_transport = transport.get_transport(to_location)
1423
to_transport.mkdir('.')
1424
except errors.FileExists:
1426
to_dir = controldir.ControlDir.open_from_transport(
1428
except errors.NotBranchError:
1429
if not use_existing_dir:
1430
raise errors.BzrCommandError(gettext('Target directory "%s" '
1431
'already exists.') % to_location)
1436
to_dir.open_branch()
1437
except errors.NotBranchError:
1440
raise errors.AlreadyBranchError(to_location)
1441
except errors.NoSuchFile:
1442
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1448
# preserve whatever source format we have.
1449
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1450
possible_transports=[to_transport],
1451
accelerator_tree=accelerator_tree,
1452
hardlink=hardlink, stacked=stacked,
1453
force_new_repo=standalone,
1454
create_tree_if_local=not no_tree,
1455
source_branch=br_from)
1456
branch = to_dir.open_branch(
1457
possible_transports=[
1458
br_from.bzrdir.root_transport, to_transport])
1459
except errors.NoSuchRevision:
1460
to_transport.delete_tree('.')
1461
msg = gettext("The branch {0} has no revision {1}.").format(
1462
from_location, revision)
1463
raise errors.BzrCommandError(msg)
1466
to_repo = to_dir.open_repository()
1467
except errors.NoRepositoryPresent:
1468
to_repo = to_dir.create_repository()
1469
to_repo.fetch(br_from.repository, revision_id=revision_id)
1470
branch = br_from.sprout(to_dir, revision_id=revision_id)
1471
_merge_tags_if_possible(br_from, branch)
1472
# If the source branch is stacked, the new branch may
1473
# be stacked whether we asked for that explicitly or not.
1474
# We therefore need a try/except here and not just 'if stacked:'
1476
note(gettext('Created new stacked branch referring to %s.') %
1477
branch.get_stacked_on_url())
1478
except (errors.NotStacked, errors.UnstackableBranchFormat,
1479
errors.UnstackableRepositoryFormat), e:
1480
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1482
# Bind to the parent
1483
parent_branch = Branch.open(from_location)
1484
branch.bind(parent_branch)
1485
note(gettext('New branch bound to %s') % from_location)
1487
# Switch to the new branch
1488
wt, _ = WorkingTree.open_containing('.')
1489
_mod_switch.switch(wt.bzrdir, branch)
1490
note(gettext('Switched to branch: %s'),
1491
urlutils.unescape_for_display(branch.base, 'utf-8'))
1494
class cmd_branches(Command):
1495
__doc__ = """List the branches available at the current location.
1497
This command will print the names of all the branches at the current
1501
takes_args = ['location?']
1503
Option('recursive', short_name='R',
1504
help='Recursively scan for branches rather than '
1505
'just looking in the specified location.')]
1507
def run(self, location=".", recursive=False):
1509
t = transport.get_transport(location)
1510
if not t.listable():
1511
raise errors.BzrCommandError(
1512
"Can't scan this type of location.")
1513
for b in controldir.ControlDir.find_branches(t):
1514
self.outf.write("%s\n" % urlutils.unescape_for_display(
1515
urlutils.relative_url(t.base, b.base),
1516
self.outf.encoding).rstrip("/"))
1518
dir = controldir.ControlDir.open_containing(location)[0]
1520
active_branch = dir.open_branch(name="")
1521
except errors.NotBranchError:
1522
active_branch = None
1523
branches = dir.get_branches()
1525
for name, branch in branches.iteritems():
1528
active = (active_branch is not None and
1529
active_branch.base == branch.base)
1530
names[name] = active
1531
# Only mention the current branch explicitly if it's not
1532
# one of the colocated branches
1533
if not any(names.values()) and active_branch is not None:
1534
self.outf.write("* %s\n" % gettext("(default)"))
1535
for name in sorted(names.keys()):
1536
active = names[name]
1541
self.outf.write("%s %s\n" % (
1542
prefix, name.encode(self.outf.encoding)))
1545
class cmd_checkout(Command):
1546
__doc__ = """Create a new checkout of an existing branch.
1548
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1549
the branch found in '.'. This is useful if you have removed the working tree
1550
or if it was never created - i.e. if you pushed the branch to its current
1551
location using SFTP.
1553
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1554
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1555
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1556
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1557
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1560
To retrieve the branch as of a particular revision, supply the --revision
1561
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1562
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1566
_see_also = ['checkouts', 'branch']
1567
takes_args = ['branch_location?', 'to_location?']
1568
takes_options = ['revision',
1569
Option('lightweight',
1570
help="Perform a lightweight checkout. Lightweight "
1571
"checkouts depend on access to the branch for "
1572
"every operation. Normal checkouts can perform "
1573
"common operations like diff and status without "
1574
"such access, and also support local commits."
1576
Option('files-from', type=str,
1577
help="Get file contents from this tree."),
1579
help='Hard-link working tree files where possible.'
1584
def run(self, branch_location=None, to_location=None, revision=None,
1585
lightweight=False, files_from=None, hardlink=False):
1586
if branch_location is None:
1587
branch_location = osutils.getcwd()
1588
to_location = branch_location
1589
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1591
if not (hardlink or files_from):
1592
# accelerator_tree is usually slower because you have to read N
1593
# files (no readahead, lots of seeks, etc), but allow the user to
1594
# explicitly request it
1595
accelerator_tree = None
1596
revision = _get_one_revision('checkout', revision)
1597
if files_from is not None and files_from != branch_location:
1598
accelerator_tree = WorkingTree.open(files_from)
1599
if revision is not None:
1600
revision_id = revision.as_revision_id(source)
1603
if to_location is None:
1604
to_location = urlutils.derive_to_location(branch_location)
1605
# if the source and to_location are the same,
1606
# and there is no working tree,
1607
# then reconstitute a branch
1608
if (osutils.abspath(to_location) ==
1609
osutils.abspath(branch_location)):
1611
source.bzrdir.open_workingtree()
1612
except errors.NoWorkingTree:
1613
source.bzrdir.create_workingtree(revision_id)
1615
source.create_checkout(to_location, revision_id, lightweight,
1616
accelerator_tree, hardlink)
1619
class cmd_renames(Command):
1620
__doc__ = """Show list of renamed files.
1622
# TODO: Option to show renames between two historical versions.
1624
# TODO: Only show renames under dir, rather than in the whole branch.
1625
_see_also = ['status']
1626
takes_args = ['dir?']
1629
def run(self, dir=u'.'):
1630
tree = WorkingTree.open_containing(dir)[0]
1631
self.add_cleanup(tree.lock_read().unlock)
1632
new_inv = tree.inventory
1633
old_tree = tree.basis_tree()
1634
self.add_cleanup(old_tree.lock_read().unlock)
1635
old_inv = old_tree.inventory
1637
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1638
for f, paths, c, v, p, n, k, e in iterator:
1639
if paths[0] == paths[1]:
1643
renames.append(paths)
1645
for old_name, new_name in renames:
1646
self.outf.write("%s => %s\n" % (old_name, new_name))
1649
class cmd_update(Command):
1650
__doc__ = """Update a working tree to a new revision.
1652
This will perform a merge of the destination revision (the tip of the
1653
branch, or the specified revision) into the working tree, and then make
1654
that revision the basis revision for the working tree.
1656
You can use this to visit an older revision, or to update a working tree
1657
that is out of date from its branch.
1659
If there are any uncommitted changes in the tree, they will be carried
1660
across and remain as uncommitted changes after the update. To discard
1661
these changes, use 'bzr revert'. The uncommitted changes may conflict
1662
with the changes brought in by the change in basis revision.
1664
If the tree's branch is bound to a master branch, bzr will also update
1665
the branch from the master.
1667
You cannot update just a single file or directory, because each Bazaar
1668
working tree has just a single basis revision. If you want to restore a
1669
file that has been removed locally, use 'bzr revert' instead of 'bzr
1670
update'. If you want to restore a file to its state in a previous
1671
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1672
out the old content of that file to a new location.
1674
The 'dir' argument, if given, must be the location of the root of a
1675
working tree to update. By default, the working tree that contains the
1676
current working directory is used.
1679
_see_also = ['pull', 'working-trees', 'status-flags']
1680
takes_args = ['dir?']
1681
takes_options = ['revision',
1683
help="Show base revision text in conflicts."),
1687
def run(self, dir=None, revision=None, show_base=None):
1688
if revision is not None and len(revision) != 1:
1689
raise errors.BzrCommandError(gettext(
1690
"bzr update --revision takes exactly one revision"))
1692
tree = WorkingTree.open_containing('.')[0]
1694
tree, relpath = WorkingTree.open_containing(dir)
1697
raise errors.BzrCommandError(gettext(
1698
"bzr update can only update a whole tree, "
1699
"not a file or subdirectory"))
1700
branch = tree.branch
1701
possible_transports = []
1702
master = branch.get_master_branch(
1703
possible_transports=possible_transports)
1704
if master is not None:
1705
branch_location = master.base
1708
branch_location = tree.branch.base
1709
tree.lock_tree_write()
1710
self.add_cleanup(tree.unlock)
1711
# get rid of the final '/' and be ready for display
1712
branch_location = urlutils.unescape_for_display(
1713
branch_location.rstrip('/'),
1715
existing_pending_merges = tree.get_parent_ids()[1:]
1719
# may need to fetch data into a heavyweight checkout
1720
# XXX: this may take some time, maybe we should display a
1722
old_tip = branch.update(possible_transports)
1723
if revision is not None:
1724
revision_id = revision[0].as_revision_id(branch)
1726
revision_id = branch.last_revision()
1727
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1728
revno = branch.revision_id_to_dotted_revno(revision_id)
1729
note(gettext("Tree is up to date at revision {0} of branch {1}"
1730
).format('.'.join(map(str, revno)), branch_location))
1732
view_info = _get_view_info_for_change_reporter(tree)
1733
change_reporter = delta._ChangeReporter(
1734
unversioned_filter=tree.is_ignored,
1735
view_info=view_info)
1737
conflicts = tree.update(
1739
possible_transports=possible_transports,
1740
revision=revision_id,
1742
show_base=show_base)
1743
except errors.NoSuchRevision, e:
1744
raise errors.BzrCommandError(gettext(
1745
"branch has no revision %s\n"
1746
"bzr update --revision only works"
1747
" for a revision in the branch history")
1749
revno = tree.branch.revision_id_to_dotted_revno(
1750
_mod_revision.ensure_null(tree.last_revision()))
1751
note(gettext('Updated to revision {0} of branch {1}').format(
1752
'.'.join(map(str, revno)), branch_location))
1753
parent_ids = tree.get_parent_ids()
1754
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1755
note(gettext('Your local commits will now show as pending merges with '
1756
"'bzr status', and can be committed with 'bzr commit'."))
1763
class cmd_info(Command):
1764
__doc__ = """Show information about a working tree, branch or repository.
1766
This command will show all known locations and formats associated to the
1767
tree, branch or repository.
1769
In verbose mode, statistical information is included with each report.
1770
To see extended statistic information, use a verbosity level of 2 or
1771
higher by specifying the verbose option multiple times, e.g. -vv.
1773
Branches and working trees will also report any missing revisions.
1777
Display information on the format and related locations:
1781
Display the above together with extended format information and
1782
basic statistics (like the number of files in the working tree and
1783
number of revisions in the branch and repository):
1787
Display the above together with number of committers to the branch:
1791
_see_also = ['revno', 'working-trees', 'repositories']
1792
takes_args = ['location?']
1793
takes_options = ['verbose']
1794
encoding_type = 'replace'
1797
def run(self, location=None, verbose=False):
1799
noise_level = get_verbosity_level()
1802
from bzrlib.info import show_bzrdir_info
1803
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1804
verbose=noise_level, outfile=self.outf)
1807
class cmd_remove(Command):
1808
__doc__ = """Remove files or directories.
1810
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1811
delete them if they can easily be recovered using revert otherwise they
1812
will be backed up (adding an extention of the form .~#~). If no options or
1813
parameters are given Bazaar will scan for files that are being tracked by
1814
Bazaar but missing in your tree and stop tracking them for you.
1816
takes_args = ['file*']
1817
takes_options = ['verbose',
1818
Option('new', help='Only remove files that have never been committed.'),
1819
RegistryOption.from_kwargs('file-deletion-strategy',
1820
'The file deletion mode to be used.',
1821
title='Deletion Strategy', value_switches=True, enum_switch=False,
1822
safe='Backup changed files (default).',
1823
keep='Delete from bzr but leave the working copy.',
1824
no_backup='Don\'t backup changed files.',
1825
force='Delete all the specified files, even if they can not be '
1826
'recovered and even if they are non-empty directories. '
1827
'(deprecated, use no-backup)')]
1828
aliases = ['rm', 'del']
1829
encoding_type = 'replace'
1831
def run(self, file_list, verbose=False, new=False,
1832
file_deletion_strategy='safe'):
1833
if file_deletion_strategy == 'force':
1834
note(gettext("(The --force option is deprecated, rather use --no-backup "
1836
file_deletion_strategy = 'no-backup'
1838
tree, file_list = WorkingTree.open_containing_paths(file_list)
1840
if file_list is not None:
1841
file_list = [f for f in file_list]
1843
self.add_cleanup(tree.lock_write().unlock)
1844
# Heuristics should probably all move into tree.remove_smart or
1847
added = tree.changes_from(tree.basis_tree(),
1848
specific_files=file_list).added
1849
file_list = sorted([f[0] for f in added], reverse=True)
1850
if len(file_list) == 0:
1851
raise errors.BzrCommandError(gettext('No matching files.'))
1852
elif file_list is None:
1853
# missing files show up in iter_changes(basis) as
1854
# versioned-with-no-kind.
1856
for change in tree.iter_changes(tree.basis_tree()):
1857
# Find paths in the working tree that have no kind:
1858
if change[1][1] is not None and change[6][1] is None:
1859
missing.append(change[1][1])
1860
file_list = sorted(missing, reverse=True)
1861
file_deletion_strategy = 'keep'
1862
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1863
keep_files=file_deletion_strategy=='keep',
1864
force=(file_deletion_strategy=='no-backup'))
1867
class cmd_file_id(Command):
1868
__doc__ = """Print file_id of a particular file or directory.
1870
The file_id is assigned when the file is first added and remains the
1871
same through all revisions where the file exists, even when it is
1876
_see_also = ['inventory', 'ls']
1877
takes_args = ['filename']
1880
def run(self, filename):
1881
tree, relpath = WorkingTree.open_containing(filename)
1882
i = tree.path2id(relpath)
1884
raise errors.NotVersionedError(filename)
1886
self.outf.write(i + '\n')
1889
class cmd_file_path(Command):
1890
__doc__ = """Print path of file_ids to a file or directory.
1892
This prints one line for each directory down to the target,
1893
starting at the branch root.
1897
takes_args = ['filename']
1900
def run(self, filename):
1901
tree, relpath = WorkingTree.open_containing(filename)
1902
fid = tree.path2id(relpath)
1904
raise errors.NotVersionedError(filename)
1905
segments = osutils.splitpath(relpath)
1906
for pos in range(1, len(segments) + 1):
1907
path = osutils.joinpath(segments[:pos])
1908
self.outf.write("%s\n" % tree.path2id(path))
1911
class cmd_reconcile(Command):
1912
__doc__ = """Reconcile bzr metadata in a branch.
1914
This can correct data mismatches that may have been caused by
1915
previous ghost operations or bzr upgrades. You should only
1916
need to run this command if 'bzr check' or a bzr developer
1917
advises you to run it.
1919
If a second branch is provided, cross-branch reconciliation is
1920
also attempted, which will check that data like the tree root
1921
id which was not present in very early bzr versions is represented
1922
correctly in both branches.
1924
At the same time it is run it may recompress data resulting in
1925
a potential saving in disk space or performance gain.
1927
The branch *MUST* be on a listable system such as local disk or sftp.
1930
_see_also = ['check']
1931
takes_args = ['branch?']
1933
Option('canonicalize-chks',
1934
help='Make sure CHKs are in canonical form (repairs '
1939
def run(self, branch=".", canonicalize_chks=False):
1940
from bzrlib.reconcile import reconcile
1941
dir = controldir.ControlDir.open(branch)
1942
reconcile(dir, canonicalize_chks=canonicalize_chks)
1945
class cmd_revision_history(Command):
1946
__doc__ = """Display the list of revision ids on a branch."""
1949
takes_args = ['location?']
1954
def run(self, location="."):
1955
branch = Branch.open_containing(location)[0]
1956
self.add_cleanup(branch.lock_read().unlock)
1957
graph = branch.repository.get_graph()
1958
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1959
[_mod_revision.NULL_REVISION]))
1960
for revid in reversed(history):
1961
self.outf.write(revid)
1962
self.outf.write('\n')
1965
class cmd_ancestry(Command):
1966
__doc__ = """List all revisions merged into this branch."""
1968
_see_also = ['log', 'revision-history']
1969
takes_args = ['location?']
1974
def run(self, location="."):
1976
wt = WorkingTree.open_containing(location)[0]
1977
except errors.NoWorkingTree:
1978
b = Branch.open(location)
1979
last_revision = b.last_revision()
1982
last_revision = wt.last_revision()
1984
self.add_cleanup(b.repository.lock_read().unlock)
1985
graph = b.repository.get_graph()
1986
revisions = [revid for revid, parents in
1987
graph.iter_ancestry([last_revision])]
1988
for revision_id in reversed(revisions):
1989
if _mod_revision.is_null(revision_id):
1991
self.outf.write(revision_id + '\n')
1994
class cmd_init(Command):
1995
__doc__ = """Make a directory into a versioned branch.
1997
Use this to create an empty branch, or before importing an
2000
If there is a repository in a parent directory of the location, then
2001
the history of the branch will be stored in the repository. Otherwise
2002
init creates a standalone branch which carries its own history
2003
in the .bzr directory.
2005
If there is already a branch at the location but it has no working tree,
2006
the tree can be populated with 'bzr checkout'.
2008
Recipe for importing a tree of files::
2014
bzr commit -m "imported project"
2017
_see_also = ['init-repository', 'branch', 'checkout']
2018
takes_args = ['location?']
2020
Option('create-prefix',
2021
help='Create the path leading up to the branch '
2022
'if it does not already exist.'),
2023
RegistryOption('format',
2024
help='Specify a format for this branch. '
2025
'See "help formats".',
2026
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2027
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2028
value_switches=True,
2029
title="Branch format",
2031
Option('append-revisions-only',
2032
help='Never change revnos or the existing log.'
2033
' Append revisions to it only.'),
2035
'Create a branch without a working tree.')
2037
def run(self, location=None, format=None, append_revisions_only=False,
2038
create_prefix=False, no_tree=False):
2040
format = controldir.format_registry.make_bzrdir('default')
2041
if location is None:
2044
to_transport = transport.get_transport(location)
2046
# The path has to exist to initialize a
2047
# branch inside of it.
2048
# Just using os.mkdir, since I don't
2049
# believe that we want to create a bunch of
2050
# locations if the user supplies an extended path
2052
to_transport.ensure_base()
2053
except errors.NoSuchFile:
2054
if not create_prefix:
2055
raise errors.BzrCommandError(gettext("Parent directory of %s"
2057
"\nYou may supply --create-prefix to create all"
2058
" leading parent directories.")
2060
to_transport.create_prefix()
2063
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
2064
except errors.NotBranchError:
2065
# really a NotBzrDir error...
2066
create_branch = controldir.ControlDir.create_branch_convenience
2068
force_new_tree = False
2070
force_new_tree = None
2071
branch = create_branch(to_transport.base, format=format,
2072
possible_transports=[to_transport],
2073
force_new_tree=force_new_tree)
2074
a_bzrdir = branch.bzrdir
2076
from bzrlib.transport.local import LocalTransport
2077
if a_bzrdir.has_branch():
2078
if (isinstance(to_transport, LocalTransport)
2079
and not a_bzrdir.has_workingtree()):
2080
raise errors.BranchExistsWithoutWorkingTree(location)
2081
raise errors.AlreadyBranchError(location)
2082
branch = a_bzrdir.create_branch()
2083
if not no_tree and not a_bzrdir.has_workingtree():
2084
a_bzrdir.create_workingtree()
2085
if append_revisions_only:
2087
branch.set_append_revisions_only(True)
2088
except errors.UpgradeRequired:
2089
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2090
' to append-revisions-only. Try --default.'))
2092
from bzrlib.info import describe_layout, describe_format
2094
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2095
except (errors.NoWorkingTree, errors.NotLocalUrl):
2097
repository = branch.repository
2098
layout = describe_layout(repository, branch, tree).lower()
2099
format = describe_format(a_bzrdir, repository, branch, tree)
2100
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2102
if repository.is_shared():
2103
#XXX: maybe this can be refactored into transport.path_or_url()
2104
url = repository.bzrdir.root_transport.external_url()
2106
url = urlutils.local_path_from_url(url)
2107
except errors.InvalidURL:
2109
self.outf.write(gettext("Using shared repository: %s\n") % url)
2112
class cmd_init_repository(Command):
2113
__doc__ = """Create a shared repository for branches to share storage space.
2115
New branches created under the repository directory will store their
2116
revisions in the repository, not in the branch directory. For branches
2117
with shared history, this reduces the amount of storage needed and
2118
speeds up the creation of new branches.
2120
If the --no-trees option is given then the branches in the repository
2121
will not have working trees by default. They will still exist as
2122
directories on disk, but they will not have separate copies of the
2123
files at a certain revision. This can be useful for repositories that
2124
store branches which are interacted with through checkouts or remote
2125
branches, such as on a server.
2128
Create a shared repository holding just branches::
2130
bzr init-repo --no-trees repo
2133
Make a lightweight checkout elsewhere::
2135
bzr checkout --lightweight repo/trunk trunk-checkout
2140
_see_also = ['init', 'branch', 'checkout', 'repositories']
2141
takes_args = ["location"]
2142
takes_options = [RegistryOption('format',
2143
help='Specify a format for this repository. See'
2144
' "bzr help formats" for details.',
2145
lazy_registry=('bzrlib.controldir', 'format_registry'),
2146
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2147
value_switches=True, title='Repository format'),
2149
help='Branches in the repository will default to'
2150
' not having a working tree.'),
2152
aliases = ["init-repo"]
2154
def run(self, location, format=None, no_trees=False):
2156
format = controldir.format_registry.make_bzrdir('default')
2158
if location is None:
2161
to_transport = transport.get_transport(location)
2163
(repo, newdir, require_stacking, repository_policy) = (
2164
format.initialize_on_transport_ex(to_transport,
2165
create_prefix=True, make_working_trees=not no_trees,
2166
shared_repo=True, force_new_repo=True,
2167
use_existing_dir=True,
2168
repo_format_name=format.repository_format.get_format_string()))
2170
from bzrlib.info import show_bzrdir_info
2171
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2174
class cmd_diff(Command):
2175
__doc__ = """Show differences in the working tree, between revisions or branches.
2177
If no arguments are given, all changes for the current tree are listed.
2178
If files are given, only the changes in those files are listed.
2179
Remote and multiple branches can be compared by using the --old and
2180
--new options. If not provided, the default for both is derived from
2181
the first argument, if any, or the current tree if no arguments are
2184
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2185
produces patches suitable for "patch -p1".
2187
Note that when using the -r argument with a range of revisions, the
2188
differences are computed between the two specified revisions. That
2189
is, the command does not show the changes introduced by the first
2190
revision in the range. This differs from the interpretation of
2191
revision ranges used by "bzr log" which includes the first revision
2196
2 - unrepresentable changes
2201
Shows the difference in the working tree versus the last commit::
2205
Difference between the working tree and revision 1::
2209
Difference between revision 3 and revision 1::
2213
Difference between revision 3 and revision 1 for branch xxx::
2217
The changes introduced by revision 2 (equivalent to -r1..2)::
2221
To see the changes introduced by revision X::
2225
Note that in the case of a merge, the -c option shows the changes
2226
compared to the left hand parent. To see the changes against
2227
another parent, use::
2229
bzr diff -r<chosen_parent>..X
2231
The changes between the current revision and the previous revision
2232
(equivalent to -c-1 and -r-2..-1)
2236
Show just the differences for file NEWS::
2240
Show the differences in working tree xxx for file NEWS::
2244
Show the differences from branch xxx to this working tree:
2248
Show the differences between two branches for file NEWS::
2250
bzr diff --old xxx --new yyy NEWS
2252
Same as 'bzr diff' but prefix paths with old/ and new/::
2254
bzr diff --prefix old/:new/
2256
Show the differences using a custom diff program with options::
2258
bzr diff --using /usr/bin/diff --diff-options -wu
2260
_see_also = ['status']
2261
takes_args = ['file*']
2263
Option('diff-options', type=str,
2264
help='Pass these options to the external diff program.'),
2265
Option('prefix', type=str,
2267
help='Set prefixes added to old and new filenames, as '
2268
'two values separated by a colon. (eg "old/:new/").'),
2270
help='Branch/tree to compare from.',
2274
help='Branch/tree to compare to.',
2280
help='Use this command to compare files.',
2283
RegistryOption('format',
2285
help='Diff format to use.',
2286
lazy_registry=('bzrlib.diff', 'format_registry'),
2287
title='Diff format'),
2289
aliases = ['di', 'dif']
2290
encoding_type = 'exact'
2293
def run(self, revision=None, file_list=None, diff_options=None,
2294
prefix=None, old=None, new=None, using=None, format=None):
2295
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2298
if (prefix is None) or (prefix == '0'):
2306
old_label, new_label = prefix.split(":")
2308
raise errors.BzrCommandError(gettext(
2309
'--prefix expects two values separated by a colon'
2310
' (eg "old/:new/")'))
2312
if revision and len(revision) > 2:
2313
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2314
' one or two revision specifiers'))
2316
if using is not None and format is not None:
2317
raise errors.BzrCommandError(gettext(
2318
'{0} and {1} are mutually exclusive').format(
2319
'--using', '--format'))
2321
(old_tree, new_tree,
2322
old_branch, new_branch,
2323
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2324
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2325
# GNU diff on Windows uses ANSI encoding for filenames
2326
path_encoding = osutils.get_diff_header_encoding()
2327
return show_diff_trees(old_tree, new_tree, sys.stdout,
2328
specific_files=specific_files,
2329
external_diff_options=diff_options,
2330
old_label=old_label, new_label=new_label,
2331
extra_trees=extra_trees,
2332
path_encoding=path_encoding,
2337
class cmd_deleted(Command):
2338
__doc__ = """List files deleted in the working tree.
2340
# TODO: Show files deleted since a previous revision, or
2341
# between two revisions.
2342
# TODO: Much more efficient way to do this: read in new
2343
# directories with readdir, rather than stating each one. Same
2344
# level of effort but possibly much less IO. (Or possibly not,
2345
# if the directories are very large...)
2346
_see_also = ['status', 'ls']
2347
takes_options = ['directory', 'show-ids']
2350
def run(self, show_ids=False, directory=u'.'):
2351
tree = WorkingTree.open_containing(directory)[0]
2352
self.add_cleanup(tree.lock_read().unlock)
2353
old = tree.basis_tree()
2354
self.add_cleanup(old.lock_read().unlock)
2355
for path, ie in old.inventory.iter_entries():
2356
if not tree.has_id(ie.file_id):
2357
self.outf.write(path)
2359
self.outf.write(' ')
2360
self.outf.write(ie.file_id)
2361
self.outf.write('\n')
2364
class cmd_modified(Command):
2365
__doc__ = """List files modified in working tree.
2369
_see_also = ['status', 'ls']
2370
takes_options = ['directory', 'null']
2373
def run(self, null=False, directory=u'.'):
2374
tree = WorkingTree.open_containing(directory)[0]
2375
self.add_cleanup(tree.lock_read().unlock)
2376
td = tree.changes_from(tree.basis_tree())
2378
for path, id, kind, text_modified, meta_modified in td.modified:
2380
self.outf.write(path + '\0')
2382
self.outf.write(osutils.quotefn(path) + '\n')
2385
class cmd_added(Command):
2386
__doc__ = """List files added in working tree.
2390
_see_also = ['status', 'ls']
2391
takes_options = ['directory', 'null']
2394
def run(self, null=False, directory=u'.'):
2395
wt = WorkingTree.open_containing(directory)[0]
2396
self.add_cleanup(wt.lock_read().unlock)
2397
basis = wt.basis_tree()
2398
self.add_cleanup(basis.lock_read().unlock)
2399
basis_inv = basis.inventory
2402
if basis_inv.has_id(file_id):
2404
if inv.is_root(file_id) and len(basis_inv) == 0:
2406
path = inv.id2path(file_id)
2407
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2410
self.outf.write(path + '\0')
2412
self.outf.write(osutils.quotefn(path) + '\n')
2415
class cmd_root(Command):
2416
__doc__ = """Show the tree root directory.
2418
The root is the nearest enclosing directory with a .bzr control
2421
takes_args = ['filename?']
2423
def run(self, filename=None):
2424
"""Print the branch root."""
2425
tree = WorkingTree.open_containing(filename)[0]
2426
self.outf.write(tree.basedir + '\n')
2429
def _parse_limit(limitstring):
2431
return int(limitstring)
2433
msg = gettext("The limit argument must be an integer.")
2434
raise errors.BzrCommandError(msg)
2437
def _parse_levels(s):
2441
msg = gettext("The levels argument must be an integer.")
2442
raise errors.BzrCommandError(msg)
2445
class cmd_log(Command):
2446
__doc__ = """Show historical log for a branch or subset of a branch.
2448
log is bzr's default tool for exploring the history of a branch.
2449
The branch to use is taken from the first parameter. If no parameters
2450
are given, the branch containing the working directory is logged.
2451
Here are some simple examples::
2453
bzr log log the current branch
2454
bzr log foo.py log a file in its branch
2455
bzr log http://server/branch log a branch on a server
2457
The filtering, ordering and information shown for each revision can
2458
be controlled as explained below. By default, all revisions are
2459
shown sorted (topologically) so that newer revisions appear before
2460
older ones and descendants always appear before ancestors. If displayed,
2461
merged revisions are shown indented under the revision in which they
2466
The log format controls how information about each revision is
2467
displayed. The standard log formats are called ``long``, ``short``
2468
and ``line``. The default is long. See ``bzr help log-formats``
2469
for more details on log formats.
2471
The following options can be used to control what information is
2474
-l N display a maximum of N revisions
2475
-n N display N levels of revisions (0 for all, 1 for collapsed)
2476
-v display a status summary (delta) for each revision
2477
-p display a diff (patch) for each revision
2478
--show-ids display revision-ids (and file-ids), not just revnos
2480
Note that the default number of levels to display is a function of the
2481
log format. If the -n option is not used, the standard log formats show
2482
just the top level (mainline).
2484
Status summaries are shown using status flags like A, M, etc. To see
2485
the changes explained using words like ``added`` and ``modified``
2486
instead, use the -vv option.
2490
To display revisions from oldest to newest, use the --forward option.
2491
In most cases, using this option will have little impact on the total
2492
time taken to produce a log, though --forward does not incrementally
2493
display revisions like --reverse does when it can.
2495
:Revision filtering:
2497
The -r option can be used to specify what revision or range of revisions
2498
to filter against. The various forms are shown below::
2500
-rX display revision X
2501
-rX.. display revision X and later
2502
-r..Y display up to and including revision Y
2503
-rX..Y display from X to Y inclusive
2505
See ``bzr help revisionspec`` for details on how to specify X and Y.
2506
Some common examples are given below::
2508
-r-1 show just the tip
2509
-r-10.. show the last 10 mainline revisions
2510
-rsubmit:.. show what's new on this branch
2511
-rancestor:path.. show changes since the common ancestor of this
2512
branch and the one at location path
2513
-rdate:yesterday.. show changes since yesterday
2515
When logging a range of revisions using -rX..Y, log starts at
2516
revision Y and searches back in history through the primary
2517
("left-hand") parents until it finds X. When logging just the
2518
top level (using -n1), an error is reported if X is not found
2519
along the way. If multi-level logging is used (-n0), X may be
2520
a nested merge revision and the log will be truncated accordingly.
2524
If parameters are given and the first one is not a branch, the log
2525
will be filtered to show only those revisions that changed the
2526
nominated files or directories.
2528
Filenames are interpreted within their historical context. To log a
2529
deleted file, specify a revision range so that the file existed at
2530
the end or start of the range.
2532
Historical context is also important when interpreting pathnames of
2533
renamed files/directories. Consider the following example:
2535
* revision 1: add tutorial.txt
2536
* revision 2: modify tutorial.txt
2537
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2541
* ``bzr log guide.txt`` will log the file added in revision 1
2543
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2545
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2546
the original file in revision 2.
2548
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2549
was no file called guide.txt in revision 2.
2551
Renames are always followed by log. By design, there is no need to
2552
explicitly ask for this (and no way to stop logging a file back
2553
until it was last renamed).
2557
The --match option can be used for finding revisions that match a
2558
regular expression in a commit message, committer, author or bug.
2559
Specifying the option several times will match any of the supplied
2560
expressions. --match-author, --match-bugs, --match-committer and
2561
--match-message can be used to only match a specific field.
2565
GUI tools and IDEs are often better at exploring history than command
2566
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2567
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2568
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2569
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2571
You may find it useful to add the aliases below to ``bazaar.conf``::
2575
top = log -l10 --line
2578
``bzr tip`` will then show the latest revision while ``bzr top``
2579
will show the last 10 mainline revisions. To see the details of a
2580
particular revision X, ``bzr show -rX``.
2582
If you are interested in looking deeper into a particular merge X,
2583
use ``bzr log -n0 -rX``.
2585
``bzr log -v`` on a branch with lots of history is currently
2586
very slow. A fix for this issue is currently under development.
2587
With or without that fix, it is recommended that a revision range
2588
be given when using the -v option.
2590
bzr has a generic full-text matching plugin, bzr-search, that can be
2591
used to find revisions matching user names, commit messages, etc.
2592
Among other features, this plugin can find all revisions containing
2593
a list of words but not others.
2595
When exploring non-mainline history on large projects with deep
2596
history, the performance of log can be greatly improved by installing
2597
the historycache plugin. This plugin buffers historical information
2598
trading disk space for faster speed.
2600
takes_args = ['file*']
2601
_see_also = ['log-formats', 'revisionspec']
2604
help='Show from oldest to newest.'),
2606
custom_help('verbose',
2607
help='Show files changed in each revision.'),
2611
type=bzrlib.option._parse_revision_str,
2613
help='Show just the specified revision.'
2614
' See also "help revisionspec".'),
2616
RegistryOption('authors',
2617
'What names to list as authors - first, all or committer.',
2619
lazy_registry=('bzrlib.log', 'author_list_registry'),
2623
help='Number of levels to display - 0 for all, 1 for flat.',
2625
type=_parse_levels),
2627
help='Show revisions whose message matches this '
2628
'regular expression.',
2633
help='Limit the output to the first N revisions.',
2638
help='Show changes made in each revision as a patch.'),
2639
Option('include-merged',
2640
help='Show merged revisions like --levels 0 does.'),
2641
Option('include-merges', hidden=True,
2642
help='Historical alias for --include-merged.'),
2643
Option('omit-merges',
2644
help='Do not report commits with more than one parent.'),
2645
Option('exclude-common-ancestry',
2646
help='Display only the revisions that are not part'
2647
' of both ancestries (require -rX..Y).'
2649
Option('signatures',
2650
help='Show digital signature validity.'),
2653
help='Show revisions whose properties match this '
2656
ListOption('match-message',
2657
help='Show revisions whose message matches this '
2660
ListOption('match-committer',
2661
help='Show revisions whose committer matches this '
2664
ListOption('match-author',
2665
help='Show revisions whose authors match this '
2668
ListOption('match-bugs',
2669
help='Show revisions whose bugs match this '
2673
encoding_type = 'replace'
2676
def run(self, file_list=None, timezone='original',
2687
include_merged=None,
2689
exclude_common_ancestry=False,
2693
match_committer=None,
2697
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2699
from bzrlib.log import (
2701
make_log_request_dict,
2702
_get_info_for_log_files,
2704
direction = (forward and 'forward') or 'reverse'
2705
if symbol_versioning.deprecated_passed(include_merges):
2706
ui.ui_factory.show_user_warning(
2707
'deprecated_command_option',
2708
deprecated_name='--include-merges',
2709
recommended_name='--include-merged',
2710
deprecated_in_version='2.5',
2711
command=self.invoked_as)
2712
if include_merged is None:
2713
include_merged = include_merges
2715
raise errors.BzrCommandError(gettext(
2716
'{0} and {1} are mutually exclusive').format(
2717
'--include-merges', '--include-merged'))
2718
if include_merged is None:
2719
include_merged = False
2720
if (exclude_common_ancestry
2721
and (revision is None or len(revision) != 2)):
2722
raise errors.BzrCommandError(gettext(
2723
'--exclude-common-ancestry requires -r with two revisions'))
2728
raise errors.BzrCommandError(gettext(
2729
'{0} and {1} are mutually exclusive').format(
2730
'--levels', '--include-merged'))
2732
if change is not None:
2734
raise errors.RangeInChangeOption()
2735
if revision is not None:
2736
raise errors.BzrCommandError(gettext(
2737
'{0} and {1} are mutually exclusive').format(
2738
'--revision', '--change'))
2743
filter_by_dir = False
2745
# find the file ids to log and check for directory filtering
2746
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2747
revision, file_list, self.add_cleanup)
2748
for relpath, file_id, kind in file_info_list:
2750
raise errors.BzrCommandError(gettext(
2751
"Path unknown at end or start of revision range: %s") %
2753
# If the relpath is the top of the tree, we log everything
2758
file_ids.append(file_id)
2759
filter_by_dir = filter_by_dir or (
2760
kind in ['directory', 'tree-reference'])
2763
# FIXME ? log the current subdir only RBC 20060203
2764
if revision is not None \
2765
and len(revision) > 0 and revision[0].get_branch():
2766
location = revision[0].get_branch()
2769
dir, relpath = controldir.ControlDir.open_containing(location)
2770
b = dir.open_branch()
2771
self.add_cleanup(b.lock_read().unlock)
2772
rev1, rev2 = _get_revision_range(revision, b, self.name())
2774
if b.get_config().validate_signatures_in_log():
2778
if not gpg.GPGStrategy.verify_signatures_available():
2779
raise errors.GpgmeNotInstalled(None)
2781
# Decide on the type of delta & diff filtering to use
2782
# TODO: add an --all-files option to make this configurable & consistent
2790
diff_type = 'partial'
2794
# Build the log formatter
2795
if log_format is None:
2796
log_format = log.log_formatter_registry.get_default(b)
2797
# Make a non-encoding output to include the diffs - bug 328007
2798
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2799
lf = log_format(show_ids=show_ids, to_file=self.outf,
2800
to_exact_file=unencoded_output,
2801
show_timezone=timezone,
2802
delta_format=get_verbosity_level(),
2804
show_advice=levels is None,
2805
author_list_handler=authors)
2807
# Choose the algorithm for doing the logging. It's annoying
2808
# having multiple code paths like this but necessary until
2809
# the underlying repository format is faster at generating
2810
# deltas or can provide everything we need from the indices.
2811
# The default algorithm - match-using-deltas - works for
2812
# multiple files and directories and is faster for small
2813
# amounts of history (200 revisions say). However, it's too
2814
# slow for logging a single file in a repository with deep
2815
# history, i.e. > 10K revisions. In the spirit of "do no
2816
# evil when adding features", we continue to use the
2817
# original algorithm - per-file-graph - for the "single
2818
# file that isn't a directory without showing a delta" case.
2819
partial_history = revision and b.repository._format.supports_chks
2820
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2821
or delta_type or partial_history)
2825
match_dict[''] = match
2827
match_dict['message'] = match_message
2829
match_dict['committer'] = match_committer
2831
match_dict['author'] = match_author
2833
match_dict['bugs'] = match_bugs
2835
# Build the LogRequest and execute it
2836
if len(file_ids) == 0:
2838
rqst = make_log_request_dict(
2839
direction=direction, specific_fileids=file_ids,
2840
start_revision=rev1, end_revision=rev2, limit=limit,
2841
message_search=message, delta_type=delta_type,
2842
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2843
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2844
signature=signatures, omit_merges=omit_merges,
2846
Logger(b, rqst).show(lf)
2849
def _get_revision_range(revisionspec_list, branch, command_name):
2850
"""Take the input of a revision option and turn it into a revision range.
2852
It returns RevisionInfo objects which can be used to obtain the rev_id's
2853
of the desired revisions. It does some user input validations.
2855
if revisionspec_list is None:
2858
elif len(revisionspec_list) == 1:
2859
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2860
elif len(revisionspec_list) == 2:
2861
start_spec = revisionspec_list[0]
2862
end_spec = revisionspec_list[1]
2863
if end_spec.get_branch() != start_spec.get_branch():
2864
# b is taken from revision[0].get_branch(), and
2865
# show_log will use its revision_history. Having
2866
# different branches will lead to weird behaviors.
2867
raise errors.BzrCommandError(gettext(
2868
"bzr %s doesn't accept two revisions in different"
2869
" branches.") % command_name)
2870
if start_spec.spec is None:
2871
# Avoid loading all the history.
2872
rev1 = RevisionInfo(branch, None, None)
2874
rev1 = start_spec.in_history(branch)
2875
# Avoid loading all of history when we know a missing
2876
# end of range means the last revision ...
2877
if end_spec.spec is None:
2878
last_revno, last_revision_id = branch.last_revision_info()
2879
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2881
rev2 = end_spec.in_history(branch)
2883
raise errors.BzrCommandError(gettext(
2884
'bzr %s --revision takes one or two values.') % command_name)
2888
def _revision_range_to_revid_range(revision_range):
2891
if revision_range[0] is not None:
2892
rev_id1 = revision_range[0].rev_id
2893
if revision_range[1] is not None:
2894
rev_id2 = revision_range[1].rev_id
2895
return rev_id1, rev_id2
2897
def get_log_format(long=False, short=False, line=False, default='long'):
2898
log_format = default
2902
log_format = 'short'
2908
class cmd_touching_revisions(Command):
2909
__doc__ = """Return revision-ids which affected a particular file.
2911
A more user-friendly interface is "bzr log FILE".
2915
takes_args = ["filename"]
2918
def run(self, filename):
2919
tree, relpath = WorkingTree.open_containing(filename)
2920
file_id = tree.path2id(relpath)
2922
self.add_cleanup(b.lock_read().unlock)
2923
touching_revs = log.find_touching_revisions(b, file_id)
2924
for revno, revision_id, what in touching_revs:
2925
self.outf.write("%6d %s\n" % (revno, what))
2928
class cmd_ls(Command):
2929
__doc__ = """List files in a tree.
2932
_see_also = ['status', 'cat']
2933
takes_args = ['path?']
2937
Option('recursive', short_name='R',
2938
help='Recurse into subdirectories.'),
2940
help='Print paths relative to the root of the branch.'),
2941
Option('unknown', short_name='u',
2942
help='Print unknown files.'),
2943
Option('versioned', help='Print versioned files.',
2945
Option('ignored', short_name='i',
2946
help='Print ignored files.'),
2947
Option('kind', short_name='k',
2948
help='List entries of a particular kind: file, directory, symlink.',
2955
def run(self, revision=None, verbose=False,
2956
recursive=False, from_root=False,
2957
unknown=False, versioned=False, ignored=False,
2958
null=False, kind=None, show_ids=False, path=None, directory=None):
2960
if kind and kind not in ('file', 'directory', 'symlink'):
2961
raise errors.BzrCommandError(gettext('invalid kind specified'))
2963
if verbose and null:
2964
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2965
all = not (unknown or versioned or ignored)
2967
selection = {'I':ignored, '?':unknown, 'V':versioned}
2973
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2976
tree, branch, relpath = \
2977
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2979
# Calculate the prefix to use
2983
prefix = relpath + '/'
2984
elif fs_path != '.' and not fs_path.endswith('/'):
2985
prefix = fs_path + '/'
2987
if revision is not None or tree is None:
2988
tree = _get_one_revision_tree('ls', revision, branch=branch)
2991
if isinstance(tree, WorkingTree) and tree.supports_views():
2992
view_files = tree.views.lookup_view()
2995
view_str = views.view_display_str(view_files)
2996
note(gettext("Ignoring files outside view. View is %s") % view_str)
2998
self.add_cleanup(tree.lock_read().unlock)
2999
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3000
from_dir=relpath, recursive=recursive):
3001
# Apply additional masking
3002
if not all and not selection[fc]:
3004
if kind is not None and fkind != kind:
3009
fullpath = osutils.pathjoin(relpath, fp)
3012
views.check_path_in_view(tree, fullpath)
3013
except errors.FileOutsideView:
3018
fp = osutils.pathjoin(prefix, fp)
3019
kindch = entry.kind_character()
3020
outstring = fp + kindch
3021
ui.ui_factory.clear_term()
3023
outstring = '%-8s %s' % (fc, outstring)
3024
if show_ids and fid is not None:
3025
outstring = "%-50s %s" % (outstring, fid)
3026
self.outf.write(outstring + '\n')
3028
self.outf.write(fp + '\0')
3031
self.outf.write(fid)
3032
self.outf.write('\0')
3040
self.outf.write('%-50s %s\n' % (outstring, my_id))
3042
self.outf.write(outstring + '\n')
3045
class cmd_unknowns(Command):
3046
__doc__ = """List unknown files.
3051
takes_options = ['directory']
3054
def run(self, directory=u'.'):
3055
for f in WorkingTree.open_containing(directory)[0].unknowns():
3056
self.outf.write(osutils.quotefn(f) + '\n')
3059
class cmd_ignore(Command):
3060
__doc__ = """Ignore specified files or patterns.
3062
See ``bzr help patterns`` for details on the syntax of patterns.
3064
If a .bzrignore file does not exist, the ignore command
3065
will create one and add the specified files or patterns to the newly
3066
created file. The ignore command will also automatically add the
3067
.bzrignore file to be versioned. Creating a .bzrignore file without
3068
the use of the ignore command will require an explicit add command.
3070
To remove patterns from the ignore list, edit the .bzrignore file.
3071
After adding, editing or deleting that file either indirectly by
3072
using this command or directly by using an editor, be sure to commit
3075
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3076
the global ignore file can be found in the application data directory as
3077
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3078
Global ignores are not touched by this command. The global ignore file
3079
can be edited directly using an editor.
3081
Patterns prefixed with '!' are exceptions to ignore patterns and take
3082
precedence over regular ignores. Such exceptions are used to specify
3083
files that should be versioned which would otherwise be ignored.
3085
Patterns prefixed with '!!' act as regular ignore patterns, but have
3086
precedence over the '!' exception patterns.
3090
* Ignore patterns containing shell wildcards must be quoted from
3093
* Ignore patterns starting with "#" act as comments in the ignore file.
3094
To ignore patterns that begin with that character, use the "RE:" prefix.
3097
Ignore the top level Makefile::
3099
bzr ignore ./Makefile
3101
Ignore .class files in all directories...::
3103
bzr ignore "*.class"
3105
...but do not ignore "special.class"::
3107
bzr ignore "!special.class"
3109
Ignore files whose name begins with the "#" character::
3113
Ignore .o files under the lib directory::
3115
bzr ignore "lib/**/*.o"
3117
Ignore .o files under the lib directory::
3119
bzr ignore "RE:lib/.*\.o"
3121
Ignore everything but the "debian" toplevel directory::
3123
bzr ignore "RE:(?!debian/).*"
3125
Ignore everything except the "local" toplevel directory,
3126
but always ignore autosave files ending in ~, even under local/::
3129
bzr ignore "!./local"
3133
_see_also = ['status', 'ignored', 'patterns']
3134
takes_args = ['name_pattern*']
3135
takes_options = ['directory',
3136
Option('default-rules',
3137
help='Display the default ignore rules that bzr uses.')
3140
def run(self, name_pattern_list=None, default_rules=None,
3142
from bzrlib import ignores
3143
if default_rules is not None:
3144
# dump the default rules and exit
3145
for pattern in ignores.USER_DEFAULTS:
3146
self.outf.write("%s\n" % pattern)
3148
if not name_pattern_list:
3149
raise errors.BzrCommandError(gettext("ignore requires at least one "
3150
"NAME_PATTERN or --default-rules."))
3151
name_pattern_list = [globbing.normalize_pattern(p)
3152
for p in name_pattern_list]
3154
bad_patterns_count = 0
3155
for p in name_pattern_list:
3156
if not globbing.Globster.is_pattern_valid(p):
3157
bad_patterns_count += 1
3158
bad_patterns += ('\n %s' % p)
3160
msg = (ngettext('Invalid ignore pattern found. %s',
3161
'Invalid ignore patterns found. %s',
3162
bad_patterns_count) % bad_patterns)
3163
ui.ui_factory.show_error(msg)
3164
raise errors.InvalidPattern('')
3165
for name_pattern in name_pattern_list:
3166
if (name_pattern[0] == '/' or
3167
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3168
raise errors.BzrCommandError(gettext(
3169
"NAME_PATTERN should not be an absolute path"))
3170
tree, relpath = WorkingTree.open_containing(directory)
3171
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3172
ignored = globbing.Globster(name_pattern_list)
3174
self.add_cleanup(tree.lock_read().unlock)
3175
for entry in tree.list_files():
3179
if ignored.match(filename):
3180
matches.append(filename)
3181
if len(matches) > 0:
3182
self.outf.write(gettext("Warning: the following files are version "
3183
"controlled and match your ignore pattern:\n%s"
3184
"\nThese files will continue to be version controlled"
3185
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3188
class cmd_ignored(Command):
3189
__doc__ = """List ignored files and the patterns that matched them.
3191
List all the ignored files and the ignore pattern that caused the file to
3194
Alternatively, to list just the files::
3199
encoding_type = 'replace'
3200
_see_also = ['ignore', 'ls']
3201
takes_options = ['directory']
3204
def run(self, directory=u'.'):
3205
tree = WorkingTree.open_containing(directory)[0]
3206
self.add_cleanup(tree.lock_read().unlock)
3207
for path, file_class, kind, file_id, entry in tree.list_files():
3208
if file_class != 'I':
3210
## XXX: Slightly inefficient since this was already calculated
3211
pat = tree.is_ignored(path)
3212
self.outf.write('%-50s %s\n' % (path, pat))
3215
class cmd_lookup_revision(Command):
3216
__doc__ = """Lookup the revision-id from a revision-number
3219
bzr lookup-revision 33
3222
takes_args = ['revno']
3223
takes_options = ['directory']
3226
def run(self, revno, directory=u'.'):
3230
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3232
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3233
self.outf.write("%s\n" % revid)
3236
class cmd_export(Command):
3237
__doc__ = """Export current or past revision to a destination directory or archive.
3239
If no revision is specified this exports the last committed revision.
3241
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3242
given, try to find the format with the extension. If no extension
3243
is found exports to a directory (equivalent to --format=dir).
3245
If root is supplied, it will be used as the root directory inside
3246
container formats (tar, zip, etc). If it is not supplied it will default
3247
to the exported filename. The root option has no effect for 'dir' format.
3249
If branch is omitted then the branch containing the current working
3250
directory will be used.
3252
Note: Export of tree with non-ASCII filenames to zip is not supported.
3254
================= =========================
3255
Supported formats Autodetected by extension
3256
================= =========================
3259
tbz2 .tar.bz2, .tbz2
3262
================= =========================
3265
takes_args = ['dest', 'branch_or_subdir?']
3266
takes_options = ['directory',
3268
help="Type of file to export to.",
3271
Option('filters', help='Apply content filters to export the '
3272
'convenient form.'),
3275
help="Name of the root directory inside the exported file."),
3276
Option('per-file-timestamps',
3277
help='Set modification time of files to that of the last '
3278
'revision in which it was changed.'),
3279
Option('uncommitted',
3280
help='Export the working tree contents rather than that of the '
3283
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3284
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3286
from bzrlib.export import export
3288
if branch_or_subdir is None:
3289
branch_or_subdir = directory
3291
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3293
if tree is not None:
3294
self.add_cleanup(tree.lock_read().unlock)
3298
raise errors.BzrCommandError(
3299
gettext("--uncommitted requires a working tree"))
3302
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3304
export(export_tree, dest, format, root, subdir, filtered=filters,
3305
per_file_timestamps=per_file_timestamps)
3306
except errors.NoSuchExportFormat, e:
3307
raise errors.BzrCommandError(
3308
gettext('Unsupported export format: %s') % e.format)
3311
class cmd_cat(Command):
3312
__doc__ = """Write the contents of a file as of a given revision to standard output.
3314
If no revision is nominated, the last revision is used.
3316
Note: Take care to redirect standard output when using this command on a
3321
takes_options = ['directory',
3322
Option('name-from-revision', help='The path name in the old tree.'),
3323
Option('filters', help='Apply content filters to display the '
3324
'convenience form.'),
3327
takes_args = ['filename']
3328
encoding_type = 'exact'
3331
def run(self, filename, revision=None, name_from_revision=False,
3332
filters=False, directory=None):
3333
if revision is not None and len(revision) != 1:
3334
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3335
" one revision specifier"))
3336
tree, branch, relpath = \
3337
_open_directory_or_containing_tree_or_branch(filename, directory)
3338
self.add_cleanup(branch.lock_read().unlock)
3339
return self._run(tree, branch, relpath, filename, revision,
3340
name_from_revision, filters)
3342
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3345
tree = b.basis_tree()
3346
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3347
self.add_cleanup(rev_tree.lock_read().unlock)
3349
old_file_id = rev_tree.path2id(relpath)
3351
# TODO: Split out this code to something that generically finds the
3352
# best id for a path across one or more trees; it's like
3353
# find_ids_across_trees but restricted to find just one. -- mbp
3355
if name_from_revision:
3356
# Try in revision if requested
3357
if old_file_id is None:
3358
raise errors.BzrCommandError(gettext(
3359
"{0!r} is not present in revision {1}").format(
3360
filename, rev_tree.get_revision_id()))
3362
actual_file_id = old_file_id
3364
cur_file_id = tree.path2id(relpath)
3365
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3366
actual_file_id = cur_file_id
3367
elif old_file_id is not None:
3368
actual_file_id = old_file_id
3370
raise errors.BzrCommandError(gettext(
3371
"{0!r} is not present in revision {1}").format(
3372
filename, rev_tree.get_revision_id()))
3374
from bzrlib.filter_tree import ContentFilterTree
3375
filter_tree = ContentFilterTree(rev_tree,
3376
rev_tree._content_filter_stack)
3377
content = filter_tree.get_file_text(actual_file_id)
3379
content = rev_tree.get_file_text(actual_file_id)
3381
self.outf.write(content)
3384
class cmd_local_time_offset(Command):
3385
__doc__ = """Show the offset in seconds from GMT to local time."""
3389
self.outf.write("%s\n" % osutils.local_time_offset())
3393
class cmd_commit(Command):
3394
__doc__ = """Commit changes into a new revision.
3396
An explanatory message needs to be given for each commit. This is
3397
often done by using the --message option (getting the message from the
3398
command line) or by using the --file option (getting the message from
3399
a file). If neither of these options is given, an editor is opened for
3400
the user to enter the message. To see the changed files in the
3401
boilerplate text loaded into the editor, use the --show-diff option.
3403
By default, the entire tree is committed and the person doing the
3404
commit is assumed to be the author. These defaults can be overridden
3409
If selected files are specified, only changes to those files are
3410
committed. If a directory is specified then the directory and
3411
everything within it is committed.
3413
When excludes are given, they take precedence over selected files.
3414
For example, to commit only changes within foo, but not changes
3417
bzr commit foo -x foo/bar
3419
A selective commit after a merge is not yet supported.
3423
If the author of the change is not the same person as the committer,
3424
you can specify the author's name using the --author option. The
3425
name should be in the same format as a committer-id, e.g.
3426
"John Doe <jdoe@example.com>". If there is more than one author of
3427
the change you can specify the option multiple times, once for each
3432
A common mistake is to forget to add a new file or directory before
3433
running the commit command. The --strict option checks for unknown
3434
files and aborts the commit if any are found. More advanced pre-commit
3435
checks can be implemented by defining hooks. See ``bzr help hooks``
3440
If you accidentially commit the wrong changes or make a spelling
3441
mistake in the commit message say, you can use the uncommit command
3442
to undo it. See ``bzr help uncommit`` for details.
3444
Hooks can also be configured to run after a commit. This allows you
3445
to trigger updates to external systems like bug trackers. The --fixes
3446
option can be used to record the association between a revision and
3447
one or more bugs. See ``bzr help bugs`` for details.
3450
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3451
takes_args = ['selected*']
3453
ListOption('exclude', type=str, short_name='x',
3454
help="Do not consider changes made to a given path."),
3455
Option('message', type=unicode,
3457
help="Description of the new revision."),
3460
help='Commit even if nothing has changed.'),
3461
Option('file', type=str,
3464
help='Take commit message from this file.'),
3466
help="Refuse to commit if there are unknown "
3467
"files in the working tree."),
3468
Option('commit-time', type=str,
3469
help="Manually set a commit time using commit date "
3470
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3471
ListOption('fixes', type=str,
3472
help="Mark a bug as being fixed by this revision "
3473
"(see \"bzr help bugs\")."),
3474
ListOption('author', type=unicode,
3475
help="Set the author's name, if it's different "
3476
"from the committer."),
3478
help="Perform a local commit in a bound "
3479
"branch. Local commits are not pushed to "
3480
"the master branch until a normal commit "
3483
Option('show-diff', short_name='p',
3484
help='When no message is supplied, show the diff along'
3485
' with the status summary in the message editor.'),
3487
help='When committing to a foreign version control '
3488
'system do not push data that can not be natively '
3491
aliases = ['ci', 'checkin']
3493
def _iter_bug_fix_urls(self, fixes, branch):
3494
default_bugtracker = None
3495
# Configure the properties for bug fixing attributes.
3496
for fixed_bug in fixes:
3497
tokens = fixed_bug.split(':')
3498
if len(tokens) == 1:
3499
if default_bugtracker is None:
3500
branch_config = branch.get_config()
3501
default_bugtracker = branch_config.get_user_option(
3503
if default_bugtracker is None:
3504
raise errors.BzrCommandError(gettext(
3505
"No tracker specified for bug %s. Use the form "
3506
"'tracker:id' or specify a default bug tracker "
3507
"using the `bugtracker` option.\nSee "
3508
"\"bzr help bugs\" for more information on this "
3509
"feature. Commit refused.") % fixed_bug)
3510
tag = default_bugtracker
3512
elif len(tokens) != 2:
3513
raise errors.BzrCommandError(gettext(
3514
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3515
"See \"bzr help bugs\" for more information on this "
3516
"feature.\nCommit refused.") % fixed_bug)
3518
tag, bug_id = tokens
3520
yield bugtracker.get_bug_url(tag, branch, bug_id)
3521
except errors.UnknownBugTrackerAbbreviation:
3522
raise errors.BzrCommandError(gettext(
3523
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3524
except errors.MalformedBugIdentifier, e:
3525
raise errors.BzrCommandError(gettext(
3526
"%s\nCommit refused.") % (str(e),))
3528
def run(self, message=None, file=None, verbose=False, selected_list=None,
3529
unchanged=False, strict=False, local=False, fixes=None,
3530
author=None, show_diff=False, exclude=None, commit_time=None,
3532
from bzrlib.errors import (
3537
from bzrlib.msgeditor import (
3538
edit_commit_message_encoded,
3539
generate_commit_message_template,
3540
make_commit_message_template_encoded,
3544
commit_stamp = offset = None
3545
if commit_time is not None:
3547
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3548
except ValueError, e:
3549
raise errors.BzrCommandError(gettext(
3550
"Could not parse --commit-time: " + str(e)))
3554
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3555
if selected_list == ['']:
3556
# workaround - commit of root of tree should be exactly the same
3557
# as just default commit in that tree, and succeed even though
3558
# selected-file merge commit is not done yet
3563
bug_property = bugtracker.encode_fixes_bug_urls(
3564
self._iter_bug_fix_urls(fixes, tree.branch))
3566
properties['bugs'] = bug_property
3568
if local and not tree.branch.get_bound_location():
3569
raise errors.LocalRequiresBoundBranch()
3571
if message is not None:
3573
file_exists = osutils.lexists(message)
3574
except UnicodeError:
3575
# The commit message contains unicode characters that can't be
3576
# represented in the filesystem encoding, so that can't be a
3581
'The commit message is a file name: "%(f)s".\n'
3582
'(use --file "%(f)s" to take commit message from that file)'
3584
ui.ui_factory.show_warning(warning_msg)
3586
message = message.replace('\r\n', '\n')
3587
message = message.replace('\r', '\n')
3589
raise errors.BzrCommandError(gettext(
3590
"please specify either --message or --file"))
3592
def get_message(commit_obj):
3593
"""Callback to get commit message"""
3597
my_message = f.read().decode(osutils.get_user_encoding())
3600
elif message is not None:
3601
my_message = message
3603
# No message supplied: make one up.
3604
# text is the status of the tree
3605
text = make_commit_message_template_encoded(tree,
3606
selected_list, diff=show_diff,
3607
output_encoding=osutils.get_user_encoding())
3608
# start_message is the template generated from hooks
3609
# XXX: Warning - looks like hooks return unicode,
3610
# make_commit_message_template_encoded returns user encoding.
3611
# We probably want to be using edit_commit_message instead to
3613
my_message = set_commit_message(commit_obj)
3614
if my_message is None:
3615
start_message = generate_commit_message_template(commit_obj)
3616
my_message = edit_commit_message_encoded(text,
3617
start_message=start_message)
3618
if my_message is None:
3619
raise errors.BzrCommandError(gettext("please specify a commit"
3620
" message with either --message or --file"))
3621
if my_message == "":
3622
raise errors.BzrCommandError(gettext("Empty commit message specified."
3623
" Please specify a commit message with either"
3624
" --message or --file or leave a blank message"
3625
" with --message \"\"."))
3628
# The API permits a commit with a filter of [] to mean 'select nothing'
3629
# but the command line should not do that.
3630
if not selected_list:
3631
selected_list = None
3633
tree.commit(message_callback=get_message,
3634
specific_files=selected_list,
3635
allow_pointless=unchanged, strict=strict, local=local,
3636
reporter=None, verbose=verbose, revprops=properties,
3637
authors=author, timestamp=commit_stamp,
3639
exclude=tree.safe_relpath_files(exclude),
3641
except PointlessCommit:
3642
raise errors.BzrCommandError(gettext("No changes to commit."
3643
" Please 'bzr add' the files you want to commit, or use"
3644
" --unchanged to force an empty commit."))
3645
except ConflictsInTree:
3646
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3647
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3649
except StrictCommitFailed:
3650
raise errors.BzrCommandError(gettext("Commit refused because there are"
3651
" unknown files in the working tree."))
3652
except errors.BoundBranchOutOfDate, e:
3653
e.extra_help = (gettext("\n"
3654
'To commit to master branch, run update and then commit.\n'
3655
'You can also pass --local to commit to continue working '
3660
class cmd_check(Command):
3661
__doc__ = """Validate working tree structure, branch consistency and repository history.
3663
This command checks various invariants about branch and repository storage
3664
to detect data corruption or bzr bugs.
3666
The working tree and branch checks will only give output if a problem is
3667
detected. The output fields of the repository check are:
3670
This is just the number of revisions checked. It doesn't
3674
This is just the number of versionedfiles checked. It
3675
doesn't indicate a problem.
3677
unreferenced ancestors
3678
Texts that are ancestors of other texts, but
3679
are not properly referenced by the revision ancestry. This is a
3680
subtle problem that Bazaar can work around.
3683
This is the total number of unique file contents
3684
seen in the checked revisions. It does not indicate a problem.
3687
This is the total number of repeated texts seen
3688
in the checked revisions. Texts can be repeated when their file
3689
entries are modified, but the file contents are not. It does not
3692
If no restrictions are specified, all Bazaar data that is found at the given
3693
location will be checked.
3697
Check the tree and branch at 'foo'::
3699
bzr check --tree --branch foo
3701
Check only the repository at 'bar'::
3703
bzr check --repo bar
3705
Check everything at 'baz'::
3710
_see_also = ['reconcile']
3711
takes_args = ['path?']
3712
takes_options = ['verbose',
3713
Option('branch', help="Check the branch related to the"
3714
" current directory."),
3715
Option('repo', help="Check the repository related to the"
3716
" current directory."),
3717
Option('tree', help="Check the working tree related to"
3718
" the current directory.")]
3720
def run(self, path=None, verbose=False, branch=False, repo=False,
3722
from bzrlib.check import check_dwim
3725
if not branch and not repo and not tree:
3726
branch = repo = tree = True
3727
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3730
class cmd_upgrade(Command):
3731
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3733
When the default format has changed after a major new release of
3734
Bazaar, you may be informed during certain operations that you
3735
should upgrade. Upgrading to a newer format may improve performance
3736
or make new features available. It may however limit interoperability
3737
with older repositories or with older versions of Bazaar.
3739
If you wish to upgrade to a particular format rather than the
3740
current default, that can be specified using the --format option.
3741
As a consequence, you can use the upgrade command this way to
3742
"downgrade" to an earlier format, though some conversions are
3743
a one way process (e.g. changing from the 1.x default to the
3744
2.x default) so downgrading is not always possible.
3746
A backup.bzr.~#~ directory is created at the start of the conversion
3747
process (where # is a number). By default, this is left there on
3748
completion. If the conversion fails, delete the new .bzr directory
3749
and rename this one back in its place. Use the --clean option to ask
3750
for the backup.bzr directory to be removed on successful conversion.
3751
Alternatively, you can delete it by hand if everything looks good
3754
If the location given is a shared repository, dependent branches
3755
are also converted provided the repository converts successfully.
3756
If the conversion of a branch fails, remaining branches are still
3759
For more information on upgrades, see the Bazaar Upgrade Guide,
3760
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3763
_see_also = ['check', 'reconcile', 'formats']
3764
takes_args = ['url?']
3766
RegistryOption('format',
3767
help='Upgrade to a specific format. See "bzr help'
3768
' formats" for details.',
3769
lazy_registry=('bzrlib.controldir', 'format_registry'),
3770
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3771
value_switches=True, title='Branch format'),
3773
help='Remove the backup.bzr directory if successful.'),
3775
help="Show what would be done, but don't actually do anything."),
3778
def run(self, url='.', format=None, clean=False, dry_run=False):
3779
from bzrlib.upgrade import upgrade
3780
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3782
if len(exceptions) == 1:
3783
# Compatibility with historical behavior
3789
class cmd_whoami(Command):
3790
__doc__ = """Show or set bzr user id.
3793
Show the email of the current user::
3797
Set the current user::
3799
bzr whoami "Frank Chu <fchu@example.com>"
3801
takes_options = [ 'directory',
3803
help='Display email address only.'),
3805
help='Set identity for the current branch instead of '
3808
takes_args = ['name?']
3809
encoding_type = 'replace'
3812
def run(self, email=False, branch=False, name=None, directory=None):
3814
if directory is None:
3815
# use branch if we're inside one; otherwise global config
3817
c = Branch.open_containing(u'.')[0].get_config_stack()
3818
except errors.NotBranchError:
3819
c = _mod_config.GlobalStack()
3821
c = Branch.open(directory).get_config_stack()
3822
identity = c.get('email')
3824
self.outf.write(_mod_config.extract_email_address(identity)
3827
self.outf.write(identity + '\n')
3831
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3834
# display a warning if an email address isn't included in the given name.
3836
_mod_config.extract_email_address(name)
3837
except errors.NoEmailInUsername, e:
3838
warning('"%s" does not seem to contain an email address. '
3839
'This is allowed, but not recommended.', name)
3841
# use global config unless --branch given
3843
if directory is None:
3844
c = Branch.open_containing(u'.')[0].get_config_stack()
3846
c = Branch.open(directory).get_config_stack()
3848
c = _mod_config.GlobalStack()
3849
c.set('email', name)
3852
class cmd_nick(Command):
3853
__doc__ = """Print or set the branch nickname.
3855
If unset, the tree root directory name is used as the nickname.
3856
To print the current nickname, execute with no argument.
3858
Bound branches use the nickname of its master branch unless it is set
3862
_see_also = ['info']
3863
takes_args = ['nickname?']
3864
takes_options = ['directory']
3865
def run(self, nickname=None, directory=u'.'):
3866
branch = Branch.open_containing(directory)[0]
3867
if nickname is None:
3868
self.printme(branch)
3870
branch.nick = nickname
3873
def printme(self, branch):
3874
self.outf.write('%s\n' % branch.nick)
3877
class cmd_alias(Command):
3878
__doc__ = """Set/unset and display aliases.
3881
Show the current aliases::
3885
Show the alias specified for 'll'::
3889
Set an alias for 'll'::
3891
bzr alias ll="log --line -r-10..-1"
3893
To remove an alias for 'll'::
3895
bzr alias --remove ll
3898
takes_args = ['name?']
3900
Option('remove', help='Remove the alias.'),
3903
def run(self, name=None, remove=False):
3905
self.remove_alias(name)
3907
self.print_aliases()
3909
equal_pos = name.find('=')
3911
self.print_alias(name)
3913
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3915
def remove_alias(self, alias_name):
3916
if alias_name is None:
3917
raise errors.BzrCommandError(gettext(
3918
'bzr alias --remove expects an alias to remove.'))
3919
# If alias is not found, print something like:
3920
# unalias: foo: not found
3921
c = _mod_config.GlobalConfig()
3922
c.unset_alias(alias_name)
3925
def print_aliases(self):
3926
"""Print out the defined aliases in a similar format to bash."""
3927
aliases = _mod_config.GlobalConfig().get_aliases()
3928
for key, value in sorted(aliases.iteritems()):
3929
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3932
def print_alias(self, alias_name):
3933
from bzrlib.commands import get_alias
3934
alias = get_alias(alias_name)
3936
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3939
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3941
def set_alias(self, alias_name, alias_command):
3942
"""Save the alias in the global config."""
3943
c = _mod_config.GlobalConfig()
3944
c.set_alias(alias_name, alias_command)
3947
class cmd_selftest(Command):
3948
__doc__ = """Run internal test suite.
3950
If arguments are given, they are regular expressions that say which tests
3951
should run. Tests matching any expression are run, and other tests are
3954
Alternatively if --first is given, matching tests are run first and then
3955
all other tests are run. This is useful if you have been working in a
3956
particular area, but want to make sure nothing else was broken.
3958
If --exclude is given, tests that match that regular expression are
3959
excluded, regardless of whether they match --first or not.
3961
To help catch accidential dependencies between tests, the --randomize
3962
option is useful. In most cases, the argument used is the word 'now'.
3963
Note that the seed used for the random number generator is displayed
3964
when this option is used. The seed can be explicitly passed as the
3965
argument to this option if required. This enables reproduction of the
3966
actual ordering used if and when an order sensitive problem is encountered.
3968
If --list-only is given, the tests that would be run are listed. This is
3969
useful when combined with --first, --exclude and/or --randomize to
3970
understand their impact. The test harness reports "Listed nn tests in ..."
3971
instead of "Ran nn tests in ..." when list mode is enabled.
3973
If the global option '--no-plugins' is given, plugins are not loaded
3974
before running the selftests. This has two effects: features provided or
3975
modified by plugins will not be tested, and tests provided by plugins will
3978
Tests that need working space on disk use a common temporary directory,
3979
typically inside $TMPDIR or /tmp.
3981
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3982
into a pdb postmortem session.
3984
The --coverage=DIRNAME global option produces a report with covered code
3988
Run only tests relating to 'ignore'::
3992
Disable plugins and list tests as they're run::
3994
bzr --no-plugins selftest -v
3996
# NB: this is used from the class without creating an instance, which is
3997
# why it does not have a self parameter.
3998
def get_transport_type(typestring):
3999
"""Parse and return a transport specifier."""
4000
if typestring == "sftp":
4001
from bzrlib.tests import stub_sftp
4002
return stub_sftp.SFTPAbsoluteServer
4003
elif typestring == "memory":
4004
from bzrlib.tests import test_server
4005
return memory.MemoryServer
4006
elif typestring == "fakenfs":
4007
from bzrlib.tests import test_server
4008
return test_server.FakeNFSServer
4009
msg = "No known transport type %s. Supported types are: sftp\n" %\
4011
raise errors.BzrCommandError(msg)
4014
takes_args = ['testspecs*']
4015
takes_options = ['verbose',
4017
help='Stop when one test fails.',
4021
help='Use a different transport by default '
4022
'throughout the test suite.',
4023
type=get_transport_type),
4025
help='Run the benchmarks rather than selftests.',
4027
Option('lsprof-timed',
4028
help='Generate lsprof output for benchmarked'
4029
' sections of code.'),
4030
Option('lsprof-tests',
4031
help='Generate lsprof output for each test.'),
4033
help='Run all tests, but run specified tests first.',
4037
help='List the tests instead of running them.'),
4038
RegistryOption('parallel',
4039
help="Run the test suite in parallel.",
4040
lazy_registry=('bzrlib.tests', 'parallel_registry'),
4041
value_switches=False,
4043
Option('randomize', type=str, argname="SEED",
4044
help='Randomize the order of tests using the given'
4045
' seed or "now" for the current time.'),
4046
ListOption('exclude', type=str, argname="PATTERN",
4048
help='Exclude tests that match this regular'
4051
help='Output test progress via subunit.'),
4052
Option('strict', help='Fail on missing dependencies or '
4054
Option('load-list', type=str, argname='TESTLISTFILE',
4055
help='Load a test id list from a text file.'),
4056
ListOption('debugflag', type=str, short_name='E',
4057
help='Turn on a selftest debug flag.'),
4058
ListOption('starting-with', type=str, argname='TESTID',
4059
param_name='starting_with', short_name='s',
4061
'Load only the tests starting with TESTID.'),
4063
help="By default we disable fsync and fdatasync"
4064
" while running the test suite.")
4066
encoding_type = 'replace'
4069
Command.__init__(self)
4070
self.additional_selftest_args = {}
4072
def run(self, testspecs_list=None, verbose=False, one=False,
4073
transport=None, benchmark=None,
4075
first=False, list_only=False,
4076
randomize=None, exclude=None, strict=False,
4077
load_list=None, debugflag=None, starting_with=None, subunit=False,
4078
parallel=None, lsprof_tests=False,
4081
# During selftest, disallow proxying, as it can cause severe
4082
# performance penalties and is only needed for thread
4083
# safety. The selftest command is assumed to not use threads
4084
# too heavily. The call should be as early as possible, as
4085
# error reporting for past duplicate imports won't have useful
4087
lazy_import.disallow_proxying()
4089
from bzrlib import tests
4091
if testspecs_list is not None:
4092
pattern = '|'.join(testspecs_list)
4097
from bzrlib.tests import SubUnitBzrRunner
4099
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4100
"needs to be installed to use --subunit."))
4101
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4102
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4103
# stdout, which would corrupt the subunit stream.
4104
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4105
# following code can be deleted when it's sufficiently deployed
4106
# -- vila/mgz 20100514
4107
if (sys.platform == "win32"
4108
and getattr(sys.stdout, 'fileno', None) is not None):
4110
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4112
self.additional_selftest_args.setdefault(
4113
'suite_decorators', []).append(parallel)
4115
raise errors.BzrCommandError(gettext(
4116
"--benchmark is no longer supported from bzr 2.2; "
4117
"use bzr-usertest instead"))
4118
test_suite_factory = None
4120
exclude_pattern = None
4122
exclude_pattern = '(' + '|'.join(exclude) + ')'
4124
self._disable_fsync()
4125
selftest_kwargs = {"verbose": verbose,
4127
"stop_on_failure": one,
4128
"transport": transport,
4129
"test_suite_factory": test_suite_factory,
4130
"lsprof_timed": lsprof_timed,
4131
"lsprof_tests": lsprof_tests,
4132
"matching_tests_first": first,
4133
"list_only": list_only,
4134
"random_seed": randomize,
4135
"exclude_pattern": exclude_pattern,
4137
"load_list": load_list,
4138
"debug_flags": debugflag,
4139
"starting_with": starting_with
4141
selftest_kwargs.update(self.additional_selftest_args)
4143
# Make deprecation warnings visible, unless -Werror is set
4144
cleanup = symbol_versioning.activate_deprecation_warnings(
4147
result = tests.selftest(**selftest_kwargs)
4150
return int(not result)
4152
def _disable_fsync(self):
4153
"""Change the 'os' functionality to not synchronize."""
4154
self._orig_fsync = getattr(os, 'fsync', None)
4155
if self._orig_fsync is not None:
4156
os.fsync = lambda filedes: None
4157
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4158
if self._orig_fdatasync is not None:
4159
os.fdatasync = lambda filedes: None
4162
class cmd_version(Command):
4163
__doc__ = """Show version of bzr."""
4165
encoding_type = 'replace'
4167
Option("short", help="Print just the version number."),
4171
def run(self, short=False):
4172
from bzrlib.version import show_version
4174
self.outf.write(bzrlib.version_string + '\n')
4176
show_version(to_file=self.outf)
4179
class cmd_rocks(Command):
4180
__doc__ = """Statement of optimism."""
4186
self.outf.write(gettext("It sure does!\n"))
4189
class cmd_find_merge_base(Command):
4190
__doc__ = """Find and print a base revision for merging two branches."""
4191
# TODO: Options to specify revisions on either side, as if
4192
# merging only part of the history.
4193
takes_args = ['branch', 'other']
4197
def run(self, branch, other):
4198
from bzrlib.revision import ensure_null
4200
branch1 = Branch.open_containing(branch)[0]
4201
branch2 = Branch.open_containing(other)[0]
4202
self.add_cleanup(branch1.lock_read().unlock)
4203
self.add_cleanup(branch2.lock_read().unlock)
4204
last1 = ensure_null(branch1.last_revision())
4205
last2 = ensure_null(branch2.last_revision())
4207
graph = branch1.repository.get_graph(branch2.repository)
4208
base_rev_id = graph.find_unique_lca(last1, last2)
4210
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4213
class cmd_merge(Command):
4214
__doc__ = """Perform a three-way merge.
4216
The source of the merge can be specified either in the form of a branch,
4217
or in the form of a path to a file containing a merge directive generated
4218
with bzr send. If neither is specified, the default is the upstream branch
4219
or the branch most recently merged using --remember. The source of the
4220
merge may also be specified in the form of a path to a file in another
4221
branch: in this case, only the modifications to that file are merged into
4222
the current working tree.
4224
When merging from a branch, by default bzr will try to merge in all new
4225
work from the other branch, automatically determining an appropriate base
4226
revision. If this fails, you may need to give an explicit base.
4228
To pick a different ending revision, pass "--revision OTHER". bzr will
4229
try to merge in all new work up to and including revision OTHER.
4231
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4232
through OTHER, excluding BASE but including OTHER, will be merged. If this
4233
causes some revisions to be skipped, i.e. if the destination branch does
4234
not already contain revision BASE, such a merge is commonly referred to as
4235
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4236
cherrypicks. The changes look like a normal commit, and the history of the
4237
changes from the other branch is not stored in the commit.
4239
Revision numbers are always relative to the source branch.
4241
Merge will do its best to combine the changes in two branches, but there
4242
are some kinds of problems only a human can fix. When it encounters those,
4243
it will mark a conflict. A conflict means that you need to fix something,
4244
before you can commit.
4246
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4248
If there is no default branch set, the first merge will set it (use
4249
--no-remember to avoid setting it). After that, you can omit the branch
4250
to use the default. To change the default, use --remember. The value will
4251
only be saved if the remote location can be accessed.
4253
The results of the merge are placed into the destination working
4254
directory, where they can be reviewed (with bzr diff), tested, and then
4255
committed to record the result of the merge.
4257
merge refuses to run if there are any uncommitted changes, unless
4258
--force is given. If --force is given, then the changes from the source
4259
will be merged with the current working tree, including any uncommitted
4260
changes in the tree. The --force option can also be used to create a
4261
merge revision which has more than two parents.
4263
If one would like to merge changes from the working tree of the other
4264
branch without merging any committed revisions, the --uncommitted option
4267
To select only some changes to merge, use "merge -i", which will prompt
4268
you to apply each diff hunk and file change, similar to "shelve".
4271
To merge all new revisions from bzr.dev::
4273
bzr merge ../bzr.dev
4275
To merge changes up to and including revision 82 from bzr.dev::
4277
bzr merge -r 82 ../bzr.dev
4279
To merge the changes introduced by 82, without previous changes::
4281
bzr merge -r 81..82 ../bzr.dev
4283
To apply a merge directive contained in /tmp/merge::
4285
bzr merge /tmp/merge
4287
To create a merge revision with three parents from two branches
4288
feature1a and feature1b:
4290
bzr merge ../feature1a
4291
bzr merge ../feature1b --force
4292
bzr commit -m 'revision with three parents'
4295
encoding_type = 'exact'
4296
_see_also = ['update', 'remerge', 'status-flags', 'send']
4297
takes_args = ['location?']
4302
help='Merge even if the destination tree has uncommitted changes.'),
4306
Option('show-base', help="Show base revision text in "
4308
Option('uncommitted', help='Apply uncommitted changes'
4309
' from a working copy, instead of branch changes.'),
4310
Option('pull', help='If the destination is already'
4311
' completely merged into the source, pull from the'
4312
' source rather than merging. When this happens,'
4313
' you do not need to commit the result.'),
4314
custom_help('directory',
4315
help='Branch to merge into, '
4316
'rather than the one containing the working directory.'),
4317
Option('preview', help='Instead of merging, show a diff of the'
4319
Option('interactive', help='Select changes interactively.',
4323
def run(self, location=None, revision=None, force=False,
4324
merge_type=None, show_base=False, reprocess=None, remember=None,
4325
uncommitted=False, pull=False,
4330
if merge_type is None:
4331
merge_type = _mod_merge.Merge3Merger
4333
if directory is None: directory = u'.'
4334
possible_transports = []
4336
allow_pending = True
4337
verified = 'inapplicable'
4339
tree = WorkingTree.open_containing(directory)[0]
4340
if tree.branch.revno() == 0:
4341
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4342
'https://bugs.launchpad.net/bzr/+bug/308562'))
4345
basis_tree = tree.revision_tree(tree.last_revision())
4346
except errors.NoSuchRevision:
4347
basis_tree = tree.basis_tree()
4349
# die as quickly as possible if there are uncommitted changes
4351
if tree.has_changes():
4352
raise errors.UncommittedChanges(tree)
4354
view_info = _get_view_info_for_change_reporter(tree)
4355
change_reporter = delta._ChangeReporter(
4356
unversioned_filter=tree.is_ignored, view_info=view_info)
4357
pb = ui.ui_factory.nested_progress_bar()
4358
self.add_cleanup(pb.finished)
4359
self.add_cleanup(tree.lock_write().unlock)
4360
if location is not None:
4362
mergeable = bundle.read_mergeable_from_url(location,
4363
possible_transports=possible_transports)
4364
except errors.NotABundle:
4368
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4369
' with bundles or merge directives.'))
4371
if revision is not None:
4372
raise errors.BzrCommandError(gettext(
4373
'Cannot use -r with merge directives or bundles'))
4374
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4377
if merger is None and uncommitted:
4378
if revision is not None and len(revision) > 0:
4379
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4380
' --revision at the same time.'))
4381
merger = self.get_merger_from_uncommitted(tree, location, None)
4382
allow_pending = False
4385
merger, allow_pending = self._get_merger_from_branch(tree,
4386
location, revision, remember, possible_transports, None)
4388
merger.merge_type = merge_type
4389
merger.reprocess = reprocess
4390
merger.show_base = show_base
4391
self.sanity_check_merger(merger)
4392
if (merger.base_rev_id == merger.other_rev_id and
4393
merger.other_rev_id is not None):
4394
# check if location is a nonexistent file (and not a branch) to
4395
# disambiguate the 'Nothing to do'
4396
if merger.interesting_files:
4397
if not merger.other_tree.has_filename(
4398
merger.interesting_files[0]):
4399
note(gettext("merger: ") + str(merger))
4400
raise errors.PathsDoNotExist([location])
4401
note(gettext('Nothing to do.'))
4403
if pull and not preview:
4404
if merger.interesting_files is not None:
4405
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4406
if (merger.base_rev_id == tree.last_revision()):
4407
result = tree.pull(merger.other_branch, False,
4408
merger.other_rev_id)
4409
result.report(self.outf)
4411
if merger.this_basis is None:
4412
raise errors.BzrCommandError(gettext(
4413
"This branch has no commits."
4414
" (perhaps you would prefer 'bzr pull')"))
4416
return self._do_preview(merger)
4418
return self._do_interactive(merger)
4420
return self._do_merge(merger, change_reporter, allow_pending,
4423
def _get_preview(self, merger):
4424
tree_merger = merger.make_merger()
4425
tt = tree_merger.make_preview_transform()
4426
self.add_cleanup(tt.finalize)
4427
result_tree = tt.get_preview_tree()
4430
def _do_preview(self, merger):
4431
from bzrlib.diff import show_diff_trees
4432
result_tree = self._get_preview(merger)
4433
path_encoding = osutils.get_diff_header_encoding()
4434
show_diff_trees(merger.this_tree, result_tree, self.outf,
4435
old_label='', new_label='',
4436
path_encoding=path_encoding)
4438
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4439
merger.change_reporter = change_reporter
4440
conflict_count = merger.do_merge()
4442
merger.set_pending()
4443
if verified == 'failed':
4444
warning('Preview patch does not match changes')
4445
if conflict_count != 0:
4450
def _do_interactive(self, merger):
4451
"""Perform an interactive merge.
4453
This works by generating a preview tree of the merge, then using
4454
Shelver to selectively remove the differences between the working tree
4455
and the preview tree.
4457
from bzrlib import shelf_ui
4458
result_tree = self._get_preview(merger)
4459
writer = bzrlib.option.diff_writer_registry.get()
4460
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4461
reporter=shelf_ui.ApplyReporter(),
4462
diff_writer=writer(sys.stdout))
4468
def sanity_check_merger(self, merger):
4469
if (merger.show_base and
4470
not merger.merge_type is _mod_merge.Merge3Merger):
4471
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4472
" merge type. %s") % merger.merge_type)
4473
if merger.reprocess is None:
4474
if merger.show_base:
4475
merger.reprocess = False
4477
# Use reprocess if the merger supports it
4478
merger.reprocess = merger.merge_type.supports_reprocess
4479
if merger.reprocess and not merger.merge_type.supports_reprocess:
4480
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4481
" for merge type %s.") %
4483
if merger.reprocess and merger.show_base:
4484
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4487
def _get_merger_from_branch(self, tree, location, revision, remember,
4488
possible_transports, pb):
4489
"""Produce a merger from a location, assuming it refers to a branch."""
4490
from bzrlib.tag import _merge_tags_if_possible
4491
# find the branch locations
4492
other_loc, user_location = self._select_branch_location(tree, location,
4494
if revision is not None and len(revision) == 2:
4495
base_loc, _unused = self._select_branch_location(tree,
4496
location, revision, 0)
4498
base_loc = other_loc
4500
other_branch, other_path = Branch.open_containing(other_loc,
4501
possible_transports)
4502
if base_loc == other_loc:
4503
base_branch = other_branch
4505
base_branch, base_path = Branch.open_containing(base_loc,
4506
possible_transports)
4507
# Find the revision ids
4508
other_revision_id = None
4509
base_revision_id = None
4510
if revision is not None:
4511
if len(revision) >= 1:
4512
other_revision_id = revision[-1].as_revision_id(other_branch)
4513
if len(revision) == 2:
4514
base_revision_id = revision[0].as_revision_id(base_branch)
4515
if other_revision_id is None:
4516
other_revision_id = _mod_revision.ensure_null(
4517
other_branch.last_revision())
4518
# Remember where we merge from. We need to remember if:
4519
# - user specify a location (and we don't merge from the parent
4521
# - user ask to remember or there is no previous location set to merge
4522
# from and user didn't ask to *not* remember
4523
if (user_location is not None
4525
or (remember is None
4526
and tree.branch.get_submit_branch() is None)))):
4527
tree.branch.set_submit_branch(other_branch.base)
4528
# Merge tags (but don't set them in the master branch yet, the user
4529
# might revert this merge). Commit will propagate them.
4530
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4531
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4532
other_revision_id, base_revision_id, other_branch, base_branch)
4533
if other_path != '':
4534
allow_pending = False
4535
merger.interesting_files = [other_path]
4537
allow_pending = True
4538
return merger, allow_pending
4540
def get_merger_from_uncommitted(self, tree, location, pb):
4541
"""Get a merger for uncommitted changes.
4543
:param tree: The tree the merger should apply to.
4544
:param location: The location containing uncommitted changes.
4545
:param pb: The progress bar to use for showing progress.
4547
location = self._select_branch_location(tree, location)[0]
4548
other_tree, other_path = WorkingTree.open_containing(location)
4549
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4550
if other_path != '':
4551
merger.interesting_files = [other_path]
4554
def _select_branch_location(self, tree, user_location, revision=None,
4556
"""Select a branch location, according to possible inputs.
4558
If provided, branches from ``revision`` are preferred. (Both
4559
``revision`` and ``index`` must be supplied.)
4561
Otherwise, the ``location`` parameter is used. If it is None, then the
4562
``submit`` or ``parent`` location is used, and a note is printed.
4564
:param tree: The working tree to select a branch for merging into
4565
:param location: The location entered by the user
4566
:param revision: The revision parameter to the command
4567
:param index: The index to use for the revision parameter. Negative
4568
indices are permitted.
4569
:return: (selected_location, user_location). The default location
4570
will be the user-entered location.
4572
if (revision is not None and index is not None
4573
and revision[index] is not None):
4574
branch = revision[index].get_branch()
4575
if branch is not None:
4576
return branch, branch
4577
if user_location is None:
4578
location = self._get_remembered(tree, 'Merging from')
4580
location = user_location
4581
return location, user_location
4583
def _get_remembered(self, tree, verb_string):
4584
"""Use tree.branch's parent if none was supplied.
4586
Report if the remembered location was used.
4588
stored_location = tree.branch.get_submit_branch()
4589
stored_location_type = "submit"
4590
if stored_location is None:
4591
stored_location = tree.branch.get_parent()
4592
stored_location_type = "parent"
4593
mutter("%s", stored_location)
4594
if stored_location is None:
4595
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4596
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4597
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4598
stored_location_type, display_url))
4599
return stored_location
4602
class cmd_remerge(Command):
4603
__doc__ = """Redo a merge.
4605
Use this if you want to try a different merge technique while resolving
4606
conflicts. Some merge techniques are better than others, and remerge
4607
lets you try different ones on different files.
4609
The options for remerge have the same meaning and defaults as the ones for
4610
merge. The difference is that remerge can (only) be run when there is a
4611
pending merge, and it lets you specify particular files.
4614
Re-do the merge of all conflicted files, and show the base text in
4615
conflict regions, in addition to the usual THIS and OTHER texts::
4617
bzr remerge --show-base
4619
Re-do the merge of "foobar", using the weave merge algorithm, with
4620
additional processing to reduce the size of conflict regions::
4622
bzr remerge --merge-type weave --reprocess foobar
4624
takes_args = ['file*']
4629
help="Show base revision text in conflicts."),
4632
def run(self, file_list=None, merge_type=None, show_base=False,
4634
from bzrlib.conflicts import restore
4635
if merge_type is None:
4636
merge_type = _mod_merge.Merge3Merger
4637
tree, file_list = WorkingTree.open_containing_paths(file_list)
4638
self.add_cleanup(tree.lock_write().unlock)
4639
parents = tree.get_parent_ids()
4640
if len(parents) != 2:
4641
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4642
" merges. Not cherrypicking or"
4644
repository = tree.branch.repository
4645
interesting_ids = None
4647
conflicts = tree.conflicts()
4648
if file_list is not None:
4649
interesting_ids = set()
4650
for filename in file_list:
4651
file_id = tree.path2id(filename)
4653
raise errors.NotVersionedError(filename)
4654
interesting_ids.add(file_id)
4655
if tree.kind(file_id) != "directory":
4658
for name, ie in tree.inventory.iter_entries(file_id):
4659
interesting_ids.add(ie.file_id)
4660
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4662
# Remerge only supports resolving contents conflicts
4663
allowed_conflicts = ('text conflict', 'contents conflict')
4664
restore_files = [c.path for c in conflicts
4665
if c.typestring in allowed_conflicts]
4666
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4667
tree.set_conflicts(ConflictList(new_conflicts))
4668
if file_list is not None:
4669
restore_files = file_list
4670
for filename in restore_files:
4672
restore(tree.abspath(filename))
4673
except errors.NotConflicted:
4675
# Disable pending merges, because the file texts we are remerging
4676
# have not had those merges performed. If we use the wrong parents
4677
# list, we imply that the working tree text has seen and rejected
4678
# all the changes from the other tree, when in fact those changes
4679
# have not yet been seen.
4680
tree.set_parent_ids(parents[:1])
4682
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4683
merger.interesting_ids = interesting_ids
4684
merger.merge_type = merge_type
4685
merger.show_base = show_base
4686
merger.reprocess = reprocess
4687
conflicts = merger.do_merge()
4689
tree.set_parent_ids(parents)
4696
class cmd_revert(Command):
4697
__doc__ = """Revert files to a previous revision.
4699
Giving a list of files will revert only those files. Otherwise, all files
4700
will be reverted. If the revision is not specified with '--revision', the
4701
last committed revision is used.
4703
To remove only some changes, without reverting to a prior version, use
4704
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4705
will remove the changes introduced by the second last commit (-2), without
4706
affecting the changes introduced by the last commit (-1). To remove
4707
certain changes on a hunk-by-hunk basis, see the shelve command.
4709
By default, any files that have been manually changed will be backed up
4710
first. (Files changed only by merge are not backed up.) Backup files have
4711
'.~#~' appended to their name, where # is a number.
4713
When you provide files, you can use their current pathname or the pathname
4714
from the target revision. So you can use revert to "undelete" a file by
4715
name. If you name a directory, all the contents of that directory will be
4718
If you have newly added files since the target revision, they will be
4719
removed. If the files to be removed have been changed, backups will be
4720
created as above. Directories containing unknown files will not be
4723
The working tree contains a list of revisions that have been merged but
4724
not yet committed. These revisions will be included as additional parents
4725
of the next commit. Normally, using revert clears that list as well as
4726
reverting the files. If any files are specified, revert leaves the list
4727
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4728
.`` in the tree root to revert all files but keep the recorded merges,
4729
and ``bzr revert --forget-merges`` to clear the pending merge list without
4730
reverting any files.
4732
Using "bzr revert --forget-merges", it is possible to apply all of the
4733
changes from a branch in a single revision. To do this, perform the merge
4734
as desired. Then doing revert with the "--forget-merges" option will keep
4735
the content of the tree as it was, but it will clear the list of pending
4736
merges. The next commit will then contain all of the changes that are
4737
present in the other branch, but without any other parent revisions.
4738
Because this technique forgets where these changes originated, it may
4739
cause additional conflicts on later merges involving the same source and
4743
_see_also = ['cat', 'export', 'merge', 'shelve']
4746
Option('no-backup', "Do not save backups of reverted files."),
4747
Option('forget-merges',
4748
'Remove pending merge marker, without changing any files.'),
4750
takes_args = ['file*']
4752
def run(self, revision=None, no_backup=False, file_list=None,
4753
forget_merges=None):
4754
tree, file_list = WorkingTree.open_containing_paths(file_list)
4755
self.add_cleanup(tree.lock_tree_write().unlock)
4757
tree.set_parent_ids(tree.get_parent_ids()[:1])
4759
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4762
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4763
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4764
tree.revert(file_list, rev_tree, not no_backup, None,
4765
report_changes=True)
4768
class cmd_assert_fail(Command):
4769
__doc__ = """Test reporting of assertion failures"""
4770
# intended just for use in testing
4775
raise AssertionError("always fails")
4778
class cmd_help(Command):
4779
__doc__ = """Show help on a command or other topic.
4782
_see_also = ['topics']
4784
Option('long', 'Show help on all commands.'),
4786
takes_args = ['topic?']
4787
aliases = ['?', '--help', '-?', '-h']
4790
def run(self, topic=None, long=False):
4792
if topic is None and long:
4794
bzrlib.help.help(topic)
4797
class cmd_shell_complete(Command):
4798
__doc__ = """Show appropriate completions for context.
4800
For a list of all available commands, say 'bzr shell-complete'.
4802
takes_args = ['context?']
4807
def run(self, context=None):
4808
from bzrlib import shellcomplete
4809
shellcomplete.shellcomplete(context)
4812
class cmd_missing(Command):
4813
__doc__ = """Show unmerged/unpulled revisions between two branches.
4815
OTHER_BRANCH may be local or remote.
4817
To filter on a range of revisions, you can use the command -r begin..end
4818
-r revision requests a specific revision, -r ..end or -r begin.. are
4822
1 - some missing revisions
4823
0 - no missing revisions
4827
Determine the missing revisions between this and the branch at the
4828
remembered pull location::
4832
Determine the missing revisions between this and another branch::
4834
bzr missing http://server/branch
4836
Determine the missing revisions up to a specific revision on the other
4839
bzr missing -r ..-10
4841
Determine the missing revisions up to a specific revision on this
4844
bzr missing --my-revision ..-10
4847
_see_also = ['merge', 'pull']
4848
takes_args = ['other_branch?']
4851
Option('reverse', 'Reverse the order of revisions.'),
4853
'Display changes in the local branch only.'),
4854
Option('this' , 'Same as --mine-only.'),
4855
Option('theirs-only',
4856
'Display changes in the remote branch only.'),
4857
Option('other', 'Same as --theirs-only.'),
4861
custom_help('revision',
4862
help='Filter on other branch revisions (inclusive). '
4863
'See "help revisionspec" for details.'),
4864
Option('my-revision',
4865
type=_parse_revision_str,
4866
help='Filter on local branch revisions (inclusive). '
4867
'See "help revisionspec" for details.'),
4868
Option('include-merged',
4869
'Show all revisions in addition to the mainline ones.'),
4870
Option('include-merges', hidden=True,
4871
help='Historical alias for --include-merged.'),
4873
encoding_type = 'replace'
4876
def run(self, other_branch=None, reverse=False, mine_only=False,
4878
log_format=None, long=False, short=False, line=False,
4879
show_ids=False, verbose=False, this=False, other=False,
4880
include_merged=None, revision=None, my_revision=None,
4882
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4883
from bzrlib.missing import find_unmerged, iter_log_revisions
4888
if symbol_versioning.deprecated_passed(include_merges):
4889
ui.ui_factory.show_user_warning(
4890
'deprecated_command_option',
4891
deprecated_name='--include-merges',
4892
recommended_name='--include-merged',
4893
deprecated_in_version='2.5',
4894
command=self.invoked_as)
4895
if include_merged is None:
4896
include_merged = include_merges
4898
raise errors.BzrCommandError(gettext(
4899
'{0} and {1} are mutually exclusive').format(
4900
'--include-merges', '--include-merged'))
4901
if include_merged is None:
4902
include_merged = False
4907
# TODO: We should probably check that we don't have mine-only and
4908
# theirs-only set, but it gets complicated because we also have
4909
# this and other which could be used.
4916
local_branch = Branch.open_containing(directory)[0]
4917
self.add_cleanup(local_branch.lock_read().unlock)
4919
parent = local_branch.get_parent()
4920
if other_branch is None:
4921
other_branch = parent
4922
if other_branch is None:
4923
raise errors.BzrCommandError(gettext("No peer location known"
4925
display_url = urlutils.unescape_for_display(parent,
4927
message(gettext("Using saved parent location: {0}\n").format(
4930
remote_branch = Branch.open(other_branch)
4931
if remote_branch.base == local_branch.base:
4932
remote_branch = local_branch
4934
self.add_cleanup(remote_branch.lock_read().unlock)
4936
local_revid_range = _revision_range_to_revid_range(
4937
_get_revision_range(my_revision, local_branch,
4940
remote_revid_range = _revision_range_to_revid_range(
4941
_get_revision_range(revision,
4942
remote_branch, self.name()))
4944
local_extra, remote_extra = find_unmerged(
4945
local_branch, remote_branch, restrict,
4946
backward=not reverse,
4947
include_merged=include_merged,
4948
local_revid_range=local_revid_range,
4949
remote_revid_range=remote_revid_range)
4951
if log_format is None:
4952
registry = log.log_formatter_registry
4953
log_format = registry.get_default(local_branch)
4954
lf = log_format(to_file=self.outf,
4956
show_timezone='original')
4959
if local_extra and not theirs_only:
4960
message(ngettext("You have %d extra revision:\n",
4961
"You have %d extra revisions:\n",
4964
for revision in iter_log_revisions(local_extra,
4965
local_branch.repository,
4967
lf.log_revision(revision)
4968
printed_local = True
4971
printed_local = False
4973
if remote_extra and not mine_only:
4974
if printed_local is True:
4976
message(ngettext("You are missing %d revision:\n",
4977
"You are missing %d revisions:\n",
4978
len(remote_extra)) %
4980
for revision in iter_log_revisions(remote_extra,
4981
remote_branch.repository,
4983
lf.log_revision(revision)
4986
if mine_only and not local_extra:
4987
# We checked local, and found nothing extra
4988
message(gettext('This branch has no new revisions.\n'))
4989
elif theirs_only and not remote_extra:
4990
# We checked remote, and found nothing extra
4991
message(gettext('Other branch has no new revisions.\n'))
4992
elif not (mine_only or theirs_only or local_extra or
4994
# We checked both branches, and neither one had extra
4996
message(gettext("Branches are up to date.\n"))
4998
if not status_code and parent is None and other_branch is not None:
4999
self.add_cleanup(local_branch.lock_write().unlock)
5000
# handle race conditions - a parent might be set while we run.
5001
if local_branch.get_parent() is None:
5002
local_branch.set_parent(remote_branch.base)
5006
class cmd_pack(Command):
5007
__doc__ = """Compress the data within a repository.
5009
This operation compresses the data within a bazaar repository. As
5010
bazaar supports automatic packing of repository, this operation is
5011
normally not required to be done manually.
5013
During the pack operation, bazaar takes a backup of existing repository
5014
data, i.e. pack files. This backup is eventually removed by bazaar
5015
automatically when it is safe to do so. To save disk space by removing
5016
the backed up pack files, the --clean-obsolete-packs option may be
5019
Warning: If you use --clean-obsolete-packs and your machine crashes
5020
during or immediately after repacking, you may be left with a state
5021
where the deletion has been written to disk but the new packs have not
5022
been. In this case the repository may be unusable.
5025
_see_also = ['repositories']
5026
takes_args = ['branch_or_repo?']
5028
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5031
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5032
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5034
branch = dir.open_branch()
5035
repository = branch.repository
5036
except errors.NotBranchError:
5037
repository = dir.open_repository()
5038
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5041
class cmd_plugins(Command):
5042
__doc__ = """List the installed plugins.
5044
This command displays the list of installed plugins including
5045
version of plugin and a short description of each.
5047
--verbose shows the path where each plugin is located.
5049
A plugin is an external component for Bazaar that extends the
5050
revision control system, by adding or replacing code in Bazaar.
5051
Plugins can do a variety of things, including overriding commands,
5052
adding new commands, providing additional network transports and
5053
customizing log output.
5055
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5056
for further information on plugins including where to find them and how to
5057
install them. Instructions are also provided there on how to write new
5058
plugins using the Python programming language.
5060
takes_options = ['verbose']
5063
def run(self, verbose=False):
5064
from bzrlib import plugin
5065
# Don't give writelines a generator as some codecs don't like that
5066
self.outf.writelines(
5067
list(plugin.describe_plugins(show_paths=verbose)))
5070
class cmd_testament(Command):
5071
__doc__ = """Show testament (signing-form) of a revision."""
5074
Option('long', help='Produce long-format testament.'),
5076
help='Produce a strict-format testament.')]
5077
takes_args = ['branch?']
5079
def run(self, branch=u'.', revision=None, long=False, strict=False):
5080
from bzrlib.testament import Testament, StrictTestament
5082
testament_class = StrictTestament
5084
testament_class = Testament
5086
b = Branch.open_containing(branch)[0]
5088
b = Branch.open(branch)
5089
self.add_cleanup(b.lock_read().unlock)
5090
if revision is None:
5091
rev_id = b.last_revision()
5093
rev_id = revision[0].as_revision_id(b)
5094
t = testament_class.from_revision(b.repository, rev_id)
5096
sys.stdout.writelines(t.as_text_lines())
5098
sys.stdout.write(t.as_short_text())
5101
class cmd_annotate(Command):
5102
__doc__ = """Show the origin of each line in a file.
5104
This prints out the given file with an annotation on the left side
5105
indicating which revision, author and date introduced the change.
5107
If the origin is the same for a run of consecutive lines, it is
5108
shown only at the top, unless the --all option is given.
5110
# TODO: annotate directories; showing when each file was last changed
5111
# TODO: if the working copy is modified, show annotations on that
5112
# with new uncommitted lines marked
5113
aliases = ['ann', 'blame', 'praise']
5114
takes_args = ['filename']
5115
takes_options = [Option('all', help='Show annotations on all lines.'),
5116
Option('long', help='Show commit date in annotations.'),
5121
encoding_type = 'exact'
5124
def run(self, filename, all=False, long=False, revision=None,
5125
show_ids=False, directory=None):
5126
from bzrlib.annotate import (
5129
wt, branch, relpath = \
5130
_open_directory_or_containing_tree_or_branch(filename, directory)
5132
self.add_cleanup(wt.lock_read().unlock)
5134
self.add_cleanup(branch.lock_read().unlock)
5135
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5136
self.add_cleanup(tree.lock_read().unlock)
5137
if wt is not None and revision is None:
5138
file_id = wt.path2id(relpath)
5140
file_id = tree.path2id(relpath)
5142
raise errors.NotVersionedError(filename)
5143
if wt is not None and revision is None:
5144
# If there is a tree and we're not annotating historical
5145
# versions, annotate the working tree's content.
5146
annotate_file_tree(wt, file_id, self.outf, long, all,
5149
annotate_file_tree(tree, file_id, self.outf, long, all,
5150
show_ids=show_ids, branch=branch)
5153
class cmd_re_sign(Command):
5154
__doc__ = """Create a digital signature for an existing revision."""
5155
# TODO be able to replace existing ones.
5157
hidden = True # is this right ?
5158
takes_args = ['revision_id*']
5159
takes_options = ['directory', 'revision']
5161
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5162
if revision_id_list is not None and revision is not None:
5163
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5164
if revision_id_list is None and revision is None:
5165
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5166
b = WorkingTree.open_containing(directory)[0].branch
5167
self.add_cleanup(b.lock_write().unlock)
5168
return self._run(b, revision_id_list, revision)
5170
def _run(self, b, revision_id_list, revision):
5171
import bzrlib.gpg as gpg
5172
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5173
if revision_id_list is not None:
5174
b.repository.start_write_group()
5176
for revision_id in revision_id_list:
5177
b.repository.sign_revision(revision_id, gpg_strategy)
5179
b.repository.abort_write_group()
5182
b.repository.commit_write_group()
5183
elif revision is not None:
5184
if len(revision) == 1:
5185
revno, rev_id = revision[0].in_history(b)
5186
b.repository.start_write_group()
5188
b.repository.sign_revision(rev_id, gpg_strategy)
5190
b.repository.abort_write_group()
5193
b.repository.commit_write_group()
5194
elif len(revision) == 2:
5195
# are they both on rh- if so we can walk between them
5196
# might be nice to have a range helper for arbitrary
5197
# revision paths. hmm.
5198
from_revno, from_revid = revision[0].in_history(b)
5199
to_revno, to_revid = revision[1].in_history(b)
5200
if to_revid is None:
5201
to_revno = b.revno()
5202
if from_revno is None or to_revno is None:
5203
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5204
b.repository.start_write_group()
5206
for revno in range(from_revno, to_revno + 1):
5207
b.repository.sign_revision(b.get_rev_id(revno),
5210
b.repository.abort_write_group()
5213
b.repository.commit_write_group()
5215
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5218
class cmd_bind(Command):
5219
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5220
If no branch is supplied, rebind to the last bound location.
5222
Once converted into a checkout, commits must succeed on the master branch
5223
before they will be applied to the local branch.
5225
Bound branches use the nickname of its master branch unless it is set
5226
locally, in which case binding will update the local nickname to be
5230
_see_also = ['checkouts', 'unbind']
5231
takes_args = ['location?']
5232
takes_options = ['directory']
5234
def run(self, location=None, directory=u'.'):
5235
b, relpath = Branch.open_containing(directory)
5236
if location is None:
5238
location = b.get_old_bound_location()
5239
except errors.UpgradeRequired:
5240
raise errors.BzrCommandError(gettext('No location supplied. '
5241
'This format does not remember old locations.'))
5243
if location is None:
5244
if b.get_bound_location() is not None:
5245
raise errors.BzrCommandError(gettext('Branch is already bound'))
5247
raise errors.BzrCommandError(gettext('No location supplied '
5248
'and no previous location known'))
5249
b_other = Branch.open(location)
5252
except errors.DivergedBranches:
5253
raise errors.BzrCommandError(gettext('These branches have diverged.'
5254
' Try merging, and then bind again.'))
5255
if b.get_config().has_explicit_nickname():
5256
b.nick = b_other.nick
5259
class cmd_unbind(Command):
5260
__doc__ = """Convert the current checkout into a regular branch.
5262
After unbinding, the local branch is considered independent and subsequent
5263
commits will be local only.
5266
_see_also = ['checkouts', 'bind']
5268
takes_options = ['directory']
5270
def run(self, directory=u'.'):
5271
b, relpath = Branch.open_containing(directory)
5273
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5276
class cmd_uncommit(Command):
5277
__doc__ = """Remove the last committed revision.
5279
--verbose will print out what is being removed.
5280
--dry-run will go through all the motions, but not actually
5283
If --revision is specified, uncommit revisions to leave the branch at the
5284
specified revision. For example, "bzr uncommit -r 15" will leave the
5285
branch at revision 15.
5287
Uncommit leaves the working tree ready for a new commit. The only change
5288
it may make is to restore any pending merges that were present before
5292
# TODO: jam 20060108 Add an option to allow uncommit to remove
5293
# unreferenced information in 'branch-as-repository' branches.
5294
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5295
# information in shared branches as well.
5296
_see_also = ['commit']
5297
takes_options = ['verbose', 'revision',
5298
Option('dry-run', help='Don\'t actually make changes.'),
5299
Option('force', help='Say yes to all questions.'),
5301
help='Keep tags that point to removed revisions.'),
5303
help="Only remove the commits from the local branch"
5304
" when in a checkout."
5307
takes_args = ['location?']
5309
encoding_type = 'replace'
5311
def run(self, location=None, dry_run=False, verbose=False,
5312
revision=None, force=False, local=False, keep_tags=False):
5313
if location is None:
5315
control, relpath = controldir.ControlDir.open_containing(location)
5317
tree = control.open_workingtree()
5319
except (errors.NoWorkingTree, errors.NotLocalUrl):
5321
b = control.open_branch()
5323
if tree is not None:
5324
self.add_cleanup(tree.lock_write().unlock)
5326
self.add_cleanup(b.lock_write().unlock)
5327
return self._run(b, tree, dry_run, verbose, revision, force,
5330
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5332
from bzrlib.log import log_formatter, show_log
5333
from bzrlib.uncommit import uncommit
5335
last_revno, last_rev_id = b.last_revision_info()
5338
if revision is None:
5340
rev_id = last_rev_id
5342
# 'bzr uncommit -r 10' actually means uncommit
5343
# so that the final tree is at revno 10.
5344
# but bzrlib.uncommit.uncommit() actually uncommits
5345
# the revisions that are supplied.
5346
# So we need to offset it by one
5347
revno = revision[0].in_history(b).revno + 1
5348
if revno <= last_revno:
5349
rev_id = b.get_rev_id(revno)
5351
if rev_id is None or _mod_revision.is_null(rev_id):
5352
self.outf.write(gettext('No revisions to uncommit.\n'))
5355
lf = log_formatter('short',
5357
show_timezone='original')
5362
direction='forward',
5363
start_revision=revno,
5364
end_revision=last_revno)
5367
self.outf.write(gettext('Dry-run, pretending to remove'
5368
' the above revisions.\n'))
5370
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5373
if not ui.ui_factory.confirm_action(
5374
gettext(u'Uncommit these revisions'),
5375
'bzrlib.builtins.uncommit',
5377
self.outf.write(gettext('Canceled\n'))
5380
mutter('Uncommitting from {%s} to {%s}',
5381
last_rev_id, rev_id)
5382
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5383
revno=revno, local=local, keep_tags=keep_tags)
5384
self.outf.write(gettext('You can restore the old tip by running:\n'
5385
' bzr pull . -r revid:%s\n') % last_rev_id)
5388
class cmd_break_lock(Command):
5389
__doc__ = """Break a dead lock.
5391
This command breaks a lock on a repository, branch, working directory or
5394
CAUTION: Locks should only be broken when you are sure that the process
5395
holding the lock has been stopped.
5397
You can get information on what locks are open via the 'bzr info
5398
[location]' command.
5402
bzr break-lock bzr+ssh://example.com/bzr/foo
5403
bzr break-lock --conf ~/.bazaar
5406
takes_args = ['location?']
5409
help='LOCATION is the directory where the config lock is.'),
5411
help='Do not ask for confirmation before breaking the lock.'),
5414
def run(self, location=None, config=False, force=False):
5415
if location is None:
5418
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5420
{'bzrlib.lockdir.break': True})
5422
conf = _mod_config.LockableConfig(file_name=location)
5425
control, relpath = controldir.ControlDir.open_containing(location)
5427
control.break_lock()
5428
except NotImplementedError:
5432
class cmd_wait_until_signalled(Command):
5433
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5435
This just prints a line to signal when it is ready, then blocks on stdin.
5441
sys.stdout.write("running\n")
5443
sys.stdin.readline()
5446
class cmd_serve(Command):
5447
__doc__ = """Run the bzr server."""
5449
aliases = ['server']
5453
help='Serve on stdin/out for use from inetd or sshd.'),
5454
RegistryOption('protocol',
5455
help="Protocol to serve.",
5456
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5457
value_switches=True),
5459
help='Listen for connections on nominated port of the form '
5460
'[hostname:]portnumber. Passing 0 as the port number will '
5461
'result in a dynamically allocated port. The default port '
5462
'depends on the protocol.',
5464
custom_help('directory',
5465
help='Serve contents of this directory.'),
5466
Option('allow-writes',
5467
help='By default the server is a readonly server. Supplying '
5468
'--allow-writes enables write access to the contents of '
5469
'the served directory and below. Note that ``bzr serve`` '
5470
'does not perform authentication, so unless some form of '
5471
'external authentication is arranged supplying this '
5472
'option leads to global uncontrolled write access to your '
5475
Option('client-timeout', type=float,
5476
help='Override the default idle client timeout (5min).'),
5479
def get_host_and_port(self, port):
5480
"""Return the host and port to run the smart server on.
5482
If 'port' is None, None will be returned for the host and port.
5484
If 'port' has a colon in it, the string before the colon will be
5485
interpreted as the host.
5487
:param port: A string of the port to run the server on.
5488
:return: A tuple of (host, port), where 'host' is a host name or IP,
5489
and port is an integer TCP/IP port.
5492
if port is not None:
5494
host, port = port.split(':')
5498
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5499
protocol=None, client_timeout=None):
5500
from bzrlib import transport
5501
if directory is None:
5502
directory = os.getcwd()
5503
if protocol is None:
5504
protocol = transport.transport_server_registry.get()
5505
host, port = self.get_host_and_port(port)
5506
url = transport.location_to_url(directory)
5507
if not allow_writes:
5508
url = 'readonly+' + url
5509
t = transport.get_transport_from_url(url)
5511
protocol(t, host, port, inet, client_timeout)
5512
except TypeError, e:
5513
# We use symbol_versioning.deprecated_in just so that people
5514
# grepping can find it here.
5515
# symbol_versioning.deprecated_in((2, 5, 0))
5516
symbol_versioning.warn(
5517
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5518
'Most likely it needs to be updated to support a'
5519
' "timeout" parameter (added in bzr 2.5.0)'
5520
% (e, protocol.__module__, protocol),
5522
protocol(t, host, port, inet)
5525
class cmd_join(Command):
5526
__doc__ = """Combine a tree into its containing tree.
5528
This command requires the target tree to be in a rich-root format.
5530
The TREE argument should be an independent tree, inside another tree, but
5531
not part of it. (Such trees can be produced by "bzr split", but also by
5532
running "bzr branch" with the target inside a tree.)
5534
The result is a combined tree, with the subtree no longer an independent
5535
part. This is marked as a merge of the subtree into the containing tree,
5536
and all history is preserved.
5539
_see_also = ['split']
5540
takes_args = ['tree']
5542
Option('reference', help='Join by reference.', hidden=True),
5545
def run(self, tree, reference=False):
5546
sub_tree = WorkingTree.open(tree)
5547
parent_dir = osutils.dirname(sub_tree.basedir)
5548
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5549
repo = containing_tree.branch.repository
5550
if not repo.supports_rich_root():
5551
raise errors.BzrCommandError(gettext(
5552
"Can't join trees because %s doesn't support rich root data.\n"
5553
"You can use bzr upgrade on the repository.")
5557
containing_tree.add_reference(sub_tree)
5558
except errors.BadReferenceTarget, e:
5559
# XXX: Would be better to just raise a nicely printable
5560
# exception from the real origin. Also below. mbp 20070306
5561
raise errors.BzrCommandError(
5562
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5565
containing_tree.subsume(sub_tree)
5566
except errors.BadSubsumeSource, e:
5567
raise errors.BzrCommandError(
5568
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5571
class cmd_split(Command):
5572
__doc__ = """Split a subdirectory of a tree into a separate tree.
5574
This command will produce a target tree in a format that supports
5575
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5576
converted into earlier formats like 'dirstate-tags'.
5578
The TREE argument should be a subdirectory of a working tree. That
5579
subdirectory will be converted into an independent tree, with its own
5580
branch. Commits in the top-level tree will not apply to the new subtree.
5583
_see_also = ['join']
5584
takes_args = ['tree']
5586
def run(self, tree):
5587
containing_tree, subdir = WorkingTree.open_containing(tree)
5588
sub_id = containing_tree.path2id(subdir)
5590
raise errors.NotVersionedError(subdir)
5592
containing_tree.extract(sub_id)
5593
except errors.RootNotRich:
5594
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5597
class cmd_merge_directive(Command):
5598
__doc__ = """Generate a merge directive for auto-merge tools.
5600
A directive requests a merge to be performed, and also provides all the
5601
information necessary to do so. This means it must either include a
5602
revision bundle, or the location of a branch containing the desired
5605
A submit branch (the location to merge into) must be supplied the first
5606
time the command is issued. After it has been supplied once, it will
5607
be remembered as the default.
5609
A public branch is optional if a revision bundle is supplied, but required
5610
if --diff or --plain is specified. It will be remembered as the default
5611
after the first use.
5614
takes_args = ['submit_branch?', 'public_branch?']
5618
_see_also = ['send']
5622
RegistryOption.from_kwargs('patch-type',
5623
'The type of patch to include in the directive.',
5625
value_switches=True,
5627
bundle='Bazaar revision bundle (default).',
5628
diff='Normal unified diff.',
5629
plain='No patch, just directive.'),
5630
Option('sign', help='GPG-sign the directive.'), 'revision',
5631
Option('mail-to', type=str,
5632
help='Instead of printing the directive, email to this address.'),
5633
Option('message', type=str, short_name='m',
5634
help='Message to use when committing this merge.')
5637
encoding_type = 'exact'
5639
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5640
sign=False, revision=None, mail_to=None, message=None,
5642
from bzrlib.revision import ensure_null, NULL_REVISION
5643
include_patch, include_bundle = {
5644
'plain': (False, False),
5645
'diff': (True, False),
5646
'bundle': (True, True),
5648
branch = Branch.open(directory)
5649
stored_submit_branch = branch.get_submit_branch()
5650
if submit_branch is None:
5651
submit_branch = stored_submit_branch
5653
if stored_submit_branch is None:
5654
branch.set_submit_branch(submit_branch)
5655
if submit_branch is None:
5656
submit_branch = branch.get_parent()
5657
if submit_branch is None:
5658
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5660
stored_public_branch = branch.get_public_branch()
5661
if public_branch is None:
5662
public_branch = stored_public_branch
5663
elif stored_public_branch is None:
5664
branch.set_public_branch(public_branch)
5665
if not include_bundle and public_branch is None:
5666
raise errors.BzrCommandError(gettext('No public branch specified or'
5668
base_revision_id = None
5669
if revision is not None:
5670
if len(revision) > 2:
5671
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5672
'at most two one revision identifiers'))
5673
revision_id = revision[-1].as_revision_id(branch)
5674
if len(revision) == 2:
5675
base_revision_id = revision[0].as_revision_id(branch)
5677
revision_id = branch.last_revision()
5678
revision_id = ensure_null(revision_id)
5679
if revision_id == NULL_REVISION:
5680
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5681
directive = merge_directive.MergeDirective2.from_objects(
5682
branch.repository, revision_id, time.time(),
5683
osutils.local_time_offset(), submit_branch,
5684
public_branch=public_branch, include_patch=include_patch,
5685
include_bundle=include_bundle, message=message,
5686
base_revision_id=base_revision_id)
5689
self.outf.write(directive.to_signed(branch))
5691
self.outf.writelines(directive.to_lines())
5693
message = directive.to_email(mail_to, branch, sign)
5694
s = SMTPConnection(branch.get_config_stack())
5695
s.send_email(message)
5698
class cmd_send(Command):
5699
__doc__ = """Mail or create a merge-directive for submitting changes.
5701
A merge directive provides many things needed for requesting merges:
5703
* A machine-readable description of the merge to perform
5705
* An optional patch that is a preview of the changes requested
5707
* An optional bundle of revision data, so that the changes can be applied
5708
directly from the merge directive, without retrieving data from a
5711
`bzr send` creates a compact data set that, when applied using bzr
5712
merge, has the same effect as merging from the source branch.
5714
By default the merge directive is self-contained and can be applied to any
5715
branch containing submit_branch in its ancestory without needing access to
5718
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5719
revisions, but only a structured request to merge from the
5720
public_location. In that case the public_branch is needed and it must be
5721
up-to-date and accessible to the recipient. The public_branch is always
5722
included if known, so that people can check it later.
5724
The submit branch defaults to the parent of the source branch, but can be
5725
overridden. Both submit branch and public branch will be remembered in
5726
branch.conf the first time they are used for a particular branch. The
5727
source branch defaults to that containing the working directory, but can
5728
be changed using --from.
5730
Both the submit branch and the public branch follow the usual behavior with
5731
respect to --remember: If there is no default location set, the first send
5732
will set it (use --no-remember to avoid setting it). After that, you can
5733
omit the location to use the default. To change the default, use
5734
--remember. The value will only be saved if the location can be accessed.
5736
In order to calculate those changes, bzr must analyse the submit branch.
5737
Therefore it is most efficient for the submit branch to be a local mirror.
5738
If a public location is known for the submit_branch, that location is used
5739
in the merge directive.
5741
The default behaviour is to send the merge directive by mail, unless -o is
5742
given, in which case it is sent to a file.
5744
Mail is sent using your preferred mail program. This should be transparent
5745
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5746
If the preferred client can't be found (or used), your editor will be used.
5748
To use a specific mail program, set the mail_client configuration option.
5749
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5750
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5751
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5752
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5755
If mail is being sent, a to address is required. This can be supplied
5756
either on the commandline, by setting the submit_to configuration
5757
option in the branch itself or the child_submit_to configuration option
5758
in the submit branch.
5760
Two formats are currently supported: "4" uses revision bundle format 4 and
5761
merge directive format 2. It is significantly faster and smaller than
5762
older formats. It is compatible with Bazaar 0.19 and later. It is the
5763
default. "0.9" uses revision bundle format 0.9 and merge directive
5764
format 1. It is compatible with Bazaar 0.12 - 0.18.
5766
The merge directives created by bzr send may be applied using bzr merge or
5767
bzr pull by specifying a file containing a merge directive as the location.
5769
bzr send makes extensive use of public locations to map local locations into
5770
URLs that can be used by other people. See `bzr help configuration` to
5771
set them, and use `bzr info` to display them.
5774
encoding_type = 'exact'
5776
_see_also = ['merge', 'pull']
5778
takes_args = ['submit_branch?', 'public_branch?']
5782
help='Do not include a bundle in the merge directive.'),
5783
Option('no-patch', help='Do not include a preview patch in the merge'
5786
help='Remember submit and public branch.'),
5788
help='Branch to generate the submission from, '
5789
'rather than the one containing the working directory.',
5792
Option('output', short_name='o',
5793
help='Write merge directive to this file or directory; '
5794
'use - for stdout.',
5797
help='Refuse to send if there are uncommitted changes in'
5798
' the working tree, --no-strict disables the check.'),
5799
Option('mail-to', help='Mail the request to this address.',
5803
Option('body', help='Body for the email.', type=unicode),
5804
RegistryOption('format',
5805
help='Use the specified output format.',
5806
lazy_registry=('bzrlib.send', 'format_registry')),
5809
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5810
no_patch=False, revision=None, remember=None, output=None,
5811
format=None, mail_to=None, message=None, body=None,
5812
strict=None, **kwargs):
5813
from bzrlib.send import send
5814
return send(submit_branch, revision, public_branch, remember,
5815
format, no_bundle, no_patch, output,
5816
kwargs.get('from', '.'), mail_to, message, body,
5821
class cmd_bundle_revisions(cmd_send):
5822
__doc__ = """Create a merge-directive for submitting changes.
5824
A merge directive provides many things needed for requesting merges:
5826
* A machine-readable description of the merge to perform
5828
* An optional patch that is a preview of the changes requested
5830
* An optional bundle of revision data, so that the changes can be applied
5831
directly from the merge directive, without retrieving data from a
5834
If --no-bundle is specified, then public_branch is needed (and must be
5835
up-to-date), so that the receiver can perform the merge using the
5836
public_branch. The public_branch is always included if known, so that
5837
people can check it later.
5839
The submit branch defaults to the parent, but can be overridden. Both
5840
submit branch and public branch will be remembered if supplied.
5842
If a public_branch is known for the submit_branch, that public submit
5843
branch is used in the merge instructions. This means that a local mirror
5844
can be used as your actual submit branch, once you have set public_branch
5847
Two formats are currently supported: "4" uses revision bundle format 4 and
5848
merge directive format 2. It is significantly faster and smaller than
5849
older formats. It is compatible with Bazaar 0.19 and later. It is the
5850
default. "0.9" uses revision bundle format 0.9 and merge directive
5851
format 1. It is compatible with Bazaar 0.12 - 0.18.
5856
help='Do not include a bundle in the merge directive.'),
5857
Option('no-patch', help='Do not include a preview patch in the merge'
5860
help='Remember submit and public branch.'),
5862
help='Branch to generate the submission from, '
5863
'rather than the one containing the working directory.',
5866
Option('output', short_name='o', help='Write directive to this file.',
5869
help='Refuse to bundle revisions if there are uncommitted'
5870
' changes in the working tree, --no-strict disables the check.'),
5872
RegistryOption('format',
5873
help='Use the specified output format.',
5874
lazy_registry=('bzrlib.send', 'format_registry')),
5876
aliases = ['bundle']
5878
_see_also = ['send', 'merge']
5882
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5883
no_patch=False, revision=None, remember=False, output=None,
5884
format=None, strict=None, **kwargs):
5887
from bzrlib.send import send
5888
return send(submit_branch, revision, public_branch, remember,
5889
format, no_bundle, no_patch, output,
5890
kwargs.get('from', '.'), None, None, None,
5891
self.outf, strict=strict)
5894
class cmd_tag(Command):
5895
__doc__ = """Create, remove or modify a tag naming a revision.
5897
Tags give human-meaningful names to revisions. Commands that take a -r
5898
(--revision) option can be given -rtag:X, where X is any previously
5901
Tags are stored in the branch. Tags are copied from one branch to another
5902
along when you branch, push, pull or merge.
5904
It is an error to give a tag name that already exists unless you pass
5905
--force, in which case the tag is moved to point to the new revision.
5907
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5908
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5910
If no tag name is specified it will be determined through the
5911
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5912
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5916
_see_also = ['commit', 'tags']
5917
takes_args = ['tag_name?']
5920
help='Delete this tag rather than placing it.',
5922
custom_help('directory',
5923
help='Branch in which to place the tag.'),
5925
help='Replace existing tags.',
5930
def run(self, tag_name=None,
5936
branch, relpath = Branch.open_containing(directory)
5937
self.add_cleanup(branch.lock_write().unlock)
5939
if tag_name is None:
5940
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5941
branch.tags.delete_tag(tag_name)
5942
note(gettext('Deleted tag %s.') % tag_name)
5945
if len(revision) != 1:
5946
raise errors.BzrCommandError(gettext(
5947
"Tags can only be placed on a single revision, "
5949
revision_id = revision[0].as_revision_id(branch)
5951
revision_id = branch.last_revision()
5952
if tag_name is None:
5953
tag_name = branch.automatic_tag_name(revision_id)
5954
if tag_name is None:
5955
raise errors.BzrCommandError(gettext(
5956
"Please specify a tag name."))
5958
existing_target = branch.tags.lookup_tag(tag_name)
5959
except errors.NoSuchTag:
5960
existing_target = None
5961
if not force and existing_target not in (None, revision_id):
5962
raise errors.TagAlreadyExists(tag_name)
5963
if existing_target == revision_id:
5964
note(gettext('Tag %s already exists for that revision.') % tag_name)
5966
branch.tags.set_tag(tag_name, revision_id)
5967
if existing_target is None:
5968
note(gettext('Created tag %s.') % tag_name)
5970
note(gettext('Updated tag %s.') % tag_name)
5973
class cmd_tags(Command):
5974
__doc__ = """List tags.
5976
This command shows a table of tag names and the revisions they reference.
5981
custom_help('directory',
5982
help='Branch whose tags should be displayed.'),
5983
RegistryOption('sort',
5984
'Sort tags by different criteria.', title='Sorting',
5985
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5992
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5993
from bzrlib.tag import tag_sort_methods
5994
branch, relpath = Branch.open_containing(directory)
5996
tags = branch.tags.get_tag_dict().items()
6000
self.add_cleanup(branch.lock_read().unlock)
6002
# Restrict to the specified range
6003
tags = self._tags_for_range(branch, revision)
6005
sort = tag_sort_methods.get()
6008
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6009
for index, (tag, revid) in enumerate(tags):
6011
revno = branch.revision_id_to_dotted_revno(revid)
6012
if isinstance(revno, tuple):
6013
revno = '.'.join(map(str, revno))
6014
except (errors.NoSuchRevision,
6015
errors.GhostRevisionsHaveNoRevno,
6016
errors.UnsupportedOperation):
6017
# Bad tag data/merges can lead to tagged revisions
6018
# which are not in this branch. Fail gracefully ...
6020
tags[index] = (tag, revno)
6022
for tag, revspec in tags:
6023
self.outf.write('%-20s %s\n' % (tag, revspec))
6025
def _tags_for_range(self, branch, revision):
6027
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6028
revid1, revid2 = rev1.rev_id, rev2.rev_id
6029
# _get_revision_range will always set revid2 if it's not specified.
6030
# If revid1 is None, it means we want to start from the branch
6031
# origin which is always a valid ancestor. If revid1 == revid2, the
6032
# ancestry check is useless.
6033
if revid1 and revid1 != revid2:
6034
# FIXME: We really want to use the same graph than
6035
# branch.iter_merge_sorted_revisions below, but this is not
6036
# easily available -- vila 2011-09-23
6037
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6038
# We don't want to output anything in this case...
6040
# only show revisions between revid1 and revid2 (inclusive)
6041
tagged_revids = branch.tags.get_reverse_tag_dict()
6043
for r in branch.iter_merge_sorted_revisions(
6044
start_revision_id=revid2, stop_revision_id=revid1,
6045
stop_rule='include'):
6046
revid_tags = tagged_revids.get(r[0], None)
6048
found.extend([(tag, r[0]) for tag in revid_tags])
6052
class cmd_reconfigure(Command):
6053
__doc__ = """Reconfigure the type of a bzr directory.
6055
A target configuration must be specified.
6057
For checkouts, the bind-to location will be auto-detected if not specified.
6058
The order of preference is
6059
1. For a lightweight checkout, the current bound location.
6060
2. For branches that used to be checkouts, the previously-bound location.
6061
3. The push location.
6062
4. The parent location.
6063
If none of these is available, --bind-to must be specified.
6066
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6067
takes_args = ['location?']
6069
RegistryOption.from_kwargs(
6072
help='The relation between branch and tree.',
6073
value_switches=True, enum_switch=False,
6074
branch='Reconfigure to be an unbound branch with no working tree.',
6075
tree='Reconfigure to be an unbound branch with a working tree.',
6076
checkout='Reconfigure to be a bound branch with a working tree.',
6077
lightweight_checkout='Reconfigure to be a lightweight'
6078
' checkout (with no local history).',
6080
RegistryOption.from_kwargs(
6082
title='Repository type',
6083
help='Location fo the repository.',
6084
value_switches=True, enum_switch=False,
6085
standalone='Reconfigure to be a standalone branch '
6086
'(i.e. stop using shared repository).',
6087
use_shared='Reconfigure to use a shared repository.',
6089
RegistryOption.from_kwargs(
6091
title='Trees in Repository',
6092
help='Whether new branches in the repository have trees.',
6093
value_switches=True, enum_switch=False,
6094
with_trees='Reconfigure repository to create '
6095
'working trees on branches by default.',
6096
with_no_trees='Reconfigure repository to not create '
6097
'working trees on branches by default.'
6099
Option('bind-to', help='Branch to bind checkout to.', type=str),
6101
help='Perform reconfiguration even if local changes'
6103
Option('stacked-on',
6104
help='Reconfigure a branch to be stacked on another branch.',
6108
help='Reconfigure a branch to be unstacked. This '
6109
'may require copying substantial data into it.',
6113
def run(self, location=None, bind_to=None, force=False,
6114
tree_type=None, repository_type=None, repository_trees=None,
6115
stacked_on=None, unstacked=None):
6116
directory = controldir.ControlDir.open(location)
6117
if stacked_on and unstacked:
6118
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6119
elif stacked_on is not None:
6120
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6122
reconfigure.ReconfigureUnstacked().apply(directory)
6123
# At the moment you can use --stacked-on and a different
6124
# reconfiguration shape at the same time; there seems no good reason
6126
if (tree_type is None and
6127
repository_type is None and
6128
repository_trees is None):
6129
if stacked_on or unstacked:
6132
raise errors.BzrCommandError(gettext('No target configuration '
6134
reconfiguration = None
6135
if tree_type == 'branch':
6136
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6137
elif tree_type == 'tree':
6138
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6139
elif tree_type == 'checkout':
6140
reconfiguration = reconfigure.Reconfigure.to_checkout(
6142
elif tree_type == 'lightweight-checkout':
6143
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6146
reconfiguration.apply(force)
6147
reconfiguration = None
6148
if repository_type == 'use-shared':
6149
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6150
elif repository_type == 'standalone':
6151
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6153
reconfiguration.apply(force)
6154
reconfiguration = None
6155
if repository_trees == 'with-trees':
6156
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6158
elif repository_trees == 'with-no-trees':
6159
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6162
reconfiguration.apply(force)
6163
reconfiguration = None
6166
class cmd_switch(Command):
6167
__doc__ = """Set the branch of a checkout and update.
6169
For lightweight checkouts, this changes the branch being referenced.
6170
For heavyweight checkouts, this checks that there are no local commits
6171
versus the current bound branch, then it makes the local branch a mirror
6172
of the new location and binds to it.
6174
In both cases, the working tree is updated and uncommitted changes
6175
are merged. The user can commit or revert these as they desire.
6177
Pending merges need to be committed or reverted before using switch.
6179
The path to the branch to switch to can be specified relative to the parent
6180
directory of the current branch. For example, if you are currently in a
6181
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6184
Bound branches use the nickname of its master branch unless it is set
6185
locally, in which case switching will update the local nickname to be
6189
takes_args = ['to_location?']
6190
takes_options = ['directory',
6192
help='Switch even if local commits will be lost.'),
6194
Option('create-branch', short_name='b',
6195
help='Create the target branch from this one before'
6196
' switching to it.'),
6199
def run(self, to_location=None, force=False, create_branch=False,
6200
revision=None, directory=u'.'):
6201
from bzrlib import switch
6202
tree_location = directory
6203
revision = _get_one_revision('switch', revision)
6204
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6205
if to_location is None:
6206
if revision is None:
6207
raise errors.BzrCommandError(gettext('You must supply either a'
6208
' revision or a location'))
6209
to_location = tree_location
6211
branch = control_dir.open_branch()
6212
had_explicit_nick = branch.get_config().has_explicit_nickname()
6213
except errors.NotBranchError:
6215
had_explicit_nick = False
6218
raise errors.BzrCommandError(
6219
gettext('cannot create branch without source branch'))
6220
to_location = lookup_new_sibling_branch(control_dir, to_location)
6221
to_branch = branch.bzrdir.sprout(to_location,
6222
possible_transports=[branch.bzrdir.root_transport],
6223
source_branch=branch).open_branch()
6225
to_branch = lookup_sibling_branch(control_dir, to_location)
6226
if revision is not None:
6227
revision = revision.as_revision_id(to_branch)
6228
switch.switch(control_dir, to_branch, force, revision_id=revision)
6229
if had_explicit_nick:
6230
branch = control_dir.open_branch() #get the new branch!
6231
branch.nick = to_branch.nick
6232
note(gettext('Switched to branch: %s'),
6233
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6237
class cmd_view(Command):
6238
__doc__ = """Manage filtered views.
6240
Views provide a mask over the tree so that users can focus on
6241
a subset of a tree when doing their work. After creating a view,
6242
commands that support a list of files - status, diff, commit, etc -
6243
effectively have that list of files implicitly given each time.
6244
An explicit list of files can still be given but those files
6245
must be within the current view.
6247
In most cases, a view has a short life-span: it is created to make
6248
a selected change and is deleted once that change is committed.
6249
At other times, you may wish to create one or more named views
6250
and switch between them.
6252
To disable the current view without deleting it, you can switch to
6253
the pseudo view called ``off``. This can be useful when you need
6254
to see the whole tree for an operation or two (e.g. merge) but
6255
want to switch back to your view after that.
6258
To define the current view::
6260
bzr view file1 dir1 ...
6262
To list the current view::
6266
To delete the current view::
6270
To disable the current view without deleting it::
6272
bzr view --switch off
6274
To define a named view and switch to it::
6276
bzr view --name view-name file1 dir1 ...
6278
To list a named view::
6280
bzr view --name view-name
6282
To delete a named view::
6284
bzr view --name view-name --delete
6286
To switch to a named view::
6288
bzr view --switch view-name
6290
To list all views defined::
6294
To delete all views::
6296
bzr view --delete --all
6300
takes_args = ['file*']
6303
help='Apply list or delete action to all views.',
6306
help='Delete the view.',
6309
help='Name of the view to define, list or delete.',
6313
help='Name of the view to switch to.',
6318
def run(self, file_list,
6324
tree, file_list = WorkingTree.open_containing_paths(file_list,
6326
current_view, view_dict = tree.views.get_view_info()
6331
raise errors.BzrCommandError(gettext(
6332
"Both --delete and a file list specified"))
6334
raise errors.BzrCommandError(gettext(
6335
"Both --delete and --switch specified"))
6337
tree.views.set_view_info(None, {})
6338
self.outf.write(gettext("Deleted all views.\n"))
6340
raise errors.BzrCommandError(gettext("No current view to delete"))
6342
tree.views.delete_view(name)
6343
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6346
raise errors.BzrCommandError(gettext(
6347
"Both --switch and a file list specified"))
6349
raise errors.BzrCommandError(gettext(
6350
"Both --switch and --all specified"))
6351
elif switch == 'off':
6352
if current_view is None:
6353
raise errors.BzrCommandError(gettext("No current view to disable"))
6354
tree.views.set_view_info(None, view_dict)
6355
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6357
tree.views.set_view_info(switch, view_dict)
6358
view_str = views.view_display_str(tree.views.lookup_view())
6359
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6362
self.outf.write(gettext('Views defined:\n'))
6363
for view in sorted(view_dict):
6364
if view == current_view:
6368
view_str = views.view_display_str(view_dict[view])
6369
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6371
self.outf.write(gettext('No views defined.\n'))
6374
# No name given and no current view set
6377
raise errors.BzrCommandError(gettext(
6378
"Cannot change the 'off' pseudo view"))
6379
tree.views.set_view(name, sorted(file_list))
6380
view_str = views.view_display_str(tree.views.lookup_view())
6381
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6385
# No name given and no current view set
6386
self.outf.write(gettext('No current view.\n'))
6388
view_str = views.view_display_str(tree.views.lookup_view(name))
6389
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6392
class cmd_hooks(Command):
6393
__doc__ = """Show hooks."""
6398
for hook_key in sorted(hooks.known_hooks.keys()):
6399
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6400
self.outf.write("%s:\n" % type(some_hooks).__name__)
6401
for hook_name, hook_point in sorted(some_hooks.items()):
6402
self.outf.write(" %s:\n" % (hook_name,))
6403
found_hooks = list(hook_point)
6405
for hook in found_hooks:
6406
self.outf.write(" %s\n" %
6407
(some_hooks.get_hook_name(hook),))
6409
self.outf.write(gettext(" <no hooks installed>\n"))
6412
class cmd_remove_branch(Command):
6413
__doc__ = """Remove a branch.
6415
This will remove the branch from the specified location but
6416
will keep any working tree or repository in place.
6420
Remove the branch at repo/trunk::
6422
bzr remove-branch repo/trunk
6426
takes_args = ["location?"]
6428
aliases = ["rmbranch"]
6430
def run(self, location=None):
6431
if location is None:
6433
branch = Branch.open_containing(location)[0]
6434
branch.bzrdir.destroy_branch()
6437
class cmd_shelve(Command):
6438
__doc__ = """Temporarily set aside some changes from the current tree.
6440
Shelve allows you to temporarily put changes you've made "on the shelf",
6441
ie. out of the way, until a later time when you can bring them back from
6442
the shelf with the 'unshelve' command. The changes are stored alongside
6443
your working tree, and so they aren't propagated along with your branch nor
6444
will they survive its deletion.
6446
If shelve --list is specified, previously-shelved changes are listed.
6448
Shelve is intended to help separate several sets of changes that have
6449
been inappropriately mingled. If you just want to get rid of all changes
6450
and you don't need to restore them later, use revert. If you want to
6451
shelve all text changes at once, use shelve --all.
6453
If filenames are specified, only the changes to those files will be
6454
shelved. Other files will be left untouched.
6456
If a revision is specified, changes since that revision will be shelved.
6458
You can put multiple items on the shelf, and by default, 'unshelve' will
6459
restore the most recently shelved changes.
6461
For complicated changes, it is possible to edit the changes in a separate
6462
editor program to decide what the file remaining in the working copy
6463
should look like. To do this, add the configuration option
6465
change_editor = PROGRAM @new_path @old_path
6467
where @new_path is replaced with the path of the new version of the
6468
file and @old_path is replaced with the path of the old version of
6469
the file. The PROGRAM should save the new file with the desired
6470
contents of the file in the working tree.
6474
takes_args = ['file*']
6479
Option('all', help='Shelve all changes.'),
6481
RegistryOption('writer', 'Method to use for writing diffs.',
6482
bzrlib.option.diff_writer_registry,
6483
value_switches=True, enum_switch=False),
6485
Option('list', help='List shelved changes.'),
6487
help='Destroy removed changes instead of shelving them.'),
6489
_see_also = ['unshelve', 'configuration']
6491
def run(self, revision=None, all=False, file_list=None, message=None,
6492
writer=None, list=False, destroy=False, directory=None):
6494
return self.run_for_list(directory=directory)
6495
from bzrlib.shelf_ui import Shelver
6497
writer = bzrlib.option.diff_writer_registry.get()
6499
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6500
file_list, message, destroy=destroy, directory=directory)
6505
except errors.UserAbort:
6508
def run_for_list(self, directory=None):
6509
if directory is None:
6511
tree = WorkingTree.open_containing(directory)[0]
6512
self.add_cleanup(tree.lock_read().unlock)
6513
manager = tree.get_shelf_manager()
6514
shelves = manager.active_shelves()
6515
if len(shelves) == 0:
6516
note(gettext('No shelved changes.'))
6518
for shelf_id in reversed(shelves):
6519
message = manager.get_metadata(shelf_id).get('message')
6521
message = '<no message>'
6522
self.outf.write('%3d: %s\n' % (shelf_id, message))
6526
class cmd_unshelve(Command):
6527
__doc__ = """Restore shelved changes.
6529
By default, the most recently shelved changes are restored. However if you
6530
specify a shelf by id those changes will be restored instead. This works
6531
best when the changes don't depend on each other.
6534
takes_args = ['shelf_id?']
6537
RegistryOption.from_kwargs(
6538
'action', help="The action to perform.",
6539
enum_switch=False, value_switches=True,
6540
apply="Apply changes and remove from the shelf.",
6541
dry_run="Show changes, but do not apply or remove them.",
6542
preview="Instead of unshelving the changes, show the diff that "
6543
"would result from unshelving.",
6544
delete_only="Delete changes without applying them.",
6545
keep="Apply changes but don't delete them.",
6548
_see_also = ['shelve']
6550
def run(self, shelf_id=None, action='apply', directory=u'.'):
6551
from bzrlib.shelf_ui import Unshelver
6552
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6556
unshelver.tree.unlock()
6559
class cmd_clean_tree(Command):
6560
__doc__ = """Remove unwanted files from working tree.
6562
By default, only unknown files, not ignored files, are deleted. Versioned
6563
files are never deleted.
6565
Another class is 'detritus', which includes files emitted by bzr during
6566
normal operations and selftests. (The value of these files decreases with
6569
If no options are specified, unknown files are deleted. Otherwise, option
6570
flags are respected, and may be combined.
6572
To check what clean-tree will do, use --dry-run.
6574
takes_options = ['directory',
6575
Option('ignored', help='Delete all ignored files.'),
6576
Option('detritus', help='Delete conflict files, merge and revert'
6577
' backups, and failed selftest dirs.'),
6579
help='Delete files unknown to bzr (default).'),
6580
Option('dry-run', help='Show files to delete instead of'
6582
Option('force', help='Do not prompt before deleting.')]
6583
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6584
force=False, directory=u'.'):
6585
from bzrlib.clean_tree import clean_tree
6586
if not (unknown or ignored or detritus):
6590
clean_tree(directory, unknown=unknown, ignored=ignored,
6591
detritus=detritus, dry_run=dry_run, no_prompt=force)
6594
class cmd_reference(Command):
6595
__doc__ = """list, view and set branch locations for nested trees.
6597
If no arguments are provided, lists the branch locations for nested trees.
6598
If one argument is provided, display the branch location for that tree.
6599
If two arguments are provided, set the branch location for that tree.
6604
takes_args = ['path?', 'location?']
6606
def run(self, path=None, location=None):
6608
if path is not None:
6610
tree, branch, relpath =(
6611
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6612
if path is not None:
6615
tree = branch.basis_tree()
6617
info = branch._get_all_reference_info().iteritems()
6618
self._display_reference_info(tree, branch, info)
6620
file_id = tree.path2id(path)
6622
raise errors.NotVersionedError(path)
6623
if location is None:
6624
info = [(file_id, branch.get_reference_info(file_id))]
6625
self._display_reference_info(tree, branch, info)
6627
branch.set_reference_info(file_id, path, location)
6629
def _display_reference_info(self, tree, branch, info):
6631
for file_id, (path, location) in info:
6633
path = tree.id2path(file_id)
6634
except errors.NoSuchId:
6636
ref_list.append((path, location))
6637
for path, location in sorted(ref_list):
6638
self.outf.write('%s %s\n' % (path, location))
6641
class cmd_export_pot(Command):
6642
__doc__ = """Export command helps and error messages in po format."""
6645
takes_options = [Option('plugin',
6646
help='Export help text from named command '\
6647
'(defaults to all built in commands).',
6649
Option('include-duplicates',
6650
help='Output multiple copies of the same msgid '
6651
'string if it appears more than once.'),
6654
def run(self, plugin=None, include_duplicates=False):
6655
from bzrlib.export_pot import export_pot
6656
export_pot(self.outf, plugin, include_duplicates)
6659
def _register_lazy_builtins():
6660
# register lazy builtins from other modules; called at startup and should
6661
# be only called once.
6662
for (name, aliases, module_name) in [
6663
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6664
('cmd_config', [], 'bzrlib.config'),
6665
('cmd_dpush', [], 'bzrlib.foreign'),
6666
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6667
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6668
('cmd_conflicts', [], 'bzrlib.conflicts'),
6669
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6670
('cmd_verify_signatures', [],
6671
'bzrlib.commit_signature_commands'),
6672
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6674
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
