1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
19
from __future__ import absolute_import
25
from bzrlib import lazy_import
26
lazy_import.lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
59
from bzrlib.branch import Branch
60
from bzrlib.conflicts import ConflictList
61
from bzrlib.transport import memory
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
63
from bzrlib.smtp_connection import SMTPConnection
64
from bzrlib.workingtree import WorkingTree
65
from bzrlib.i18n import gettext, ngettext
68
from bzrlib.commands import (
70
builtin_command_registry,
73
from bzrlib.option import (
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
86
def _get_branch_location(control_dir, possible_transports=None):
87
"""Return location of branch for this control dir."""
89
this_branch = control_dir.open_branch(
90
possible_transports=possible_transports)
91
# This may be a heavy checkout, where we want the master branch
92
master_location = this_branch.get_bound_location()
93
if master_location is not None:
94
return master_location
95
# If not, use a local sibling
96
return this_branch.base
97
except errors.NotBranchError:
98
format = control_dir.find_branch_format()
99
if getattr(format, 'get_reference', None) is not None:
100
return format.get_reference(control_dir)
102
return control_dir.root_transport.base
105
def _is_colocated(control_dir, possible_transports=None):
106
"""Check if the branch in control_dir is colocated.
108
:param control_dir: Control directory
109
:return: Boolean indicating whether
111
# This path is meant to be relative to the existing branch
112
this_url = _get_branch_location(control_dir,
113
possible_transports=possible_transports)
114
# Perhaps the target control dir supports colocated branches?
116
root = controldir.ControlDir.open(this_url,
117
possible_transports=possible_transports)
118
except errors.NotBranchError:
119
return (False, this_url)
122
wt = control_dir.open_workingtree()
123
except (errors.NoWorkingTree, errors.NotLocalUrl):
124
return (False, this_url)
127
root._format.colocated_branches and
128
control_dir.control_url == root.control_url,
132
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
133
"""Lookup the location for a new sibling branch.
135
:param control_dir: Control directory relative to which to look up
137
:param location: Name of the new branch
138
:return: Full location to the new branch
140
location = directory_service.directories.dereference(location)
141
if '/' not in location and '\\' not in location:
142
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
145
return urlutils.join_segment_parameters(this_url,
146
{"branch": urlutils.escape(location)})
148
return urlutils.join(this_url, '..', urlutils.escape(location))
152
def lookup_sibling_branch(control_dir, location, possible_transports=None):
153
"""Lookup sibling branch.
155
:param control_dir: Control directory relative to which to lookup the
157
:param location: Location to look up
158
:return: branch to open
161
# Perhaps it's a colocated branch?
162
return control_dir.open_branch(location,
163
possible_transports=possible_transports)
164
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
166
return Branch.open(location)
167
except errors.NotBranchError:
168
this_url = _get_branch_location(control_dir)
171
this_url, '..', urlutils.escape(location)))
174
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
175
def tree_files(file_list, default_branch=u'.', canonicalize=True,
177
return internal_tree_files(file_list, default_branch, canonicalize,
181
def tree_files_for_add(file_list):
183
Return a tree and list of absolute paths from a file list.
185
Similar to tree_files, but add handles files a bit differently, so it a
186
custom implementation. In particular, MutableTreeTree.smart_add expects
187
absolute paths, which it immediately converts to relative paths.
189
# FIXME Would be nice to just return the relative paths like
190
# internal_tree_files does, but there are a large number of unit tests
191
# that assume the current interface to mutabletree.smart_add
193
tree, relpath = WorkingTree.open_containing(file_list[0])
194
if tree.supports_views():
195
view_files = tree.views.lookup_view()
197
for filename in file_list:
198
if not osutils.is_inside_any(view_files, filename):
199
raise errors.FileOutsideView(filename, view_files)
200
file_list = file_list[:]
201
file_list[0] = tree.abspath(relpath)
203
tree = WorkingTree.open_containing(u'.')[0]
204
if tree.supports_views():
205
view_files = tree.views.lookup_view()
207
file_list = view_files
208
view_str = views.view_display_str(view_files)
209
note(gettext("Ignoring files outside view. View is %s") % view_str)
210
return tree, file_list
213
def _get_one_revision(command_name, revisions):
214
if revisions is None:
216
if len(revisions) != 1:
217
raise errors.BzrCommandError(gettext(
218
'bzr %s --revision takes exactly one revision identifier') % (
223
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
224
"""Get a revision tree. Not suitable for commands that change the tree.
226
Specifically, the basis tree in dirstate trees is coupled to the dirstate
227
and doing a commit/uncommit/pull will at best fail due to changing the
230
If tree is passed in, it should be already locked, for lifetime management
231
of the trees internal cached state.
235
if revisions is None:
237
rev_tree = tree.basis_tree()
239
rev_tree = branch.basis_tree()
241
revision = _get_one_revision(command_name, revisions)
242
rev_tree = revision.as_tree(branch)
246
# XXX: Bad function name; should possibly also be a class method of
247
# WorkingTree rather than a function.
248
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
249
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
251
"""Convert command-line paths to a WorkingTree and relative paths.
253
Deprecated: use WorkingTree.open_containing_paths instead.
255
This is typically used for command-line processors that take one or
256
more filenames, and infer the workingtree that contains them.
258
The filenames given are not required to exist.
260
:param file_list: Filenames to convert.
262
:param default_branch: Fallback tree path to use if file_list is empty or
265
:param apply_view: if True and a view is set, apply it or check that
266
specified files are within it
268
:return: workingtree, [relative_paths]
270
return WorkingTree.open_containing_paths(
271
file_list, default_directory='.',
276
def _get_view_info_for_change_reporter(tree):
277
"""Get the view information from a tree for change reporting."""
280
current_view = tree.views.get_view_info()[0]
281
if current_view is not None:
282
view_info = (current_view, tree.views.lookup_view())
283
except errors.ViewsNotSupported:
288
def _open_directory_or_containing_tree_or_branch(filename, directory):
289
"""Open the tree or branch containing the specified file, unless
290
the --directory option is used to specify a different branch."""
291
if directory is not None:
292
return (None, Branch.open(directory), filename)
293
return controldir.ControlDir.open_containing_tree_or_branch(filename)
296
# TODO: Make sure no commands unconditionally use the working directory as a
297
# branch. If a filename argument is used, the first of them should be used to
298
# specify the branch. (Perhaps this can be factored out into some kind of
299
# Argument class, representing a file in a branch, where the first occurrence
302
class cmd_status(Command):
303
__doc__ = """Display status summary.
305
This reports on versioned and unknown files, reporting them
306
grouped by state. Possible states are:
309
Versioned in the working copy but not in the previous revision.
312
Versioned in the previous revision but removed or deleted
316
Path of this file changed from the previous revision;
317
the text may also have changed. This includes files whose
318
parent directory was renamed.
321
Text has changed since the previous revision.
324
File kind has been changed (e.g. from file to directory).
327
Not versioned and not matching an ignore pattern.
329
Additionally for directories, symlinks and files with a changed
330
executable bit, Bazaar indicates their type using a trailing
331
character: '/', '@' or '*' respectively. These decorations can be
332
disabled using the '--no-classify' option.
334
To see ignored files use 'bzr ignored'. For details on the
335
changes to file texts, use 'bzr diff'.
337
Note that --short or -S gives status flags for each item, similar
338
to Subversion's status command. To get output similar to svn -q,
341
If no arguments are specified, the status of the entire working
342
directory is shown. Otherwise, only the status of the specified
343
files or directories is reported. If a directory is given, status
344
is reported for everything inside that directory.
346
Before merges are committed, the pending merge tip revisions are
347
shown. To see all pending merge revisions, use the -v option.
348
To skip the display of pending merge information altogether, use
349
the no-pending option or specify a file/directory.
351
To compare the working directory to a specific revision, pass a
352
single revision to the revision argument.
354
To see which files have changed in a specific revision, or between
355
two revisions, pass a revision range to the revision argument.
356
This will produce the same results as calling 'bzr diff --summarize'.
359
# TODO: --no-recurse, --recurse options
361
takes_args = ['file*']
362
takes_options = ['show-ids', 'revision', 'change', 'verbose',
363
Option('short', help='Use short status indicators.',
365
Option('versioned', help='Only show versioned files.',
367
Option('no-pending', help='Don\'t show pending merges.',
369
Option('no-classify',
370
help='Do not mark object type using indicator.',
373
aliases = ['st', 'stat']
375
encoding_type = 'replace'
376
_see_also = ['diff', 'revert', 'status-flags']
379
def run(self, show_ids=False, file_list=None, revision=None, short=False,
380
versioned=False, no_pending=False, verbose=False,
382
from bzrlib.status import show_tree_status
384
if revision and len(revision) > 2:
385
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
386
' one or two revision specifiers'))
388
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
389
# Avoid asking for specific files when that is not needed.
390
if relfile_list == ['']:
392
# Don't disable pending merges for full trees other than '.'.
393
if file_list == ['.']:
395
# A specific path within a tree was given.
396
elif relfile_list is not None:
398
show_tree_status(tree, show_ids=show_ids,
399
specific_files=relfile_list, revision=revision,
400
to_file=self.outf, short=short, versioned=versioned,
401
show_pending=(not no_pending), verbose=verbose,
402
classify=not no_classify)
405
class cmd_cat_revision(Command):
406
__doc__ = """Write out metadata for a revision.
408
The revision to print can either be specified by a specific
409
revision identifier, or you can use --revision.
413
takes_args = ['revision_id?']
414
takes_options = ['directory', 'revision']
415
# cat-revision is more for frontends so should be exact
418
def print_revision(self, revisions, revid):
419
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
420
record = stream.next()
421
if record.storage_kind == 'absent':
422
raise errors.NoSuchRevision(revisions, revid)
423
revtext = record.get_bytes_as('fulltext')
424
self.outf.write(revtext.decode('utf-8'))
427
def run(self, revision_id=None, revision=None, directory=u'.'):
428
if revision_id is not None and revision is not None:
429
raise errors.BzrCommandError(gettext('You can only supply one of'
430
' revision_id or --revision'))
431
if revision_id is None and revision is None:
432
raise errors.BzrCommandError(gettext('You must supply either'
433
' --revision or a revision_id'))
435
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
437
revisions = b.repository.revisions
438
if revisions is None:
439
raise errors.BzrCommandError(gettext('Repository %r does not support '
440
'access to raw revision texts'))
442
b.repository.lock_read()
444
# TODO: jam 20060112 should cat-revision always output utf-8?
445
if revision_id is not None:
446
revision_id = osutils.safe_revision_id(revision_id, warn=False)
448
self.print_revision(revisions, revision_id)
449
except errors.NoSuchRevision:
450
msg = gettext("The repository {0} contains no revision {1}.").format(
451
b.repository.base, revision_id)
452
raise errors.BzrCommandError(msg)
453
elif revision is not None:
456
raise errors.BzrCommandError(
457
gettext('You cannot specify a NULL revision.'))
458
rev_id = rev.as_revision_id(b)
459
self.print_revision(revisions, rev_id)
461
b.repository.unlock()
464
class cmd_dump_btree(Command):
465
__doc__ = """Dump the contents of a btree index file to stdout.
467
PATH is a btree index file, it can be any URL. This includes things like
468
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
470
By default, the tuples stored in the index file will be displayed. With
471
--raw, we will uncompress the pages, but otherwise display the raw bytes
475
# TODO: Do we want to dump the internal nodes as well?
476
# TODO: It would be nice to be able to dump the un-parsed information,
477
# rather than only going through iter_all_entries. However, this is
478
# good enough for a start
480
encoding_type = 'exact'
481
takes_args = ['path']
482
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
483
' rather than the parsed tuples.'),
486
def run(self, path, raw=False):
487
dirname, basename = osutils.split(path)
488
t = transport.get_transport(dirname)
490
self._dump_raw_bytes(t, basename)
492
self._dump_entries(t, basename)
494
def _get_index_and_bytes(self, trans, basename):
495
"""Create a BTreeGraphIndex and raw bytes."""
496
bt = btree_index.BTreeGraphIndex(trans, basename, None)
497
bytes = trans.get_bytes(basename)
498
bt._file = cStringIO.StringIO(bytes)
499
bt._size = len(bytes)
502
def _dump_raw_bytes(self, trans, basename):
505
# We need to parse at least the root node.
506
# This is because the first page of every row starts with an
507
# uncompressed header.
508
bt, bytes = self._get_index_and_bytes(trans, basename)
509
for page_idx, page_start in enumerate(xrange(0, len(bytes),
510
btree_index._PAGE_SIZE)):
511
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
512
page_bytes = bytes[page_start:page_end]
514
self.outf.write('Root node:\n')
515
header_end, data = bt._parse_header_from_bytes(page_bytes)
516
self.outf.write(page_bytes[:header_end])
518
self.outf.write('\nPage %d\n' % (page_idx,))
519
if len(page_bytes) == 0:
520
self.outf.write('(empty)\n');
522
decomp_bytes = zlib.decompress(page_bytes)
523
self.outf.write(decomp_bytes)
524
self.outf.write('\n')
526
def _dump_entries(self, trans, basename):
528
st = trans.stat(basename)
529
except errors.TransportNotPossible:
530
# We can't stat, so we'll fake it because we have to do the 'get()'
532
bt, _ = self._get_index_and_bytes(trans, basename)
534
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
535
for node in bt.iter_all_entries():
536
# Node is made up of:
537
# (index, key, value, [references])
541
refs_as_tuples = None
543
refs_as_tuples = static_tuple.as_tuples(refs)
544
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
545
self.outf.write('%s\n' % (as_tuple,))
548
class cmd_remove_tree(Command):
549
__doc__ = """Remove the working tree from a given branch/checkout.
551
Since a lightweight checkout is little more than a working tree
552
this will refuse to run against one.
554
To re-create the working tree, use "bzr checkout".
556
_see_also = ['checkout', 'working-trees']
557
takes_args = ['location*']
560
help='Remove the working tree even if it has '
561
'uncommitted or shelved changes.'),
564
def run(self, location_list, force=False):
565
if not location_list:
568
for location in location_list:
569
d = controldir.ControlDir.open(location)
572
working = d.open_workingtree()
573
except errors.NoWorkingTree:
574
raise errors.BzrCommandError(gettext("No working tree to remove"))
575
except errors.NotLocalUrl:
576
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
577
" of a remote path"))
579
if (working.has_changes()):
580
raise errors.UncommittedChanges(working)
581
if working.get_shelf_manager().last_shelf() is not None:
582
raise errors.ShelvedChanges(working)
584
if working.user_url != working.branch.user_url:
585
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
586
" from a lightweight checkout"))
588
d.destroy_workingtree()
591
class cmd_repair_workingtree(Command):
592
__doc__ = """Reset the working tree state file.
594
This is not meant to be used normally, but more as a way to recover from
595
filesystem corruption, etc. This rebuilds the working inventory back to a
596
'known good' state. Any new modifications (adding a file, renaming, etc)
597
will be lost, though modified files will still be detected as such.
599
Most users will want something more like "bzr revert" or "bzr update"
600
unless the state file has become corrupted.
602
By default this attempts to recover the current state by looking at the
603
headers of the state file. If the state file is too corrupted to even do
604
that, you can supply --revision to force the state of the tree.
607
takes_options = ['revision', 'directory',
609
help='Reset the tree even if it doesn\'t appear to be'
614
def run(self, revision=None, directory='.', force=False):
615
tree, _ = WorkingTree.open_containing(directory)
616
self.add_cleanup(tree.lock_tree_write().unlock)
620
except errors.BzrError:
621
pass # There seems to be a real error here, so we'll reset
624
raise errors.BzrCommandError(gettext(
625
'The tree does not appear to be corrupt. You probably'
626
' want "bzr revert" instead. Use "--force" if you are'
627
' sure you want to reset the working tree.'))
631
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
633
tree.reset_state(revision_ids)
634
except errors.BzrError, e:
635
if revision_ids is None:
636
extra = (gettext(', the header appears corrupt, try passing -r -1'
637
' to set the state to the last commit'))
640
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
643
class cmd_revno(Command):
644
__doc__ = """Show current revision number.
646
This is equal to the number of revisions on this branch.
650
takes_args = ['location?']
652
Option('tree', help='Show revno of working tree.'),
657
def run(self, tree=False, location=u'.', revision=None):
658
if revision is not None and tree:
659
raise errors.BzrCommandError(gettext("--tree and --revision can "
660
"not be used together"))
664
wt = WorkingTree.open_containing(location)[0]
665
self.add_cleanup(wt.lock_read().unlock)
666
except (errors.NoWorkingTree, errors.NotLocalUrl):
667
raise errors.NoWorkingTree(location)
669
revid = wt.last_revision()
671
b = Branch.open_containing(location)[0]
672
self.add_cleanup(b.lock_read().unlock)
674
if len(revision) != 1:
675
raise errors.BzrCommandError(gettext(
676
"Tags can only be placed on a single revision, "
678
revid = revision[0].as_revision_id(b)
680
revid = b.last_revision()
682
revno_t = b.revision_id_to_dotted_revno(revid)
683
except errors.NoSuchRevision:
685
revno = ".".join(str(n) for n in revno_t)
687
self.outf.write(revno + '\n')
690
class cmd_revision_info(Command):
691
__doc__ = """Show revision number and revision id for a given revision identifier.
694
takes_args = ['revision_info*']
697
custom_help('directory',
698
help='Branch to examine, '
699
'rather than the one containing the working directory.'),
700
Option('tree', help='Show revno of working tree.'),
704
def run(self, revision=None, directory=u'.', tree=False,
705
revision_info_list=[]):
708
wt = WorkingTree.open_containing(directory)[0]
710
self.add_cleanup(wt.lock_read().unlock)
711
except (errors.NoWorkingTree, errors.NotLocalUrl):
713
b = Branch.open_containing(directory)[0]
714
self.add_cleanup(b.lock_read().unlock)
716
if revision is not None:
717
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
718
if revision_info_list is not None:
719
for rev_str in revision_info_list:
720
rev_spec = RevisionSpec.from_string(rev_str)
721
revision_ids.append(rev_spec.as_revision_id(b))
722
# No arguments supplied, default to the last revision
723
if len(revision_ids) == 0:
726
raise errors.NoWorkingTree(directory)
727
revision_ids.append(wt.last_revision())
729
revision_ids.append(b.last_revision())
733
for revision_id in revision_ids:
735
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
736
revno = '.'.join(str(i) for i in dotted_revno)
737
except errors.NoSuchRevision:
739
maxlen = max(maxlen, len(revno))
740
revinfos.append([revno, revision_id])
744
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
747
class cmd_add(Command):
748
__doc__ = """Add specified files or directories.
750
In non-recursive mode, all the named items are added, regardless
751
of whether they were previously ignored. A warning is given if
752
any of the named files are already versioned.
754
In recursive mode (the default), files are treated the same way
755
but the behaviour for directories is different. Directories that
756
are already versioned do not give a warning. All directories,
757
whether already versioned or not, are searched for files or
758
subdirectories that are neither versioned or ignored, and these
759
are added. This search proceeds recursively into versioned
760
directories. If no names are given '.' is assumed.
762
A warning will be printed when nested trees are encountered,
763
unless they are explicitly ignored.
765
Therefore simply saying 'bzr add' will version all files that
766
are currently unknown.
768
Adding a file whose parent directory is not versioned will
769
implicitly add the parent, and so on up to the root. This means
770
you should never need to explicitly add a directory, they'll just
771
get added when you add a file in the directory.
773
--dry-run will show which files would be added, but not actually
776
--file-ids-from will try to use the file ids from the supplied path.
777
It looks up ids trying to find a matching parent directory with the
778
same filename, and then by pure path. This option is rarely needed
779
but can be useful when adding the same logical file into two
780
branches that will be merged later (without showing the two different
781
adds as a conflict). It is also useful when merging another project
782
into a subdirectory of this one.
784
Any files matching patterns in the ignore list will not be added
785
unless they are explicitly mentioned.
787
In recursive mode, files larger than the configuration option
788
add.maximum_file_size will be skipped. Named items are never skipped due
791
takes_args = ['file*']
794
help="Don't recursively add the contents of directories."),
796
help="Show what would be done, but don't actually do anything."),
798
Option('file-ids-from',
800
help='Lookup file ids from this tree.'),
802
encoding_type = 'replace'
803
_see_also = ['remove', 'ignore']
805
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
810
if file_ids_from is not None:
812
base_tree, base_path = WorkingTree.open_containing(
814
except errors.NoWorkingTree:
815
base_branch, base_path = Branch.open_containing(
817
base_tree = base_branch.basis_tree()
819
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
820
to_file=self.outf, should_print=(not is_quiet()))
822
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
823
should_print=(not is_quiet()))
826
self.add_cleanup(base_tree.lock_read().unlock)
827
tree, file_list = tree_files_for_add(file_list)
828
added, ignored = tree.smart_add(file_list, not
829
no_recurse, action=action, save=not dry_run)
833
for glob in sorted(ignored.keys()):
834
for path in ignored[glob]:
836
gettext("ignored {0} matching \"{1}\"\n").format(
840
class cmd_mkdir(Command):
841
__doc__ = """Create a new versioned directory.
843
This is equivalent to creating the directory and then adding it.
846
takes_args = ['dir+']
850
help='No error if existing, make parent directories as needed.',
854
encoding_type = 'replace'
857
def add_file_with_parents(cls, wt, relpath):
858
if wt.path2id(relpath) is not None:
860
cls.add_file_with_parents(wt, osutils.dirname(relpath))
864
def add_file_single(cls, wt, relpath):
867
def run(self, dir_list, parents=False):
869
add_file = self.add_file_with_parents
871
add_file = self.add_file_single
873
wt, relpath = WorkingTree.open_containing(dir)
878
if e.errno != errno.EEXIST:
882
add_file(wt, relpath)
884
self.outf.write(gettext('added %s\n') % dir)
887
class cmd_relpath(Command):
888
__doc__ = """Show path of a file relative to root"""
890
takes_args = ['filename']
894
def run(self, filename):
895
# TODO: jam 20050106 Can relpath return a munged path if
896
# sys.stdout encoding cannot represent it?
897
tree, relpath = WorkingTree.open_containing(filename)
898
self.outf.write(relpath)
899
self.outf.write('\n')
902
class cmd_inventory(Command):
903
__doc__ = """Show inventory of the current working copy or a revision.
905
It is possible to limit the output to a particular entry
906
type using the --kind option. For example: --kind file.
908
It is also possible to restrict the list of files to a specific
909
set. For example: bzr inventory --show-ids this/file
918
help='List entries of a particular kind: file, directory, symlink.',
921
takes_args = ['file*']
924
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
925
if kind and kind not in ['file', 'directory', 'symlink']:
926
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
928
revision = _get_one_revision('inventory', revision)
929
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
930
self.add_cleanup(work_tree.lock_read().unlock)
931
if revision is not None:
932
tree = revision.as_tree(work_tree.branch)
934
extra_trees = [work_tree]
935
self.add_cleanup(tree.lock_read().unlock)
940
if file_list is not None:
941
file_ids = tree.paths2ids(file_list, trees=extra_trees,
942
require_versioned=True)
943
# find_ids_across_trees may include some paths that don't
946
(tree.id2path(file_id), tree.inventory[file_id])
947
for file_id in file_ids if tree.has_id(file_id))
949
entries = tree.inventory.entries()
952
for path, entry in entries:
953
if kind and kind != entry.kind:
956
self.outf.write('%-50s %s\n' % (path, entry.file_id))
958
self.outf.write(path)
959
self.outf.write('\n')
962
class cmd_mv(Command):
963
__doc__ = """Move or rename a file.
966
bzr mv OLDNAME NEWNAME
968
bzr mv SOURCE... DESTINATION
970
If the last argument is a versioned directory, all the other names
971
are moved into it. Otherwise, there must be exactly two arguments
972
and the file is changed to a new name.
974
If OLDNAME does not exist on the filesystem but is versioned and
975
NEWNAME does exist on the filesystem but is not versioned, mv
976
assumes that the file has been manually moved and only updates
977
its internal inventory to reflect that change.
978
The same is valid when moving many SOURCE files to a DESTINATION.
980
Files cannot be moved between branches.
983
takes_args = ['names*']
984
takes_options = [Option("after", help="Move only the bzr identifier"
985
" of the file, because the file has already been moved."),
986
Option('auto', help='Automatically guess renames.'),
987
Option('dry-run', help='Avoid making changes when guessing renames.'),
989
aliases = ['move', 'rename']
990
encoding_type = 'replace'
992
def run(self, names_list, after=False, auto=False, dry_run=False):
994
return self.run_auto(names_list, after, dry_run)
996
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
997
if names_list is None:
999
if len(names_list) < 2:
1000
raise errors.BzrCommandError(gettext("missing file argument"))
1001
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1002
for file_name in rel_names[0:-1]:
1004
raise errors.BzrCommandError(gettext("can not move root of branch"))
1005
self.add_cleanup(tree.lock_tree_write().unlock)
1006
self._run(tree, names_list, rel_names, after)
1008
def run_auto(self, names_list, after, dry_run):
1009
if names_list is not None and len(names_list) > 1:
1010
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1013
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1015
work_tree, file_list = WorkingTree.open_containing_paths(
1016
names_list, default_directory='.')
1017
self.add_cleanup(work_tree.lock_tree_write().unlock)
1018
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1020
def _run(self, tree, names_list, rel_names, after):
1021
into_existing = osutils.isdir(names_list[-1])
1022
if into_existing and len(names_list) == 2:
1024
# a. case-insensitive filesystem and change case of dir
1025
# b. move directory after the fact (if the source used to be
1026
# a directory, but now doesn't exist in the working tree
1027
# and the target is an existing directory, just rename it)
1028
if (not tree.case_sensitive
1029
and rel_names[0].lower() == rel_names[1].lower()):
1030
into_existing = False
1032
inv = tree.inventory
1033
# 'fix' the case of a potential 'from'
1034
from_id = tree.path2id(
1035
tree.get_canonical_inventory_path(rel_names[0]))
1036
if (not osutils.lexists(names_list[0]) and
1037
from_id and inv.get_file_kind(from_id) == "directory"):
1038
into_existing = False
1041
# move into existing directory
1042
# All entries reference existing inventory items, so fix them up
1043
# for cicp file-systems.
1044
rel_names = tree.get_canonical_inventory_paths(rel_names)
1045
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1047
self.outf.write("%s => %s\n" % (src, dest))
1049
if len(names_list) != 2:
1050
raise errors.BzrCommandError(gettext('to mv multiple files the'
1051
' destination must be a versioned'
1054
# for cicp file-systems: the src references an existing inventory
1056
src = tree.get_canonical_inventory_path(rel_names[0])
1057
# Find the canonical version of the destination: In all cases, the
1058
# parent of the target must be in the inventory, so we fetch the
1059
# canonical version from there (we do not always *use* the
1060
# canonicalized tail portion - we may be attempting to rename the
1062
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1063
dest_parent = osutils.dirname(canon_dest)
1064
spec_tail = osutils.basename(rel_names[1])
1065
# For a CICP file-system, we need to avoid creating 2 inventory
1066
# entries that differ only by case. So regardless of the case
1067
# we *want* to use (ie, specified by the user or the file-system),
1068
# we must always choose to use the case of any existing inventory
1069
# items. The only exception to this is when we are attempting a
1070
# case-only rename (ie, canonical versions of src and dest are
1072
dest_id = tree.path2id(canon_dest)
1073
if dest_id is None or tree.path2id(src) == dest_id:
1074
# No existing item we care about, so work out what case we
1075
# are actually going to use.
1077
# If 'after' is specified, the tail must refer to a file on disk.
1079
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1081
# pathjoin with an empty tail adds a slash, which breaks
1083
dest_parent_fq = tree.basedir
1085
dest_tail = osutils.canonical_relpath(
1087
osutils.pathjoin(dest_parent_fq, spec_tail))
1089
# not 'after', so case as specified is used
1090
dest_tail = spec_tail
1092
# Use the existing item so 'mv' fails with AlreadyVersioned.
1093
dest_tail = os.path.basename(canon_dest)
1094
dest = osutils.pathjoin(dest_parent, dest_tail)
1095
mutter("attempting to move %s => %s", src, dest)
1096
tree.rename_one(src, dest, after=after)
1098
self.outf.write("%s => %s\n" % (src, dest))
1101
class cmd_pull(Command):
1102
__doc__ = """Turn this branch into a mirror of another branch.
1104
By default, this command only works on branches that have not diverged.
1105
Branches are considered diverged if the destination branch's most recent
1106
commit is one that has not been merged (directly or indirectly) into the
1109
If branches have diverged, you can use 'bzr merge' to integrate the changes
1110
from one into the other. Once one branch has merged, the other should
1111
be able to pull it again.
1113
If you want to replace your local changes and just want your branch to
1114
match the remote one, use pull --overwrite. This will work even if the two
1115
branches have diverged.
1117
If there is no default location set, the first pull will set it (use
1118
--no-remember to avoid setting it). After that, you can omit the
1119
location to use the default. To change the default, use --remember. The
1120
value will only be saved if the remote location can be accessed.
1122
The --verbose option will display the revisions pulled using the log_format
1123
configuration option. You can use a different format by overriding it with
1124
-Olog_format=<other_format>.
1126
Note: The location can be specified either in the form of a branch,
1127
or in the form of a path to a file containing a merge directive generated
1131
_see_also = ['push', 'update', 'status-flags', 'send']
1132
takes_options = ['remember', 'overwrite', 'revision',
1133
custom_help('verbose',
1134
help='Show logs of pulled revisions.'),
1135
custom_help('directory',
1136
help='Branch to pull into, '
1137
'rather than the one containing the working directory.'),
1139
help="Perform a local pull in a bound "
1140
"branch. Local pulls are not applied to "
1141
"the master branch."
1144
help="Show base revision text in conflicts.")
1146
takes_args = ['location?']
1147
encoding_type = 'replace'
1149
def run(self, location=None, remember=None, overwrite=False,
1150
revision=None, verbose=False,
1151
directory=None, local=False,
1153
# FIXME: too much stuff is in the command class
1156
if directory is None:
1159
tree_to = WorkingTree.open_containing(directory)[0]
1160
branch_to = tree_to.branch
1161
self.add_cleanup(tree_to.lock_write().unlock)
1162
except errors.NoWorkingTree:
1164
branch_to = Branch.open_containing(directory)[0]
1165
self.add_cleanup(branch_to.lock_write().unlock)
1167
if tree_to is None and show_base:
1168
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1170
if local and not branch_to.get_bound_location():
1171
raise errors.LocalRequiresBoundBranch()
1173
possible_transports = []
1174
if location is not None:
1176
mergeable = bundle.read_mergeable_from_url(location,
1177
possible_transports=possible_transports)
1178
except errors.NotABundle:
1181
stored_loc = branch_to.get_parent()
1182
if location is None:
1183
if stored_loc is None:
1184
raise errors.BzrCommandError(gettext("No pull location known or"
1187
display_url = urlutils.unescape_for_display(stored_loc,
1190
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1191
location = stored_loc
1193
revision = _get_one_revision('pull', revision)
1194
if mergeable is not None:
1195
if revision is not None:
1196
raise errors.BzrCommandError(gettext(
1197
'Cannot use -r with merge directives or bundles'))
1198
mergeable.install_revisions(branch_to.repository)
1199
base_revision_id, revision_id, verified = \
1200
mergeable.get_merge_request(branch_to.repository)
1201
branch_from = branch_to
1203
branch_from = Branch.open(location,
1204
possible_transports=possible_transports)
1205
self.add_cleanup(branch_from.lock_read().unlock)
1206
# Remembers if asked explicitly or no previous location is set
1208
or (remember is None and branch_to.get_parent() is None)):
1209
branch_to.set_parent(branch_from.base)
1211
if revision is not None:
1212
revision_id = revision.as_revision_id(branch_from)
1214
if tree_to is not None:
1215
view_info = _get_view_info_for_change_reporter(tree_to)
1216
change_reporter = delta._ChangeReporter(
1217
unversioned_filter=tree_to.is_ignored,
1218
view_info=view_info)
1219
result = tree_to.pull(
1220
branch_from, overwrite, revision_id, change_reporter,
1221
local=local, show_base=show_base)
1223
result = branch_to.pull(
1224
branch_from, overwrite, revision_id, local=local)
1226
result.report(self.outf)
1227
if verbose and result.old_revid != result.new_revid:
1228
log.show_branch_change(
1229
branch_to, self.outf, result.old_revno,
1231
if getattr(result, 'tag_conflicts', None):
1237
class cmd_push(Command):
1238
__doc__ = """Update a mirror of this branch.
1240
The target branch will not have its working tree populated because this
1241
is both expensive, and is not supported on remote file systems.
1243
Some smart servers or protocols *may* put the working tree in place in
1246
This command only works on branches that have not diverged. Branches are
1247
considered diverged if the destination branch's most recent commit is one
1248
that has not been merged (directly or indirectly) by the source branch.
1250
If branches have diverged, you can use 'bzr push --overwrite' to replace
1251
the other branch completely, discarding its unmerged changes.
1253
If you want to ensure you have the different changes in the other branch,
1254
do a merge (see bzr help merge) from the other branch, and commit that.
1255
After that you will be able to do a push without '--overwrite'.
1257
If there is no default push location set, the first push will set it (use
1258
--no-remember to avoid setting it). After that, you can omit the
1259
location to use the default. To change the default, use --remember. The
1260
value will only be saved if the remote location can be accessed.
1262
The --verbose option will display the revisions pushed using the log_format
1263
configuration option. You can use a different format by overriding it with
1264
-Olog_format=<other_format>.
1267
_see_also = ['pull', 'update', 'working-trees']
1268
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1269
Option('create-prefix',
1270
help='Create the path leading up to the branch '
1271
'if it does not already exist.'),
1272
custom_help('directory',
1273
help='Branch to push from, '
1274
'rather than the one containing the working directory.'),
1275
Option('use-existing-dir',
1276
help='By default push will fail if the target'
1277
' directory exists, but does not already'
1278
' have a control directory. This flag will'
1279
' allow push to proceed.'),
1281
help='Create a stacked branch that references the public location '
1282
'of the parent branch.'),
1283
Option('stacked-on',
1284
help='Create a stacked branch that refers to another branch '
1285
'for the commit history. Only the work not present in the '
1286
'referenced branch is included in the branch created.',
1289
help='Refuse to push if there are uncommitted changes in'
1290
' the working tree, --no-strict disables the check.'),
1292
help="Don't populate the working tree, even for protocols"
1293
" that support it."),
1295
takes_args = ['location?']
1296
encoding_type = 'replace'
1298
def run(self, location=None, remember=None, overwrite=False,
1299
create_prefix=False, verbose=False, revision=None,
1300
use_existing_dir=False, directory=None, stacked_on=None,
1301
stacked=False, strict=None, no_tree=False):
1302
from bzrlib.push import _show_push_branch
1304
if directory is None:
1306
# Get the source branch
1308
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1309
# Get the tip's revision_id
1310
revision = _get_one_revision('push', revision)
1311
if revision is not None:
1312
revision_id = revision.in_history(br_from).rev_id
1315
if tree is not None and revision_id is None:
1316
tree.check_changed_or_out_of_date(
1317
strict, 'push_strict',
1318
more_error='Use --no-strict to force the push.',
1319
more_warning='Uncommitted changes will not be pushed.')
1320
# Get the stacked_on branch, if any
1321
if stacked_on is not None:
1322
stacked_on = urlutils.normalize_url(stacked_on)
1324
parent_url = br_from.get_parent()
1326
parent = Branch.open(parent_url)
1327
stacked_on = parent.get_public_branch()
1329
# I considered excluding non-http url's here, thus forcing
1330
# 'public' branches only, but that only works for some
1331
# users, so it's best to just depend on the user spotting an
1332
# error by the feedback given to them. RBC 20080227.
1333
stacked_on = parent_url
1335
raise errors.BzrCommandError(gettext(
1336
"Could not determine branch to refer to."))
1338
# Get the destination location
1339
if location is None:
1340
stored_loc = br_from.get_push_location()
1341
if stored_loc is None:
1342
parent_loc = br_from.get_parent()
1344
raise errors.BzrCommandError(gettext(
1345
"No push location known or specified. To push to the "
1346
"parent branch (at %s), use 'bzr push :parent'." %
1347
urlutils.unescape_for_display(parent_loc,
1348
self.outf.encoding)))
1350
raise errors.BzrCommandError(gettext(
1351
"No push location known or specified."))
1353
display_url = urlutils.unescape_for_display(stored_loc,
1355
note(gettext("Using saved push location: %s") % display_url)
1356
location = stored_loc
1358
_show_push_branch(br_from, revision_id, location, self.outf,
1359
verbose=verbose, overwrite=overwrite, remember=remember,
1360
stacked_on=stacked_on, create_prefix=create_prefix,
1361
use_existing_dir=use_existing_dir, no_tree=no_tree)
1364
class cmd_branch(Command):
1365
__doc__ = """Create a new branch that is a copy of an existing branch.
1367
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1368
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1369
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1370
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1371
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1374
To retrieve the branch as of a particular revision, supply the --revision
1375
parameter, as in "branch foo/bar -r 5".
1377
The synonyms 'clone' and 'get' for this command are deprecated.
1380
_see_also = ['checkout']
1381
takes_args = ['from_location', 'to_location?']
1382
takes_options = ['revision',
1383
Option('hardlink', help='Hard-link working tree files where possible.'),
1384
Option('files-from', type=str,
1385
help="Get file contents from this tree."),
1387
help="Create a branch without a working-tree."),
1389
help="Switch the checkout in the current directory "
1390
"to the new branch."),
1392
help='Create a stacked branch referring to the source branch. '
1393
'The new branch will depend on the availability of the source '
1394
'branch for all operations.'),
1395
Option('standalone',
1396
help='Do not use a shared repository, even if available.'),
1397
Option('use-existing-dir',
1398
help='By default branch will fail if the target'
1399
' directory exists, but does not already'
1400
' have a control directory. This flag will'
1401
' allow branch to proceed.'),
1403
help="Bind new branch to from location."),
1405
aliases = ['get', 'clone']
1407
def run(self, from_location, to_location=None, revision=None,
1408
hardlink=False, stacked=False, standalone=False, no_tree=False,
1409
use_existing_dir=False, switch=False, bind=False,
1411
from bzrlib import switch as _mod_switch
1412
from bzrlib.tag import _merge_tags_if_possible
1413
if self.invoked_as in ['get', 'clone']:
1414
ui.ui_factory.show_user_warning(
1415
'deprecated_command',
1416
deprecated_name=self.invoked_as,
1417
recommended_name='branch',
1418
deprecated_in_version='2.4')
1419
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1421
if not (hardlink or files_from):
1422
# accelerator_tree is usually slower because you have to read N
1423
# files (no readahead, lots of seeks, etc), but allow the user to
1424
# explicitly request it
1425
accelerator_tree = None
1426
if files_from is not None and files_from != from_location:
1427
accelerator_tree = WorkingTree.open(files_from)
1428
revision = _get_one_revision('branch', revision)
1429
self.add_cleanup(br_from.lock_read().unlock)
1430
if revision is not None:
1431
revision_id = revision.as_revision_id(br_from)
1433
# FIXME - wt.last_revision, fallback to branch, fall back to
1434
# None or perhaps NULL_REVISION to mean copy nothing
1436
revision_id = br_from.last_revision()
1437
if to_location is None:
1438
to_location = getattr(br_from, "name", None)
1440
to_location = urlutils.derive_to_location(from_location)
1441
to_transport = transport.get_transport(to_location)
1443
to_transport.mkdir('.')
1444
except errors.FileExists:
1446
to_dir = controldir.ControlDir.open_from_transport(
1448
except errors.NotBranchError:
1449
if not use_existing_dir:
1450
raise errors.BzrCommandError(gettext('Target directory "%s" '
1451
'already exists.') % to_location)
1456
to_dir.open_branch()
1457
except errors.NotBranchError:
1460
raise errors.AlreadyBranchError(to_location)
1461
except errors.NoSuchFile:
1462
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1468
# preserve whatever source format we have.
1469
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1470
possible_transports=[to_transport],
1471
accelerator_tree=accelerator_tree,
1472
hardlink=hardlink, stacked=stacked,
1473
force_new_repo=standalone,
1474
create_tree_if_local=not no_tree,
1475
source_branch=br_from)
1476
branch = to_dir.open_branch(
1477
possible_transports=[
1478
br_from.bzrdir.root_transport, to_transport])
1479
except errors.NoSuchRevision:
1480
to_transport.delete_tree('.')
1481
msg = gettext("The branch {0} has no revision {1}.").format(
1482
from_location, revision)
1483
raise errors.BzrCommandError(msg)
1486
to_repo = to_dir.open_repository()
1487
except errors.NoRepositoryPresent:
1488
to_repo = to_dir.create_repository()
1489
to_repo.fetch(br_from.repository, revision_id=revision_id)
1490
branch = br_from.sprout(to_dir, revision_id=revision_id)
1491
_merge_tags_if_possible(br_from, branch)
1492
# If the source branch is stacked, the new branch may
1493
# be stacked whether we asked for that explicitly or not.
1494
# We therefore need a try/except here and not just 'if stacked:'
1496
note(gettext('Created new stacked branch referring to %s.') %
1497
branch.get_stacked_on_url())
1498
except (errors.NotStacked, errors.UnstackableBranchFormat,
1499
errors.UnstackableRepositoryFormat), e:
1500
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1502
# Bind to the parent
1503
parent_branch = Branch.open(from_location)
1504
branch.bind(parent_branch)
1505
note(gettext('New branch bound to %s') % from_location)
1507
# Switch to the new branch
1508
wt, _ = WorkingTree.open_containing('.')
1509
_mod_switch.switch(wt.bzrdir, branch)
1510
note(gettext('Switched to branch: %s'),
1511
urlutils.unescape_for_display(branch.base, 'utf-8'))
1514
class cmd_branches(Command):
1515
__doc__ = """List the branches available at the current location.
1517
This command will print the names of all the branches at the current
1521
takes_args = ['location?']
1523
Option('recursive', short_name='R',
1524
help='Recursively scan for branches rather than '
1525
'just looking in the specified location.')]
1527
def run(self, location=".", recursive=False):
1529
t = transport.get_transport(location)
1530
if not t.listable():
1531
raise errors.BzrCommandError(
1532
"Can't scan this type of location.")
1533
for b in controldir.ControlDir.find_branches(t):
1534
self.outf.write("%s\n" % urlutils.unescape_for_display(
1535
urlutils.relative_url(t.base, b.base),
1536
self.outf.encoding).rstrip("/"))
1538
dir = controldir.ControlDir.open_containing(location)[0]
1540
active_branch = dir.open_branch(name="")
1541
except errors.NotBranchError:
1542
active_branch = None
1543
branches = dir.get_branches()
1545
for name, branch in branches.iteritems():
1548
active = (active_branch is not None and
1549
active_branch.base == branch.base)
1550
names[name] = active
1551
# Only mention the current branch explicitly if it's not
1552
# one of the colocated branches
1553
if not any(names.values()) and active_branch is not None:
1554
self.outf.write("* %s\n" % gettext("(default)"))
1555
for name in sorted(names.keys()):
1556
active = names[name]
1561
self.outf.write("%s %s\n" % (
1562
prefix, name.encode(self.outf.encoding)))
1565
class cmd_checkout(Command):
1566
__doc__ = """Create a new checkout of an existing branch.
1568
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1569
the branch found in '.'. This is useful if you have removed the working tree
1570
or if it was never created - i.e. if you pushed the branch to its current
1571
location using SFTP.
1573
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1574
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1575
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1576
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1577
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1580
To retrieve the branch as of a particular revision, supply the --revision
1581
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1582
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1586
_see_also = ['checkouts', 'branch']
1587
takes_args = ['branch_location?', 'to_location?']
1588
takes_options = ['revision',
1589
Option('lightweight',
1590
help="Perform a lightweight checkout. Lightweight "
1591
"checkouts depend on access to the branch for "
1592
"every operation. Normal checkouts can perform "
1593
"common operations like diff and status without "
1594
"such access, and also support local commits."
1596
Option('files-from', type=str,
1597
help="Get file contents from this tree."),
1599
help='Hard-link working tree files where possible.'
1604
def run(self, branch_location=None, to_location=None, revision=None,
1605
lightweight=False, files_from=None, hardlink=False):
1606
if branch_location is None:
1607
branch_location = osutils.getcwd()
1608
to_location = branch_location
1609
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1611
if not (hardlink or files_from):
1612
# accelerator_tree is usually slower because you have to read N
1613
# files (no readahead, lots of seeks, etc), but allow the user to
1614
# explicitly request it
1615
accelerator_tree = None
1616
revision = _get_one_revision('checkout', revision)
1617
if files_from is not None and files_from != branch_location:
1618
accelerator_tree = WorkingTree.open(files_from)
1619
if revision is not None:
1620
revision_id = revision.as_revision_id(source)
1623
if to_location is None:
1624
to_location = urlutils.derive_to_location(branch_location)
1625
# if the source and to_location are the same,
1626
# and there is no working tree,
1627
# then reconstitute a branch
1628
if (osutils.abspath(to_location) ==
1629
osutils.abspath(branch_location)):
1631
source.bzrdir.open_workingtree()
1632
except errors.NoWorkingTree:
1633
source.bzrdir.create_workingtree(revision_id)
1635
source.create_checkout(to_location, revision_id, lightweight,
1636
accelerator_tree, hardlink)
1639
class cmd_renames(Command):
1640
__doc__ = """Show list of renamed files.
1642
# TODO: Option to show renames between two historical versions.
1644
# TODO: Only show renames under dir, rather than in the whole branch.
1645
_see_also = ['status']
1646
takes_args = ['dir?']
1649
def run(self, dir=u'.'):
1650
tree = WorkingTree.open_containing(dir)[0]
1651
self.add_cleanup(tree.lock_read().unlock)
1652
new_inv = tree.inventory
1653
old_tree = tree.basis_tree()
1654
self.add_cleanup(old_tree.lock_read().unlock)
1655
old_inv = old_tree.inventory
1657
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1658
for f, paths, c, v, p, n, k, e in iterator:
1659
if paths[0] == paths[1]:
1663
renames.append(paths)
1665
for old_name, new_name in renames:
1666
self.outf.write("%s => %s\n" % (old_name, new_name))
1669
class cmd_update(Command):
1670
__doc__ = """Update a working tree to a new revision.
1672
This will perform a merge of the destination revision (the tip of the
1673
branch, or the specified revision) into the working tree, and then make
1674
that revision the basis revision for the working tree.
1676
You can use this to visit an older revision, or to update a working tree
1677
that is out of date from its branch.
1679
If there are any uncommitted changes in the tree, they will be carried
1680
across and remain as uncommitted changes after the update. To discard
1681
these changes, use 'bzr revert'. The uncommitted changes may conflict
1682
with the changes brought in by the change in basis revision.
1684
If the tree's branch is bound to a master branch, bzr will also update
1685
the branch from the master.
1687
You cannot update just a single file or directory, because each Bazaar
1688
working tree has just a single basis revision. If you want to restore a
1689
file that has been removed locally, use 'bzr revert' instead of 'bzr
1690
update'. If you want to restore a file to its state in a previous
1691
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1692
out the old content of that file to a new location.
1694
The 'dir' argument, if given, must be the location of the root of a
1695
working tree to update. By default, the working tree that contains the
1696
current working directory is used.
1699
_see_also = ['pull', 'working-trees', 'status-flags']
1700
takes_args = ['dir?']
1701
takes_options = ['revision',
1703
help="Show base revision text in conflicts."),
1707
def run(self, dir=None, revision=None, show_base=None):
1708
if revision is not None and len(revision) != 1:
1709
raise errors.BzrCommandError(gettext(
1710
"bzr update --revision takes exactly one revision"))
1712
tree = WorkingTree.open_containing('.')[0]
1714
tree, relpath = WorkingTree.open_containing(dir)
1717
raise errors.BzrCommandError(gettext(
1718
"bzr update can only update a whole tree, "
1719
"not a file or subdirectory"))
1720
branch = tree.branch
1721
possible_transports = []
1722
master = branch.get_master_branch(
1723
possible_transports=possible_transports)
1724
if master is not None:
1725
branch_location = master.base
1728
branch_location = tree.branch.base
1729
tree.lock_tree_write()
1730
self.add_cleanup(tree.unlock)
1731
# get rid of the final '/' and be ready for display
1732
branch_location = urlutils.unescape_for_display(
1733
branch_location.rstrip('/'),
1735
existing_pending_merges = tree.get_parent_ids()[1:]
1739
# may need to fetch data into a heavyweight checkout
1740
# XXX: this may take some time, maybe we should display a
1742
old_tip = branch.update(possible_transports)
1743
if revision is not None:
1744
revision_id = revision[0].as_revision_id(branch)
1746
revision_id = branch.last_revision()
1747
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1748
revno = branch.revision_id_to_dotted_revno(revision_id)
1749
note(gettext("Tree is up to date at revision {0} of branch {1}"
1750
).format('.'.join(map(str, revno)), branch_location))
1752
view_info = _get_view_info_for_change_reporter(tree)
1753
change_reporter = delta._ChangeReporter(
1754
unversioned_filter=tree.is_ignored,
1755
view_info=view_info)
1757
conflicts = tree.update(
1759
possible_transports=possible_transports,
1760
revision=revision_id,
1762
show_base=show_base)
1763
except errors.NoSuchRevision, e:
1764
raise errors.BzrCommandError(gettext(
1765
"branch has no revision %s\n"
1766
"bzr update --revision only works"
1767
" for a revision in the branch history")
1769
revno = tree.branch.revision_id_to_dotted_revno(
1770
_mod_revision.ensure_null(tree.last_revision()))
1771
note(gettext('Updated to revision {0} of branch {1}').format(
1772
'.'.join(map(str, revno)), branch_location))
1773
parent_ids = tree.get_parent_ids()
1774
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1775
note(gettext('Your local commits will now show as pending merges with '
1776
"'bzr status', and can be committed with 'bzr commit'."))
1783
class cmd_info(Command):
1784
__doc__ = """Show information about a working tree, branch or repository.
1786
This command will show all known locations and formats associated to the
1787
tree, branch or repository.
1789
In verbose mode, statistical information is included with each report.
1790
To see extended statistic information, use a verbosity level of 2 or
1791
higher by specifying the verbose option multiple times, e.g. -vv.
1793
Branches and working trees will also report any missing revisions.
1797
Display information on the format and related locations:
1801
Display the above together with extended format information and
1802
basic statistics (like the number of files in the working tree and
1803
number of revisions in the branch and repository):
1807
Display the above together with number of committers to the branch:
1811
_see_also = ['revno', 'working-trees', 'repositories']
1812
takes_args = ['location?']
1813
takes_options = ['verbose']
1814
encoding_type = 'replace'
1817
def run(self, location=None, verbose=False):
1819
noise_level = get_verbosity_level()
1822
from bzrlib.info import show_bzrdir_info
1823
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1824
verbose=noise_level, outfile=self.outf)
1827
class cmd_remove(Command):
1828
__doc__ = """Remove files or directories.
1830
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1831
delete them if they can easily be recovered using revert otherwise they
1832
will be backed up (adding an extention of the form .~#~). If no options or
1833
parameters are given Bazaar will scan for files that are being tracked by
1834
Bazaar but missing in your tree and stop tracking them for you.
1836
takes_args = ['file*']
1837
takes_options = ['verbose',
1838
Option('new', help='Only remove files that have never been committed.'),
1839
RegistryOption.from_kwargs('file-deletion-strategy',
1840
'The file deletion mode to be used.',
1841
title='Deletion Strategy', value_switches=True, enum_switch=False,
1842
safe='Backup changed files (default).',
1843
keep='Delete from bzr but leave the working copy.',
1844
no_backup='Don\'t backup changed files.',
1845
force='Delete all the specified files, even if they can not be '
1846
'recovered and even if they are non-empty directories. '
1847
'(deprecated, use no-backup)')]
1848
aliases = ['rm', 'del']
1849
encoding_type = 'replace'
1851
def run(self, file_list, verbose=False, new=False,
1852
file_deletion_strategy='safe'):
1853
if file_deletion_strategy == 'force':
1854
note(gettext("(The --force option is deprecated, rather use --no-backup "
1856
file_deletion_strategy = 'no-backup'
1858
tree, file_list = WorkingTree.open_containing_paths(file_list)
1860
if file_list is not None:
1861
file_list = [f for f in file_list]
1863
self.add_cleanup(tree.lock_write().unlock)
1864
# Heuristics should probably all move into tree.remove_smart or
1867
added = tree.changes_from(tree.basis_tree(),
1868
specific_files=file_list).added
1869
file_list = sorted([f[0] for f in added], reverse=True)
1870
if len(file_list) == 0:
1871
raise errors.BzrCommandError(gettext('No matching files.'))
1872
elif file_list is None:
1873
# missing files show up in iter_changes(basis) as
1874
# versioned-with-no-kind.
1876
for change in tree.iter_changes(tree.basis_tree()):
1877
# Find paths in the working tree that have no kind:
1878
if change[1][1] is not None and change[6][1] is None:
1879
missing.append(change[1][1])
1880
file_list = sorted(missing, reverse=True)
1881
file_deletion_strategy = 'keep'
1882
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1883
keep_files=file_deletion_strategy=='keep',
1884
force=(file_deletion_strategy=='no-backup'))
1887
class cmd_file_id(Command):
1888
__doc__ = """Print file_id of a particular file or directory.
1890
The file_id is assigned when the file is first added and remains the
1891
same through all revisions where the file exists, even when it is
1896
_see_also = ['inventory', 'ls']
1897
takes_args = ['filename']
1900
def run(self, filename):
1901
tree, relpath = WorkingTree.open_containing(filename)
1902
i = tree.path2id(relpath)
1904
raise errors.NotVersionedError(filename)
1906
self.outf.write(i + '\n')
1909
class cmd_file_path(Command):
1910
__doc__ = """Print path of file_ids to a file or directory.
1912
This prints one line for each directory down to the target,
1913
starting at the branch root.
1917
takes_args = ['filename']
1920
def run(self, filename):
1921
tree, relpath = WorkingTree.open_containing(filename)
1922
fid = tree.path2id(relpath)
1924
raise errors.NotVersionedError(filename)
1925
segments = osutils.splitpath(relpath)
1926
for pos in range(1, len(segments) + 1):
1927
path = osutils.joinpath(segments[:pos])
1928
self.outf.write("%s\n" % tree.path2id(path))
1931
class cmd_reconcile(Command):
1932
__doc__ = """Reconcile bzr metadata in a branch.
1934
This can correct data mismatches that may have been caused by
1935
previous ghost operations or bzr upgrades. You should only
1936
need to run this command if 'bzr check' or a bzr developer
1937
advises you to run it.
1939
If a second branch is provided, cross-branch reconciliation is
1940
also attempted, which will check that data like the tree root
1941
id which was not present in very early bzr versions is represented
1942
correctly in both branches.
1944
At the same time it is run it may recompress data resulting in
1945
a potential saving in disk space or performance gain.
1947
The branch *MUST* be on a listable system such as local disk or sftp.
1950
_see_also = ['check']
1951
takes_args = ['branch?']
1953
Option('canonicalize-chks',
1954
help='Make sure CHKs are in canonical form (repairs '
1959
def run(self, branch=".", canonicalize_chks=False):
1960
from bzrlib.reconcile import reconcile
1961
dir = controldir.ControlDir.open(branch)
1962
reconcile(dir, canonicalize_chks=canonicalize_chks)
1965
class cmd_revision_history(Command):
1966
__doc__ = """Display the list of revision ids on a branch."""
1969
takes_args = ['location?']
1974
def run(self, location="."):
1975
branch = Branch.open_containing(location)[0]
1976
self.add_cleanup(branch.lock_read().unlock)
1977
graph = branch.repository.get_graph()
1978
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1979
[_mod_revision.NULL_REVISION]))
1980
for revid in reversed(history):
1981
self.outf.write(revid)
1982
self.outf.write('\n')
1985
class cmd_ancestry(Command):
1986
__doc__ = """List all revisions merged into this branch."""
1988
_see_also = ['log', 'revision-history']
1989
takes_args = ['location?']
1994
def run(self, location="."):
1996
wt = WorkingTree.open_containing(location)[0]
1997
except errors.NoWorkingTree:
1998
b = Branch.open(location)
1999
last_revision = b.last_revision()
2002
last_revision = wt.last_revision()
2004
self.add_cleanup(b.repository.lock_read().unlock)
2005
graph = b.repository.get_graph()
2006
revisions = [revid for revid, parents in
2007
graph.iter_ancestry([last_revision])]
2008
for revision_id in reversed(revisions):
2009
if _mod_revision.is_null(revision_id):
2011
self.outf.write(revision_id + '\n')
2014
class cmd_init(Command):
2015
__doc__ = """Make a directory into a versioned branch.
2017
Use this to create an empty branch, or before importing an
2020
If there is a repository in a parent directory of the location, then
2021
the history of the branch will be stored in the repository. Otherwise
2022
init creates a standalone branch which carries its own history
2023
in the .bzr directory.
2025
If there is already a branch at the location but it has no working tree,
2026
the tree can be populated with 'bzr checkout'.
2028
Recipe for importing a tree of files::
2034
bzr commit -m "imported project"
2037
_see_also = ['init-repository', 'branch', 'checkout']
2038
takes_args = ['location?']
2040
Option('create-prefix',
2041
help='Create the path leading up to the branch '
2042
'if it does not already exist.'),
2043
RegistryOption('format',
2044
help='Specify a format for this branch. '
2045
'See "help formats".',
2046
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2047
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2048
value_switches=True,
2049
title="Branch format",
2051
Option('append-revisions-only',
2052
help='Never change revnos or the existing log.'
2053
' Append revisions to it only.'),
2055
'Create a branch without a working tree.')
2057
def run(self, location=None, format=None, append_revisions_only=False,
2058
create_prefix=False, no_tree=False):
2060
format = controldir.format_registry.make_bzrdir('default')
2061
if location is None:
2064
to_transport = transport.get_transport(location)
2066
# The path has to exist to initialize a
2067
# branch inside of it.
2068
# Just using os.mkdir, since I don't
2069
# believe that we want to create a bunch of
2070
# locations if the user supplies an extended path
2072
to_transport.ensure_base()
2073
except errors.NoSuchFile:
2074
if not create_prefix:
2075
raise errors.BzrCommandError(gettext("Parent directory of %s"
2077
"\nYou may supply --create-prefix to create all"
2078
" leading parent directories.")
2080
to_transport.create_prefix()
2083
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
2084
except errors.NotBranchError:
2085
# really a NotBzrDir error...
2086
create_branch = controldir.ControlDir.create_branch_convenience
2088
force_new_tree = False
2090
force_new_tree = None
2091
branch = create_branch(to_transport.base, format=format,
2092
possible_transports=[to_transport],
2093
force_new_tree=force_new_tree)
2094
a_bzrdir = branch.bzrdir
2096
from bzrlib.transport.local import LocalTransport
2097
if a_bzrdir.has_branch():
2098
if (isinstance(to_transport, LocalTransport)
2099
and not a_bzrdir.has_workingtree()):
2100
raise errors.BranchExistsWithoutWorkingTree(location)
2101
raise errors.AlreadyBranchError(location)
2102
branch = a_bzrdir.create_branch()
2103
if not no_tree and not a_bzrdir.has_workingtree():
2104
a_bzrdir.create_workingtree()
2105
if append_revisions_only:
2107
branch.set_append_revisions_only(True)
2108
except errors.UpgradeRequired:
2109
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2110
' to append-revisions-only. Try --default.'))
2112
from bzrlib.info import describe_layout, describe_format
2114
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2115
except (errors.NoWorkingTree, errors.NotLocalUrl):
2117
repository = branch.repository
2118
layout = describe_layout(repository, branch, tree).lower()
2119
format = describe_format(a_bzrdir, repository, branch, tree)
2120
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2122
if repository.is_shared():
2123
#XXX: maybe this can be refactored into transport.path_or_url()
2124
url = repository.bzrdir.root_transport.external_url()
2126
url = urlutils.local_path_from_url(url)
2127
except errors.InvalidURL:
2129
self.outf.write(gettext("Using shared repository: %s\n") % url)
2132
class cmd_init_repository(Command):
2133
__doc__ = """Create a shared repository for branches to share storage space.
2135
New branches created under the repository directory will store their
2136
revisions in the repository, not in the branch directory. For branches
2137
with shared history, this reduces the amount of storage needed and
2138
speeds up the creation of new branches.
2140
If the --no-trees option is given then the branches in the repository
2141
will not have working trees by default. They will still exist as
2142
directories on disk, but they will not have separate copies of the
2143
files at a certain revision. This can be useful for repositories that
2144
store branches which are interacted with through checkouts or remote
2145
branches, such as on a server.
2148
Create a shared repository holding just branches::
2150
bzr init-repo --no-trees repo
2153
Make a lightweight checkout elsewhere::
2155
bzr checkout --lightweight repo/trunk trunk-checkout
2160
_see_also = ['init', 'branch', 'checkout', 'repositories']
2161
takes_args = ["location"]
2162
takes_options = [RegistryOption('format',
2163
help='Specify a format for this repository. See'
2164
' "bzr help formats" for details.',
2165
lazy_registry=('bzrlib.controldir', 'format_registry'),
2166
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2167
value_switches=True, title='Repository format'),
2169
help='Branches in the repository will default to'
2170
' not having a working tree.'),
2172
aliases = ["init-repo"]
2174
def run(self, location, format=None, no_trees=False):
2176
format = controldir.format_registry.make_bzrdir('default')
2178
if location is None:
2181
to_transport = transport.get_transport(location)
2183
(repo, newdir, require_stacking, repository_policy) = (
2184
format.initialize_on_transport_ex(to_transport,
2185
create_prefix=True, make_working_trees=not no_trees,
2186
shared_repo=True, force_new_repo=True,
2187
use_existing_dir=True,
2188
repo_format_name=format.repository_format.get_format_string()))
2190
from bzrlib.info import show_bzrdir_info
2191
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2194
class cmd_diff(Command):
2195
__doc__ = """Show differences in the working tree, between revisions or branches.
2197
If no arguments are given, all changes for the current tree are listed.
2198
If files are given, only the changes in those files are listed.
2199
Remote and multiple branches can be compared by using the --old and
2200
--new options. If not provided, the default for both is derived from
2201
the first argument, if any, or the current tree if no arguments are
2204
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2205
produces patches suitable for "patch -p1".
2207
Note that when using the -r argument with a range of revisions, the
2208
differences are computed between the two specified revisions. That
2209
is, the command does not show the changes introduced by the first
2210
revision in the range. This differs from the interpretation of
2211
revision ranges used by "bzr log" which includes the first revision
2216
2 - unrepresentable changes
2221
Shows the difference in the working tree versus the last commit::
2225
Difference between the working tree and revision 1::
2229
Difference between revision 3 and revision 1::
2233
Difference between revision 3 and revision 1 for branch xxx::
2237
The changes introduced by revision 2 (equivalent to -r1..2)::
2241
To see the changes introduced by revision X::
2245
Note that in the case of a merge, the -c option shows the changes
2246
compared to the left hand parent. To see the changes against
2247
another parent, use::
2249
bzr diff -r<chosen_parent>..X
2251
The changes between the current revision and the previous revision
2252
(equivalent to -c-1 and -r-2..-1)
2256
Show just the differences for file NEWS::
2260
Show the differences in working tree xxx for file NEWS::
2264
Show the differences from branch xxx to this working tree:
2268
Show the differences between two branches for file NEWS::
2270
bzr diff --old xxx --new yyy NEWS
2272
Same as 'bzr diff' but prefix paths with old/ and new/::
2274
bzr diff --prefix old/:new/
2276
Show the differences using a custom diff program with options::
2278
bzr diff --using /usr/bin/diff --diff-options -wu
2280
_see_also = ['status']
2281
takes_args = ['file*']
2283
Option('diff-options', type=str,
2284
help='Pass these options to the external diff program.'),
2285
Option('prefix', type=str,
2287
help='Set prefixes added to old and new filenames, as '
2288
'two values separated by a colon. (eg "old/:new/").'),
2290
help='Branch/tree to compare from.',
2294
help='Branch/tree to compare to.',
2300
help='Use this command to compare files.',
2303
RegistryOption('format',
2305
help='Diff format to use.',
2306
lazy_registry=('bzrlib.diff', 'format_registry'),
2307
title='Diff format'),
2309
aliases = ['di', 'dif']
2310
encoding_type = 'exact'
2313
def run(self, revision=None, file_list=None, diff_options=None,
2314
prefix=None, old=None, new=None, using=None, format=None):
2315
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2318
if (prefix is None) or (prefix == '0'):
2326
old_label, new_label = prefix.split(":")
2328
raise errors.BzrCommandError(gettext(
2329
'--prefix expects two values separated by a colon'
2330
' (eg "old/:new/")'))
2332
if revision and len(revision) > 2:
2333
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2334
' one or two revision specifiers'))
2336
if using is not None and format is not None:
2337
raise errors.BzrCommandError(gettext(
2338
'{0} and {1} are mutually exclusive').format(
2339
'--using', '--format'))
2341
(old_tree, new_tree,
2342
old_branch, new_branch,
2343
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2344
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2345
# GNU diff on Windows uses ANSI encoding for filenames
2346
path_encoding = osutils.get_diff_header_encoding()
2347
return show_diff_trees(old_tree, new_tree, sys.stdout,
2348
specific_files=specific_files,
2349
external_diff_options=diff_options,
2350
old_label=old_label, new_label=new_label,
2351
extra_trees=extra_trees,
2352
path_encoding=path_encoding,
2357
class cmd_deleted(Command):
2358
__doc__ = """List files deleted in the working tree.
2360
# TODO: Show files deleted since a previous revision, or
2361
# between two revisions.
2362
# TODO: Much more efficient way to do this: read in new
2363
# directories with readdir, rather than stating each one. Same
2364
# level of effort but possibly much less IO. (Or possibly not,
2365
# if the directories are very large...)
2366
_see_also = ['status', 'ls']
2367
takes_options = ['directory', 'show-ids']
2370
def run(self, show_ids=False, directory=u'.'):
2371
tree = WorkingTree.open_containing(directory)[0]
2372
self.add_cleanup(tree.lock_read().unlock)
2373
old = tree.basis_tree()
2374
self.add_cleanup(old.lock_read().unlock)
2375
for path, ie in old.inventory.iter_entries():
2376
if not tree.has_id(ie.file_id):
2377
self.outf.write(path)
2379
self.outf.write(' ')
2380
self.outf.write(ie.file_id)
2381
self.outf.write('\n')
2384
class cmd_modified(Command):
2385
__doc__ = """List files modified in working tree.
2389
_see_also = ['status', 'ls']
2390
takes_options = ['directory', 'null']
2393
def run(self, null=False, directory=u'.'):
2394
tree = WorkingTree.open_containing(directory)[0]
2395
self.add_cleanup(tree.lock_read().unlock)
2396
td = tree.changes_from(tree.basis_tree())
2398
for path, id, kind, text_modified, meta_modified in td.modified:
2400
self.outf.write(path + '\0')
2402
self.outf.write(osutils.quotefn(path) + '\n')
2405
class cmd_added(Command):
2406
__doc__ = """List files added in working tree.
2410
_see_also = ['status', 'ls']
2411
takes_options = ['directory', 'null']
2414
def run(self, null=False, directory=u'.'):
2415
wt = WorkingTree.open_containing(directory)[0]
2416
self.add_cleanup(wt.lock_read().unlock)
2417
basis = wt.basis_tree()
2418
self.add_cleanup(basis.lock_read().unlock)
2419
basis_inv = basis.inventory
2422
if basis_inv.has_id(file_id):
2424
if inv.is_root(file_id) and len(basis_inv) == 0:
2426
path = inv.id2path(file_id)
2427
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2430
self.outf.write(path + '\0')
2432
self.outf.write(osutils.quotefn(path) + '\n')
2435
class cmd_root(Command):
2436
__doc__ = """Show the tree root directory.
2438
The root is the nearest enclosing directory with a .bzr control
2441
takes_args = ['filename?']
2443
def run(self, filename=None):
2444
"""Print the branch root."""
2445
tree = WorkingTree.open_containing(filename)[0]
2446
self.outf.write(tree.basedir + '\n')
2449
def _parse_limit(limitstring):
2451
return int(limitstring)
2453
msg = gettext("The limit argument must be an integer.")
2454
raise errors.BzrCommandError(msg)
2457
def _parse_levels(s):
2461
msg = gettext("The levels argument must be an integer.")
2462
raise errors.BzrCommandError(msg)
2465
class cmd_log(Command):
2466
__doc__ = """Show historical log for a branch or subset of a branch.
2468
log is bzr's default tool for exploring the history of a branch.
2469
The branch to use is taken from the first parameter. If no parameters
2470
are given, the branch containing the working directory is logged.
2471
Here are some simple examples::
2473
bzr log log the current branch
2474
bzr log foo.py log a file in its branch
2475
bzr log http://server/branch log a branch on a server
2477
The filtering, ordering and information shown for each revision can
2478
be controlled as explained below. By default, all revisions are
2479
shown sorted (topologically) so that newer revisions appear before
2480
older ones and descendants always appear before ancestors. If displayed,
2481
merged revisions are shown indented under the revision in which they
2486
The log format controls how information about each revision is
2487
displayed. The standard log formats are called ``long``, ``short``
2488
and ``line``. The default is long. See ``bzr help log-formats``
2489
for more details on log formats.
2491
The following options can be used to control what information is
2494
-l N display a maximum of N revisions
2495
-n N display N levels of revisions (0 for all, 1 for collapsed)
2496
-v display a status summary (delta) for each revision
2497
-p display a diff (patch) for each revision
2498
--show-ids display revision-ids (and file-ids), not just revnos
2500
Note that the default number of levels to display is a function of the
2501
log format. If the -n option is not used, the standard log formats show
2502
just the top level (mainline).
2504
Status summaries are shown using status flags like A, M, etc. To see
2505
the changes explained using words like ``added`` and ``modified``
2506
instead, use the -vv option.
2510
To display revisions from oldest to newest, use the --forward option.
2511
In most cases, using this option will have little impact on the total
2512
time taken to produce a log, though --forward does not incrementally
2513
display revisions like --reverse does when it can.
2515
:Revision filtering:
2517
The -r option can be used to specify what revision or range of revisions
2518
to filter against. The various forms are shown below::
2520
-rX display revision X
2521
-rX.. display revision X and later
2522
-r..Y display up to and including revision Y
2523
-rX..Y display from X to Y inclusive
2525
See ``bzr help revisionspec`` for details on how to specify X and Y.
2526
Some common examples are given below::
2528
-r-1 show just the tip
2529
-r-10.. show the last 10 mainline revisions
2530
-rsubmit:.. show what's new on this branch
2531
-rancestor:path.. show changes since the common ancestor of this
2532
branch and the one at location path
2533
-rdate:yesterday.. show changes since yesterday
2535
When logging a range of revisions using -rX..Y, log starts at
2536
revision Y and searches back in history through the primary
2537
("left-hand") parents until it finds X. When logging just the
2538
top level (using -n1), an error is reported if X is not found
2539
along the way. If multi-level logging is used (-n0), X may be
2540
a nested merge revision and the log will be truncated accordingly.
2544
If parameters are given and the first one is not a branch, the log
2545
will be filtered to show only those revisions that changed the
2546
nominated files or directories.
2548
Filenames are interpreted within their historical context. To log a
2549
deleted file, specify a revision range so that the file existed at
2550
the end or start of the range.
2552
Historical context is also important when interpreting pathnames of
2553
renamed files/directories. Consider the following example:
2555
* revision 1: add tutorial.txt
2556
* revision 2: modify tutorial.txt
2557
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2561
* ``bzr log guide.txt`` will log the file added in revision 1
2563
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2565
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2566
the original file in revision 2.
2568
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2569
was no file called guide.txt in revision 2.
2571
Renames are always followed by log. By design, there is no need to
2572
explicitly ask for this (and no way to stop logging a file back
2573
until it was last renamed).
2577
The --match option can be used for finding revisions that match a
2578
regular expression in a commit message, committer, author or bug.
2579
Specifying the option several times will match any of the supplied
2580
expressions. --match-author, --match-bugs, --match-committer and
2581
--match-message can be used to only match a specific field.
2585
GUI tools and IDEs are often better at exploring history than command
2586
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2587
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2588
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2589
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2591
You may find it useful to add the aliases below to ``bazaar.conf``::
2595
top = log -l10 --line
2598
``bzr tip`` will then show the latest revision while ``bzr top``
2599
will show the last 10 mainline revisions. To see the details of a
2600
particular revision X, ``bzr show -rX``.
2602
If you are interested in looking deeper into a particular merge X,
2603
use ``bzr log -n0 -rX``.
2605
``bzr log -v`` on a branch with lots of history is currently
2606
very slow. A fix for this issue is currently under development.
2607
With or without that fix, it is recommended that a revision range
2608
be given when using the -v option.
2610
bzr has a generic full-text matching plugin, bzr-search, that can be
2611
used to find revisions matching user names, commit messages, etc.
2612
Among other features, this plugin can find all revisions containing
2613
a list of words but not others.
2615
When exploring non-mainline history on large projects with deep
2616
history, the performance of log can be greatly improved by installing
2617
the historycache plugin. This plugin buffers historical information
2618
trading disk space for faster speed.
2620
takes_args = ['file*']
2621
_see_also = ['log-formats', 'revisionspec']
2624
help='Show from oldest to newest.'),
2626
custom_help('verbose',
2627
help='Show files changed in each revision.'),
2631
type=bzrlib.option._parse_revision_str,
2633
help='Show just the specified revision.'
2634
' See also "help revisionspec".'),
2636
RegistryOption('authors',
2637
'What names to list as authors - first, all or committer.',
2639
lazy_registry=('bzrlib.log', 'author_list_registry'),
2643
help='Number of levels to display - 0 for all, 1 for flat.',
2645
type=_parse_levels),
2647
help='Show revisions whose message matches this '
2648
'regular expression.',
2653
help='Limit the output to the first N revisions.',
2658
help='Show changes made in each revision as a patch.'),
2659
Option('include-merged',
2660
help='Show merged revisions like --levels 0 does.'),
2661
Option('include-merges', hidden=True,
2662
help='Historical alias for --include-merged.'),
2663
Option('omit-merges',
2664
help='Do not report commits with more than one parent.'),
2665
Option('exclude-common-ancestry',
2666
help='Display only the revisions that are not part'
2667
' of both ancestries (require -rX..Y).'
2669
Option('signatures',
2670
help='Show digital signature validity.'),
2673
help='Show revisions whose properties match this '
2676
ListOption('match-message',
2677
help='Show revisions whose message matches this '
2680
ListOption('match-committer',
2681
help='Show revisions whose committer matches this '
2684
ListOption('match-author',
2685
help='Show revisions whose authors match this '
2688
ListOption('match-bugs',
2689
help='Show revisions whose bugs match this '
2693
encoding_type = 'replace'
2696
def run(self, file_list=None, timezone='original',
2707
include_merged=None,
2709
exclude_common_ancestry=False,
2713
match_committer=None,
2717
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2719
from bzrlib.log import (
2721
make_log_request_dict,
2722
_get_info_for_log_files,
2724
direction = (forward and 'forward') or 'reverse'
2725
if symbol_versioning.deprecated_passed(include_merges):
2726
ui.ui_factory.show_user_warning(
2727
'deprecated_command_option',
2728
deprecated_name='--include-merges',
2729
recommended_name='--include-merged',
2730
deprecated_in_version='2.5',
2731
command=self.invoked_as)
2732
if include_merged is None:
2733
include_merged = include_merges
2735
raise errors.BzrCommandError(gettext(
2736
'{0} and {1} are mutually exclusive').format(
2737
'--include-merges', '--include-merged'))
2738
if include_merged is None:
2739
include_merged = False
2740
if (exclude_common_ancestry
2741
and (revision is None or len(revision) != 2)):
2742
raise errors.BzrCommandError(gettext(
2743
'--exclude-common-ancestry requires -r with two revisions'))
2748
raise errors.BzrCommandError(gettext(
2749
'{0} and {1} are mutually exclusive').format(
2750
'--levels', '--include-merged'))
2752
if change is not None:
2754
raise errors.RangeInChangeOption()
2755
if revision is not None:
2756
raise errors.BzrCommandError(gettext(
2757
'{0} and {1} are mutually exclusive').format(
2758
'--revision', '--change'))
2763
filter_by_dir = False
2765
# find the file ids to log and check for directory filtering
2766
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2767
revision, file_list, self.add_cleanup)
2768
for relpath, file_id, kind in file_info_list:
2770
raise errors.BzrCommandError(gettext(
2771
"Path unknown at end or start of revision range: %s") %
2773
# If the relpath is the top of the tree, we log everything
2778
file_ids.append(file_id)
2779
filter_by_dir = filter_by_dir or (
2780
kind in ['directory', 'tree-reference'])
2783
# FIXME ? log the current subdir only RBC 20060203
2784
if revision is not None \
2785
and len(revision) > 0 and revision[0].get_branch():
2786
location = revision[0].get_branch()
2789
dir, relpath = controldir.ControlDir.open_containing(location)
2790
b = dir.open_branch()
2791
self.add_cleanup(b.lock_read().unlock)
2792
rev1, rev2 = _get_revision_range(revision, b, self.name())
2794
if b.get_config().validate_signatures_in_log():
2798
if not gpg.GPGStrategy.verify_signatures_available():
2799
raise errors.GpgmeNotInstalled(None)
2801
# Decide on the type of delta & diff filtering to use
2802
# TODO: add an --all-files option to make this configurable & consistent
2810
diff_type = 'partial'
2814
# Build the log formatter
2815
if log_format is None:
2816
log_format = log.log_formatter_registry.get_default(b)
2817
# Make a non-encoding output to include the diffs - bug 328007
2818
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2819
lf = log_format(show_ids=show_ids, to_file=self.outf,
2820
to_exact_file=unencoded_output,
2821
show_timezone=timezone,
2822
delta_format=get_verbosity_level(),
2824
show_advice=levels is None,
2825
author_list_handler=authors)
2827
# Choose the algorithm for doing the logging. It's annoying
2828
# having multiple code paths like this but necessary until
2829
# the underlying repository format is faster at generating
2830
# deltas or can provide everything we need from the indices.
2831
# The default algorithm - match-using-deltas - works for
2832
# multiple files and directories and is faster for small
2833
# amounts of history (200 revisions say). However, it's too
2834
# slow for logging a single file in a repository with deep
2835
# history, i.e. > 10K revisions. In the spirit of "do no
2836
# evil when adding features", we continue to use the
2837
# original algorithm - per-file-graph - for the "single
2838
# file that isn't a directory without showing a delta" case.
2839
partial_history = revision and b.repository._format.supports_chks
2840
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2841
or delta_type or partial_history)
2845
match_dict[''] = match
2847
match_dict['message'] = match_message
2849
match_dict['committer'] = match_committer
2851
match_dict['author'] = match_author
2853
match_dict['bugs'] = match_bugs
2855
# Build the LogRequest and execute it
2856
if len(file_ids) == 0:
2858
rqst = make_log_request_dict(
2859
direction=direction, specific_fileids=file_ids,
2860
start_revision=rev1, end_revision=rev2, limit=limit,
2861
message_search=message, delta_type=delta_type,
2862
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2863
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2864
signature=signatures, omit_merges=omit_merges,
2866
Logger(b, rqst).show(lf)
2869
def _get_revision_range(revisionspec_list, branch, command_name):
2870
"""Take the input of a revision option and turn it into a revision range.
2872
It returns RevisionInfo objects which can be used to obtain the rev_id's
2873
of the desired revisions. It does some user input validations.
2875
if revisionspec_list is None:
2878
elif len(revisionspec_list) == 1:
2879
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2880
elif len(revisionspec_list) == 2:
2881
start_spec = revisionspec_list[0]
2882
end_spec = revisionspec_list[1]
2883
if end_spec.get_branch() != start_spec.get_branch():
2884
# b is taken from revision[0].get_branch(), and
2885
# show_log will use its revision_history. Having
2886
# different branches will lead to weird behaviors.
2887
raise errors.BzrCommandError(gettext(
2888
"bzr %s doesn't accept two revisions in different"
2889
" branches.") % command_name)
2890
if start_spec.spec is None:
2891
# Avoid loading all the history.
2892
rev1 = RevisionInfo(branch, None, None)
2894
rev1 = start_spec.in_history(branch)
2895
# Avoid loading all of history when we know a missing
2896
# end of range means the last revision ...
2897
if end_spec.spec is None:
2898
last_revno, last_revision_id = branch.last_revision_info()
2899
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2901
rev2 = end_spec.in_history(branch)
2903
raise errors.BzrCommandError(gettext(
2904
'bzr %s --revision takes one or two values.') % command_name)
2908
def _revision_range_to_revid_range(revision_range):
2911
if revision_range[0] is not None:
2912
rev_id1 = revision_range[0].rev_id
2913
if revision_range[1] is not None:
2914
rev_id2 = revision_range[1].rev_id
2915
return rev_id1, rev_id2
2917
def get_log_format(long=False, short=False, line=False, default='long'):
2918
log_format = default
2922
log_format = 'short'
2928
class cmd_touching_revisions(Command):
2929
__doc__ = """Return revision-ids which affected a particular file.
2931
A more user-friendly interface is "bzr log FILE".
2935
takes_args = ["filename"]
2938
def run(self, filename):
2939
tree, relpath = WorkingTree.open_containing(filename)
2940
file_id = tree.path2id(relpath)
2942
self.add_cleanup(b.lock_read().unlock)
2943
touching_revs = log.find_touching_revisions(b, file_id)
2944
for revno, revision_id, what in touching_revs:
2945
self.outf.write("%6d %s\n" % (revno, what))
2948
class cmd_ls(Command):
2949
__doc__ = """List files in a tree.
2952
_see_also = ['status', 'cat']
2953
takes_args = ['path?']
2957
Option('recursive', short_name='R',
2958
help='Recurse into subdirectories.'),
2960
help='Print paths relative to the root of the branch.'),
2961
Option('unknown', short_name='u',
2962
help='Print unknown files.'),
2963
Option('versioned', help='Print versioned files.',
2965
Option('ignored', short_name='i',
2966
help='Print ignored files.'),
2967
Option('kind', short_name='k',
2968
help='List entries of a particular kind: file, directory, symlink.',
2975
def run(self, revision=None, verbose=False,
2976
recursive=False, from_root=False,
2977
unknown=False, versioned=False, ignored=False,
2978
null=False, kind=None, show_ids=False, path=None, directory=None):
2980
if kind and kind not in ('file', 'directory', 'symlink'):
2981
raise errors.BzrCommandError(gettext('invalid kind specified'))
2983
if verbose and null:
2984
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2985
all = not (unknown or versioned or ignored)
2987
selection = {'I':ignored, '?':unknown, 'V':versioned}
2993
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2996
tree, branch, relpath = \
2997
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2999
# Calculate the prefix to use
3003
prefix = relpath + '/'
3004
elif fs_path != '.' and not fs_path.endswith('/'):
3005
prefix = fs_path + '/'
3007
if revision is not None or tree is None:
3008
tree = _get_one_revision_tree('ls', revision, branch=branch)
3011
if isinstance(tree, WorkingTree) and tree.supports_views():
3012
view_files = tree.views.lookup_view()
3015
view_str = views.view_display_str(view_files)
3016
note(gettext("Ignoring files outside view. View is %s") % view_str)
3018
self.add_cleanup(tree.lock_read().unlock)
3019
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3020
from_dir=relpath, recursive=recursive):
3021
# Apply additional masking
3022
if not all and not selection[fc]:
3024
if kind is not None and fkind != kind:
3029
fullpath = osutils.pathjoin(relpath, fp)
3032
views.check_path_in_view(tree, fullpath)
3033
except errors.FileOutsideView:
3038
fp = osutils.pathjoin(prefix, fp)
3039
kindch = entry.kind_character()
3040
outstring = fp + kindch
3041
ui.ui_factory.clear_term()
3043
outstring = '%-8s %s' % (fc, outstring)
3044
if show_ids and fid is not None:
3045
outstring = "%-50s %s" % (outstring, fid)
3046
self.outf.write(outstring + '\n')
3048
self.outf.write(fp + '\0')
3051
self.outf.write(fid)
3052
self.outf.write('\0')
3060
self.outf.write('%-50s %s\n' % (outstring, my_id))
3062
self.outf.write(outstring + '\n')
3065
class cmd_unknowns(Command):
3066
__doc__ = """List unknown files.
3071
takes_options = ['directory']
3074
def run(self, directory=u'.'):
3075
for f in WorkingTree.open_containing(directory)[0].unknowns():
3076
self.outf.write(osutils.quotefn(f) + '\n')
3079
class cmd_ignore(Command):
3080
__doc__ = """Ignore specified files or patterns.
3082
See ``bzr help patterns`` for details on the syntax of patterns.
3084
If a .bzrignore file does not exist, the ignore command
3085
will create one and add the specified files or patterns to the newly
3086
created file. The ignore command will also automatically add the
3087
.bzrignore file to be versioned. Creating a .bzrignore file without
3088
the use of the ignore command will require an explicit add command.
3090
To remove patterns from the ignore list, edit the .bzrignore file.
3091
After adding, editing or deleting that file either indirectly by
3092
using this command or directly by using an editor, be sure to commit
3095
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3096
the global ignore file can be found in the application data directory as
3097
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3098
Global ignores are not touched by this command. The global ignore file
3099
can be edited directly using an editor.
3101
Patterns prefixed with '!' are exceptions to ignore patterns and take
3102
precedence over regular ignores. Such exceptions are used to specify
3103
files that should be versioned which would otherwise be ignored.
3105
Patterns prefixed with '!!' act as regular ignore patterns, but have
3106
precedence over the '!' exception patterns.
3110
* Ignore patterns containing shell wildcards must be quoted from
3113
* Ignore patterns starting with "#" act as comments in the ignore file.
3114
To ignore patterns that begin with that character, use the "RE:" prefix.
3117
Ignore the top level Makefile::
3119
bzr ignore ./Makefile
3121
Ignore .class files in all directories...::
3123
bzr ignore "*.class"
3125
...but do not ignore "special.class"::
3127
bzr ignore "!special.class"
3129
Ignore files whose name begins with the "#" character::
3133
Ignore .o files under the lib directory::
3135
bzr ignore "lib/**/*.o"
3137
Ignore .o files under the lib directory::
3139
bzr ignore "RE:lib/.*\.o"
3141
Ignore everything but the "debian" toplevel directory::
3143
bzr ignore "RE:(?!debian/).*"
3145
Ignore everything except the "local" toplevel directory,
3146
but always ignore autosave files ending in ~, even under local/::
3149
bzr ignore "!./local"
3153
_see_also = ['status', 'ignored', 'patterns']
3154
takes_args = ['name_pattern*']
3155
takes_options = ['directory',
3156
Option('default-rules',
3157
help='Display the default ignore rules that bzr uses.')
3160
def run(self, name_pattern_list=None, default_rules=None,
3162
from bzrlib import ignores
3163
if default_rules is not None:
3164
# dump the default rules and exit
3165
for pattern in ignores.USER_DEFAULTS:
3166
self.outf.write("%s\n" % pattern)
3168
if not name_pattern_list:
3169
raise errors.BzrCommandError(gettext("ignore requires at least one "
3170
"NAME_PATTERN or --default-rules."))
3171
name_pattern_list = [globbing.normalize_pattern(p)
3172
for p in name_pattern_list]
3174
bad_patterns_count = 0
3175
for p in name_pattern_list:
3176
if not globbing.Globster.is_pattern_valid(p):
3177
bad_patterns_count += 1
3178
bad_patterns += ('\n %s' % p)
3180
msg = (ngettext('Invalid ignore pattern found. %s',
3181
'Invalid ignore patterns found. %s',
3182
bad_patterns_count) % bad_patterns)
3183
ui.ui_factory.show_error(msg)
3184
raise errors.InvalidPattern('')
3185
for name_pattern in name_pattern_list:
3186
if (name_pattern[0] == '/' or
3187
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3188
raise errors.BzrCommandError(gettext(
3189
"NAME_PATTERN should not be an absolute path"))
3190
tree, relpath = WorkingTree.open_containing(directory)
3191
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3192
ignored = globbing.Globster(name_pattern_list)
3194
self.add_cleanup(tree.lock_read().unlock)
3195
for entry in tree.list_files():
3199
if ignored.match(filename):
3200
matches.append(filename)
3201
if len(matches) > 0:
3202
self.outf.write(gettext("Warning: the following files are version "
3203
"controlled and match your ignore pattern:\n%s"
3204
"\nThese files will continue to be version controlled"
3205
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3208
class cmd_ignored(Command):
3209
__doc__ = """List ignored files and the patterns that matched them.
3211
List all the ignored files and the ignore pattern that caused the file to
3214
Alternatively, to list just the files::
3219
encoding_type = 'replace'
3220
_see_also = ['ignore', 'ls']
3221
takes_options = ['directory']
3224
def run(self, directory=u'.'):
3225
tree = WorkingTree.open_containing(directory)[0]
3226
self.add_cleanup(tree.lock_read().unlock)
3227
for path, file_class, kind, file_id, entry in tree.list_files():
3228
if file_class != 'I':
3230
## XXX: Slightly inefficient since this was already calculated
3231
pat = tree.is_ignored(path)
3232
self.outf.write('%-50s %s\n' % (path, pat))
3235
class cmd_lookup_revision(Command):
3236
__doc__ = """Lookup the revision-id from a revision-number
3239
bzr lookup-revision 33
3242
takes_args = ['revno']
3243
takes_options = ['directory']
3246
def run(self, revno, directory=u'.'):
3250
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3252
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3253
self.outf.write("%s\n" % revid)
3256
class cmd_export(Command):
3257
__doc__ = """Export current or past revision to a destination directory or archive.
3259
If no revision is specified this exports the last committed revision.
3261
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3262
given, try to find the format with the extension. If no extension
3263
is found exports to a directory (equivalent to --format=dir).
3265
If root is supplied, it will be used as the root directory inside
3266
container formats (tar, zip, etc). If it is not supplied it will default
3267
to the exported filename. The root option has no effect for 'dir' format.
3269
If branch is omitted then the branch containing the current working
3270
directory will be used.
3272
Note: Export of tree with non-ASCII filenames to zip is not supported.
3274
================= =========================
3275
Supported formats Autodetected by extension
3276
================= =========================
3279
tbz2 .tar.bz2, .tbz2
3282
================= =========================
3285
takes_args = ['dest', 'branch_or_subdir?']
3286
takes_options = ['directory',
3288
help="Type of file to export to.",
3291
Option('filters', help='Apply content filters to export the '
3292
'convenient form.'),
3295
help="Name of the root directory inside the exported file."),
3296
Option('per-file-timestamps',
3297
help='Set modification time of files to that of the last '
3298
'revision in which it was changed.'),
3299
Option('uncommitted',
3300
help='Export the working tree contents rather than that of the '
3303
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3304
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3306
from bzrlib.export import export
3308
if branch_or_subdir is None:
3309
branch_or_subdir = directory
3311
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3313
if tree is not None:
3314
self.add_cleanup(tree.lock_read().unlock)
3318
raise errors.BzrCommandError(
3319
gettext("--uncommitted requires a working tree"))
3322
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3324
export(export_tree, dest, format, root, subdir, filtered=filters,
3325
per_file_timestamps=per_file_timestamps)
3326
except errors.NoSuchExportFormat, e:
3327
raise errors.BzrCommandError(
3328
gettext('Unsupported export format: %s') % e.format)
3331
class cmd_cat(Command):
3332
__doc__ = """Write the contents of a file as of a given revision to standard output.
3334
If no revision is nominated, the last revision is used.
3336
Note: Take care to redirect standard output when using this command on a
3341
takes_options = ['directory',
3342
Option('name-from-revision', help='The path name in the old tree.'),
3343
Option('filters', help='Apply content filters to display the '
3344
'convenience form.'),
3347
takes_args = ['filename']
3348
encoding_type = 'exact'
3351
def run(self, filename, revision=None, name_from_revision=False,
3352
filters=False, directory=None):
3353
if revision is not None and len(revision) != 1:
3354
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3355
" one revision specifier"))
3356
tree, branch, relpath = \
3357
_open_directory_or_containing_tree_or_branch(filename, directory)
3358
self.add_cleanup(branch.lock_read().unlock)
3359
return self._run(tree, branch, relpath, filename, revision,
3360
name_from_revision, filters)
3362
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3365
tree = b.basis_tree()
3366
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3367
self.add_cleanup(rev_tree.lock_read().unlock)
3369
old_file_id = rev_tree.path2id(relpath)
3371
# TODO: Split out this code to something that generically finds the
3372
# best id for a path across one or more trees; it's like
3373
# find_ids_across_trees but restricted to find just one. -- mbp
3375
if name_from_revision:
3376
# Try in revision if requested
3377
if old_file_id is None:
3378
raise errors.BzrCommandError(gettext(
3379
"{0!r} is not present in revision {1}").format(
3380
filename, rev_tree.get_revision_id()))
3382
actual_file_id = old_file_id
3384
cur_file_id = tree.path2id(relpath)
3385
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3386
actual_file_id = cur_file_id
3387
elif old_file_id is not None:
3388
actual_file_id = old_file_id
3390
raise errors.BzrCommandError(gettext(
3391
"{0!r} is not present in revision {1}").format(
3392
filename, rev_tree.get_revision_id()))
3394
from bzrlib.filter_tree import ContentFilterTree
3395
filter_tree = ContentFilterTree(rev_tree,
3396
rev_tree._content_filter_stack)
3397
content = filter_tree.get_file_text(actual_file_id)
3399
content = rev_tree.get_file_text(actual_file_id)
3401
self.outf.write(content)
3404
class cmd_local_time_offset(Command):
3405
__doc__ = """Show the offset in seconds from GMT to local time."""
3409
self.outf.write("%s\n" % osutils.local_time_offset())
3413
class cmd_commit(Command):
3414
__doc__ = """Commit changes into a new revision.
3416
An explanatory message needs to be given for each commit. This is
3417
often done by using the --message option (getting the message from the
3418
command line) or by using the --file option (getting the message from
3419
a file). If neither of these options is given, an editor is opened for
3420
the user to enter the message. To see the changed files in the
3421
boilerplate text loaded into the editor, use the --show-diff option.
3423
By default, the entire tree is committed and the person doing the
3424
commit is assumed to be the author. These defaults can be overridden
3429
If selected files are specified, only changes to those files are
3430
committed. If a directory is specified then the directory and
3431
everything within it is committed.
3433
When excludes are given, they take precedence over selected files.
3434
For example, to commit only changes within foo, but not changes
3437
bzr commit foo -x foo/bar
3439
A selective commit after a merge is not yet supported.
3443
If the author of the change is not the same person as the committer,
3444
you can specify the author's name using the --author option. The
3445
name should be in the same format as a committer-id, e.g.
3446
"John Doe <jdoe@example.com>". If there is more than one author of
3447
the change you can specify the option multiple times, once for each
3452
A common mistake is to forget to add a new file or directory before
3453
running the commit command. The --strict option checks for unknown
3454
files and aborts the commit if any are found. More advanced pre-commit
3455
checks can be implemented by defining hooks. See ``bzr help hooks``
3460
If you accidentially commit the wrong changes or make a spelling
3461
mistake in the commit message say, you can use the uncommit command
3462
to undo it. See ``bzr help uncommit`` for details.
3464
Hooks can also be configured to run after a commit. This allows you
3465
to trigger updates to external systems like bug trackers. The --fixes
3466
option can be used to record the association between a revision and
3467
one or more bugs. See ``bzr help bugs`` for details.
3470
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3471
takes_args = ['selected*']
3473
ListOption('exclude', type=str, short_name='x',
3474
help="Do not consider changes made to a given path."),
3475
Option('message', type=unicode,
3477
help="Description of the new revision."),
3480
help='Commit even if nothing has changed.'),
3481
Option('file', type=str,
3484
help='Take commit message from this file.'),
3486
help="Refuse to commit if there are unknown "
3487
"files in the working tree."),
3488
Option('commit-time', type=str,
3489
help="Manually set a commit time using commit date "
3490
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3491
ListOption('fixes', type=str,
3492
help="Mark a bug as being fixed by this revision "
3493
"(see \"bzr help bugs\")."),
3494
ListOption('author', type=unicode,
3495
help="Set the author's name, if it's different "
3496
"from the committer."),
3498
help="Perform a local commit in a bound "
3499
"branch. Local commits are not pushed to "
3500
"the master branch until a normal commit "
3503
Option('show-diff', short_name='p',
3504
help='When no message is supplied, show the diff along'
3505
' with the status summary in the message editor.'),
3507
help='When committing to a foreign version control '
3508
'system do not push data that can not be natively '
3511
aliases = ['ci', 'checkin']
3513
def _iter_bug_fix_urls(self, fixes, branch):
3514
default_bugtracker = None
3515
# Configure the properties for bug fixing attributes.
3516
for fixed_bug in fixes:
3517
tokens = fixed_bug.split(':')
3518
if len(tokens) == 1:
3519
if default_bugtracker is None:
3520
branch_config = branch.get_config()
3521
default_bugtracker = branch_config.get_user_option(
3523
if default_bugtracker is None:
3524
raise errors.BzrCommandError(gettext(
3525
"No tracker specified for bug %s. Use the form "
3526
"'tracker:id' or specify a default bug tracker "
3527
"using the `bugtracker` option.\nSee "
3528
"\"bzr help bugs\" for more information on this "
3529
"feature. Commit refused.") % fixed_bug)
3530
tag = default_bugtracker
3532
elif len(tokens) != 2:
3533
raise errors.BzrCommandError(gettext(
3534
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3535
"See \"bzr help bugs\" for more information on this "
3536
"feature.\nCommit refused.") % fixed_bug)
3538
tag, bug_id = tokens
3540
yield bugtracker.get_bug_url(tag, branch, bug_id)
3541
except errors.UnknownBugTrackerAbbreviation:
3542
raise errors.BzrCommandError(gettext(
3543
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3544
except errors.MalformedBugIdentifier, e:
3545
raise errors.BzrCommandError(gettext(
3546
"%s\nCommit refused.") % (str(e),))
3548
def run(self, message=None, file=None, verbose=False, selected_list=None,
3549
unchanged=False, strict=False, local=False, fixes=None,
3550
author=None, show_diff=False, exclude=None, commit_time=None,
3552
from bzrlib.errors import (
3557
from bzrlib.msgeditor import (
3558
edit_commit_message_encoded,
3559
generate_commit_message_template,
3560
make_commit_message_template_encoded,
3564
commit_stamp = offset = None
3565
if commit_time is not None:
3567
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3568
except ValueError, e:
3569
raise errors.BzrCommandError(gettext(
3570
"Could not parse --commit-time: " + str(e)))
3574
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3575
if selected_list == ['']:
3576
# workaround - commit of root of tree should be exactly the same
3577
# as just default commit in that tree, and succeed even though
3578
# selected-file merge commit is not done yet
3583
bug_property = bugtracker.encode_fixes_bug_urls(
3584
self._iter_bug_fix_urls(fixes, tree.branch))
3586
properties['bugs'] = bug_property
3588
if local and not tree.branch.get_bound_location():
3589
raise errors.LocalRequiresBoundBranch()
3591
if message is not None:
3593
file_exists = osutils.lexists(message)
3594
except UnicodeError:
3595
# The commit message contains unicode characters that can't be
3596
# represented in the filesystem encoding, so that can't be a
3601
'The commit message is a file name: "%(f)s".\n'
3602
'(use --file "%(f)s" to take commit message from that file)'
3604
ui.ui_factory.show_warning(warning_msg)
3606
message = message.replace('\r\n', '\n')
3607
message = message.replace('\r', '\n')
3609
raise errors.BzrCommandError(gettext(
3610
"please specify either --message or --file"))
3612
def get_message(commit_obj):
3613
"""Callback to get commit message"""
3617
my_message = f.read().decode(osutils.get_user_encoding())
3620
elif message is not None:
3621
my_message = message
3623
# No message supplied: make one up.
3624
# text is the status of the tree
3625
text = make_commit_message_template_encoded(tree,
3626
selected_list, diff=show_diff,
3627
output_encoding=osutils.get_user_encoding())
3628
# start_message is the template generated from hooks
3629
# XXX: Warning - looks like hooks return unicode,
3630
# make_commit_message_template_encoded returns user encoding.
3631
# We probably want to be using edit_commit_message instead to
3633
my_message = set_commit_message(commit_obj)
3634
if my_message is None:
3635
start_message = generate_commit_message_template(commit_obj)
3636
my_message = edit_commit_message_encoded(text,
3637
start_message=start_message)
3638
if my_message is None:
3639
raise errors.BzrCommandError(gettext("please specify a commit"
3640
" message with either --message or --file"))
3641
if my_message == "":
3642
raise errors.BzrCommandError(gettext("Empty commit message specified."
3643
" Please specify a commit message with either"
3644
" --message or --file or leave a blank message"
3645
" with --message \"\"."))
3648
# The API permits a commit with a filter of [] to mean 'select nothing'
3649
# but the command line should not do that.
3650
if not selected_list:
3651
selected_list = None
3653
tree.commit(message_callback=get_message,
3654
specific_files=selected_list,
3655
allow_pointless=unchanged, strict=strict, local=local,
3656
reporter=None, verbose=verbose, revprops=properties,
3657
authors=author, timestamp=commit_stamp,
3659
exclude=tree.safe_relpath_files(exclude),
3661
except PointlessCommit:
3662
raise errors.BzrCommandError(gettext("No changes to commit."
3663
" Please 'bzr add' the files you want to commit, or use"
3664
" --unchanged to force an empty commit."))
3665
except ConflictsInTree:
3666
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3667
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3669
except StrictCommitFailed:
3670
raise errors.BzrCommandError(gettext("Commit refused because there are"
3671
" unknown files in the working tree."))
3672
except errors.BoundBranchOutOfDate, e:
3673
e.extra_help = (gettext("\n"
3674
'To commit to master branch, run update and then commit.\n'
3675
'You can also pass --local to commit to continue working '
3680
class cmd_check(Command):
3681
__doc__ = """Validate working tree structure, branch consistency and repository history.
3683
This command checks various invariants about branch and repository storage
3684
to detect data corruption or bzr bugs.
3686
The working tree and branch checks will only give output if a problem is
3687
detected. The output fields of the repository check are:
3690
This is just the number of revisions checked. It doesn't
3694
This is just the number of versionedfiles checked. It
3695
doesn't indicate a problem.
3697
unreferenced ancestors
3698
Texts that are ancestors of other texts, but
3699
are not properly referenced by the revision ancestry. This is a
3700
subtle problem that Bazaar can work around.
3703
This is the total number of unique file contents
3704
seen in the checked revisions. It does not indicate a problem.
3707
This is the total number of repeated texts seen
3708
in the checked revisions. Texts can be repeated when their file
3709
entries are modified, but the file contents are not. It does not
3712
If no restrictions are specified, all Bazaar data that is found at the given
3713
location will be checked.
3717
Check the tree and branch at 'foo'::
3719
bzr check --tree --branch foo
3721
Check only the repository at 'bar'::
3723
bzr check --repo bar
3725
Check everything at 'baz'::
3730
_see_also = ['reconcile']
3731
takes_args = ['path?']
3732
takes_options = ['verbose',
3733
Option('branch', help="Check the branch related to the"
3734
" current directory."),
3735
Option('repo', help="Check the repository related to the"
3736
" current directory."),
3737
Option('tree', help="Check the working tree related to"
3738
" the current directory.")]
3740
def run(self, path=None, verbose=False, branch=False, repo=False,
3742
from bzrlib.check import check_dwim
3745
if not branch and not repo and not tree:
3746
branch = repo = tree = True
3747
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3750
class cmd_upgrade(Command):
3751
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3753
When the default format has changed after a major new release of
3754
Bazaar, you may be informed during certain operations that you
3755
should upgrade. Upgrading to a newer format may improve performance
3756
or make new features available. It may however limit interoperability
3757
with older repositories or with older versions of Bazaar.
3759
If you wish to upgrade to a particular format rather than the
3760
current default, that can be specified using the --format option.
3761
As a consequence, you can use the upgrade command this way to
3762
"downgrade" to an earlier format, though some conversions are
3763
a one way process (e.g. changing from the 1.x default to the
3764
2.x default) so downgrading is not always possible.
3766
A backup.bzr.~#~ directory is created at the start of the conversion
3767
process (where # is a number). By default, this is left there on
3768
completion. If the conversion fails, delete the new .bzr directory
3769
and rename this one back in its place. Use the --clean option to ask
3770
for the backup.bzr directory to be removed on successful conversion.
3771
Alternatively, you can delete it by hand if everything looks good
3774
If the location given is a shared repository, dependent branches
3775
are also converted provided the repository converts successfully.
3776
If the conversion of a branch fails, remaining branches are still
3779
For more information on upgrades, see the Bazaar Upgrade Guide,
3780
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3783
_see_also = ['check', 'reconcile', 'formats']
3784
takes_args = ['url?']
3786
RegistryOption('format',
3787
help='Upgrade to a specific format. See "bzr help'
3788
' formats" for details.',
3789
lazy_registry=('bzrlib.controldir', 'format_registry'),
3790
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3791
value_switches=True, title='Branch format'),
3793
help='Remove the backup.bzr directory if successful.'),
3795
help="Show what would be done, but don't actually do anything."),
3798
def run(self, url='.', format=None, clean=False, dry_run=False):
3799
from bzrlib.upgrade import upgrade
3800
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3802
if len(exceptions) == 1:
3803
# Compatibility with historical behavior
3809
class cmd_whoami(Command):
3810
__doc__ = """Show or set bzr user id.
3813
Show the email of the current user::
3817
Set the current user::
3819
bzr whoami "Frank Chu <fchu@example.com>"
3821
takes_options = [ 'directory',
3823
help='Display email address only.'),
3825
help='Set identity for the current branch instead of '
3828
takes_args = ['name?']
3829
encoding_type = 'replace'
3832
def run(self, email=False, branch=False, name=None, directory=None):
3834
if directory is None:
3835
# use branch if we're inside one; otherwise global config
3837
c = Branch.open_containing(u'.')[0].get_config_stack()
3838
except errors.NotBranchError:
3839
c = _mod_config.GlobalStack()
3841
c = Branch.open(directory).get_config_stack()
3842
identity = c.get('email')
3844
self.outf.write(_mod_config.extract_email_address(identity)
3847
self.outf.write(identity + '\n')
3851
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3854
# display a warning if an email address isn't included in the given name.
3856
_mod_config.extract_email_address(name)
3857
except errors.NoEmailInUsername, e:
3858
warning('"%s" does not seem to contain an email address. '
3859
'This is allowed, but not recommended.', name)
3861
# use global config unless --branch given
3863
if directory is None:
3864
c = Branch.open_containing(u'.')[0].get_config_stack()
3866
c = Branch.open(directory).get_config_stack()
3868
c = _mod_config.GlobalStack()
3869
c.set('email', name)
3872
class cmd_nick(Command):
3873
__doc__ = """Print or set the branch nickname.
3875
If unset, the tree root directory name is used as the nickname.
3876
To print the current nickname, execute with no argument.
3878
Bound branches use the nickname of its master branch unless it is set
3882
_see_also = ['info']
3883
takes_args = ['nickname?']
3884
takes_options = ['directory']
3885
def run(self, nickname=None, directory=u'.'):
3886
branch = Branch.open_containing(directory)[0]
3887
if nickname is None:
3888
self.printme(branch)
3890
branch.nick = nickname
3893
def printme(self, branch):
3894
self.outf.write('%s\n' % branch.nick)
3897
class cmd_alias(Command):
3898
__doc__ = """Set/unset and display aliases.
3901
Show the current aliases::
3905
Show the alias specified for 'll'::
3909
Set an alias for 'll'::
3911
bzr alias ll="log --line -r-10..-1"
3913
To remove an alias for 'll'::
3915
bzr alias --remove ll
3918
takes_args = ['name?']
3920
Option('remove', help='Remove the alias.'),
3923
def run(self, name=None, remove=False):
3925
self.remove_alias(name)
3927
self.print_aliases()
3929
equal_pos = name.find('=')
3931
self.print_alias(name)
3933
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3935
def remove_alias(self, alias_name):
3936
if alias_name is None:
3937
raise errors.BzrCommandError(gettext(
3938
'bzr alias --remove expects an alias to remove.'))
3939
# If alias is not found, print something like:
3940
# unalias: foo: not found
3941
c = _mod_config.GlobalConfig()
3942
c.unset_alias(alias_name)
3945
def print_aliases(self):
3946
"""Print out the defined aliases in a similar format to bash."""
3947
aliases = _mod_config.GlobalConfig().get_aliases()
3948
for key, value in sorted(aliases.iteritems()):
3949
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3952
def print_alias(self, alias_name):
3953
from bzrlib.commands import get_alias
3954
alias = get_alias(alias_name)
3956
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3959
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3961
def set_alias(self, alias_name, alias_command):
3962
"""Save the alias in the global config."""
3963
c = _mod_config.GlobalConfig()
3964
c.set_alias(alias_name, alias_command)
3967
class cmd_selftest(Command):
3968
__doc__ = """Run internal test suite.
3970
If arguments are given, they are regular expressions that say which tests
3971
should run. Tests matching any expression are run, and other tests are
3974
Alternatively if --first is given, matching tests are run first and then
3975
all other tests are run. This is useful if you have been working in a
3976
particular area, but want to make sure nothing else was broken.
3978
If --exclude is given, tests that match that regular expression are
3979
excluded, regardless of whether they match --first or not.
3981
To help catch accidential dependencies between tests, the --randomize
3982
option is useful. In most cases, the argument used is the word 'now'.
3983
Note that the seed used for the random number generator is displayed
3984
when this option is used. The seed can be explicitly passed as the
3985
argument to this option if required. This enables reproduction of the
3986
actual ordering used if and when an order sensitive problem is encountered.
3988
If --list-only is given, the tests that would be run are listed. This is
3989
useful when combined with --first, --exclude and/or --randomize to
3990
understand their impact. The test harness reports "Listed nn tests in ..."
3991
instead of "Ran nn tests in ..." when list mode is enabled.
3993
If the global option '--no-plugins' is given, plugins are not loaded
3994
before running the selftests. This has two effects: features provided or
3995
modified by plugins will not be tested, and tests provided by plugins will
3998
Tests that need working space on disk use a common temporary directory,
3999
typically inside $TMPDIR or /tmp.
4001
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
4002
into a pdb postmortem session.
4004
The --coverage=DIRNAME global option produces a report with covered code
4008
Run only tests relating to 'ignore'::
4012
Disable plugins and list tests as they're run::
4014
bzr --no-plugins selftest -v
4016
# NB: this is used from the class without creating an instance, which is
4017
# why it does not have a self parameter.
4018
def get_transport_type(typestring):
4019
"""Parse and return a transport specifier."""
4020
if typestring == "sftp":
4021
from bzrlib.tests import stub_sftp
4022
return stub_sftp.SFTPAbsoluteServer
4023
elif typestring == "memory":
4024
from bzrlib.tests import test_server
4025
return memory.MemoryServer
4026
elif typestring == "fakenfs":
4027
from bzrlib.tests import test_server
4028
return test_server.FakeNFSServer
4029
msg = "No known transport type %s. Supported types are: sftp\n" %\
4031
raise errors.BzrCommandError(msg)
4034
takes_args = ['testspecs*']
4035
takes_options = ['verbose',
4037
help='Stop when one test fails.',
4041
help='Use a different transport by default '
4042
'throughout the test suite.',
4043
type=get_transport_type),
4045
help='Run the benchmarks rather than selftests.',
4047
Option('lsprof-timed',
4048
help='Generate lsprof output for benchmarked'
4049
' sections of code.'),
4050
Option('lsprof-tests',
4051
help='Generate lsprof output for each test.'),
4053
help='Run all tests, but run specified tests first.',
4057
help='List the tests instead of running them.'),
4058
RegistryOption('parallel',
4059
help="Run the test suite in parallel.",
4060
lazy_registry=('bzrlib.tests', 'parallel_registry'),
4061
value_switches=False,
4063
Option('randomize', type=str, argname="SEED",
4064
help='Randomize the order of tests using the given'
4065
' seed or "now" for the current time.'),
4066
ListOption('exclude', type=str, argname="PATTERN",
4068
help='Exclude tests that match this regular'
4071
help='Output test progress via subunit.'),
4072
Option('strict', help='Fail on missing dependencies or '
4074
Option('load-list', type=str, argname='TESTLISTFILE',
4075
help='Load a test id list from a text file.'),
4076
ListOption('debugflag', type=str, short_name='E',
4077
help='Turn on a selftest debug flag.'),
4078
ListOption('starting-with', type=str, argname='TESTID',
4079
param_name='starting_with', short_name='s',
4081
'Load only the tests starting with TESTID.'),
4083
help="By default we disable fsync and fdatasync"
4084
" while running the test suite.")
4086
encoding_type = 'replace'
4089
Command.__init__(self)
4090
self.additional_selftest_args = {}
4092
def run(self, testspecs_list=None, verbose=False, one=False,
4093
transport=None, benchmark=None,
4095
first=False, list_only=False,
4096
randomize=None, exclude=None, strict=False,
4097
load_list=None, debugflag=None, starting_with=None, subunit=False,
4098
parallel=None, lsprof_tests=False,
4101
# During selftest, disallow proxying, as it can cause severe
4102
# performance penalties and is only needed for thread
4103
# safety. The selftest command is assumed to not use threads
4104
# too heavily. The call should be as early as possible, as
4105
# error reporting for past duplicate imports won't have useful
4107
lazy_import.disallow_proxying()
4109
from bzrlib import tests
4111
if testspecs_list is not None:
4112
pattern = '|'.join(testspecs_list)
4117
from bzrlib.tests import SubUnitBzrRunner
4119
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4120
"needs to be installed to use --subunit."))
4121
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4122
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4123
# stdout, which would corrupt the subunit stream.
4124
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4125
# following code can be deleted when it's sufficiently deployed
4126
# -- vila/mgz 20100514
4127
if (sys.platform == "win32"
4128
and getattr(sys.stdout, 'fileno', None) is not None):
4130
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4132
self.additional_selftest_args.setdefault(
4133
'suite_decorators', []).append(parallel)
4135
raise errors.BzrCommandError(gettext(
4136
"--benchmark is no longer supported from bzr 2.2; "
4137
"use bzr-usertest instead"))
4138
test_suite_factory = None
4140
exclude_pattern = None
4142
exclude_pattern = '(' + '|'.join(exclude) + ')'
4144
self._disable_fsync()
4145
selftest_kwargs = {"verbose": verbose,
4147
"stop_on_failure": one,
4148
"transport": transport,
4149
"test_suite_factory": test_suite_factory,
4150
"lsprof_timed": lsprof_timed,
4151
"lsprof_tests": lsprof_tests,
4152
"matching_tests_first": first,
4153
"list_only": list_only,
4154
"random_seed": randomize,
4155
"exclude_pattern": exclude_pattern,
4157
"load_list": load_list,
4158
"debug_flags": debugflag,
4159
"starting_with": starting_with
4161
selftest_kwargs.update(self.additional_selftest_args)
4163
# Make deprecation warnings visible, unless -Werror is set
4164
cleanup = symbol_versioning.activate_deprecation_warnings(
4167
result = tests.selftest(**selftest_kwargs)
4170
return int(not result)
4172
def _disable_fsync(self):
4173
"""Change the 'os' functionality to not synchronize."""
4174
self._orig_fsync = getattr(os, 'fsync', None)
4175
if self._orig_fsync is not None:
4176
os.fsync = lambda filedes: None
4177
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4178
if self._orig_fdatasync is not None:
4179
os.fdatasync = lambda filedes: None
4182
class cmd_version(Command):
4183
__doc__ = """Show version of bzr."""
4185
encoding_type = 'replace'
4187
Option("short", help="Print just the version number."),
4191
def run(self, short=False):
4192
from bzrlib.version import show_version
4194
self.outf.write(bzrlib.version_string + '\n')
4196
show_version(to_file=self.outf)
4199
class cmd_rocks(Command):
4200
__doc__ = """Statement of optimism."""
4206
self.outf.write(gettext("It sure does!\n"))
4209
class cmd_find_merge_base(Command):
4210
__doc__ = """Find and print a base revision for merging two branches."""
4211
# TODO: Options to specify revisions on either side, as if
4212
# merging only part of the history.
4213
takes_args = ['branch', 'other']
4217
def run(self, branch, other):
4218
from bzrlib.revision import ensure_null
4220
branch1 = Branch.open_containing(branch)[0]
4221
branch2 = Branch.open_containing(other)[0]
4222
self.add_cleanup(branch1.lock_read().unlock)
4223
self.add_cleanup(branch2.lock_read().unlock)
4224
last1 = ensure_null(branch1.last_revision())
4225
last2 = ensure_null(branch2.last_revision())
4227
graph = branch1.repository.get_graph(branch2.repository)
4228
base_rev_id = graph.find_unique_lca(last1, last2)
4230
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4233
class cmd_merge(Command):
4234
__doc__ = """Perform a three-way merge.
4236
The source of the merge can be specified either in the form of a branch,
4237
or in the form of a path to a file containing a merge directive generated
4238
with bzr send. If neither is specified, the default is the upstream branch
4239
or the branch most recently merged using --remember. The source of the
4240
merge may also be specified in the form of a path to a file in another
4241
branch: in this case, only the modifications to that file are merged into
4242
the current working tree.
4244
When merging from a branch, by default bzr will try to merge in all new
4245
work from the other branch, automatically determining an appropriate base
4246
revision. If this fails, you may need to give an explicit base.
4248
To pick a different ending revision, pass "--revision OTHER". bzr will
4249
try to merge in all new work up to and including revision OTHER.
4251
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4252
through OTHER, excluding BASE but including OTHER, will be merged. If this
4253
causes some revisions to be skipped, i.e. if the destination branch does
4254
not already contain revision BASE, such a merge is commonly referred to as
4255
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4256
cherrypicks. The changes look like a normal commit, and the history of the
4257
changes from the other branch is not stored in the commit.
4259
Revision numbers are always relative to the source branch.
4261
Merge will do its best to combine the changes in two branches, but there
4262
are some kinds of problems only a human can fix. When it encounters those,
4263
it will mark a conflict. A conflict means that you need to fix something,
4264
before you can commit.
4266
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4268
If there is no default branch set, the first merge will set it (use
4269
--no-remember to avoid setting it). After that, you can omit the branch
4270
to use the default. To change the default, use --remember. The value will
4271
only be saved if the remote location can be accessed.
4273
The results of the merge are placed into the destination working
4274
directory, where they can be reviewed (with bzr diff), tested, and then
4275
committed to record the result of the merge.
4277
merge refuses to run if there are any uncommitted changes, unless
4278
--force is given. If --force is given, then the changes from the source
4279
will be merged with the current working tree, including any uncommitted
4280
changes in the tree. The --force option can also be used to create a
4281
merge revision which has more than two parents.
4283
If one would like to merge changes from the working tree of the other
4284
branch without merging any committed revisions, the --uncommitted option
4287
To select only some changes to merge, use "merge -i", which will prompt
4288
you to apply each diff hunk and file change, similar to "shelve".
4291
To merge all new revisions from bzr.dev::
4293
bzr merge ../bzr.dev
4295
To merge changes up to and including revision 82 from bzr.dev::
4297
bzr merge -r 82 ../bzr.dev
4299
To merge the changes introduced by 82, without previous changes::
4301
bzr merge -r 81..82 ../bzr.dev
4303
To apply a merge directive contained in /tmp/merge::
4305
bzr merge /tmp/merge
4307
To create a merge revision with three parents from two branches
4308
feature1a and feature1b:
4310
bzr merge ../feature1a
4311
bzr merge ../feature1b --force
4312
bzr commit -m 'revision with three parents'
4315
encoding_type = 'exact'
4316
_see_also = ['update', 'remerge', 'status-flags', 'send']
4317
takes_args = ['location?']
4322
help='Merge even if the destination tree has uncommitted changes.'),
4326
Option('show-base', help="Show base revision text in "
4328
Option('uncommitted', help='Apply uncommitted changes'
4329
' from a working copy, instead of branch changes.'),
4330
Option('pull', help='If the destination is already'
4331
' completely merged into the source, pull from the'
4332
' source rather than merging. When this happens,'
4333
' you do not need to commit the result.'),
4334
custom_help('directory',
4335
help='Branch to merge into, '
4336
'rather than the one containing the working directory.'),
4337
Option('preview', help='Instead of merging, show a diff of the'
4339
Option('interactive', help='Select changes interactively.',
4343
def run(self, location=None, revision=None, force=False,
4344
merge_type=None, show_base=False, reprocess=None, remember=None,
4345
uncommitted=False, pull=False,
4350
if merge_type is None:
4351
merge_type = _mod_merge.Merge3Merger
4353
if directory is None: directory = u'.'
4354
possible_transports = []
4356
allow_pending = True
4357
verified = 'inapplicable'
4359
tree = WorkingTree.open_containing(directory)[0]
4360
if tree.branch.revno() == 0:
4361
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4362
'https://bugs.launchpad.net/bzr/+bug/308562'))
4365
basis_tree = tree.revision_tree(tree.last_revision())
4366
except errors.NoSuchRevision:
4367
basis_tree = tree.basis_tree()
4369
# die as quickly as possible if there are uncommitted changes
4371
if tree.has_changes():
4372
raise errors.UncommittedChanges(tree)
4374
view_info = _get_view_info_for_change_reporter(tree)
4375
change_reporter = delta._ChangeReporter(
4376
unversioned_filter=tree.is_ignored, view_info=view_info)
4377
pb = ui.ui_factory.nested_progress_bar()
4378
self.add_cleanup(pb.finished)
4379
self.add_cleanup(tree.lock_write().unlock)
4380
if location is not None:
4382
mergeable = bundle.read_mergeable_from_url(location,
4383
possible_transports=possible_transports)
4384
except errors.NotABundle:
4388
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4389
' with bundles or merge directives.'))
4391
if revision is not None:
4392
raise errors.BzrCommandError(gettext(
4393
'Cannot use -r with merge directives or bundles'))
4394
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4397
if merger is None and uncommitted:
4398
if revision is not None and len(revision) > 0:
4399
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4400
' --revision at the same time.'))
4401
merger = self.get_merger_from_uncommitted(tree, location, None)
4402
allow_pending = False
4405
merger, allow_pending = self._get_merger_from_branch(tree,
4406
location, revision, remember, possible_transports, None)
4408
merger.merge_type = merge_type
4409
merger.reprocess = reprocess
4410
merger.show_base = show_base
4411
self.sanity_check_merger(merger)
4412
if (merger.base_rev_id == merger.other_rev_id and
4413
merger.other_rev_id is not None):
4414
# check if location is a nonexistent file (and not a branch) to
4415
# disambiguate the 'Nothing to do'
4416
if merger.interesting_files:
4417
if not merger.other_tree.has_filename(
4418
merger.interesting_files[0]):
4419
note(gettext("merger: ") + str(merger))
4420
raise errors.PathsDoNotExist([location])
4421
note(gettext('Nothing to do.'))
4423
if pull and not preview:
4424
if merger.interesting_files is not None:
4425
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4426
if (merger.base_rev_id == tree.last_revision()):
4427
result = tree.pull(merger.other_branch, False,
4428
merger.other_rev_id)
4429
result.report(self.outf)
4431
if merger.this_basis is None:
4432
raise errors.BzrCommandError(gettext(
4433
"This branch has no commits."
4434
" (perhaps you would prefer 'bzr pull')"))
4436
return self._do_preview(merger)
4438
return self._do_interactive(merger)
4440
return self._do_merge(merger, change_reporter, allow_pending,
4443
def _get_preview(self, merger):
4444
tree_merger = merger.make_merger()
4445
tt = tree_merger.make_preview_transform()
4446
self.add_cleanup(tt.finalize)
4447
result_tree = tt.get_preview_tree()
4450
def _do_preview(self, merger):
4451
from bzrlib.diff import show_diff_trees
4452
result_tree = self._get_preview(merger)
4453
path_encoding = osutils.get_diff_header_encoding()
4454
show_diff_trees(merger.this_tree, result_tree, self.outf,
4455
old_label='', new_label='',
4456
path_encoding=path_encoding)
4458
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4459
merger.change_reporter = change_reporter
4460
conflict_count = merger.do_merge()
4462
merger.set_pending()
4463
if verified == 'failed':
4464
warning('Preview patch does not match changes')
4465
if conflict_count != 0:
4470
def _do_interactive(self, merger):
4471
"""Perform an interactive merge.
4473
This works by generating a preview tree of the merge, then using
4474
Shelver to selectively remove the differences between the working tree
4475
and the preview tree.
4477
from bzrlib import shelf_ui
4478
result_tree = self._get_preview(merger)
4479
writer = bzrlib.option.diff_writer_registry.get()
4480
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4481
reporter=shelf_ui.ApplyReporter(),
4482
diff_writer=writer(sys.stdout))
4488
def sanity_check_merger(self, merger):
4489
if (merger.show_base and
4490
not merger.merge_type is _mod_merge.Merge3Merger):
4491
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4492
" merge type. %s") % merger.merge_type)
4493
if merger.reprocess is None:
4494
if merger.show_base:
4495
merger.reprocess = False
4497
# Use reprocess if the merger supports it
4498
merger.reprocess = merger.merge_type.supports_reprocess
4499
if merger.reprocess and not merger.merge_type.supports_reprocess:
4500
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4501
" for merge type %s.") %
4503
if merger.reprocess and merger.show_base:
4504
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4507
def _get_merger_from_branch(self, tree, location, revision, remember,
4508
possible_transports, pb):
4509
"""Produce a merger from a location, assuming it refers to a branch."""
4510
from bzrlib.tag import _merge_tags_if_possible
4511
# find the branch locations
4512
other_loc, user_location = self._select_branch_location(tree, location,
4514
if revision is not None and len(revision) == 2:
4515
base_loc, _unused = self._select_branch_location(tree,
4516
location, revision, 0)
4518
base_loc = other_loc
4520
other_branch, other_path = Branch.open_containing(other_loc,
4521
possible_transports)
4522
if base_loc == other_loc:
4523
base_branch = other_branch
4525
base_branch, base_path = Branch.open_containing(base_loc,
4526
possible_transports)
4527
# Find the revision ids
4528
other_revision_id = None
4529
base_revision_id = None
4530
if revision is not None:
4531
if len(revision) >= 1:
4532
other_revision_id = revision[-1].as_revision_id(other_branch)
4533
if len(revision) == 2:
4534
base_revision_id = revision[0].as_revision_id(base_branch)
4535
if other_revision_id is None:
4536
other_revision_id = _mod_revision.ensure_null(
4537
other_branch.last_revision())
4538
# Remember where we merge from. We need to remember if:
4539
# - user specify a location (and we don't merge from the parent
4541
# - user ask to remember or there is no previous location set to merge
4542
# from and user didn't ask to *not* remember
4543
if (user_location is not None
4545
or (remember is None
4546
and tree.branch.get_submit_branch() is None)))):
4547
tree.branch.set_submit_branch(other_branch.base)
4548
# Merge tags (but don't set them in the master branch yet, the user
4549
# might revert this merge). Commit will propagate them.
4550
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4551
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4552
other_revision_id, base_revision_id, other_branch, base_branch)
4553
if other_path != '':
4554
allow_pending = False
4555
merger.interesting_files = [other_path]
4557
allow_pending = True
4558
return merger, allow_pending
4560
def get_merger_from_uncommitted(self, tree, location, pb):
4561
"""Get a merger for uncommitted changes.
4563
:param tree: The tree the merger should apply to.
4564
:param location: The location containing uncommitted changes.
4565
:param pb: The progress bar to use for showing progress.
4567
location = self._select_branch_location(tree, location)[0]
4568
other_tree, other_path = WorkingTree.open_containing(location)
4569
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4570
if other_path != '':
4571
merger.interesting_files = [other_path]
4574
def _select_branch_location(self, tree, user_location, revision=None,
4576
"""Select a branch location, according to possible inputs.
4578
If provided, branches from ``revision`` are preferred. (Both
4579
``revision`` and ``index`` must be supplied.)
4581
Otherwise, the ``location`` parameter is used. If it is None, then the
4582
``submit`` or ``parent`` location is used, and a note is printed.
4584
:param tree: The working tree to select a branch for merging into
4585
:param location: The location entered by the user
4586
:param revision: The revision parameter to the command
4587
:param index: The index to use for the revision parameter. Negative
4588
indices are permitted.
4589
:return: (selected_location, user_location). The default location
4590
will be the user-entered location.
4592
if (revision is not None and index is not None
4593
and revision[index] is not None):
4594
branch = revision[index].get_branch()
4595
if branch is not None:
4596
return branch, branch
4597
if user_location is None:
4598
location = self._get_remembered(tree, 'Merging from')
4600
location = user_location
4601
return location, user_location
4603
def _get_remembered(self, tree, verb_string):
4604
"""Use tree.branch's parent if none was supplied.
4606
Report if the remembered location was used.
4608
stored_location = tree.branch.get_submit_branch()
4609
stored_location_type = "submit"
4610
if stored_location is None:
4611
stored_location = tree.branch.get_parent()
4612
stored_location_type = "parent"
4613
mutter("%s", stored_location)
4614
if stored_location is None:
4615
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4616
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4617
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4618
stored_location_type, display_url))
4619
return stored_location
4622
class cmd_remerge(Command):
4623
__doc__ = """Redo a merge.
4625
Use this if you want to try a different merge technique while resolving
4626
conflicts. Some merge techniques are better than others, and remerge
4627
lets you try different ones on different files.
4629
The options for remerge have the same meaning and defaults as the ones for
4630
merge. The difference is that remerge can (only) be run when there is a
4631
pending merge, and it lets you specify particular files.
4634
Re-do the merge of all conflicted files, and show the base text in
4635
conflict regions, in addition to the usual THIS and OTHER texts::
4637
bzr remerge --show-base
4639
Re-do the merge of "foobar", using the weave merge algorithm, with
4640
additional processing to reduce the size of conflict regions::
4642
bzr remerge --merge-type weave --reprocess foobar
4644
takes_args = ['file*']
4649
help="Show base revision text in conflicts."),
4652
def run(self, file_list=None, merge_type=None, show_base=False,
4654
from bzrlib.conflicts import restore
4655
if merge_type is None:
4656
merge_type = _mod_merge.Merge3Merger
4657
tree, file_list = WorkingTree.open_containing_paths(file_list)
4658
self.add_cleanup(tree.lock_write().unlock)
4659
parents = tree.get_parent_ids()
4660
if len(parents) != 2:
4661
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4662
" merges. Not cherrypicking or"
4664
repository = tree.branch.repository
4665
interesting_ids = None
4667
conflicts = tree.conflicts()
4668
if file_list is not None:
4669
interesting_ids = set()
4670
for filename in file_list:
4671
file_id = tree.path2id(filename)
4673
raise errors.NotVersionedError(filename)
4674
interesting_ids.add(file_id)
4675
if tree.kind(file_id) != "directory":
4678
for name, ie in tree.inventory.iter_entries(file_id):
4679
interesting_ids.add(ie.file_id)
4680
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4682
# Remerge only supports resolving contents conflicts
4683
allowed_conflicts = ('text conflict', 'contents conflict')
4684
restore_files = [c.path for c in conflicts
4685
if c.typestring in allowed_conflicts]
4686
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4687
tree.set_conflicts(ConflictList(new_conflicts))
4688
if file_list is not None:
4689
restore_files = file_list
4690
for filename in restore_files:
4692
restore(tree.abspath(filename))
4693
except errors.NotConflicted:
4695
# Disable pending merges, because the file texts we are remerging
4696
# have not had those merges performed. If we use the wrong parents
4697
# list, we imply that the working tree text has seen and rejected
4698
# all the changes from the other tree, when in fact those changes
4699
# have not yet been seen.
4700
tree.set_parent_ids(parents[:1])
4702
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4703
merger.interesting_ids = interesting_ids
4704
merger.merge_type = merge_type
4705
merger.show_base = show_base
4706
merger.reprocess = reprocess
4707
conflicts = merger.do_merge()
4709
tree.set_parent_ids(parents)
4716
class cmd_revert(Command):
4717
__doc__ = """Revert files to a previous revision.
4719
Giving a list of files will revert only those files. Otherwise, all files
4720
will be reverted. If the revision is not specified with '--revision', the
4721
last committed revision is used.
4723
To remove only some changes, without reverting to a prior version, use
4724
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4725
will remove the changes introduced by the second last commit (-2), without
4726
affecting the changes introduced by the last commit (-1). To remove
4727
certain changes on a hunk-by-hunk basis, see the shelve command.
4729
By default, any files that have been manually changed will be backed up
4730
first. (Files changed only by merge are not backed up.) Backup files have
4731
'.~#~' appended to their name, where # is a number.
4733
When you provide files, you can use their current pathname or the pathname
4734
from the target revision. So you can use revert to "undelete" a file by
4735
name. If you name a directory, all the contents of that directory will be
4738
If you have newly added files since the target revision, they will be
4739
removed. If the files to be removed have been changed, backups will be
4740
created as above. Directories containing unknown files will not be
4743
The working tree contains a list of revisions that have been merged but
4744
not yet committed. These revisions will be included as additional parents
4745
of the next commit. Normally, using revert clears that list as well as
4746
reverting the files. If any files are specified, revert leaves the list
4747
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4748
.`` in the tree root to revert all files but keep the recorded merges,
4749
and ``bzr revert --forget-merges`` to clear the pending merge list without
4750
reverting any files.
4752
Using "bzr revert --forget-merges", it is possible to apply all of the
4753
changes from a branch in a single revision. To do this, perform the merge
4754
as desired. Then doing revert with the "--forget-merges" option will keep
4755
the content of the tree as it was, but it will clear the list of pending
4756
merges. The next commit will then contain all of the changes that are
4757
present in the other branch, but without any other parent revisions.
4758
Because this technique forgets where these changes originated, it may
4759
cause additional conflicts on later merges involving the same source and
4763
_see_also = ['cat', 'export', 'merge', 'shelve']
4766
Option('no-backup', "Do not save backups of reverted files."),
4767
Option('forget-merges',
4768
'Remove pending merge marker, without changing any files.'),
4770
takes_args = ['file*']
4772
def run(self, revision=None, no_backup=False, file_list=None,
4773
forget_merges=None):
4774
tree, file_list = WorkingTree.open_containing_paths(file_list)
4775
self.add_cleanup(tree.lock_tree_write().unlock)
4777
tree.set_parent_ids(tree.get_parent_ids()[:1])
4779
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4782
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4783
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4784
tree.revert(file_list, rev_tree, not no_backup, None,
4785
report_changes=True)
4788
class cmd_assert_fail(Command):
4789
__doc__ = """Test reporting of assertion failures"""
4790
# intended just for use in testing
4795
raise AssertionError("always fails")
4798
class cmd_help(Command):
4799
__doc__ = """Show help on a command or other topic.
4802
_see_also = ['topics']
4804
Option('long', 'Show help on all commands.'),
4806
takes_args = ['topic?']
4807
aliases = ['?', '--help', '-?', '-h']
4810
def run(self, topic=None, long=False):
4812
if topic is None and long:
4814
bzrlib.help.help(topic)
4817
class cmd_shell_complete(Command):
4818
__doc__ = """Show appropriate completions for context.
4820
For a list of all available commands, say 'bzr shell-complete'.
4822
takes_args = ['context?']
4827
def run(self, context=None):
4828
from bzrlib import shellcomplete
4829
shellcomplete.shellcomplete(context)
4832
class cmd_missing(Command):
4833
__doc__ = """Show unmerged/unpulled revisions between two branches.
4835
OTHER_BRANCH may be local or remote.
4837
To filter on a range of revisions, you can use the command -r begin..end
4838
-r revision requests a specific revision, -r ..end or -r begin.. are
4842
1 - some missing revisions
4843
0 - no missing revisions
4847
Determine the missing revisions between this and the branch at the
4848
remembered pull location::
4852
Determine the missing revisions between this and another branch::
4854
bzr missing http://server/branch
4856
Determine the missing revisions up to a specific revision on the other
4859
bzr missing -r ..-10
4861
Determine the missing revisions up to a specific revision on this
4864
bzr missing --my-revision ..-10
4867
_see_also = ['merge', 'pull']
4868
takes_args = ['other_branch?']
4871
Option('reverse', 'Reverse the order of revisions.'),
4873
'Display changes in the local branch only.'),
4874
Option('this' , 'Same as --mine-only.'),
4875
Option('theirs-only',
4876
'Display changes in the remote branch only.'),
4877
Option('other', 'Same as --theirs-only.'),
4881
custom_help('revision',
4882
help='Filter on other branch revisions (inclusive). '
4883
'See "help revisionspec" for details.'),
4884
Option('my-revision',
4885
type=_parse_revision_str,
4886
help='Filter on local branch revisions (inclusive). '
4887
'See "help revisionspec" for details.'),
4888
Option('include-merged',
4889
'Show all revisions in addition to the mainline ones.'),
4890
Option('include-merges', hidden=True,
4891
help='Historical alias for --include-merged.'),
4893
encoding_type = 'replace'
4896
def run(self, other_branch=None, reverse=False, mine_only=False,
4898
log_format=None, long=False, short=False, line=False,
4899
show_ids=False, verbose=False, this=False, other=False,
4900
include_merged=None, revision=None, my_revision=None,
4902
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4903
from bzrlib.missing import find_unmerged, iter_log_revisions
4908
if symbol_versioning.deprecated_passed(include_merges):
4909
ui.ui_factory.show_user_warning(
4910
'deprecated_command_option',
4911
deprecated_name='--include-merges',
4912
recommended_name='--include-merged',
4913
deprecated_in_version='2.5',
4914
command=self.invoked_as)
4915
if include_merged is None:
4916
include_merged = include_merges
4918
raise errors.BzrCommandError(gettext(
4919
'{0} and {1} are mutually exclusive').format(
4920
'--include-merges', '--include-merged'))
4921
if include_merged is None:
4922
include_merged = False
4927
# TODO: We should probably check that we don't have mine-only and
4928
# theirs-only set, but it gets complicated because we also have
4929
# this and other which could be used.
4936
local_branch = Branch.open_containing(directory)[0]
4937
self.add_cleanup(local_branch.lock_read().unlock)
4939
parent = local_branch.get_parent()
4940
if other_branch is None:
4941
other_branch = parent
4942
if other_branch is None:
4943
raise errors.BzrCommandError(gettext("No peer location known"
4945
display_url = urlutils.unescape_for_display(parent,
4947
message(gettext("Using saved parent location: {0}\n").format(
4950
remote_branch = Branch.open(other_branch)
4951
if remote_branch.base == local_branch.base:
4952
remote_branch = local_branch
4954
self.add_cleanup(remote_branch.lock_read().unlock)
4956
local_revid_range = _revision_range_to_revid_range(
4957
_get_revision_range(my_revision, local_branch,
4960
remote_revid_range = _revision_range_to_revid_range(
4961
_get_revision_range(revision,
4962
remote_branch, self.name()))
4964
local_extra, remote_extra = find_unmerged(
4965
local_branch, remote_branch, restrict,
4966
backward=not reverse,
4967
include_merged=include_merged,
4968
local_revid_range=local_revid_range,
4969
remote_revid_range=remote_revid_range)
4971
if log_format is None:
4972
registry = log.log_formatter_registry
4973
log_format = registry.get_default(local_branch)
4974
lf = log_format(to_file=self.outf,
4976
show_timezone='original')
4979
if local_extra and not theirs_only:
4980
message(ngettext("You have %d extra revision:\n",
4981
"You have %d extra revisions:\n",
4984
for revision in iter_log_revisions(local_extra,
4985
local_branch.repository,
4987
lf.log_revision(revision)
4988
printed_local = True
4991
printed_local = False
4993
if remote_extra and not mine_only:
4994
if printed_local is True:
4996
message(ngettext("You are missing %d revision:\n",
4997
"You are missing %d revisions:\n",
4998
len(remote_extra)) %
5000
for revision in iter_log_revisions(remote_extra,
5001
remote_branch.repository,
5003
lf.log_revision(revision)
5006
if mine_only and not local_extra:
5007
# We checked local, and found nothing extra
5008
message(gettext('This branch has no new revisions.\n'))
5009
elif theirs_only and not remote_extra:
5010
# We checked remote, and found nothing extra
5011
message(gettext('Other branch has no new revisions.\n'))
5012
elif not (mine_only or theirs_only or local_extra or
5014
# We checked both branches, and neither one had extra
5016
message(gettext("Branches are up to date.\n"))
5018
if not status_code and parent is None and other_branch is not None:
5019
self.add_cleanup(local_branch.lock_write().unlock)
5020
# handle race conditions - a parent might be set while we run.
5021
if local_branch.get_parent() is None:
5022
local_branch.set_parent(remote_branch.base)
5026
class cmd_pack(Command):
5027
__doc__ = """Compress the data within a repository.
5029
This operation compresses the data within a bazaar repository. As
5030
bazaar supports automatic packing of repository, this operation is
5031
normally not required to be done manually.
5033
During the pack operation, bazaar takes a backup of existing repository
5034
data, i.e. pack files. This backup is eventually removed by bazaar
5035
automatically when it is safe to do so. To save disk space by removing
5036
the backed up pack files, the --clean-obsolete-packs option may be
5039
Warning: If you use --clean-obsolete-packs and your machine crashes
5040
during or immediately after repacking, you may be left with a state
5041
where the deletion has been written to disk but the new packs have not
5042
been. In this case the repository may be unusable.
5045
_see_also = ['repositories']
5046
takes_args = ['branch_or_repo?']
5048
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5051
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5052
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5054
branch = dir.open_branch()
5055
repository = branch.repository
5056
except errors.NotBranchError:
5057
repository = dir.open_repository()
5058
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5061
class cmd_plugins(Command):
5062
__doc__ = """List the installed plugins.
5064
This command displays the list of installed plugins including
5065
version of plugin and a short description of each.
5067
--verbose shows the path where each plugin is located.
5069
A plugin is an external component for Bazaar that extends the
5070
revision control system, by adding or replacing code in Bazaar.
5071
Plugins can do a variety of things, including overriding commands,
5072
adding new commands, providing additional network transports and
5073
customizing log output.
5075
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5076
for further information on plugins including where to find them and how to
5077
install them. Instructions are also provided there on how to write new
5078
plugins using the Python programming language.
5080
takes_options = ['verbose']
5083
def run(self, verbose=False):
5084
from bzrlib import plugin
5085
# Don't give writelines a generator as some codecs don't like that
5086
self.outf.writelines(
5087
list(plugin.describe_plugins(show_paths=verbose)))
5090
class cmd_testament(Command):
5091
__doc__ = """Show testament (signing-form) of a revision."""
5094
Option('long', help='Produce long-format testament.'),
5096
help='Produce a strict-format testament.')]
5097
takes_args = ['branch?']
5099
def run(self, branch=u'.', revision=None, long=False, strict=False):
5100
from bzrlib.testament import Testament, StrictTestament
5102
testament_class = StrictTestament
5104
testament_class = Testament
5106
b = Branch.open_containing(branch)[0]
5108
b = Branch.open(branch)
5109
self.add_cleanup(b.lock_read().unlock)
5110
if revision is None:
5111
rev_id = b.last_revision()
5113
rev_id = revision[0].as_revision_id(b)
5114
t = testament_class.from_revision(b.repository, rev_id)
5116
sys.stdout.writelines(t.as_text_lines())
5118
sys.stdout.write(t.as_short_text())
5121
class cmd_annotate(Command):
5122
__doc__ = """Show the origin of each line in a file.
5124
This prints out the given file with an annotation on the left side
5125
indicating which revision, author and date introduced the change.
5127
If the origin is the same for a run of consecutive lines, it is
5128
shown only at the top, unless the --all option is given.
5130
# TODO: annotate directories; showing when each file was last changed
5131
# TODO: if the working copy is modified, show annotations on that
5132
# with new uncommitted lines marked
5133
aliases = ['ann', 'blame', 'praise']
5134
takes_args = ['filename']
5135
takes_options = [Option('all', help='Show annotations on all lines.'),
5136
Option('long', help='Show commit date in annotations.'),
5141
encoding_type = 'exact'
5144
def run(self, filename, all=False, long=False, revision=None,
5145
show_ids=False, directory=None):
5146
from bzrlib.annotate import (
5149
wt, branch, relpath = \
5150
_open_directory_or_containing_tree_or_branch(filename, directory)
5152
self.add_cleanup(wt.lock_read().unlock)
5154
self.add_cleanup(branch.lock_read().unlock)
5155
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5156
self.add_cleanup(tree.lock_read().unlock)
5157
if wt is not None and revision is None:
5158
file_id = wt.path2id(relpath)
5160
file_id = tree.path2id(relpath)
5162
raise errors.NotVersionedError(filename)
5163
if wt is not None and revision is None:
5164
# If there is a tree and we're not annotating historical
5165
# versions, annotate the working tree's content.
5166
annotate_file_tree(wt, file_id, self.outf, long, all,
5169
annotate_file_tree(tree, file_id, self.outf, long, all,
5170
show_ids=show_ids, branch=branch)
5173
class cmd_re_sign(Command):
5174
__doc__ = """Create a digital signature for an existing revision."""
5175
# TODO be able to replace existing ones.
5177
hidden = True # is this right ?
5178
takes_args = ['revision_id*']
5179
takes_options = ['directory', 'revision']
5181
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5182
if revision_id_list is not None and revision is not None:
5183
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5184
if revision_id_list is None and revision is None:
5185
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5186
b = WorkingTree.open_containing(directory)[0].branch
5187
self.add_cleanup(b.lock_write().unlock)
5188
return self._run(b, revision_id_list, revision)
5190
def _run(self, b, revision_id_list, revision):
5191
import bzrlib.gpg as gpg
5192
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5193
if revision_id_list is not None:
5194
b.repository.start_write_group()
5196
for revision_id in revision_id_list:
5197
b.repository.sign_revision(revision_id, gpg_strategy)
5199
b.repository.abort_write_group()
5202
b.repository.commit_write_group()
5203
elif revision is not None:
5204
if len(revision) == 1:
5205
revno, rev_id = revision[0].in_history(b)
5206
b.repository.start_write_group()
5208
b.repository.sign_revision(rev_id, gpg_strategy)
5210
b.repository.abort_write_group()
5213
b.repository.commit_write_group()
5214
elif len(revision) == 2:
5215
# are they both on rh- if so we can walk between them
5216
# might be nice to have a range helper for arbitrary
5217
# revision paths. hmm.
5218
from_revno, from_revid = revision[0].in_history(b)
5219
to_revno, to_revid = revision[1].in_history(b)
5220
if to_revid is None:
5221
to_revno = b.revno()
5222
if from_revno is None or to_revno is None:
5223
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5224
b.repository.start_write_group()
5226
for revno in range(from_revno, to_revno + 1):
5227
b.repository.sign_revision(b.get_rev_id(revno),
5230
b.repository.abort_write_group()
5233
b.repository.commit_write_group()
5235
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5238
class cmd_bind(Command):
5239
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5240
If no branch is supplied, rebind to the last bound location.
5242
Once converted into a checkout, commits must succeed on the master branch
5243
before they will be applied to the local branch.
5245
Bound branches use the nickname of its master branch unless it is set
5246
locally, in which case binding will update the local nickname to be
5250
_see_also = ['checkouts', 'unbind']
5251
takes_args = ['location?']
5252
takes_options = ['directory']
5254
def run(self, location=None, directory=u'.'):
5255
b, relpath = Branch.open_containing(directory)
5256
if location is None:
5258
location = b.get_old_bound_location()
5259
except errors.UpgradeRequired:
5260
raise errors.BzrCommandError(gettext('No location supplied. '
5261
'This format does not remember old locations.'))
5263
if location is None:
5264
if b.get_bound_location() is not None:
5265
raise errors.BzrCommandError(gettext('Branch is already bound'))
5267
raise errors.BzrCommandError(gettext('No location supplied '
5268
'and no previous location known'))
5269
b_other = Branch.open(location)
5272
except errors.DivergedBranches:
5273
raise errors.BzrCommandError(gettext('These branches have diverged.'
5274
' Try merging, and then bind again.'))
5275
if b.get_config().has_explicit_nickname():
5276
b.nick = b_other.nick
5279
class cmd_unbind(Command):
5280
__doc__ = """Convert the current checkout into a regular branch.
5282
After unbinding, the local branch is considered independent and subsequent
5283
commits will be local only.
5286
_see_also = ['checkouts', 'bind']
5288
takes_options = ['directory']
5290
def run(self, directory=u'.'):
5291
b, relpath = Branch.open_containing(directory)
5293
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5296
class cmd_uncommit(Command):
5297
__doc__ = """Remove the last committed revision.
5299
--verbose will print out what is being removed.
5300
--dry-run will go through all the motions, but not actually
5303
If --revision is specified, uncommit revisions to leave the branch at the
5304
specified revision. For example, "bzr uncommit -r 15" will leave the
5305
branch at revision 15.
5307
Uncommit leaves the working tree ready for a new commit. The only change
5308
it may make is to restore any pending merges that were present before
5312
# TODO: jam 20060108 Add an option to allow uncommit to remove
5313
# unreferenced information in 'branch-as-repository' branches.
5314
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5315
# information in shared branches as well.
5316
_see_also = ['commit']
5317
takes_options = ['verbose', 'revision',
5318
Option('dry-run', help='Don\'t actually make changes.'),
5319
Option('force', help='Say yes to all questions.'),
5321
help='Keep tags that point to removed revisions.'),
5323
help="Only remove the commits from the local branch"
5324
" when in a checkout."
5327
takes_args = ['location?']
5329
encoding_type = 'replace'
5331
def run(self, location=None, dry_run=False, verbose=False,
5332
revision=None, force=False, local=False, keep_tags=False):
5333
if location is None:
5335
control, relpath = controldir.ControlDir.open_containing(location)
5337
tree = control.open_workingtree()
5339
except (errors.NoWorkingTree, errors.NotLocalUrl):
5341
b = control.open_branch()
5343
if tree is not None:
5344
self.add_cleanup(tree.lock_write().unlock)
5346
self.add_cleanup(b.lock_write().unlock)
5347
return self._run(b, tree, dry_run, verbose, revision, force,
5350
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5352
from bzrlib.log import log_formatter, show_log
5353
from bzrlib.uncommit import uncommit
5355
last_revno, last_rev_id = b.last_revision_info()
5358
if revision is None:
5360
rev_id = last_rev_id
5362
# 'bzr uncommit -r 10' actually means uncommit
5363
# so that the final tree is at revno 10.
5364
# but bzrlib.uncommit.uncommit() actually uncommits
5365
# the revisions that are supplied.
5366
# So we need to offset it by one
5367
revno = revision[0].in_history(b).revno + 1
5368
if revno <= last_revno:
5369
rev_id = b.get_rev_id(revno)
5371
if rev_id is None or _mod_revision.is_null(rev_id):
5372
self.outf.write(gettext('No revisions to uncommit.\n'))
5375
lf = log_formatter('short',
5377
show_timezone='original')
5382
direction='forward',
5383
start_revision=revno,
5384
end_revision=last_revno)
5387
self.outf.write(gettext('Dry-run, pretending to remove'
5388
' the above revisions.\n'))
5390
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5393
if not ui.ui_factory.confirm_action(
5394
gettext(u'Uncommit these revisions'),
5395
'bzrlib.builtins.uncommit',
5397
self.outf.write(gettext('Canceled\n'))
5400
mutter('Uncommitting from {%s} to {%s}',
5401
last_rev_id, rev_id)
5402
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5403
revno=revno, local=local, keep_tags=keep_tags)
5404
self.outf.write(gettext('You can restore the old tip by running:\n'
5405
' bzr pull . -r revid:%s\n') % last_rev_id)
5408
class cmd_break_lock(Command):
5409
__doc__ = """Break a dead lock.
5411
This command breaks a lock on a repository, branch, working directory or
5414
CAUTION: Locks should only be broken when you are sure that the process
5415
holding the lock has been stopped.
5417
You can get information on what locks are open via the 'bzr info
5418
[location]' command.
5422
bzr break-lock bzr+ssh://example.com/bzr/foo
5423
bzr break-lock --conf ~/.bazaar
5426
takes_args = ['location?']
5429
help='LOCATION is the directory where the config lock is.'),
5431
help='Do not ask for confirmation before breaking the lock.'),
5434
def run(self, location=None, config=False, force=False):
5435
if location is None:
5438
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5440
{'bzrlib.lockdir.break': True})
5442
conf = _mod_config.LockableConfig(file_name=location)
5445
control, relpath = controldir.ControlDir.open_containing(location)
5447
control.break_lock()
5448
except NotImplementedError:
5452
class cmd_wait_until_signalled(Command):
5453
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5455
This just prints a line to signal when it is ready, then blocks on stdin.
5461
sys.stdout.write("running\n")
5463
sys.stdin.readline()
5466
class cmd_serve(Command):
5467
__doc__ = """Run the bzr server."""
5469
aliases = ['server']
5473
help='Serve on stdin/out for use from inetd or sshd.'),
5474
RegistryOption('protocol',
5475
help="Protocol to serve.",
5476
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5477
value_switches=True),
5479
help='Listen for connections on nominated port of the form '
5480
'[hostname:]portnumber. Passing 0 as the port number will '
5481
'result in a dynamically allocated port. The default port '
5482
'depends on the protocol.',
5484
custom_help('directory',
5485
help='Serve contents of this directory.'),
5486
Option('allow-writes',
5487
help='By default the server is a readonly server. Supplying '
5488
'--allow-writes enables write access to the contents of '
5489
'the served directory and below. Note that ``bzr serve`` '
5490
'does not perform authentication, so unless some form of '
5491
'external authentication is arranged supplying this '
5492
'option leads to global uncontrolled write access to your '
5495
Option('client-timeout', type=float,
5496
help='Override the default idle client timeout (5min).'),
5499
def get_host_and_port(self, port):
5500
"""Return the host and port to run the smart server on.
5502
If 'port' is None, None will be returned for the host and port.
5504
If 'port' has a colon in it, the string before the colon will be
5505
interpreted as the host.
5507
:param port: A string of the port to run the server on.
5508
:return: A tuple of (host, port), where 'host' is a host name or IP,
5509
and port is an integer TCP/IP port.
5512
if port is not None:
5514
host, port = port.split(':')
5518
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5519
protocol=None, client_timeout=None):
5520
from bzrlib import transport
5521
if directory is None:
5522
directory = os.getcwd()
5523
if protocol is None:
5524
protocol = transport.transport_server_registry.get()
5525
host, port = self.get_host_and_port(port)
5526
url = transport.location_to_url(directory)
5527
if not allow_writes:
5528
url = 'readonly+' + url
5529
t = transport.get_transport_from_url(url)
5531
protocol(t, host, port, inet, client_timeout)
5532
except TypeError, e:
5533
# We use symbol_versioning.deprecated_in just so that people
5534
# grepping can find it here.
5535
# symbol_versioning.deprecated_in((2, 5, 0))
5536
symbol_versioning.warn(
5537
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5538
'Most likely it needs to be updated to support a'
5539
' "timeout" parameter (added in bzr 2.5.0)'
5540
% (e, protocol.__module__, protocol),
5542
protocol(t, host, port, inet)
5545
class cmd_join(Command):
5546
__doc__ = """Combine a tree into its containing tree.
5548
This command requires the target tree to be in a rich-root format.
5550
The TREE argument should be an independent tree, inside another tree, but
5551
not part of it. (Such trees can be produced by "bzr split", but also by
5552
running "bzr branch" with the target inside a tree.)
5554
The result is a combined tree, with the subtree no longer an independent
5555
part. This is marked as a merge of the subtree into the containing tree,
5556
and all history is preserved.
5559
_see_also = ['split']
5560
takes_args = ['tree']
5562
Option('reference', help='Join by reference.', hidden=True),
5565
def run(self, tree, reference=False):
5566
sub_tree = WorkingTree.open(tree)
5567
parent_dir = osutils.dirname(sub_tree.basedir)
5568
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5569
repo = containing_tree.branch.repository
5570
if not repo.supports_rich_root():
5571
raise errors.BzrCommandError(gettext(
5572
"Can't join trees because %s doesn't support rich root data.\n"
5573
"You can use bzr upgrade on the repository.")
5577
containing_tree.add_reference(sub_tree)
5578
except errors.BadReferenceTarget, e:
5579
# XXX: Would be better to just raise a nicely printable
5580
# exception from the real origin. Also below. mbp 20070306
5581
raise errors.BzrCommandError(
5582
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5585
containing_tree.subsume(sub_tree)
5586
except errors.BadSubsumeSource, e:
5587
raise errors.BzrCommandError(
5588
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5591
class cmd_split(Command):
5592
__doc__ = """Split a subdirectory of a tree into a separate tree.
5594
This command will produce a target tree in a format that supports
5595
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5596
converted into earlier formats like 'dirstate-tags'.
5598
The TREE argument should be a subdirectory of a working tree. That
5599
subdirectory will be converted into an independent tree, with its own
5600
branch. Commits in the top-level tree will not apply to the new subtree.
5603
_see_also = ['join']
5604
takes_args = ['tree']
5606
def run(self, tree):
5607
containing_tree, subdir = WorkingTree.open_containing(tree)
5608
sub_id = containing_tree.path2id(subdir)
5610
raise errors.NotVersionedError(subdir)
5612
containing_tree.extract(sub_id)
5613
except errors.RootNotRich:
5614
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5617
class cmd_merge_directive(Command):
5618
__doc__ = """Generate a merge directive for auto-merge tools.
5620
A directive requests a merge to be performed, and also provides all the
5621
information necessary to do so. This means it must either include a
5622
revision bundle, or the location of a branch containing the desired
5625
A submit branch (the location to merge into) must be supplied the first
5626
time the command is issued. After it has been supplied once, it will
5627
be remembered as the default.
5629
A public branch is optional if a revision bundle is supplied, but required
5630
if --diff or --plain is specified. It will be remembered as the default
5631
after the first use.
5634
takes_args = ['submit_branch?', 'public_branch?']
5638
_see_also = ['send']
5642
RegistryOption.from_kwargs('patch-type',
5643
'The type of patch to include in the directive.',
5645
value_switches=True,
5647
bundle='Bazaar revision bundle (default).',
5648
diff='Normal unified diff.',
5649
plain='No patch, just directive.'),
5650
Option('sign', help='GPG-sign the directive.'), 'revision',
5651
Option('mail-to', type=str,
5652
help='Instead of printing the directive, email to this address.'),
5653
Option('message', type=str, short_name='m',
5654
help='Message to use when committing this merge.')
5657
encoding_type = 'exact'
5659
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5660
sign=False, revision=None, mail_to=None, message=None,
5662
from bzrlib.revision import ensure_null, NULL_REVISION
5663
include_patch, include_bundle = {
5664
'plain': (False, False),
5665
'diff': (True, False),
5666
'bundle': (True, True),
5668
branch = Branch.open(directory)
5669
stored_submit_branch = branch.get_submit_branch()
5670
if submit_branch is None:
5671
submit_branch = stored_submit_branch
5673
if stored_submit_branch is None:
5674
branch.set_submit_branch(submit_branch)
5675
if submit_branch is None:
5676
submit_branch = branch.get_parent()
5677
if submit_branch is None:
5678
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5680
stored_public_branch = branch.get_public_branch()
5681
if public_branch is None:
5682
public_branch = stored_public_branch
5683
elif stored_public_branch is None:
5684
branch.set_public_branch(public_branch)
5685
if not include_bundle and public_branch is None:
5686
raise errors.BzrCommandError(gettext('No public branch specified or'
5688
base_revision_id = None
5689
if revision is not None:
5690
if len(revision) > 2:
5691
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5692
'at most two one revision identifiers'))
5693
revision_id = revision[-1].as_revision_id(branch)
5694
if len(revision) == 2:
5695
base_revision_id = revision[0].as_revision_id(branch)
5697
revision_id = branch.last_revision()
5698
revision_id = ensure_null(revision_id)
5699
if revision_id == NULL_REVISION:
5700
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5701
directive = merge_directive.MergeDirective2.from_objects(
5702
branch.repository, revision_id, time.time(),
5703
osutils.local_time_offset(), submit_branch,
5704
public_branch=public_branch, include_patch=include_patch,
5705
include_bundle=include_bundle, message=message,
5706
base_revision_id=base_revision_id)
5709
self.outf.write(directive.to_signed(branch))
5711
self.outf.writelines(directive.to_lines())
5713
message = directive.to_email(mail_to, branch, sign)
5714
s = SMTPConnection(branch.get_config_stack())
5715
s.send_email(message)
5718
class cmd_send(Command):
5719
__doc__ = """Mail or create a merge-directive for submitting changes.
5721
A merge directive provides many things needed for requesting merges:
5723
* A machine-readable description of the merge to perform
5725
* An optional patch that is a preview of the changes requested
5727
* An optional bundle of revision data, so that the changes can be applied
5728
directly from the merge directive, without retrieving data from a
5731
`bzr send` creates a compact data set that, when applied using bzr
5732
merge, has the same effect as merging from the source branch.
5734
By default the merge directive is self-contained and can be applied to any
5735
branch containing submit_branch in its ancestory without needing access to
5738
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5739
revisions, but only a structured request to merge from the
5740
public_location. In that case the public_branch is needed and it must be
5741
up-to-date and accessible to the recipient. The public_branch is always
5742
included if known, so that people can check it later.
5744
The submit branch defaults to the parent of the source branch, but can be
5745
overridden. Both submit branch and public branch will be remembered in
5746
branch.conf the first time they are used for a particular branch. The
5747
source branch defaults to that containing the working directory, but can
5748
be changed using --from.
5750
Both the submit branch and the public branch follow the usual behavior with
5751
respect to --remember: If there is no default location set, the first send
5752
will set it (use --no-remember to avoid setting it). After that, you can
5753
omit the location to use the default. To change the default, use
5754
--remember. The value will only be saved if the location can be accessed.
5756
In order to calculate those changes, bzr must analyse the submit branch.
5757
Therefore it is most efficient for the submit branch to be a local mirror.
5758
If a public location is known for the submit_branch, that location is used
5759
in the merge directive.
5761
The default behaviour is to send the merge directive by mail, unless -o is
5762
given, in which case it is sent to a file.
5764
Mail is sent using your preferred mail program. This should be transparent
5765
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5766
If the preferred client can't be found (or used), your editor will be used.
5768
To use a specific mail program, set the mail_client configuration option.
5769
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5770
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5771
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5772
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5775
If mail is being sent, a to address is required. This can be supplied
5776
either on the commandline, by setting the submit_to configuration
5777
option in the branch itself or the child_submit_to configuration option
5778
in the submit branch.
5780
Two formats are currently supported: "4" uses revision bundle format 4 and
5781
merge directive format 2. It is significantly faster and smaller than
5782
older formats. It is compatible with Bazaar 0.19 and later. It is the
5783
default. "0.9" uses revision bundle format 0.9 and merge directive
5784
format 1. It is compatible with Bazaar 0.12 - 0.18.
5786
The merge directives created by bzr send may be applied using bzr merge or
5787
bzr pull by specifying a file containing a merge directive as the location.
5789
bzr send makes extensive use of public locations to map local locations into
5790
URLs that can be used by other people. See `bzr help configuration` to
5791
set them, and use `bzr info` to display them.
5794
encoding_type = 'exact'
5796
_see_also = ['merge', 'pull']
5798
takes_args = ['submit_branch?', 'public_branch?']
5802
help='Do not include a bundle in the merge directive.'),
5803
Option('no-patch', help='Do not include a preview patch in the merge'
5806
help='Remember submit and public branch.'),
5808
help='Branch to generate the submission from, '
5809
'rather than the one containing the working directory.',
5812
Option('output', short_name='o',
5813
help='Write merge directive to this file or directory; '
5814
'use - for stdout.',
5817
help='Refuse to send if there are uncommitted changes in'
5818
' the working tree, --no-strict disables the check.'),
5819
Option('mail-to', help='Mail the request to this address.',
5823
Option('body', help='Body for the email.', type=unicode),
5824
RegistryOption('format',
5825
help='Use the specified output format.',
5826
lazy_registry=('bzrlib.send', 'format_registry')),
5829
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5830
no_patch=False, revision=None, remember=None, output=None,
5831
format=None, mail_to=None, message=None, body=None,
5832
strict=None, **kwargs):
5833
from bzrlib.send import send
5834
return send(submit_branch, revision, public_branch, remember,
5835
format, no_bundle, no_patch, output,
5836
kwargs.get('from', '.'), mail_to, message, body,
5841
class cmd_bundle_revisions(cmd_send):
5842
__doc__ = """Create a merge-directive for submitting changes.
5844
A merge directive provides many things needed for requesting merges:
5846
* A machine-readable description of the merge to perform
5848
* An optional patch that is a preview of the changes requested
5850
* An optional bundle of revision data, so that the changes can be applied
5851
directly from the merge directive, without retrieving data from a
5854
If --no-bundle is specified, then public_branch is needed (and must be
5855
up-to-date), so that the receiver can perform the merge using the
5856
public_branch. The public_branch is always included if known, so that
5857
people can check it later.
5859
The submit branch defaults to the parent, but can be overridden. Both
5860
submit branch and public branch will be remembered if supplied.
5862
If a public_branch is known for the submit_branch, that public submit
5863
branch is used in the merge instructions. This means that a local mirror
5864
can be used as your actual submit branch, once you have set public_branch
5867
Two formats are currently supported: "4" uses revision bundle format 4 and
5868
merge directive format 2. It is significantly faster and smaller than
5869
older formats. It is compatible with Bazaar 0.19 and later. It is the
5870
default. "0.9" uses revision bundle format 0.9 and merge directive
5871
format 1. It is compatible with Bazaar 0.12 - 0.18.
5876
help='Do not include a bundle in the merge directive.'),
5877
Option('no-patch', help='Do not include a preview patch in the merge'
5880
help='Remember submit and public branch.'),
5882
help='Branch to generate the submission from, '
5883
'rather than the one containing the working directory.',
5886
Option('output', short_name='o', help='Write directive to this file.',
5889
help='Refuse to bundle revisions if there are uncommitted'
5890
' changes in the working tree, --no-strict disables the check.'),
5892
RegistryOption('format',
5893
help='Use the specified output format.',
5894
lazy_registry=('bzrlib.send', 'format_registry')),
5896
aliases = ['bundle']
5898
_see_also = ['send', 'merge']
5902
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5903
no_patch=False, revision=None, remember=False, output=None,
5904
format=None, strict=None, **kwargs):
5907
from bzrlib.send import send
5908
return send(submit_branch, revision, public_branch, remember,
5909
format, no_bundle, no_patch, output,
5910
kwargs.get('from', '.'), None, None, None,
5911
self.outf, strict=strict)
5914
class cmd_tag(Command):
5915
__doc__ = """Create, remove or modify a tag naming a revision.
5917
Tags give human-meaningful names to revisions. Commands that take a -r
5918
(--revision) option can be given -rtag:X, where X is any previously
5921
Tags are stored in the branch. Tags are copied from one branch to another
5922
along when you branch, push, pull or merge.
5924
It is an error to give a tag name that already exists unless you pass
5925
--force, in which case the tag is moved to point to the new revision.
5927
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5928
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5930
If no tag name is specified it will be determined through the
5931
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5932
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5936
_see_also = ['commit', 'tags']
5937
takes_args = ['tag_name?']
5940
help='Delete this tag rather than placing it.',
5942
custom_help('directory',
5943
help='Branch in which to place the tag.'),
5945
help='Replace existing tags.',
5950
def run(self, tag_name=None,
5956
branch, relpath = Branch.open_containing(directory)
5957
self.add_cleanup(branch.lock_write().unlock)
5959
if tag_name is None:
5960
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5961
branch.tags.delete_tag(tag_name)
5962
note(gettext('Deleted tag %s.') % tag_name)
5965
if len(revision) != 1:
5966
raise errors.BzrCommandError(gettext(
5967
"Tags can only be placed on a single revision, "
5969
revision_id = revision[0].as_revision_id(branch)
5971
revision_id = branch.last_revision()
5972
if tag_name is None:
5973
tag_name = branch.automatic_tag_name(revision_id)
5974
if tag_name is None:
5975
raise errors.BzrCommandError(gettext(
5976
"Please specify a tag name."))
5978
existing_target = branch.tags.lookup_tag(tag_name)
5979
except errors.NoSuchTag:
5980
existing_target = None
5981
if not force and existing_target not in (None, revision_id):
5982
raise errors.TagAlreadyExists(tag_name)
5983
if existing_target == revision_id:
5984
note(gettext('Tag %s already exists for that revision.') % tag_name)
5986
branch.tags.set_tag(tag_name, revision_id)
5987
if existing_target is None:
5988
note(gettext('Created tag %s.') % tag_name)
5990
note(gettext('Updated tag %s.') % tag_name)
5993
class cmd_tags(Command):
5994
__doc__ = """List tags.
5996
This command shows a table of tag names and the revisions they reference.
6001
custom_help('directory',
6002
help='Branch whose tags should be displayed.'),
6003
RegistryOption('sort',
6004
'Sort tags by different criteria.', title='Sorting',
6005
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
6012
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6013
from bzrlib.tag import tag_sort_methods
6014
branch, relpath = Branch.open_containing(directory)
6016
tags = branch.tags.get_tag_dict().items()
6020
self.add_cleanup(branch.lock_read().unlock)
6022
# Restrict to the specified range
6023
tags = self._tags_for_range(branch, revision)
6025
sort = tag_sort_methods.get()
6028
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6029
for index, (tag, revid) in enumerate(tags):
6031
revno = branch.revision_id_to_dotted_revno(revid)
6032
if isinstance(revno, tuple):
6033
revno = '.'.join(map(str, revno))
6034
except (errors.NoSuchRevision,
6035
errors.GhostRevisionsHaveNoRevno,
6036
errors.UnsupportedOperation):
6037
# Bad tag data/merges can lead to tagged revisions
6038
# which are not in this branch. Fail gracefully ...
6040
tags[index] = (tag, revno)
6042
for tag, revspec in tags:
6043
self.outf.write('%-20s %s\n' % (tag, revspec))
6045
def _tags_for_range(self, branch, revision):
6047
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6048
revid1, revid2 = rev1.rev_id, rev2.rev_id
6049
# _get_revision_range will always set revid2 if it's not specified.
6050
# If revid1 is None, it means we want to start from the branch
6051
# origin which is always a valid ancestor. If revid1 == revid2, the
6052
# ancestry check is useless.
6053
if revid1 and revid1 != revid2:
6054
# FIXME: We really want to use the same graph than
6055
# branch.iter_merge_sorted_revisions below, but this is not
6056
# easily available -- vila 2011-09-23
6057
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6058
# We don't want to output anything in this case...
6060
# only show revisions between revid1 and revid2 (inclusive)
6061
tagged_revids = branch.tags.get_reverse_tag_dict()
6063
for r in branch.iter_merge_sorted_revisions(
6064
start_revision_id=revid2, stop_revision_id=revid1,
6065
stop_rule='include'):
6066
revid_tags = tagged_revids.get(r[0], None)
6068
found.extend([(tag, r[0]) for tag in revid_tags])
6072
class cmd_reconfigure(Command):
6073
__doc__ = """Reconfigure the type of a bzr directory.
6075
A target configuration must be specified.
6077
For checkouts, the bind-to location will be auto-detected if not specified.
6078
The order of preference is
6079
1. For a lightweight checkout, the current bound location.
6080
2. For branches that used to be checkouts, the previously-bound location.
6081
3. The push location.
6082
4. The parent location.
6083
If none of these is available, --bind-to must be specified.
6086
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6087
takes_args = ['location?']
6089
RegistryOption.from_kwargs(
6092
help='The relation between branch and tree.',
6093
value_switches=True, enum_switch=False,
6094
branch='Reconfigure to be an unbound branch with no working tree.',
6095
tree='Reconfigure to be an unbound branch with a working tree.',
6096
checkout='Reconfigure to be a bound branch with a working tree.',
6097
lightweight_checkout='Reconfigure to be a lightweight'
6098
' checkout (with no local history).',
6100
RegistryOption.from_kwargs(
6102
title='Repository type',
6103
help='Location fo the repository.',
6104
value_switches=True, enum_switch=False,
6105
standalone='Reconfigure to be a standalone branch '
6106
'(i.e. stop using shared repository).',
6107
use_shared='Reconfigure to use a shared repository.',
6109
RegistryOption.from_kwargs(
6111
title='Trees in Repository',
6112
help='Whether new branches in the repository have trees.',
6113
value_switches=True, enum_switch=False,
6114
with_trees='Reconfigure repository to create '
6115
'working trees on branches by default.',
6116
with_no_trees='Reconfigure repository to not create '
6117
'working trees on branches by default.'
6119
Option('bind-to', help='Branch to bind checkout to.', type=str),
6121
help='Perform reconfiguration even if local changes'
6123
Option('stacked-on',
6124
help='Reconfigure a branch to be stacked on another branch.',
6128
help='Reconfigure a branch to be unstacked. This '
6129
'may require copying substantial data into it.',
6133
def run(self, location=None, bind_to=None, force=False,
6134
tree_type=None, repository_type=None, repository_trees=None,
6135
stacked_on=None, unstacked=None):
6136
directory = controldir.ControlDir.open(location)
6137
if stacked_on and unstacked:
6138
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6139
elif stacked_on is not None:
6140
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6142
reconfigure.ReconfigureUnstacked().apply(directory)
6143
# At the moment you can use --stacked-on and a different
6144
# reconfiguration shape at the same time; there seems no good reason
6146
if (tree_type is None and
6147
repository_type is None and
6148
repository_trees is None):
6149
if stacked_on or unstacked:
6152
raise errors.BzrCommandError(gettext('No target configuration '
6154
reconfiguration = None
6155
if tree_type == 'branch':
6156
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6157
elif tree_type == 'tree':
6158
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6159
elif tree_type == 'checkout':
6160
reconfiguration = reconfigure.Reconfigure.to_checkout(
6162
elif tree_type == 'lightweight-checkout':
6163
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6166
reconfiguration.apply(force)
6167
reconfiguration = None
6168
if repository_type == 'use-shared':
6169
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6170
elif repository_type == 'standalone':
6171
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6173
reconfiguration.apply(force)
6174
reconfiguration = None
6175
if repository_trees == 'with-trees':
6176
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6178
elif repository_trees == 'with-no-trees':
6179
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6182
reconfiguration.apply(force)
6183
reconfiguration = None
6186
class cmd_switch(Command):
6187
__doc__ = """Set the branch of a checkout and update.
6189
For lightweight checkouts, this changes the branch being referenced.
6190
For heavyweight checkouts, this checks that there are no local commits
6191
versus the current bound branch, then it makes the local branch a mirror
6192
of the new location and binds to it.
6194
In both cases, the working tree is updated and uncommitted changes
6195
are merged. The user can commit or revert these as they desire.
6197
Pending merges need to be committed or reverted before using switch.
6199
The path to the branch to switch to can be specified relative to the parent
6200
directory of the current branch. For example, if you are currently in a
6201
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6204
Bound branches use the nickname of its master branch unless it is set
6205
locally, in which case switching will update the local nickname to be
6209
takes_args = ['to_location?']
6210
takes_options = ['directory',
6212
help='Switch even if local commits will be lost.'),
6214
Option('create-branch', short_name='b',
6215
help='Create the target branch from this one before'
6216
' switching to it.'),
6219
def run(self, to_location=None, force=False, create_branch=False,
6220
revision=None, directory=u'.'):
6221
from bzrlib import switch
6222
tree_location = directory
6223
revision = _get_one_revision('switch', revision)
6224
possible_transports = []
6225
control_dir = controldir.ControlDir.open_containing(tree_location,
6226
possible_transports=possible_transports)[0]
6227
if to_location is None:
6228
if revision is None:
6229
raise errors.BzrCommandError(gettext('You must supply either a'
6230
' revision or a location'))
6231
to_location = tree_location
6233
branch = control_dir.open_branch(
6234
possible_transports=possible_transports)
6235
had_explicit_nick = branch.get_config().has_explicit_nickname()
6236
except errors.NotBranchError:
6238
had_explicit_nick = False
6241
raise errors.BzrCommandError(
6242
gettext('cannot create branch without source branch'))
6243
to_location = lookup_new_sibling_branch(control_dir, to_location,
6244
possible_transports=possible_transports)
6245
to_branch = branch.bzrdir.sprout(to_location,
6246
possible_transports=possible_transports,
6247
source_branch=branch).open_branch()
6249
to_branch = lookup_sibling_branch(control_dir, to_location)
6250
if revision is not None:
6251
revision = revision.as_revision_id(to_branch)
6252
switch.switch(control_dir, to_branch, force, revision_id=revision)
6253
if had_explicit_nick:
6254
branch = control_dir.open_branch() #get the new branch!
6255
branch.nick = to_branch.nick
6256
note(gettext('Switched to branch: %s'),
6257
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6261
class cmd_view(Command):
6262
__doc__ = """Manage filtered views.
6264
Views provide a mask over the tree so that users can focus on
6265
a subset of a tree when doing their work. After creating a view,
6266
commands that support a list of files - status, diff, commit, etc -
6267
effectively have that list of files implicitly given each time.
6268
An explicit list of files can still be given but those files
6269
must be within the current view.
6271
In most cases, a view has a short life-span: it is created to make
6272
a selected change and is deleted once that change is committed.
6273
At other times, you may wish to create one or more named views
6274
and switch between them.
6276
To disable the current view without deleting it, you can switch to
6277
the pseudo view called ``off``. This can be useful when you need
6278
to see the whole tree for an operation or two (e.g. merge) but
6279
want to switch back to your view after that.
6282
To define the current view::
6284
bzr view file1 dir1 ...
6286
To list the current view::
6290
To delete the current view::
6294
To disable the current view without deleting it::
6296
bzr view --switch off
6298
To define a named view and switch to it::
6300
bzr view --name view-name file1 dir1 ...
6302
To list a named view::
6304
bzr view --name view-name
6306
To delete a named view::
6308
bzr view --name view-name --delete
6310
To switch to a named view::
6312
bzr view --switch view-name
6314
To list all views defined::
6318
To delete all views::
6320
bzr view --delete --all
6324
takes_args = ['file*']
6327
help='Apply list or delete action to all views.',
6330
help='Delete the view.',
6333
help='Name of the view to define, list or delete.',
6337
help='Name of the view to switch to.',
6342
def run(self, file_list,
6348
tree, file_list = WorkingTree.open_containing_paths(file_list,
6350
current_view, view_dict = tree.views.get_view_info()
6355
raise errors.BzrCommandError(gettext(
6356
"Both --delete and a file list specified"))
6358
raise errors.BzrCommandError(gettext(
6359
"Both --delete and --switch specified"))
6361
tree.views.set_view_info(None, {})
6362
self.outf.write(gettext("Deleted all views.\n"))
6364
raise errors.BzrCommandError(gettext("No current view to delete"))
6366
tree.views.delete_view(name)
6367
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6370
raise errors.BzrCommandError(gettext(
6371
"Both --switch and a file list specified"))
6373
raise errors.BzrCommandError(gettext(
6374
"Both --switch and --all specified"))
6375
elif switch == 'off':
6376
if current_view is None:
6377
raise errors.BzrCommandError(gettext("No current view to disable"))
6378
tree.views.set_view_info(None, view_dict)
6379
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6381
tree.views.set_view_info(switch, view_dict)
6382
view_str = views.view_display_str(tree.views.lookup_view())
6383
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6386
self.outf.write(gettext('Views defined:\n'))
6387
for view in sorted(view_dict):
6388
if view == current_view:
6392
view_str = views.view_display_str(view_dict[view])
6393
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6395
self.outf.write(gettext('No views defined.\n'))
6398
# No name given and no current view set
6401
raise errors.BzrCommandError(gettext(
6402
"Cannot change the 'off' pseudo view"))
6403
tree.views.set_view(name, sorted(file_list))
6404
view_str = views.view_display_str(tree.views.lookup_view())
6405
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6409
# No name given and no current view set
6410
self.outf.write(gettext('No current view.\n'))
6412
view_str = views.view_display_str(tree.views.lookup_view(name))
6413
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6416
class cmd_hooks(Command):
6417
__doc__ = """Show hooks."""
6422
for hook_key in sorted(hooks.known_hooks.keys()):
6423
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6424
self.outf.write("%s:\n" % type(some_hooks).__name__)
6425
for hook_name, hook_point in sorted(some_hooks.items()):
6426
self.outf.write(" %s:\n" % (hook_name,))
6427
found_hooks = list(hook_point)
6429
for hook in found_hooks:
6430
self.outf.write(" %s\n" %
6431
(some_hooks.get_hook_name(hook),))
6433
self.outf.write(gettext(" <no hooks installed>\n"))
6436
class cmd_remove_branch(Command):
6437
__doc__ = """Remove a branch.
6439
This will remove the branch from the specified location but
6440
will keep any working tree or repository in place.
6444
Remove the branch at repo/trunk::
6446
bzr remove-branch repo/trunk
6450
takes_args = ["location?"]
6452
aliases = ["rmbranch"]
6454
def run(self, location=None):
6455
if location is None:
6457
branch = Branch.open_containing(location)[0]
6458
branch.bzrdir.destroy_branch()
6461
class cmd_shelve(Command):
6462
__doc__ = """Temporarily set aside some changes from the current tree.
6464
Shelve allows you to temporarily put changes you've made "on the shelf",
6465
ie. out of the way, until a later time when you can bring them back from
6466
the shelf with the 'unshelve' command. The changes are stored alongside
6467
your working tree, and so they aren't propagated along with your branch nor
6468
will they survive its deletion.
6470
If shelve --list is specified, previously-shelved changes are listed.
6472
Shelve is intended to help separate several sets of changes that have
6473
been inappropriately mingled. If you just want to get rid of all changes
6474
and you don't need to restore them later, use revert. If you want to
6475
shelve all text changes at once, use shelve --all.
6477
If filenames are specified, only the changes to those files will be
6478
shelved. Other files will be left untouched.
6480
If a revision is specified, changes since that revision will be shelved.
6482
You can put multiple items on the shelf, and by default, 'unshelve' will
6483
restore the most recently shelved changes.
6485
For complicated changes, it is possible to edit the changes in a separate
6486
editor program to decide what the file remaining in the working copy
6487
should look like. To do this, add the configuration option
6489
change_editor = PROGRAM @new_path @old_path
6491
where @new_path is replaced with the path of the new version of the
6492
file and @old_path is replaced with the path of the old version of
6493
the file. The PROGRAM should save the new file with the desired
6494
contents of the file in the working tree.
6498
takes_args = ['file*']
6503
Option('all', help='Shelve all changes.'),
6505
RegistryOption('writer', 'Method to use for writing diffs.',
6506
bzrlib.option.diff_writer_registry,
6507
value_switches=True, enum_switch=False),
6509
Option('list', help='List shelved changes.'),
6511
help='Destroy removed changes instead of shelving them.'),
6513
_see_also = ['unshelve', 'configuration']
6515
def run(self, revision=None, all=False, file_list=None, message=None,
6516
writer=None, list=False, destroy=False, directory=None):
6518
return self.run_for_list(directory=directory)
6519
from bzrlib.shelf_ui import Shelver
6521
writer = bzrlib.option.diff_writer_registry.get()
6523
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6524
file_list, message, destroy=destroy, directory=directory)
6529
except errors.UserAbort:
6532
def run_for_list(self, directory=None):
6533
if directory is None:
6535
tree = WorkingTree.open_containing(directory)[0]
6536
self.add_cleanup(tree.lock_read().unlock)
6537
manager = tree.get_shelf_manager()
6538
shelves = manager.active_shelves()
6539
if len(shelves) == 0:
6540
note(gettext('No shelved changes.'))
6542
for shelf_id in reversed(shelves):
6543
message = manager.get_metadata(shelf_id).get('message')
6545
message = '<no message>'
6546
self.outf.write('%3d: %s\n' % (shelf_id, message))
6550
class cmd_unshelve(Command):
6551
__doc__ = """Restore shelved changes.
6553
By default, the most recently shelved changes are restored. However if you
6554
specify a shelf by id those changes will be restored instead. This works
6555
best when the changes don't depend on each other.
6558
takes_args = ['shelf_id?']
6561
RegistryOption.from_kwargs(
6562
'action', help="The action to perform.",
6563
enum_switch=False, value_switches=True,
6564
apply="Apply changes and remove from the shelf.",
6565
dry_run="Show changes, but do not apply or remove them.",
6566
preview="Instead of unshelving the changes, show the diff that "
6567
"would result from unshelving.",
6568
delete_only="Delete changes without applying them.",
6569
keep="Apply changes but don't delete them.",
6572
_see_also = ['shelve']
6574
def run(self, shelf_id=None, action='apply', directory=u'.'):
6575
from bzrlib.shelf_ui import Unshelver
6576
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6580
unshelver.tree.unlock()
6583
class cmd_clean_tree(Command):
6584
__doc__ = """Remove unwanted files from working tree.
6586
By default, only unknown files, not ignored files, are deleted. Versioned
6587
files are never deleted.
6589
Another class is 'detritus', which includes files emitted by bzr during
6590
normal operations and selftests. (The value of these files decreases with
6593
If no options are specified, unknown files are deleted. Otherwise, option
6594
flags are respected, and may be combined.
6596
To check what clean-tree will do, use --dry-run.
6598
takes_options = ['directory',
6599
Option('ignored', help='Delete all ignored files.'),
6600
Option('detritus', help='Delete conflict files, merge and revert'
6601
' backups, and failed selftest dirs.'),
6603
help='Delete files unknown to bzr (default).'),
6604
Option('dry-run', help='Show files to delete instead of'
6606
Option('force', help='Do not prompt before deleting.')]
6607
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6608
force=False, directory=u'.'):
6609
from bzrlib.clean_tree import clean_tree
6610
if not (unknown or ignored or detritus):
6614
clean_tree(directory, unknown=unknown, ignored=ignored,
6615
detritus=detritus, dry_run=dry_run, no_prompt=force)
6618
class cmd_reference(Command):
6619
__doc__ = """list, view and set branch locations for nested trees.
6621
If no arguments are provided, lists the branch locations for nested trees.
6622
If one argument is provided, display the branch location for that tree.
6623
If two arguments are provided, set the branch location for that tree.
6628
takes_args = ['path?', 'location?']
6630
def run(self, path=None, location=None):
6632
if path is not None:
6634
tree, branch, relpath =(
6635
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6636
if path is not None:
6639
tree = branch.basis_tree()
6641
info = branch._get_all_reference_info().iteritems()
6642
self._display_reference_info(tree, branch, info)
6644
file_id = tree.path2id(path)
6646
raise errors.NotVersionedError(path)
6647
if location is None:
6648
info = [(file_id, branch.get_reference_info(file_id))]
6649
self._display_reference_info(tree, branch, info)
6651
branch.set_reference_info(file_id, path, location)
6653
def _display_reference_info(self, tree, branch, info):
6655
for file_id, (path, location) in info:
6657
path = tree.id2path(file_id)
6658
except errors.NoSuchId:
6660
ref_list.append((path, location))
6661
for path, location in sorted(ref_list):
6662
self.outf.write('%s %s\n' % (path, location))
6665
class cmd_export_pot(Command):
6666
__doc__ = """Export command helps and error messages in po format."""
6669
takes_options = [Option('plugin',
6670
help='Export help text from named command '\
6671
'(defaults to all built in commands).',
6673
Option('include-duplicates',
6674
help='Output multiple copies of the same msgid '
6675
'string if it appears more than once.'),
6678
def run(self, plugin=None, include_duplicates=False):
6679
from bzrlib.export_pot import export_pot
6680
export_pot(self.outf, plugin, include_duplicates)
6683
def _register_lazy_builtins():
6684
# register lazy builtins from other modules; called at startup and should
6685
# be only called once.
6686
for (name, aliases, module_name) in [
6687
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6688
('cmd_config', [], 'bzrlib.config'),
6689
('cmd_dpush', [], 'bzrlib.foreign'),
6690
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6691
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6692
('cmd_conflicts', [], 'bzrlib.conflicts'),
6693
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6694
('cmd_verify_signatures', [],
6695
'bzrlib.commit_signature_commands'),
6696
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6698
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
