1
# Copyright (C) 2005-2012 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
19
from __future__ import absolute_import
25
from bzrlib import lazy_import
26
lazy_import.lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
59
from bzrlib.branch import Branch
60
from bzrlib.conflicts import ConflictList
61
from bzrlib.transport import memory
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
63
from bzrlib.smtp_connection import SMTPConnection
64
from bzrlib.workingtree import WorkingTree
65
from bzrlib.i18n import gettext, ngettext
68
from bzrlib.commands import (
70
builtin_command_registry,
73
from bzrlib.option import (
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
86
def _get_branch_location(control_dir, possible_transports=None):
87
"""Return location of branch for this control dir."""
89
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
self.add_cleanup(tree.lock_read().unlock)
941
if file_list is not None:
942
file_ids = tree.paths2ids(file_list, trees=extra_trees,
943
require_versioned=True)
944
# find_ids_across_trees may include some paths that don't
946
entries = tree.iter_entries_by_dir(specific_file_ids=file_ids)
948
entries = tree.iter_entries_by_dir()
950
for path, entry in sorted(entries):
951
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
# 'fix' the case of a potential 'from'
1033
from_id = tree.path2id(
1034
tree.get_canonical_inventory_path(rel_names[0]))
1035
if (not osutils.lexists(names_list[0]) and
1036
from_id and tree.stored_kind(from_id) == "directory"):
1037
into_existing = False
1040
# move into existing directory
1041
# All entries reference existing inventory items, so fix them up
1042
# for cicp file-systems.
1043
rel_names = tree.get_canonical_inventory_paths(rel_names)
1044
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1046
self.outf.write("%s => %s\n" % (src, dest))
1048
if len(names_list) != 2:
1049
raise errors.BzrCommandError(gettext('to mv multiple files the'
1050
' destination must be a versioned'
1053
# for cicp file-systems: the src references an existing inventory
1055
src = tree.get_canonical_inventory_path(rel_names[0])
1056
# Find the canonical version of the destination: In all cases, the
1057
# parent of the target must be in the inventory, so we fetch the
1058
# canonical version from there (we do not always *use* the
1059
# canonicalized tail portion - we may be attempting to rename the
1061
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1062
dest_parent = osutils.dirname(canon_dest)
1063
spec_tail = osutils.basename(rel_names[1])
1064
# For a CICP file-system, we need to avoid creating 2 inventory
1065
# entries that differ only by case. So regardless of the case
1066
# we *want* to use (ie, specified by the user or the file-system),
1067
# we must always choose to use the case of any existing inventory
1068
# items. The only exception to this is when we are attempting a
1069
# case-only rename (ie, canonical versions of src and dest are
1071
dest_id = tree.path2id(canon_dest)
1072
if dest_id is None or tree.path2id(src) == dest_id:
1073
# No existing item we care about, so work out what case we
1074
# are actually going to use.
1076
# If 'after' is specified, the tail must refer to a file on disk.
1078
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1080
# pathjoin with an empty tail adds a slash, which breaks
1082
dest_parent_fq = tree.basedir
1084
dest_tail = osutils.canonical_relpath(
1086
osutils.pathjoin(dest_parent_fq, spec_tail))
1088
# not 'after', so case as specified is used
1089
dest_tail = spec_tail
1091
# Use the existing item so 'mv' fails with AlreadyVersioned.
1092
dest_tail = os.path.basename(canon_dest)
1093
dest = osutils.pathjoin(dest_parent, dest_tail)
1094
mutter("attempting to move %s => %s", src, dest)
1095
tree.rename_one(src, dest, after=after)
1097
self.outf.write("%s => %s\n" % (src, dest))
1100
class cmd_pull(Command):
1101
__doc__ = """Turn this branch into a mirror of another branch.
1103
By default, this command only works on branches that have not diverged.
1104
Branches are considered diverged if the destination branch's most recent
1105
commit is one that has not been merged (directly or indirectly) into the
1108
If branches have diverged, you can use 'bzr merge' to integrate the changes
1109
from one into the other. Once one branch has merged, the other should
1110
be able to pull it again.
1112
If you want to replace your local changes and just want your branch to
1113
match the remote one, use pull --overwrite. This will work even if the two
1114
branches have diverged.
1116
If there is no default location set, the first pull will set it (use
1117
--no-remember to avoid setting it). After that, you can omit the
1118
location to use the default. To change the default, use --remember. The
1119
value will only be saved if the remote location can be accessed.
1121
The --verbose option will display the revisions pulled using the log_format
1122
configuration option. You can use a different format by overriding it with
1123
-Olog_format=<other_format>.
1125
Note: The location can be specified either in the form of a branch,
1126
or in the form of a path to a file containing a merge directive generated
1130
_see_also = ['push', 'update', 'status-flags', 'send']
1131
takes_options = ['remember', 'overwrite', 'revision',
1132
custom_help('verbose',
1133
help='Show logs of pulled revisions.'),
1134
custom_help('directory',
1135
help='Branch to pull into, '
1136
'rather than the one containing the working directory.'),
1138
help="Perform a local pull in a bound "
1139
"branch. Local pulls are not applied to "
1140
"the master branch."
1143
help="Show base revision text in conflicts.")
1145
takes_args = ['location?']
1146
encoding_type = 'replace'
1148
def run(self, location=None, remember=None, overwrite=False,
1149
revision=None, verbose=False,
1150
directory=None, local=False,
1152
# FIXME: too much stuff is in the command class
1155
if directory is None:
1158
tree_to = WorkingTree.open_containing(directory)[0]
1159
branch_to = tree_to.branch
1160
self.add_cleanup(tree_to.lock_write().unlock)
1161
except errors.NoWorkingTree:
1163
branch_to = Branch.open_containing(directory)[0]
1164
self.add_cleanup(branch_to.lock_write().unlock)
1166
if tree_to is None and show_base:
1167
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1169
if local and not branch_to.get_bound_location():
1170
raise errors.LocalRequiresBoundBranch()
1172
possible_transports = []
1173
if location is not None:
1175
mergeable = bundle.read_mergeable_from_url(location,
1176
possible_transports=possible_transports)
1177
except errors.NotABundle:
1180
stored_loc = branch_to.get_parent()
1181
if location is None:
1182
if stored_loc is None:
1183
raise errors.BzrCommandError(gettext("No pull location known or"
1186
display_url = urlutils.unescape_for_display(stored_loc,
1189
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1190
location = stored_loc
1192
revision = _get_one_revision('pull', revision)
1193
if mergeable is not None:
1194
if revision is not None:
1195
raise errors.BzrCommandError(gettext(
1196
'Cannot use -r with merge directives or bundles'))
1197
mergeable.install_revisions(branch_to.repository)
1198
base_revision_id, revision_id, verified = \
1199
mergeable.get_merge_request(branch_to.repository)
1200
branch_from = branch_to
1202
branch_from = Branch.open(location,
1203
possible_transports=possible_transports)
1204
self.add_cleanup(branch_from.lock_read().unlock)
1205
# Remembers if asked explicitly or no previous location is set
1207
or (remember is None and branch_to.get_parent() is None)):
1208
# FIXME: This shouldn't be done before the pull
1209
# succeeds... -- vila 2012-01-02
1210
branch_to.set_parent(branch_from.base)
1212
if revision is not None:
1213
revision_id = revision.as_revision_id(branch_from)
1215
if tree_to is not None:
1216
view_info = _get_view_info_for_change_reporter(tree_to)
1217
change_reporter = delta._ChangeReporter(
1218
unversioned_filter=tree_to.is_ignored,
1219
view_info=view_info)
1220
result = tree_to.pull(
1221
branch_from, overwrite, revision_id, change_reporter,
1222
local=local, show_base=show_base)
1224
result = branch_to.pull(
1225
branch_from, overwrite, revision_id, local=local)
1227
result.report(self.outf)
1228
if verbose and result.old_revid != result.new_revid:
1229
log.show_branch_change(
1230
branch_to, self.outf, result.old_revno,
1232
if getattr(result, 'tag_conflicts', None):
1238
class cmd_push(Command):
1239
__doc__ = """Update a mirror of this branch.
1241
The target branch will not have its working tree populated because this
1242
is both expensive, and is not supported on remote file systems.
1244
Some smart servers or protocols *may* put the working tree in place in
1247
This command only works on branches that have not diverged. Branches are
1248
considered diverged if the destination branch's most recent commit is one
1249
that has not been merged (directly or indirectly) by the source branch.
1251
If branches have diverged, you can use 'bzr push --overwrite' to replace
1252
the other branch completely, discarding its unmerged changes.
1254
If you want to ensure you have the different changes in the other branch,
1255
do a merge (see bzr help merge) from the other branch, and commit that.
1256
After that you will be able to do a push without '--overwrite'.
1258
If there is no default push location set, the first push will set it (use
1259
--no-remember to avoid setting it). After that, you can omit the
1260
location to use the default. To change the default, use --remember. The
1261
value will only be saved if the remote location can be accessed.
1263
The --verbose option will display the revisions pushed using the log_format
1264
configuration option. You can use a different format by overriding it with
1265
-Olog_format=<other_format>.
1268
_see_also = ['pull', 'update', 'working-trees']
1269
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1270
Option('create-prefix',
1271
help='Create the path leading up to the branch '
1272
'if it does not already exist.'),
1273
custom_help('directory',
1274
help='Branch to push from, '
1275
'rather than the one containing the working directory.'),
1276
Option('use-existing-dir',
1277
help='By default push will fail if the target'
1278
' directory exists, but does not already'
1279
' have a control directory. This flag will'
1280
' allow push to proceed.'),
1282
help='Create a stacked branch that references the public location '
1283
'of the parent branch.'),
1284
Option('stacked-on',
1285
help='Create a stacked branch that refers to another branch '
1286
'for the commit history. Only the work not present in the '
1287
'referenced branch is included in the branch created.',
1290
help='Refuse to push if there are uncommitted changes in'
1291
' the working tree, --no-strict disables the check.'),
1293
help="Don't populate the working tree, even for protocols"
1294
" that support it."),
1296
takes_args = ['location?']
1297
encoding_type = 'replace'
1299
def run(self, location=None, remember=None, overwrite=False,
1300
create_prefix=False, verbose=False, revision=None,
1301
use_existing_dir=False, directory=None, stacked_on=None,
1302
stacked=False, strict=None, no_tree=False):
1303
from bzrlib.push import _show_push_branch
1305
if directory is None:
1307
# Get the source branch
1309
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1310
# Get the tip's revision_id
1311
revision = _get_one_revision('push', revision)
1312
if revision is not None:
1313
revision_id = revision.in_history(br_from).rev_id
1316
if tree is not None and revision_id is None:
1317
tree.check_changed_or_out_of_date(
1318
strict, 'push_strict',
1319
more_error='Use --no-strict to force the push.',
1320
more_warning='Uncommitted changes will not be pushed.')
1321
# Get the stacked_on branch, if any
1322
if stacked_on is not None:
1323
stacked_on = urlutils.normalize_url(stacked_on)
1325
parent_url = br_from.get_parent()
1327
parent = Branch.open(parent_url)
1328
stacked_on = parent.get_public_branch()
1330
# I considered excluding non-http url's here, thus forcing
1331
# 'public' branches only, but that only works for some
1332
# users, so it's best to just depend on the user spotting an
1333
# error by the feedback given to them. RBC 20080227.
1334
stacked_on = parent_url
1336
raise errors.BzrCommandError(gettext(
1337
"Could not determine branch to refer to."))
1339
# Get the destination location
1340
if location is None:
1341
stored_loc = br_from.get_push_location()
1342
if stored_loc is None:
1343
parent_loc = br_from.get_parent()
1345
raise errors.BzrCommandError(gettext(
1346
"No push location known or specified. To push to the "
1347
"parent branch (at %s), use 'bzr push :parent'." %
1348
urlutils.unescape_for_display(parent_loc,
1349
self.outf.encoding)))
1351
raise errors.BzrCommandError(gettext(
1352
"No push location known or specified."))
1354
display_url = urlutils.unescape_for_display(stored_loc,
1356
note(gettext("Using saved push location: %s") % display_url)
1357
location = stored_loc
1359
_show_push_branch(br_from, revision_id, location, self.outf,
1360
verbose=verbose, overwrite=overwrite, remember=remember,
1361
stacked_on=stacked_on, create_prefix=create_prefix,
1362
use_existing_dir=use_existing_dir, no_tree=no_tree)
1365
class cmd_branch(Command):
1366
__doc__ = """Create a new branch that is a copy of an existing branch.
1368
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1369
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1370
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1371
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1372
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1375
To retrieve the branch as of a particular revision, supply the --revision
1376
parameter, as in "branch foo/bar -r 5".
1378
The synonyms 'clone' and 'get' for this command are deprecated.
1381
_see_also = ['checkout']
1382
takes_args = ['from_location', 'to_location?']
1383
takes_options = ['revision',
1384
Option('hardlink', help='Hard-link working tree files where possible.'),
1385
Option('files-from', type=str,
1386
help="Get file contents from this tree."),
1388
help="Create a branch without a working-tree."),
1390
help="Switch the checkout in the current directory "
1391
"to the new branch."),
1393
help='Create a stacked branch referring to the source branch. '
1394
'The new branch will depend on the availability of the source '
1395
'branch for all operations.'),
1396
Option('standalone',
1397
help='Do not use a shared repository, even if available.'),
1398
Option('use-existing-dir',
1399
help='By default branch will fail if the target'
1400
' directory exists, but does not already'
1401
' have a control directory. This flag will'
1402
' allow branch to proceed.'),
1404
help="Bind new branch to from location."),
1406
aliases = ['get', 'clone']
1408
def run(self, from_location, to_location=None, revision=None,
1409
hardlink=False, stacked=False, standalone=False, no_tree=False,
1410
use_existing_dir=False, switch=False, bind=False,
1412
from bzrlib import switch as _mod_switch
1413
from bzrlib.tag import _merge_tags_if_possible
1414
if self.invoked_as in ['get', 'clone']:
1415
ui.ui_factory.show_user_warning(
1416
'deprecated_command',
1417
deprecated_name=self.invoked_as,
1418
recommended_name='branch',
1419
deprecated_in_version='2.4')
1420
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1422
if not (hardlink or files_from):
1423
# accelerator_tree is usually slower because you have to read N
1424
# files (no readahead, lots of seeks, etc), but allow the user to
1425
# explicitly request it
1426
accelerator_tree = None
1427
if files_from is not None and files_from != from_location:
1428
accelerator_tree = WorkingTree.open(files_from)
1429
revision = _get_one_revision('branch', revision)
1430
self.add_cleanup(br_from.lock_read().unlock)
1431
if revision is not None:
1432
revision_id = revision.as_revision_id(br_from)
1434
# FIXME - wt.last_revision, fallback to branch, fall back to
1435
# None or perhaps NULL_REVISION to mean copy nothing
1437
revision_id = br_from.last_revision()
1438
if to_location is None:
1439
to_location = getattr(br_from, "name", None)
1441
to_location = urlutils.derive_to_location(from_location)
1442
to_transport = transport.get_transport(to_location)
1444
to_transport.mkdir('.')
1445
except errors.FileExists:
1447
to_dir = controldir.ControlDir.open_from_transport(
1449
except errors.NotBranchError:
1450
if not use_existing_dir:
1451
raise errors.BzrCommandError(gettext('Target directory "%s" '
1452
'already exists.') % to_location)
1457
to_dir.open_branch()
1458
except errors.NotBranchError:
1461
raise errors.AlreadyBranchError(to_location)
1462
except errors.NoSuchFile:
1463
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1469
# preserve whatever source format we have.
1470
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1471
possible_transports=[to_transport],
1472
accelerator_tree=accelerator_tree,
1473
hardlink=hardlink, stacked=stacked,
1474
force_new_repo=standalone,
1475
create_tree_if_local=not no_tree,
1476
source_branch=br_from)
1477
branch = to_dir.open_branch(
1478
possible_transports=[
1479
br_from.bzrdir.root_transport, to_transport])
1480
except errors.NoSuchRevision:
1481
to_transport.delete_tree('.')
1482
msg = gettext("The branch {0} has no revision {1}.").format(
1483
from_location, revision)
1484
raise errors.BzrCommandError(msg)
1487
to_repo = to_dir.open_repository()
1488
except errors.NoRepositoryPresent:
1489
to_repo = to_dir.create_repository()
1490
to_repo.fetch(br_from.repository, revision_id=revision_id)
1491
branch = br_from.sprout(to_dir, revision_id=revision_id)
1492
_merge_tags_if_possible(br_from, branch)
1493
# If the source branch is stacked, the new branch may
1494
# be stacked whether we asked for that explicitly or not.
1495
# We therefore need a try/except here and not just 'if stacked:'
1497
note(gettext('Created new stacked branch referring to %s.') %
1498
branch.get_stacked_on_url())
1499
except (errors.NotStacked, errors.UnstackableBranchFormat,
1500
errors.UnstackableRepositoryFormat), e:
1501
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1503
# Bind to the parent
1504
parent_branch = Branch.open(from_location)
1505
branch.bind(parent_branch)
1506
note(gettext('New branch bound to %s') % from_location)
1508
# Switch to the new branch
1509
wt, _ = WorkingTree.open_containing('.')
1510
_mod_switch.switch(wt.bzrdir, branch)
1511
note(gettext('Switched to branch: %s'),
1512
urlutils.unescape_for_display(branch.base, 'utf-8'))
1515
class cmd_branches(Command):
1516
__doc__ = """List the branches available at the current location.
1518
This command will print the names of all the branches at the current
1522
takes_args = ['location?']
1524
Option('recursive', short_name='R',
1525
help='Recursively scan for branches rather than '
1526
'just looking in the specified location.')]
1528
def run(self, location=".", recursive=False):
1530
t = transport.get_transport(location)
1531
if not t.listable():
1532
raise errors.BzrCommandError(
1533
"Can't scan this type of location.")
1534
for b in controldir.ControlDir.find_branches(t):
1535
self.outf.write("%s\n" % urlutils.unescape_for_display(
1536
urlutils.relative_url(t.base, b.base),
1537
self.outf.encoding).rstrip("/"))
1539
dir = controldir.ControlDir.open_containing(location)[0]
1541
active_branch = dir.open_branch(name="")
1542
except errors.NotBranchError:
1543
active_branch = None
1544
branches = dir.get_branches()
1546
for name, branch in branches.iteritems():
1549
active = (active_branch is not None and
1550
active_branch.base == branch.base)
1551
names[name] = active
1552
# Only mention the current branch explicitly if it's not
1553
# one of the colocated branches
1554
if not any(names.values()) and active_branch is not None:
1555
self.outf.write("* %s\n" % gettext("(default)"))
1556
for name in sorted(names.keys()):
1557
active = names[name]
1562
self.outf.write("%s %s\n" % (
1563
prefix, name.encode(self.outf.encoding)))
1566
class cmd_checkout(Command):
1567
__doc__ = """Create a new checkout of an existing branch.
1569
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1570
the branch found in '.'. This is useful if you have removed the working tree
1571
or if it was never created - i.e. if you pushed the branch to its current
1572
location using SFTP.
1574
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1575
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1576
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1577
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1578
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1581
To retrieve the branch as of a particular revision, supply the --revision
1582
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1583
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1587
_see_also = ['checkouts', 'branch']
1588
takes_args = ['branch_location?', 'to_location?']
1589
takes_options = ['revision',
1590
Option('lightweight',
1591
help="Perform a lightweight checkout. Lightweight "
1592
"checkouts depend on access to the branch for "
1593
"every operation. Normal checkouts can perform "
1594
"common operations like diff and status without "
1595
"such access, and also support local commits."
1597
Option('files-from', type=str,
1598
help="Get file contents from this tree."),
1600
help='Hard-link working tree files where possible.'
1605
def run(self, branch_location=None, to_location=None, revision=None,
1606
lightweight=False, files_from=None, hardlink=False):
1607
if branch_location is None:
1608
branch_location = osutils.getcwd()
1609
to_location = branch_location
1610
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1612
if not (hardlink or files_from):
1613
# accelerator_tree is usually slower because you have to read N
1614
# files (no readahead, lots of seeks, etc), but allow the user to
1615
# explicitly request it
1616
accelerator_tree = None
1617
revision = _get_one_revision('checkout', revision)
1618
if files_from is not None and files_from != branch_location:
1619
accelerator_tree = WorkingTree.open(files_from)
1620
if revision is not None:
1621
revision_id = revision.as_revision_id(source)
1624
if to_location is None:
1625
to_location = urlutils.derive_to_location(branch_location)
1626
# if the source and to_location are the same,
1627
# and there is no working tree,
1628
# then reconstitute a branch
1629
if (osutils.abspath(to_location) ==
1630
osutils.abspath(branch_location)):
1632
source.bzrdir.open_workingtree()
1633
except errors.NoWorkingTree:
1634
source.bzrdir.create_workingtree(revision_id)
1636
source.create_checkout(to_location, revision_id, lightweight,
1637
accelerator_tree, hardlink)
1640
class cmd_renames(Command):
1641
__doc__ = """Show list of renamed files.
1643
# TODO: Option to show renames between two historical versions.
1645
# TODO: Only show renames under dir, rather than in the whole branch.
1646
_see_also = ['status']
1647
takes_args = ['dir?']
1650
def run(self, dir=u'.'):
1651
tree = WorkingTree.open_containing(dir)[0]
1652
self.add_cleanup(tree.lock_read().unlock)
1653
old_tree = tree.basis_tree()
1654
self.add_cleanup(old_tree.lock_read().unlock)
1656
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1657
for f, paths, c, v, p, n, k, e in iterator:
1658
if paths[0] == paths[1]:
1662
renames.append(paths)
1664
for old_name, new_name in renames:
1665
self.outf.write("%s => %s\n" % (old_name, new_name))
1668
class cmd_update(Command):
1669
__doc__ = """Update a working tree to a new revision.
1671
This will perform a merge of the destination revision (the tip of the
1672
branch, or the specified revision) into the working tree, and then make
1673
that revision the basis revision for the working tree.
1675
You can use this to visit an older revision, or to update a working tree
1676
that is out of date from its branch.
1678
If there are any uncommitted changes in the tree, they will be carried
1679
across and remain as uncommitted changes after the update. To discard
1680
these changes, use 'bzr revert'. The uncommitted changes may conflict
1681
with the changes brought in by the change in basis revision.
1683
If the tree's branch is bound to a master branch, bzr will also update
1684
the branch from the master.
1686
You cannot update just a single file or directory, because each Bazaar
1687
working tree has just a single basis revision. If you want to restore a
1688
file that has been removed locally, use 'bzr revert' instead of 'bzr
1689
update'. If you want to restore a file to its state in a previous
1690
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1691
out the old content of that file to a new location.
1693
The 'dir' argument, if given, must be the location of the root of a
1694
working tree to update. By default, the working tree that contains the
1695
current working directory is used.
1698
_see_also = ['pull', 'working-trees', 'status-flags']
1699
takes_args = ['dir?']
1700
takes_options = ['revision',
1702
help="Show base revision text in conflicts."),
1706
def run(self, dir=None, revision=None, show_base=None):
1707
if revision is not None and len(revision) != 1:
1708
raise errors.BzrCommandError(gettext(
1709
"bzr update --revision takes exactly one revision"))
1711
tree = WorkingTree.open_containing('.')[0]
1713
tree, relpath = WorkingTree.open_containing(dir)
1716
raise errors.BzrCommandError(gettext(
1717
"bzr update can only update a whole tree, "
1718
"not a file or subdirectory"))
1719
branch = tree.branch
1720
possible_transports = []
1721
master = branch.get_master_branch(
1722
possible_transports=possible_transports)
1723
if master is not None:
1724
branch_location = master.base
1727
branch_location = tree.branch.base
1728
tree.lock_tree_write()
1729
self.add_cleanup(tree.unlock)
1730
# get rid of the final '/' and be ready for display
1731
branch_location = urlutils.unescape_for_display(
1732
branch_location.rstrip('/'),
1734
existing_pending_merges = tree.get_parent_ids()[1:]
1738
# may need to fetch data into a heavyweight checkout
1739
# XXX: this may take some time, maybe we should display a
1741
old_tip = branch.update(possible_transports)
1742
if revision is not None:
1743
revision_id = revision[0].as_revision_id(branch)
1745
revision_id = branch.last_revision()
1746
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1747
revno = branch.revision_id_to_dotted_revno(revision_id)
1748
note(gettext("Tree is up to date at revision {0} of branch {1}"
1749
).format('.'.join(map(str, revno)), branch_location))
1751
view_info = _get_view_info_for_change_reporter(tree)
1752
change_reporter = delta._ChangeReporter(
1753
unversioned_filter=tree.is_ignored,
1754
view_info=view_info)
1756
conflicts = tree.update(
1758
possible_transports=possible_transports,
1759
revision=revision_id,
1761
show_base=show_base)
1762
except errors.NoSuchRevision, e:
1763
raise errors.BzrCommandError(gettext(
1764
"branch has no revision %s\n"
1765
"bzr update --revision only works"
1766
" for a revision in the branch history")
1768
revno = tree.branch.revision_id_to_dotted_revno(
1769
_mod_revision.ensure_null(tree.last_revision()))
1770
note(gettext('Updated to revision {0} of branch {1}').format(
1771
'.'.join(map(str, revno)), branch_location))
1772
parent_ids = tree.get_parent_ids()
1773
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1774
note(gettext('Your local commits will now show as pending merges with '
1775
"'bzr status', and can be committed with 'bzr commit'."))
1782
class cmd_info(Command):
1783
__doc__ = """Show information about a working tree, branch or repository.
1785
This command will show all known locations and formats associated to the
1786
tree, branch or repository.
1788
In verbose mode, statistical information is included with each report.
1789
To see extended statistic information, use a verbosity level of 2 or
1790
higher by specifying the verbose option multiple times, e.g. -vv.
1792
Branches and working trees will also report any missing revisions.
1796
Display information on the format and related locations:
1800
Display the above together with extended format information and
1801
basic statistics (like the number of files in the working tree and
1802
number of revisions in the branch and repository):
1806
Display the above together with number of committers to the branch:
1810
_see_also = ['revno', 'working-trees', 'repositories']
1811
takes_args = ['location?']
1812
takes_options = ['verbose']
1813
encoding_type = 'replace'
1816
def run(self, location=None, verbose=False):
1818
noise_level = get_verbosity_level()
1821
from bzrlib.info import show_bzrdir_info
1822
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1823
verbose=noise_level, outfile=self.outf)
1826
class cmd_remove(Command):
1827
__doc__ = """Remove files or directories.
1829
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1830
delete them if they can easily be recovered using revert otherwise they
1831
will be backed up (adding an extention of the form .~#~). If no options or
1832
parameters are given Bazaar will scan for files that are being tracked by
1833
Bazaar but missing in your tree and stop tracking them for you.
1835
takes_args = ['file*']
1836
takes_options = ['verbose',
1837
Option('new', help='Only remove files that have never been committed.'),
1838
RegistryOption.from_kwargs('file-deletion-strategy',
1839
'The file deletion mode to be used.',
1840
title='Deletion Strategy', value_switches=True, enum_switch=False,
1841
safe='Backup changed files (default).',
1842
keep='Delete from bzr but leave the working copy.',
1843
no_backup='Don\'t backup changed files.',
1844
force='Delete all the specified files, even if they can not be '
1845
'recovered and even if they are non-empty directories. '
1846
'(deprecated, use no-backup)')]
1847
aliases = ['rm', 'del']
1848
encoding_type = 'replace'
1850
def run(self, file_list, verbose=False, new=False,
1851
file_deletion_strategy='safe'):
1852
if file_deletion_strategy == 'force':
1853
note(gettext("(The --force option is deprecated, rather use --no-backup "
1855
file_deletion_strategy = 'no-backup'
1857
tree, file_list = WorkingTree.open_containing_paths(file_list)
1859
if file_list is not None:
1860
file_list = [f for f in file_list]
1862
self.add_cleanup(tree.lock_write().unlock)
1863
# Heuristics should probably all move into tree.remove_smart or
1866
added = tree.changes_from(tree.basis_tree(),
1867
specific_files=file_list).added
1868
file_list = sorted([f[0] for f in added], reverse=True)
1869
if len(file_list) == 0:
1870
raise errors.BzrCommandError(gettext('No matching files.'))
1871
elif file_list is None:
1872
# missing files show up in iter_changes(basis) as
1873
# versioned-with-no-kind.
1875
for change in tree.iter_changes(tree.basis_tree()):
1876
# Find paths in the working tree that have no kind:
1877
if change[1][1] is not None and change[6][1] is None:
1878
missing.append(change[1][1])
1879
file_list = sorted(missing, reverse=True)
1880
file_deletion_strategy = 'keep'
1881
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1882
keep_files=file_deletion_strategy=='keep',
1883
force=(file_deletion_strategy=='no-backup'))
1886
class cmd_file_id(Command):
1887
__doc__ = """Print file_id of a particular file or directory.
1889
The file_id is assigned when the file is first added and remains the
1890
same through all revisions where the file exists, even when it is
1895
_see_also = ['inventory', 'ls']
1896
takes_args = ['filename']
1899
def run(self, filename):
1900
tree, relpath = WorkingTree.open_containing(filename)
1901
i = tree.path2id(relpath)
1903
raise errors.NotVersionedError(filename)
1905
self.outf.write(i + '\n')
1908
class cmd_file_path(Command):
1909
__doc__ = """Print path of file_ids to a file or directory.
1911
This prints one line for each directory down to the target,
1912
starting at the branch root.
1916
takes_args = ['filename']
1919
def run(self, filename):
1920
tree, relpath = WorkingTree.open_containing(filename)
1921
fid = tree.path2id(relpath)
1923
raise errors.NotVersionedError(filename)
1924
segments = osutils.splitpath(relpath)
1925
for pos in range(1, len(segments) + 1):
1926
path = osutils.joinpath(segments[:pos])
1927
self.outf.write("%s\n" % tree.path2id(path))
1930
class cmd_reconcile(Command):
1931
__doc__ = """Reconcile bzr metadata in a branch.
1933
This can correct data mismatches that may have been caused by
1934
previous ghost operations or bzr upgrades. You should only
1935
need to run this command if 'bzr check' or a bzr developer
1936
advises you to run it.
1938
If a second branch is provided, cross-branch reconciliation is
1939
also attempted, which will check that data like the tree root
1940
id which was not present in very early bzr versions is represented
1941
correctly in both branches.
1943
At the same time it is run it may recompress data resulting in
1944
a potential saving in disk space or performance gain.
1946
The branch *MUST* be on a listable system such as local disk or sftp.
1949
_see_also = ['check']
1950
takes_args = ['branch?']
1952
Option('canonicalize-chks',
1953
help='Make sure CHKs are in canonical form (repairs '
1958
def run(self, branch=".", canonicalize_chks=False):
1959
from bzrlib.reconcile import reconcile
1960
dir = controldir.ControlDir.open(branch)
1961
reconcile(dir, canonicalize_chks=canonicalize_chks)
1964
class cmd_revision_history(Command):
1965
__doc__ = """Display the list of revision ids on a branch."""
1968
takes_args = ['location?']
1973
def run(self, location="."):
1974
branch = Branch.open_containing(location)[0]
1975
self.add_cleanup(branch.lock_read().unlock)
1976
graph = branch.repository.get_graph()
1977
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1978
[_mod_revision.NULL_REVISION]))
1979
for revid in reversed(history):
1980
self.outf.write(revid)
1981
self.outf.write('\n')
1984
class cmd_ancestry(Command):
1985
__doc__ = """List all revisions merged into this branch."""
1987
_see_also = ['log', 'revision-history']
1988
takes_args = ['location?']
1993
def run(self, location="."):
1995
wt = WorkingTree.open_containing(location)[0]
1996
except errors.NoWorkingTree:
1997
b = Branch.open(location)
1998
last_revision = b.last_revision()
2001
last_revision = wt.last_revision()
2003
self.add_cleanup(b.repository.lock_read().unlock)
2004
graph = b.repository.get_graph()
2005
revisions = [revid for revid, parents in
2006
graph.iter_ancestry([last_revision])]
2007
for revision_id in reversed(revisions):
2008
if _mod_revision.is_null(revision_id):
2010
self.outf.write(revision_id + '\n')
2013
class cmd_init(Command):
2014
__doc__ = """Make a directory into a versioned branch.
2016
Use this to create an empty branch, or before importing an
2019
If there is a repository in a parent directory of the location, then
2020
the history of the branch will be stored in the repository. Otherwise
2021
init creates a standalone branch which carries its own history
2022
in the .bzr directory.
2024
If there is already a branch at the location but it has no working tree,
2025
the tree can be populated with 'bzr checkout'.
2027
Recipe for importing a tree of files::
2033
bzr commit -m "imported project"
2036
_see_also = ['init-repository', 'branch', 'checkout']
2037
takes_args = ['location?']
2039
Option('create-prefix',
2040
help='Create the path leading up to the branch '
2041
'if it does not already exist.'),
2042
RegistryOption('format',
2043
help='Specify a format for this branch. '
2044
'See "help formats".',
2045
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2046
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2047
value_switches=True,
2048
title="Branch format",
2050
Option('append-revisions-only',
2051
help='Never change revnos or the existing log.'
2052
' Append revisions to it only.'),
2054
'Create a branch without a working tree.')
2056
def run(self, location=None, format=None, append_revisions_only=False,
2057
create_prefix=False, no_tree=False):
2059
format = controldir.format_registry.make_bzrdir('default')
2060
if location is None:
2063
to_transport = transport.get_transport(location)
2065
# The path has to exist to initialize a
2066
# branch inside of it.
2067
# Just using os.mkdir, since I don't
2068
# believe that we want to create a bunch of
2069
# locations if the user supplies an extended path
2071
to_transport.ensure_base()
2072
except errors.NoSuchFile:
2073
if not create_prefix:
2074
raise errors.BzrCommandError(gettext("Parent directory of %s"
2076
"\nYou may supply --create-prefix to create all"
2077
" leading parent directories.")
2079
to_transport.create_prefix()
2082
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
2083
except errors.NotBranchError:
2084
# really a NotBzrDir error...
2085
create_branch = controldir.ControlDir.create_branch_convenience
2087
force_new_tree = False
2089
force_new_tree = None
2090
branch = create_branch(to_transport.base, format=format,
2091
possible_transports=[to_transport],
2092
force_new_tree=force_new_tree)
2093
a_bzrdir = branch.bzrdir
2095
from bzrlib.transport.local import LocalTransport
2096
if a_bzrdir.has_branch():
2097
if (isinstance(to_transport, LocalTransport)
2098
and not a_bzrdir.has_workingtree()):
2099
raise errors.BranchExistsWithoutWorkingTree(location)
2100
raise errors.AlreadyBranchError(location)
2101
branch = a_bzrdir.create_branch()
2102
if not no_tree and not a_bzrdir.has_workingtree():
2103
a_bzrdir.create_workingtree()
2104
if append_revisions_only:
2106
branch.set_append_revisions_only(True)
2107
except errors.UpgradeRequired:
2108
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2109
' to append-revisions-only. Try --default.'))
2111
from bzrlib.info import describe_layout, describe_format
2113
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2114
except (errors.NoWorkingTree, errors.NotLocalUrl):
2116
repository = branch.repository
2117
layout = describe_layout(repository, branch, tree).lower()
2118
format = describe_format(a_bzrdir, repository, branch, tree)
2119
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2121
if repository.is_shared():
2122
#XXX: maybe this can be refactored into transport.path_or_url()
2123
url = repository.bzrdir.root_transport.external_url()
2125
url = urlutils.local_path_from_url(url)
2126
except errors.InvalidURL:
2128
self.outf.write(gettext("Using shared repository: %s\n") % url)
2131
class cmd_init_repository(Command):
2132
__doc__ = """Create a shared repository for branches to share storage space.
2134
New branches created under the repository directory will store their
2135
revisions in the repository, not in the branch directory. For branches
2136
with shared history, this reduces the amount of storage needed and
2137
speeds up the creation of new branches.
2139
If the --no-trees option is given then the branches in the repository
2140
will not have working trees by default. They will still exist as
2141
directories on disk, but they will not have separate copies of the
2142
files at a certain revision. This can be useful for repositories that
2143
store branches which are interacted with through checkouts or remote
2144
branches, such as on a server.
2147
Create a shared repository holding just branches::
2149
bzr init-repo --no-trees repo
2152
Make a lightweight checkout elsewhere::
2154
bzr checkout --lightweight repo/trunk trunk-checkout
2159
_see_also = ['init', 'branch', 'checkout', 'repositories']
2160
takes_args = ["location"]
2161
takes_options = [RegistryOption('format',
2162
help='Specify a format for this repository. See'
2163
' "bzr help formats" for details.',
2164
lazy_registry=('bzrlib.controldir', 'format_registry'),
2165
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2166
value_switches=True, title='Repository format'),
2168
help='Branches in the repository will default to'
2169
' not having a working tree.'),
2171
aliases = ["init-repo"]
2173
def run(self, location, format=None, no_trees=False):
2175
format = controldir.format_registry.make_bzrdir('default')
2177
if location is None:
2180
to_transport = transport.get_transport(location)
2182
(repo, newdir, require_stacking, repository_policy) = (
2183
format.initialize_on_transport_ex(to_transport,
2184
create_prefix=True, make_working_trees=not no_trees,
2185
shared_repo=True, force_new_repo=True,
2186
use_existing_dir=True,
2187
repo_format_name=format.repository_format.get_format_string()))
2189
from bzrlib.info import show_bzrdir_info
2190
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2193
class cmd_diff(Command):
2194
__doc__ = """Show differences in the working tree, between revisions or branches.
2196
If no arguments are given, all changes for the current tree are listed.
2197
If files are given, only the changes in those files are listed.
2198
Remote and multiple branches can be compared by using the --old and
2199
--new options. If not provided, the default for both is derived from
2200
the first argument, if any, or the current tree if no arguments are
2203
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2204
produces patches suitable for "patch -p1".
2206
Note that when using the -r argument with a range of revisions, the
2207
differences are computed between the two specified revisions. That
2208
is, the command does not show the changes introduced by the first
2209
revision in the range. This differs from the interpretation of
2210
revision ranges used by "bzr log" which includes the first revision
2215
2 - unrepresentable changes
2220
Shows the difference in the working tree versus the last commit::
2224
Difference between the working tree and revision 1::
2228
Difference between revision 3 and revision 1::
2232
Difference between revision 3 and revision 1 for branch xxx::
2236
The changes introduced by revision 2 (equivalent to -r1..2)::
2240
To see the changes introduced by revision X::
2244
Note that in the case of a merge, the -c option shows the changes
2245
compared to the left hand parent. To see the changes against
2246
another parent, use::
2248
bzr diff -r<chosen_parent>..X
2250
The changes between the current revision and the previous revision
2251
(equivalent to -c-1 and -r-2..-1)
2255
Show just the differences for file NEWS::
2259
Show the differences in working tree xxx for file NEWS::
2263
Show the differences from branch xxx to this working tree:
2267
Show the differences between two branches for file NEWS::
2269
bzr diff --old xxx --new yyy NEWS
2271
Same as 'bzr diff' but prefix paths with old/ and new/::
2273
bzr diff --prefix old/:new/
2275
Show the differences using a custom diff program with options::
2277
bzr diff --using /usr/bin/diff --diff-options -wu
2279
_see_also = ['status']
2280
takes_args = ['file*']
2282
Option('diff-options', type=str,
2283
help='Pass these options to the external diff program.'),
2284
Option('prefix', type=str,
2286
help='Set prefixes added to old and new filenames, as '
2287
'two values separated by a colon. (eg "old/:new/").'),
2289
help='Branch/tree to compare from.',
2293
help='Branch/tree to compare to.',
2299
help='Use this command to compare files.',
2302
RegistryOption('format',
2304
help='Diff format to use.',
2305
lazy_registry=('bzrlib.diff', 'format_registry'),
2306
title='Diff format'),
2308
aliases = ['di', 'dif']
2309
encoding_type = 'exact'
2312
def run(self, revision=None, file_list=None, diff_options=None,
2313
prefix=None, old=None, new=None, using=None, format=None):
2314
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2317
if (prefix is None) or (prefix == '0'):
2325
old_label, new_label = prefix.split(":")
2327
raise errors.BzrCommandError(gettext(
2328
'--prefix expects two values separated by a colon'
2329
' (eg "old/:new/")'))
2331
if revision and len(revision) > 2:
2332
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2333
' one or two revision specifiers'))
2335
if using is not None and format is not None:
2336
raise errors.BzrCommandError(gettext(
2337
'{0} and {1} are mutually exclusive').format(
2338
'--using', '--format'))
2340
(old_tree, new_tree,
2341
old_branch, new_branch,
2342
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2343
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2344
# GNU diff on Windows uses ANSI encoding for filenames
2345
path_encoding = osutils.get_diff_header_encoding()
2346
return show_diff_trees(old_tree, new_tree, sys.stdout,
2347
specific_files=specific_files,
2348
external_diff_options=diff_options,
2349
old_label=old_label, new_label=new_label,
2350
extra_trees=extra_trees,
2351
path_encoding=path_encoding,
2356
class cmd_deleted(Command):
2357
__doc__ = """List files deleted in the working tree.
2359
# TODO: Show files deleted since a previous revision, or
2360
# between two revisions.
2361
# TODO: Much more efficient way to do this: read in new
2362
# directories with readdir, rather than stating each one. Same
2363
# level of effort but possibly much less IO. (Or possibly not,
2364
# if the directories are very large...)
2365
_see_also = ['status', 'ls']
2366
takes_options = ['directory', 'show-ids']
2369
def run(self, show_ids=False, directory=u'.'):
2370
tree = WorkingTree.open_containing(directory)[0]
2371
self.add_cleanup(tree.lock_read().unlock)
2372
old = tree.basis_tree()
2373
self.add_cleanup(old.lock_read().unlock)
2374
for path, ie in old.iter_entries_by_dir():
2375
if not tree.has_id(ie.file_id):
2376
self.outf.write(path)
2378
self.outf.write(' ')
2379
self.outf.write(ie.file_id)
2380
self.outf.write('\n')
2383
class cmd_modified(Command):
2384
__doc__ = """List files modified in working tree.
2388
_see_also = ['status', 'ls']
2389
takes_options = ['directory', 'null']
2392
def run(self, null=False, directory=u'.'):
2393
tree = WorkingTree.open_containing(directory)[0]
2394
self.add_cleanup(tree.lock_read().unlock)
2395
td = tree.changes_from(tree.basis_tree())
2397
for path, id, kind, text_modified, meta_modified in td.modified:
2399
self.outf.write(path + '\0')
2401
self.outf.write(osutils.quotefn(path) + '\n')
2404
class cmd_added(Command):
2405
__doc__ = """List files added in working tree.
2409
_see_also = ['status', 'ls']
2410
takes_options = ['directory', 'null']
2413
def run(self, null=False, directory=u'.'):
2414
wt = WorkingTree.open_containing(directory)[0]
2415
self.add_cleanup(wt.lock_read().unlock)
2416
basis = wt.basis_tree()
2417
self.add_cleanup(basis.lock_read().unlock)
2418
root_id = wt.get_root_id()
2419
for file_id in wt.all_file_ids():
2420
if basis.has_id(file_id):
2422
if root_id == file_id:
2424
path = wt.id2path(file_id)
2425
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2428
self.outf.write(path + '\0')
2430
self.outf.write(osutils.quotefn(path) + '\n')
2433
class cmd_root(Command):
2434
__doc__ = """Show the tree root directory.
2436
The root is the nearest enclosing directory with a .bzr control
2439
takes_args = ['filename?']
2441
def run(self, filename=None):
2442
"""Print the branch root."""
2443
tree = WorkingTree.open_containing(filename)[0]
2444
self.outf.write(tree.basedir + '\n')
2447
def _parse_limit(limitstring):
2449
return int(limitstring)
2451
msg = gettext("The limit argument must be an integer.")
2452
raise errors.BzrCommandError(msg)
2455
def _parse_levels(s):
2459
msg = gettext("The levels argument must be an integer.")
2460
raise errors.BzrCommandError(msg)
2463
class cmd_log(Command):
2464
__doc__ = """Show historical log for a branch or subset of a branch.
2466
log is bzr's default tool for exploring the history of a branch.
2467
The branch to use is taken from the first parameter. If no parameters
2468
are given, the branch containing the working directory is logged.
2469
Here are some simple examples::
2471
bzr log log the current branch
2472
bzr log foo.py log a file in its branch
2473
bzr log http://server/branch log a branch on a server
2475
The filtering, ordering and information shown for each revision can
2476
be controlled as explained below. By default, all revisions are
2477
shown sorted (topologically) so that newer revisions appear before
2478
older ones and descendants always appear before ancestors. If displayed,
2479
merged revisions are shown indented under the revision in which they
2484
The log format controls how information about each revision is
2485
displayed. The standard log formats are called ``long``, ``short``
2486
and ``line``. The default is long. See ``bzr help log-formats``
2487
for more details on log formats.
2489
The following options can be used to control what information is
2492
-l N display a maximum of N revisions
2493
-n N display N levels of revisions (0 for all, 1 for collapsed)
2494
-v display a status summary (delta) for each revision
2495
-p display a diff (patch) for each revision
2496
--show-ids display revision-ids (and file-ids), not just revnos
2498
Note that the default number of levels to display is a function of the
2499
log format. If the -n option is not used, the standard log formats show
2500
just the top level (mainline).
2502
Status summaries are shown using status flags like A, M, etc. To see
2503
the changes explained using words like ``added`` and ``modified``
2504
instead, use the -vv option.
2508
To display revisions from oldest to newest, use the --forward option.
2509
In most cases, using this option will have little impact on the total
2510
time taken to produce a log, though --forward does not incrementally
2511
display revisions like --reverse does when it can.
2513
:Revision filtering:
2515
The -r option can be used to specify what revision or range of revisions
2516
to filter against. The various forms are shown below::
2518
-rX display revision X
2519
-rX.. display revision X and later
2520
-r..Y display up to and including revision Y
2521
-rX..Y display from X to Y inclusive
2523
See ``bzr help revisionspec`` for details on how to specify X and Y.
2524
Some common examples are given below::
2526
-r-1 show just the tip
2527
-r-10.. show the last 10 mainline revisions
2528
-rsubmit:.. show what's new on this branch
2529
-rancestor:path.. show changes since the common ancestor of this
2530
branch and the one at location path
2531
-rdate:yesterday.. show changes since yesterday
2533
When logging a range of revisions using -rX..Y, log starts at
2534
revision Y and searches back in history through the primary
2535
("left-hand") parents until it finds X. When logging just the
2536
top level (using -n1), an error is reported if X is not found
2537
along the way. If multi-level logging is used (-n0), X may be
2538
a nested merge revision and the log will be truncated accordingly.
2542
If parameters are given and the first one is not a branch, the log
2543
will be filtered to show only those revisions that changed the
2544
nominated files or directories.
2546
Filenames are interpreted within their historical context. To log a
2547
deleted file, specify a revision range so that the file existed at
2548
the end or start of the range.
2550
Historical context is also important when interpreting pathnames of
2551
renamed files/directories. Consider the following example:
2553
* revision 1: add tutorial.txt
2554
* revision 2: modify tutorial.txt
2555
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2559
* ``bzr log guide.txt`` will log the file added in revision 1
2561
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2563
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2564
the original file in revision 2.
2566
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2567
was no file called guide.txt in revision 2.
2569
Renames are always followed by log. By design, there is no need to
2570
explicitly ask for this (and no way to stop logging a file back
2571
until it was last renamed).
2575
The --match option can be used for finding revisions that match a
2576
regular expression in a commit message, committer, author or bug.
2577
Specifying the option several times will match any of the supplied
2578
expressions. --match-author, --match-bugs, --match-committer and
2579
--match-message can be used to only match a specific field.
2583
GUI tools and IDEs are often better at exploring history than command
2584
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2585
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2586
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2587
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2589
You may find it useful to add the aliases below to ``bazaar.conf``::
2593
top = log -l10 --line
2596
``bzr tip`` will then show the latest revision while ``bzr top``
2597
will show the last 10 mainline revisions. To see the details of a
2598
particular revision X, ``bzr show -rX``.
2600
If you are interested in looking deeper into a particular merge X,
2601
use ``bzr log -n0 -rX``.
2603
``bzr log -v`` on a branch with lots of history is currently
2604
very slow. A fix for this issue is currently under development.
2605
With or without that fix, it is recommended that a revision range
2606
be given when using the -v option.
2608
bzr has a generic full-text matching plugin, bzr-search, that can be
2609
used to find revisions matching user names, commit messages, etc.
2610
Among other features, this plugin can find all revisions containing
2611
a list of words but not others.
2613
When exploring non-mainline history on large projects with deep
2614
history, the performance of log can be greatly improved by installing
2615
the historycache plugin. This plugin buffers historical information
2616
trading disk space for faster speed.
2618
takes_args = ['file*']
2619
_see_also = ['log-formats', 'revisionspec']
2622
help='Show from oldest to newest.'),
2624
custom_help('verbose',
2625
help='Show files changed in each revision.'),
2629
type=bzrlib.option._parse_revision_str,
2631
help='Show just the specified revision.'
2632
' See also "help revisionspec".'),
2634
RegistryOption('authors',
2635
'What names to list as authors - first, all or committer.',
2637
lazy_registry=('bzrlib.log', 'author_list_registry'),
2641
help='Number of levels to display - 0 for all, 1 for flat.',
2643
type=_parse_levels),
2645
help='Show revisions whose message matches this '
2646
'regular expression.',
2651
help='Limit the output to the first N revisions.',
2656
help='Show changes made in each revision as a patch.'),
2657
Option('include-merged',
2658
help='Show merged revisions like --levels 0 does.'),
2659
Option('include-merges', hidden=True,
2660
help='Historical alias for --include-merged.'),
2661
Option('omit-merges',
2662
help='Do not report commits with more than one parent.'),
2663
Option('exclude-common-ancestry',
2664
help='Display only the revisions that are not part'
2665
' of both ancestries (require -rX..Y).'
2667
Option('signatures',
2668
help='Show digital signature validity.'),
2671
help='Show revisions whose properties match this '
2674
ListOption('match-message',
2675
help='Show revisions whose message matches this '
2678
ListOption('match-committer',
2679
help='Show revisions whose committer matches this '
2682
ListOption('match-author',
2683
help='Show revisions whose authors match this '
2686
ListOption('match-bugs',
2687
help='Show revisions whose bugs match this '
2691
encoding_type = 'replace'
2694
def run(self, file_list=None, timezone='original',
2705
include_merged=None,
2707
exclude_common_ancestry=False,
2711
match_committer=None,
2715
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2717
from bzrlib.log import (
2719
make_log_request_dict,
2720
_get_info_for_log_files,
2722
direction = (forward and 'forward') or 'reverse'
2723
if symbol_versioning.deprecated_passed(include_merges):
2724
ui.ui_factory.show_user_warning(
2725
'deprecated_command_option',
2726
deprecated_name='--include-merges',
2727
recommended_name='--include-merged',
2728
deprecated_in_version='2.5',
2729
command=self.invoked_as)
2730
if include_merged is None:
2731
include_merged = include_merges
2733
raise errors.BzrCommandError(gettext(
2734
'{0} and {1} are mutually exclusive').format(
2735
'--include-merges', '--include-merged'))
2736
if include_merged is None:
2737
include_merged = False
2738
if (exclude_common_ancestry
2739
and (revision is None or len(revision) != 2)):
2740
raise errors.BzrCommandError(gettext(
2741
'--exclude-common-ancestry requires -r with two revisions'))
2746
raise errors.BzrCommandError(gettext(
2747
'{0} and {1} are mutually exclusive').format(
2748
'--levels', '--include-merged'))
2750
if change is not None:
2752
raise errors.RangeInChangeOption()
2753
if revision is not None:
2754
raise errors.BzrCommandError(gettext(
2755
'{0} and {1} are mutually exclusive').format(
2756
'--revision', '--change'))
2761
filter_by_dir = False
2763
# find the file ids to log and check for directory filtering
2764
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2765
revision, file_list, self.add_cleanup)
2766
for relpath, file_id, kind in file_info_list:
2768
raise errors.BzrCommandError(gettext(
2769
"Path unknown at end or start of revision range: %s") %
2771
# If the relpath is the top of the tree, we log everything
2776
file_ids.append(file_id)
2777
filter_by_dir = filter_by_dir or (
2778
kind in ['directory', 'tree-reference'])
2781
# FIXME ? log the current subdir only RBC 20060203
2782
if revision is not None \
2783
and len(revision) > 0 and revision[0].get_branch():
2784
location = revision[0].get_branch()
2787
dir, relpath = controldir.ControlDir.open_containing(location)
2788
b = dir.open_branch()
2789
self.add_cleanup(b.lock_read().unlock)
2790
rev1, rev2 = _get_revision_range(revision, b, self.name())
2792
if b.get_config_stack().get('validate_signatures_in_log'):
2796
if not gpg.GPGStrategy.verify_signatures_available():
2797
raise errors.GpgmeNotInstalled(None)
2799
# Decide on the type of delta & diff filtering to use
2800
# TODO: add an --all-files option to make this configurable & consistent
2808
diff_type = 'partial'
2812
# Build the log formatter
2813
if log_format is None:
2814
log_format = log.log_formatter_registry.get_default(b)
2815
# Make a non-encoding output to include the diffs - bug 328007
2816
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2817
lf = log_format(show_ids=show_ids, to_file=self.outf,
2818
to_exact_file=unencoded_output,
2819
show_timezone=timezone,
2820
delta_format=get_verbosity_level(),
2822
show_advice=levels is None,
2823
author_list_handler=authors)
2825
# Choose the algorithm for doing the logging. It's annoying
2826
# having multiple code paths like this but necessary until
2827
# the underlying repository format is faster at generating
2828
# deltas or can provide everything we need from the indices.
2829
# The default algorithm - match-using-deltas - works for
2830
# multiple files and directories and is faster for small
2831
# amounts of history (200 revisions say). However, it's too
2832
# slow for logging a single file in a repository with deep
2833
# history, i.e. > 10K revisions. In the spirit of "do no
2834
# evil when adding features", we continue to use the
2835
# original algorithm - per-file-graph - for the "single
2836
# file that isn't a directory without showing a delta" case.
2837
partial_history = revision and b.repository._format.supports_chks
2838
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2839
or delta_type or partial_history)
2843
match_dict[''] = match
2845
match_dict['message'] = match_message
2847
match_dict['committer'] = match_committer
2849
match_dict['author'] = match_author
2851
match_dict['bugs'] = match_bugs
2853
# Build the LogRequest and execute it
2854
if len(file_ids) == 0:
2856
rqst = make_log_request_dict(
2857
direction=direction, specific_fileids=file_ids,
2858
start_revision=rev1, end_revision=rev2, limit=limit,
2859
message_search=message, delta_type=delta_type,
2860
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2861
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2862
signature=signatures, omit_merges=omit_merges,
2864
Logger(b, rqst).show(lf)
2867
def _get_revision_range(revisionspec_list, branch, command_name):
2868
"""Take the input of a revision option and turn it into a revision range.
2870
It returns RevisionInfo objects which can be used to obtain the rev_id's
2871
of the desired revisions. It does some user input validations.
2873
if revisionspec_list is None:
2876
elif len(revisionspec_list) == 1:
2877
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2878
elif len(revisionspec_list) == 2:
2879
start_spec = revisionspec_list[0]
2880
end_spec = revisionspec_list[1]
2881
if end_spec.get_branch() != start_spec.get_branch():
2882
# b is taken from revision[0].get_branch(), and
2883
# show_log will use its revision_history. Having
2884
# different branches will lead to weird behaviors.
2885
raise errors.BzrCommandError(gettext(
2886
"bzr %s doesn't accept two revisions in different"
2887
" branches.") % command_name)
2888
if start_spec.spec is None:
2889
# Avoid loading all the history.
2890
rev1 = RevisionInfo(branch, None, None)
2892
rev1 = start_spec.in_history(branch)
2893
# Avoid loading all of history when we know a missing
2894
# end of range means the last revision ...
2895
if end_spec.spec is None:
2896
last_revno, last_revision_id = branch.last_revision_info()
2897
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2899
rev2 = end_spec.in_history(branch)
2901
raise errors.BzrCommandError(gettext(
2902
'bzr %s --revision takes one or two values.') % command_name)
2906
def _revision_range_to_revid_range(revision_range):
2909
if revision_range[0] is not None:
2910
rev_id1 = revision_range[0].rev_id
2911
if revision_range[1] is not None:
2912
rev_id2 = revision_range[1].rev_id
2913
return rev_id1, rev_id2
2915
def get_log_format(long=False, short=False, line=False, default='long'):
2916
log_format = default
2920
log_format = 'short'
2926
class cmd_touching_revisions(Command):
2927
__doc__ = """Return revision-ids which affected a particular file.
2929
A more user-friendly interface is "bzr log FILE".
2933
takes_args = ["filename"]
2936
def run(self, filename):
2937
tree, relpath = WorkingTree.open_containing(filename)
2938
file_id = tree.path2id(relpath)
2940
self.add_cleanup(b.lock_read().unlock)
2941
touching_revs = log.find_touching_revisions(b, file_id)
2942
for revno, revision_id, what in touching_revs:
2943
self.outf.write("%6d %s\n" % (revno, what))
2946
class cmd_ls(Command):
2947
__doc__ = """List files in a tree.
2950
_see_also = ['status', 'cat']
2951
takes_args = ['path?']
2955
Option('recursive', short_name='R',
2956
help='Recurse into subdirectories.'),
2958
help='Print paths relative to the root of the branch.'),
2959
Option('unknown', short_name='u',
2960
help='Print unknown files.'),
2961
Option('versioned', help='Print versioned files.',
2963
Option('ignored', short_name='i',
2964
help='Print ignored files.'),
2965
Option('kind', short_name='k',
2966
help='List entries of a particular kind: file, directory, symlink.',
2973
def run(self, revision=None, verbose=False,
2974
recursive=False, from_root=False,
2975
unknown=False, versioned=False, ignored=False,
2976
null=False, kind=None, show_ids=False, path=None, directory=None):
2978
if kind and kind not in ('file', 'directory', 'symlink'):
2979
raise errors.BzrCommandError(gettext('invalid kind specified'))
2981
if verbose and null:
2982
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2983
all = not (unknown or versioned or ignored)
2985
selection = {'I':ignored, '?':unknown, 'V':versioned}
2991
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2994
tree, branch, relpath = \
2995
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2997
# Calculate the prefix to use
3001
prefix = relpath + '/'
3002
elif fs_path != '.' and not fs_path.endswith('/'):
3003
prefix = fs_path + '/'
3005
if revision is not None or tree is None:
3006
tree = _get_one_revision_tree('ls', revision, branch=branch)
3009
if isinstance(tree, WorkingTree) and tree.supports_views():
3010
view_files = tree.views.lookup_view()
3013
view_str = views.view_display_str(view_files)
3014
note(gettext("Ignoring files outside view. View is %s") % view_str)
3016
self.add_cleanup(tree.lock_read().unlock)
3017
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3018
from_dir=relpath, recursive=recursive):
3019
# Apply additional masking
3020
if not all and not selection[fc]:
3022
if kind is not None and fkind != kind:
3027
fullpath = osutils.pathjoin(relpath, fp)
3030
views.check_path_in_view(tree, fullpath)
3031
except errors.FileOutsideView:
3036
fp = osutils.pathjoin(prefix, fp)
3037
kindch = entry.kind_character()
3038
outstring = fp + kindch
3039
ui.ui_factory.clear_term()
3041
outstring = '%-8s %s' % (fc, outstring)
3042
if show_ids and fid is not None:
3043
outstring = "%-50s %s" % (outstring, fid)
3044
self.outf.write(outstring + '\n')
3046
self.outf.write(fp + '\0')
3049
self.outf.write(fid)
3050
self.outf.write('\0')
3058
self.outf.write('%-50s %s\n' % (outstring, my_id))
3060
self.outf.write(outstring + '\n')
3063
class cmd_unknowns(Command):
3064
__doc__ = """List unknown files.
3069
takes_options = ['directory']
3072
def run(self, directory=u'.'):
3073
for f in WorkingTree.open_containing(directory)[0].unknowns():
3074
self.outf.write(osutils.quotefn(f) + '\n')
3077
class cmd_ignore(Command):
3078
__doc__ = """Ignore specified files or patterns.
3080
See ``bzr help patterns`` for details on the syntax of patterns.
3082
If a .bzrignore file does not exist, the ignore command
3083
will create one and add the specified files or patterns to the newly
3084
created file. The ignore command will also automatically add the
3085
.bzrignore file to be versioned. Creating a .bzrignore file without
3086
the use of the ignore command will require an explicit add command.
3088
To remove patterns from the ignore list, edit the .bzrignore file.
3089
After adding, editing or deleting that file either indirectly by
3090
using this command or directly by using an editor, be sure to commit
3093
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3094
the global ignore file can be found in the application data directory as
3095
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3096
Global ignores are not touched by this command. The global ignore file
3097
can be edited directly using an editor.
3099
Patterns prefixed with '!' are exceptions to ignore patterns and take
3100
precedence over regular ignores. Such exceptions are used to specify
3101
files that should be versioned which would otherwise be ignored.
3103
Patterns prefixed with '!!' act as regular ignore patterns, but have
3104
precedence over the '!' exception patterns.
3108
* Ignore patterns containing shell wildcards must be quoted from
3111
* Ignore patterns starting with "#" act as comments in the ignore file.
3112
To ignore patterns that begin with that character, use the "RE:" prefix.
3115
Ignore the top level Makefile::
3117
bzr ignore ./Makefile
3119
Ignore .class files in all directories...::
3121
bzr ignore "*.class"
3123
...but do not ignore "special.class"::
3125
bzr ignore "!special.class"
3127
Ignore files whose name begins with the "#" character::
3131
Ignore .o files under the lib directory::
3133
bzr ignore "lib/**/*.o"
3135
Ignore .o files under the lib directory::
3137
bzr ignore "RE:lib/.*\.o"
3139
Ignore everything but the "debian" toplevel directory::
3141
bzr ignore "RE:(?!debian/).*"
3143
Ignore everything except the "local" toplevel directory,
3144
but always ignore autosave files ending in ~, even under local/::
3147
bzr ignore "!./local"
3151
_see_also = ['status', 'ignored', 'patterns']
3152
takes_args = ['name_pattern*']
3153
takes_options = ['directory',
3154
Option('default-rules',
3155
help='Display the default ignore rules that bzr uses.')
3158
def run(self, name_pattern_list=None, default_rules=None,
3160
from bzrlib import ignores
3161
if default_rules is not None:
3162
# dump the default rules and exit
3163
for pattern in ignores.USER_DEFAULTS:
3164
self.outf.write("%s\n" % pattern)
3166
if not name_pattern_list:
3167
raise errors.BzrCommandError(gettext("ignore requires at least one "
3168
"NAME_PATTERN or --default-rules."))
3169
name_pattern_list = [globbing.normalize_pattern(p)
3170
for p in name_pattern_list]
3172
bad_patterns_count = 0
3173
for p in name_pattern_list:
3174
if not globbing.Globster.is_pattern_valid(p):
3175
bad_patterns_count += 1
3176
bad_patterns += ('\n %s' % p)
3178
msg = (ngettext('Invalid ignore pattern found. %s',
3179
'Invalid ignore patterns found. %s',
3180
bad_patterns_count) % bad_patterns)
3181
ui.ui_factory.show_error(msg)
3182
raise errors.InvalidPattern('')
3183
for name_pattern in name_pattern_list:
3184
if (name_pattern[0] == '/' or
3185
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3186
raise errors.BzrCommandError(gettext(
3187
"NAME_PATTERN should not be an absolute path"))
3188
tree, relpath = WorkingTree.open_containing(directory)
3189
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3190
ignored = globbing.Globster(name_pattern_list)
3192
self.add_cleanup(tree.lock_read().unlock)
3193
for entry in tree.list_files():
3197
if ignored.match(filename):
3198
matches.append(filename)
3199
if len(matches) > 0:
3200
self.outf.write(gettext("Warning: the following files are version "
3201
"controlled and match your ignore pattern:\n%s"
3202
"\nThese files will continue to be version controlled"
3203
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3206
class cmd_ignored(Command):
3207
__doc__ = """List ignored files and the patterns that matched them.
3209
List all the ignored files and the ignore pattern that caused the file to
3212
Alternatively, to list just the files::
3217
encoding_type = 'replace'
3218
_see_also = ['ignore', 'ls']
3219
takes_options = ['directory']
3222
def run(self, directory=u'.'):
3223
tree = WorkingTree.open_containing(directory)[0]
3224
self.add_cleanup(tree.lock_read().unlock)
3225
for path, file_class, kind, file_id, entry in tree.list_files():
3226
if file_class != 'I':
3228
## XXX: Slightly inefficient since this was already calculated
3229
pat = tree.is_ignored(path)
3230
self.outf.write('%-50s %s\n' % (path, pat))
3233
class cmd_lookup_revision(Command):
3234
__doc__ = """Lookup the revision-id from a revision-number
3237
bzr lookup-revision 33
3240
takes_args = ['revno']
3241
takes_options = ['directory']
3244
def run(self, revno, directory=u'.'):
3248
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3250
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3251
self.outf.write("%s\n" % revid)
3254
class cmd_export(Command):
3255
__doc__ = """Export current or past revision to a destination directory or archive.
3257
If no revision is specified this exports the last committed revision.
3259
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3260
given, try to find the format with the extension. If no extension
3261
is found exports to a directory (equivalent to --format=dir).
3263
If root is supplied, it will be used as the root directory inside
3264
container formats (tar, zip, etc). If it is not supplied it will default
3265
to the exported filename. The root option has no effect for 'dir' format.
3267
If branch is omitted then the branch containing the current working
3268
directory will be used.
3270
Note: Export of tree with non-ASCII filenames to zip is not supported.
3272
================= =========================
3273
Supported formats Autodetected by extension
3274
================= =========================
3277
tbz2 .tar.bz2, .tbz2
3280
================= =========================
3283
takes_args = ['dest', 'branch_or_subdir?']
3284
takes_options = ['directory',
3286
help="Type of file to export to.",
3289
Option('filters', help='Apply content filters to export the '
3290
'convenient form.'),
3293
help="Name of the root directory inside the exported file."),
3294
Option('per-file-timestamps',
3295
help='Set modification time of files to that of the last '
3296
'revision in which it was changed.'),
3297
Option('uncommitted',
3298
help='Export the working tree contents rather than that of the '
3301
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3302
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3304
from bzrlib.export import export
3306
if branch_or_subdir is None:
3307
branch_or_subdir = directory
3309
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3311
if tree is not None:
3312
self.add_cleanup(tree.lock_read().unlock)
3316
raise errors.BzrCommandError(
3317
gettext("--uncommitted requires a working tree"))
3320
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3322
export(export_tree, dest, format, root, subdir, filtered=filters,
3323
per_file_timestamps=per_file_timestamps)
3324
except errors.NoSuchExportFormat, e:
3325
raise errors.BzrCommandError(
3326
gettext('Unsupported export format: %s') % e.format)
3329
class cmd_cat(Command):
3330
__doc__ = """Write the contents of a file as of a given revision to standard output.
3332
If no revision is nominated, the last revision is used.
3334
Note: Take care to redirect standard output when using this command on a
3339
takes_options = ['directory',
3340
Option('name-from-revision', help='The path name in the old tree.'),
3341
Option('filters', help='Apply content filters to display the '
3342
'convenience form.'),
3345
takes_args = ['filename']
3346
encoding_type = 'exact'
3349
def run(self, filename, revision=None, name_from_revision=False,
3350
filters=False, directory=None):
3351
if revision is not None and len(revision) != 1:
3352
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3353
" one revision specifier"))
3354
tree, branch, relpath = \
3355
_open_directory_or_containing_tree_or_branch(filename, directory)
3356
self.add_cleanup(branch.lock_read().unlock)
3357
return self._run(tree, branch, relpath, filename, revision,
3358
name_from_revision, filters)
3360
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3363
tree = b.basis_tree()
3364
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3365
self.add_cleanup(rev_tree.lock_read().unlock)
3367
old_file_id = rev_tree.path2id(relpath)
3369
# TODO: Split out this code to something that generically finds the
3370
# best id for a path across one or more trees; it's like
3371
# find_ids_across_trees but restricted to find just one. -- mbp
3373
if name_from_revision:
3374
# Try in revision if requested
3375
if old_file_id is None:
3376
raise errors.BzrCommandError(gettext(
3377
"{0!r} is not present in revision {1}").format(
3378
filename, rev_tree.get_revision_id()))
3380
actual_file_id = old_file_id
3382
cur_file_id = tree.path2id(relpath)
3383
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3384
actual_file_id = cur_file_id
3385
elif old_file_id is not None:
3386
actual_file_id = old_file_id
3388
raise errors.BzrCommandError(gettext(
3389
"{0!r} is not present in revision {1}").format(
3390
filename, rev_tree.get_revision_id()))
3392
from bzrlib.filter_tree import ContentFilterTree
3393
filter_tree = ContentFilterTree(rev_tree,
3394
rev_tree._content_filter_stack)
3395
content = filter_tree.get_file_text(actual_file_id)
3397
content = rev_tree.get_file_text(actual_file_id)
3399
self.outf.write(content)
3402
class cmd_local_time_offset(Command):
3403
__doc__ = """Show the offset in seconds from GMT to local time."""
3407
self.outf.write("%s\n" % osutils.local_time_offset())
3411
class cmd_commit(Command):
3412
__doc__ = """Commit changes into a new revision.
3414
An explanatory message needs to be given for each commit. This is
3415
often done by using the --message option (getting the message from the
3416
command line) or by using the --file option (getting the message from
3417
a file). If neither of these options is given, an editor is opened for
3418
the user to enter the message. To see the changed files in the
3419
boilerplate text loaded into the editor, use the --show-diff option.
3421
By default, the entire tree is committed and the person doing the
3422
commit is assumed to be the author. These defaults can be overridden
3427
If selected files are specified, only changes to those files are
3428
committed. If a directory is specified then the directory and
3429
everything within it is committed.
3431
When excludes are given, they take precedence over selected files.
3432
For example, to commit only changes within foo, but not changes
3435
bzr commit foo -x foo/bar
3437
A selective commit after a merge is not yet supported.
3441
If the author of the change is not the same person as the committer,
3442
you can specify the author's name using the --author option. The
3443
name should be in the same format as a committer-id, e.g.
3444
"John Doe <jdoe@example.com>". If there is more than one author of
3445
the change you can specify the option multiple times, once for each
3450
A common mistake is to forget to add a new file or directory before
3451
running the commit command. The --strict option checks for unknown
3452
files and aborts the commit if any are found. More advanced pre-commit
3453
checks can be implemented by defining hooks. See ``bzr help hooks``
3458
If you accidentially commit the wrong changes or make a spelling
3459
mistake in the commit message say, you can use the uncommit command
3460
to undo it. See ``bzr help uncommit`` for details.
3462
Hooks can also be configured to run after a commit. This allows you
3463
to trigger updates to external systems like bug trackers. The --fixes
3464
option can be used to record the association between a revision and
3465
one or more bugs. See ``bzr help bugs`` for details.
3468
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3469
takes_args = ['selected*']
3471
ListOption('exclude', type=str, short_name='x',
3472
help="Do not consider changes made to a given path."),
3473
Option('message', type=unicode,
3475
help="Description of the new revision."),
3478
help='Commit even if nothing has changed.'),
3479
Option('file', type=str,
3482
help='Take commit message from this file.'),
3484
help="Refuse to commit if there are unknown "
3485
"files in the working tree."),
3486
Option('commit-time', type=str,
3487
help="Manually set a commit time using commit date "
3488
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3489
ListOption('fixes', type=str,
3490
help="Mark a bug as being fixed by this revision "
3491
"(see \"bzr help bugs\")."),
3492
ListOption('author', type=unicode,
3493
help="Set the author's name, if it's different "
3494
"from the committer."),
3496
help="Perform a local commit in a bound "
3497
"branch. Local commits are not pushed to "
3498
"the master branch until a normal commit "
3501
Option('show-diff', short_name='p',
3502
help='When no message is supplied, show the diff along'
3503
' with the status summary in the message editor.'),
3505
help='When committing to a foreign version control '
3506
'system do not push data that can not be natively '
3509
aliases = ['ci', 'checkin']
3511
def _iter_bug_fix_urls(self, fixes, branch):
3512
default_bugtracker = None
3513
# Configure the properties for bug fixing attributes.
3514
for fixed_bug in fixes:
3515
tokens = fixed_bug.split(':')
3516
if len(tokens) == 1:
3517
if default_bugtracker is None:
3518
branch_config = branch.get_config_stack()
3519
default_bugtracker = branch_config.get(
3521
if default_bugtracker is None:
3522
raise errors.BzrCommandError(gettext(
3523
"No tracker specified for bug %s. Use the form "
3524
"'tracker:id' or specify a default bug tracker "
3525
"using the `bugtracker` option.\nSee "
3526
"\"bzr help bugs\" for more information on this "
3527
"feature. Commit refused.") % fixed_bug)
3528
tag = default_bugtracker
3530
elif len(tokens) != 2:
3531
raise errors.BzrCommandError(gettext(
3532
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3533
"See \"bzr help bugs\" for more information on this "
3534
"feature.\nCommit refused.") % fixed_bug)
3536
tag, bug_id = tokens
3538
yield bugtracker.get_bug_url(tag, branch, bug_id)
3539
except errors.UnknownBugTrackerAbbreviation:
3540
raise errors.BzrCommandError(gettext(
3541
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3542
except errors.MalformedBugIdentifier, e:
3543
raise errors.BzrCommandError(gettext(
3544
"%s\nCommit refused.") % (str(e),))
3546
def run(self, message=None, file=None, verbose=False, selected_list=None,
3547
unchanged=False, strict=False, local=False, fixes=None,
3548
author=None, show_diff=False, exclude=None, commit_time=None,
3550
from bzrlib.errors import (
3555
from bzrlib.msgeditor import (
3556
edit_commit_message_encoded,
3557
generate_commit_message_template,
3558
make_commit_message_template_encoded,
3562
commit_stamp = offset = None
3563
if commit_time is not None:
3565
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3566
except ValueError, e:
3567
raise errors.BzrCommandError(gettext(
3568
"Could not parse --commit-time: " + str(e)))
3572
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3573
if selected_list == ['']:
3574
# workaround - commit of root of tree should be exactly the same
3575
# as just default commit in that tree, and succeed even though
3576
# selected-file merge commit is not done yet
3581
bug_property = bugtracker.encode_fixes_bug_urls(
3582
self._iter_bug_fix_urls(fixes, tree.branch))
3584
properties['bugs'] = bug_property
3586
if local and not tree.branch.get_bound_location():
3587
raise errors.LocalRequiresBoundBranch()
3589
if message is not None:
3591
file_exists = osutils.lexists(message)
3592
except UnicodeError:
3593
# The commit message contains unicode characters that can't be
3594
# represented in the filesystem encoding, so that can't be a
3599
'The commit message is a file name: "%(f)s".\n'
3600
'(use --file "%(f)s" to take commit message from that file)'
3602
ui.ui_factory.show_warning(warning_msg)
3604
message = message.replace('\r\n', '\n')
3605
message = message.replace('\r', '\n')
3607
raise errors.BzrCommandError(gettext(
3608
"please specify either --message or --file"))
3610
def get_message(commit_obj):
3611
"""Callback to get commit message"""
3615
my_message = f.read().decode(osutils.get_user_encoding())
3618
elif message is not None:
3619
my_message = message
3621
# No message supplied: make one up.
3622
# text is the status of the tree
3623
text = make_commit_message_template_encoded(tree,
3624
selected_list, diff=show_diff,
3625
output_encoding=osutils.get_user_encoding())
3626
# start_message is the template generated from hooks
3627
# XXX: Warning - looks like hooks return unicode,
3628
# make_commit_message_template_encoded returns user encoding.
3629
# We probably want to be using edit_commit_message instead to
3631
my_message = set_commit_message(commit_obj)
3632
if my_message is None:
3633
start_message = generate_commit_message_template(commit_obj)
3634
my_message = edit_commit_message_encoded(text,
3635
start_message=start_message)
3636
if my_message is None:
3637
raise errors.BzrCommandError(gettext("please specify a commit"
3638
" message with either --message or --file"))
3639
if my_message == "":
3640
raise errors.BzrCommandError(gettext("Empty commit message specified."
3641
" Please specify a commit message with either"
3642
" --message or --file or leave a blank message"
3643
" with --message \"\"."))
3646
# The API permits a commit with a filter of [] to mean 'select nothing'
3647
# but the command line should not do that.
3648
if not selected_list:
3649
selected_list = None
3651
tree.commit(message_callback=get_message,
3652
specific_files=selected_list,
3653
allow_pointless=unchanged, strict=strict, local=local,
3654
reporter=None, verbose=verbose, revprops=properties,
3655
authors=author, timestamp=commit_stamp,
3657
exclude=tree.safe_relpath_files(exclude),
3659
except PointlessCommit:
3660
raise errors.BzrCommandError(gettext("No changes to commit."
3661
" Please 'bzr add' the files you want to commit, or use"
3662
" --unchanged to force an empty commit."))
3663
except ConflictsInTree:
3664
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3665
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3667
except StrictCommitFailed:
3668
raise errors.BzrCommandError(gettext("Commit refused because there are"
3669
" unknown files in the working tree."))
3670
except errors.BoundBranchOutOfDate, e:
3671
e.extra_help = (gettext("\n"
3672
'To commit to master branch, run update and then commit.\n'
3673
'You can also pass --local to commit to continue working '
3678
class cmd_check(Command):
3679
__doc__ = """Validate working tree structure, branch consistency and repository history.
3681
This command checks various invariants about branch and repository storage
3682
to detect data corruption or bzr bugs.
3684
The working tree and branch checks will only give output if a problem is
3685
detected. The output fields of the repository check are:
3688
This is just the number of revisions checked. It doesn't
3692
This is just the number of versionedfiles checked. It
3693
doesn't indicate a problem.
3695
unreferenced ancestors
3696
Texts that are ancestors of other texts, but
3697
are not properly referenced by the revision ancestry. This is a
3698
subtle problem that Bazaar can work around.
3701
This is the total number of unique file contents
3702
seen in the checked revisions. It does not indicate a problem.
3705
This is the total number of repeated texts seen
3706
in the checked revisions. Texts can be repeated when their file
3707
entries are modified, but the file contents are not. It does not
3710
If no restrictions are specified, all Bazaar data that is found at the given
3711
location will be checked.
3715
Check the tree and branch at 'foo'::
3717
bzr check --tree --branch foo
3719
Check only the repository at 'bar'::
3721
bzr check --repo bar
3723
Check everything at 'baz'::
3728
_see_also = ['reconcile']
3729
takes_args = ['path?']
3730
takes_options = ['verbose',
3731
Option('branch', help="Check the branch related to the"
3732
" current directory."),
3733
Option('repo', help="Check the repository related to the"
3734
" current directory."),
3735
Option('tree', help="Check the working tree related to"
3736
" the current directory.")]
3738
def run(self, path=None, verbose=False, branch=False, repo=False,
3740
from bzrlib.check import check_dwim
3743
if not branch and not repo and not tree:
3744
branch = repo = tree = True
3745
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3748
class cmd_upgrade(Command):
3749
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3751
When the default format has changed after a major new release of
3752
Bazaar, you may be informed during certain operations that you
3753
should upgrade. Upgrading to a newer format may improve performance
3754
or make new features available. It may however limit interoperability
3755
with older repositories or with older versions of Bazaar.
3757
If you wish to upgrade to a particular format rather than the
3758
current default, that can be specified using the --format option.
3759
As a consequence, you can use the upgrade command this way to
3760
"downgrade" to an earlier format, though some conversions are
3761
a one way process (e.g. changing from the 1.x default to the
3762
2.x default) so downgrading is not always possible.
3764
A backup.bzr.~#~ directory is created at the start of the conversion
3765
process (where # is a number). By default, this is left there on
3766
completion. If the conversion fails, delete the new .bzr directory
3767
and rename this one back in its place. Use the --clean option to ask
3768
for the backup.bzr directory to be removed on successful conversion.
3769
Alternatively, you can delete it by hand if everything looks good
3772
If the location given is a shared repository, dependent branches
3773
are also converted provided the repository converts successfully.
3774
If the conversion of a branch fails, remaining branches are still
3777
For more information on upgrades, see the Bazaar Upgrade Guide,
3778
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3781
_see_also = ['check', 'reconcile', 'formats']
3782
takes_args = ['url?']
3784
RegistryOption('format',
3785
help='Upgrade to a specific format. See "bzr help'
3786
' formats" for details.',
3787
lazy_registry=('bzrlib.controldir', 'format_registry'),
3788
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3789
value_switches=True, title='Branch format'),
3791
help='Remove the backup.bzr directory if successful.'),
3793
help="Show what would be done, but don't actually do anything."),
3796
def run(self, url='.', format=None, clean=False, dry_run=False):
3797
from bzrlib.upgrade import upgrade
3798
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3800
if len(exceptions) == 1:
3801
# Compatibility with historical behavior
3807
class cmd_whoami(Command):
3808
__doc__ = """Show or set bzr user id.
3811
Show the email of the current user::
3815
Set the current user::
3817
bzr whoami "Frank Chu <fchu@example.com>"
3819
takes_options = [ 'directory',
3821
help='Display email address only.'),
3823
help='Set identity for the current branch instead of '
3826
takes_args = ['name?']
3827
encoding_type = 'replace'
3830
def run(self, email=False, branch=False, name=None, directory=None):
3832
if directory is None:
3833
# use branch if we're inside one; otherwise global config
3835
c = Branch.open_containing(u'.')[0].get_config_stack()
3836
except errors.NotBranchError:
3837
c = _mod_config.GlobalStack()
3839
c = Branch.open(directory).get_config_stack()
3840
identity = c.get('email')
3842
self.outf.write(_mod_config.extract_email_address(identity)
3845
self.outf.write(identity + '\n')
3849
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3852
# display a warning if an email address isn't included in the given name.
3854
_mod_config.extract_email_address(name)
3855
except errors.NoEmailInUsername, e:
3856
warning('"%s" does not seem to contain an email address. '
3857
'This is allowed, but not recommended.', name)
3859
# use global config unless --branch given
3861
if directory is None:
3862
c = Branch.open_containing(u'.')[0].get_config_stack()
3864
b = Branch.open(directory)
3865
self.add_cleanup(b.lock_write().unlock)
3866
c = b.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
# FIXME: Support nested trees
4679
for name, ie in tree.root_inventory.iter_entries(file_id):
4680
interesting_ids.add(ie.file_id)
4681
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4683
# Remerge only supports resolving contents conflicts
4684
allowed_conflicts = ('text conflict', 'contents conflict')
4685
restore_files = [c.path for c in conflicts
4686
if c.typestring in allowed_conflicts]
4687
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4688
tree.set_conflicts(ConflictList(new_conflicts))
4689
if file_list is not None:
4690
restore_files = file_list
4691
for filename in restore_files:
4693
restore(tree.abspath(filename))
4694
except errors.NotConflicted:
4696
# Disable pending merges, because the file texts we are remerging
4697
# have not had those merges performed. If we use the wrong parents
4698
# list, we imply that the working tree text has seen and rejected
4699
# all the changes from the other tree, when in fact those changes
4700
# have not yet been seen.
4701
tree.set_parent_ids(parents[:1])
4703
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4704
merger.interesting_ids = interesting_ids
4705
merger.merge_type = merge_type
4706
merger.show_base = show_base
4707
merger.reprocess = reprocess
4708
conflicts = merger.do_merge()
4710
tree.set_parent_ids(parents)
4717
class cmd_revert(Command):
4718
__doc__ = """Revert files to a previous revision.
4720
Giving a list of files will revert only those files. Otherwise, all files
4721
will be reverted. If the revision is not specified with '--revision', the
4722
last committed revision is used.
4724
To remove only some changes, without reverting to a prior version, use
4725
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4726
will remove the changes introduced by the second last commit (-2), without
4727
affecting the changes introduced by the last commit (-1). To remove
4728
certain changes on a hunk-by-hunk basis, see the shelve command.
4730
By default, any files that have been manually changed will be backed up
4731
first. (Files changed only by merge are not backed up.) Backup files have
4732
'.~#~' appended to their name, where # is a number.
4734
When you provide files, you can use their current pathname or the pathname
4735
from the target revision. So you can use revert to "undelete" a file by
4736
name. If you name a directory, all the contents of that directory will be
4739
If you have newly added files since the target revision, they will be
4740
removed. If the files to be removed have been changed, backups will be
4741
created as above. Directories containing unknown files will not be
4744
The working tree contains a list of revisions that have been merged but
4745
not yet committed. These revisions will be included as additional parents
4746
of the next commit. Normally, using revert clears that list as well as
4747
reverting the files. If any files are specified, revert leaves the list
4748
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4749
.`` in the tree root to revert all files but keep the recorded merges,
4750
and ``bzr revert --forget-merges`` to clear the pending merge list without
4751
reverting any files.
4753
Using "bzr revert --forget-merges", it is possible to apply all of the
4754
changes from a branch in a single revision. To do this, perform the merge
4755
as desired. Then doing revert with the "--forget-merges" option will keep
4756
the content of the tree as it was, but it will clear the list of pending
4757
merges. The next commit will then contain all of the changes that are
4758
present in the other branch, but without any other parent revisions.
4759
Because this technique forgets where these changes originated, it may
4760
cause additional conflicts on later merges involving the same source and
4764
_see_also = ['cat', 'export', 'merge', 'shelve']
4767
Option('no-backup', "Do not save backups of reverted files."),
4768
Option('forget-merges',
4769
'Remove pending merge marker, without changing any files.'),
4771
takes_args = ['file*']
4773
def run(self, revision=None, no_backup=False, file_list=None,
4774
forget_merges=None):
4775
tree, file_list = WorkingTree.open_containing_paths(file_list)
4776
self.add_cleanup(tree.lock_tree_write().unlock)
4778
tree.set_parent_ids(tree.get_parent_ids()[:1])
4780
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4783
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4784
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4785
tree.revert(file_list, rev_tree, not no_backup, None,
4786
report_changes=True)
4789
class cmd_assert_fail(Command):
4790
__doc__ = """Test reporting of assertion failures"""
4791
# intended just for use in testing
4796
raise AssertionError("always fails")
4799
class cmd_help(Command):
4800
__doc__ = """Show help on a command or other topic.
4803
_see_also = ['topics']
4805
Option('long', 'Show help on all commands.'),
4807
takes_args = ['topic?']
4808
aliases = ['?', '--help', '-?', '-h']
4811
def run(self, topic=None, long=False):
4813
if topic is None and long:
4815
bzrlib.help.help(topic)
4818
class cmd_shell_complete(Command):
4819
__doc__ = """Show appropriate completions for context.
4821
For a list of all available commands, say 'bzr shell-complete'.
4823
takes_args = ['context?']
4828
def run(self, context=None):
4829
from bzrlib import shellcomplete
4830
shellcomplete.shellcomplete(context)
4833
class cmd_missing(Command):
4834
__doc__ = """Show unmerged/unpulled revisions between two branches.
4836
OTHER_BRANCH may be local or remote.
4838
To filter on a range of revisions, you can use the command -r begin..end
4839
-r revision requests a specific revision, -r ..end or -r begin.. are
4843
1 - some missing revisions
4844
0 - no missing revisions
4848
Determine the missing revisions between this and the branch at the
4849
remembered pull location::
4853
Determine the missing revisions between this and another branch::
4855
bzr missing http://server/branch
4857
Determine the missing revisions up to a specific revision on the other
4860
bzr missing -r ..-10
4862
Determine the missing revisions up to a specific revision on this
4865
bzr missing --my-revision ..-10
4868
_see_also = ['merge', 'pull']
4869
takes_args = ['other_branch?']
4872
Option('reverse', 'Reverse the order of revisions.'),
4874
'Display changes in the local branch only.'),
4875
Option('this' , 'Same as --mine-only.'),
4876
Option('theirs-only',
4877
'Display changes in the remote branch only.'),
4878
Option('other', 'Same as --theirs-only.'),
4882
custom_help('revision',
4883
help='Filter on other branch revisions (inclusive). '
4884
'See "help revisionspec" for details.'),
4885
Option('my-revision',
4886
type=_parse_revision_str,
4887
help='Filter on local branch revisions (inclusive). '
4888
'See "help revisionspec" for details.'),
4889
Option('include-merged',
4890
'Show all revisions in addition to the mainline ones.'),
4891
Option('include-merges', hidden=True,
4892
help='Historical alias for --include-merged.'),
4894
encoding_type = 'replace'
4897
def run(self, other_branch=None, reverse=False, mine_only=False,
4899
log_format=None, long=False, short=False, line=False,
4900
show_ids=False, verbose=False, this=False, other=False,
4901
include_merged=None, revision=None, my_revision=None,
4903
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4904
from bzrlib.missing import find_unmerged, iter_log_revisions
4909
if symbol_versioning.deprecated_passed(include_merges):
4910
ui.ui_factory.show_user_warning(
4911
'deprecated_command_option',
4912
deprecated_name='--include-merges',
4913
recommended_name='--include-merged',
4914
deprecated_in_version='2.5',
4915
command=self.invoked_as)
4916
if include_merged is None:
4917
include_merged = include_merges
4919
raise errors.BzrCommandError(gettext(
4920
'{0} and {1} are mutually exclusive').format(
4921
'--include-merges', '--include-merged'))
4922
if include_merged is None:
4923
include_merged = False
4928
# TODO: We should probably check that we don't have mine-only and
4929
# theirs-only set, but it gets complicated because we also have
4930
# this and other which could be used.
4937
local_branch = Branch.open_containing(directory)[0]
4938
self.add_cleanup(local_branch.lock_read().unlock)
4940
parent = local_branch.get_parent()
4941
if other_branch is None:
4942
other_branch = parent
4943
if other_branch is None:
4944
raise errors.BzrCommandError(gettext("No peer location known"
4946
display_url = urlutils.unescape_for_display(parent,
4948
message(gettext("Using saved parent location: {0}\n").format(
4951
remote_branch = Branch.open(other_branch)
4952
if remote_branch.base == local_branch.base:
4953
remote_branch = local_branch
4955
self.add_cleanup(remote_branch.lock_read().unlock)
4957
local_revid_range = _revision_range_to_revid_range(
4958
_get_revision_range(my_revision, local_branch,
4961
remote_revid_range = _revision_range_to_revid_range(
4962
_get_revision_range(revision,
4963
remote_branch, self.name()))
4965
local_extra, remote_extra = find_unmerged(
4966
local_branch, remote_branch, restrict,
4967
backward=not reverse,
4968
include_merged=include_merged,
4969
local_revid_range=local_revid_range,
4970
remote_revid_range=remote_revid_range)
4972
if log_format is None:
4973
registry = log.log_formatter_registry
4974
log_format = registry.get_default(local_branch)
4975
lf = log_format(to_file=self.outf,
4977
show_timezone='original')
4980
if local_extra and not theirs_only:
4981
message(ngettext("You have %d extra revision:\n",
4982
"You have %d extra revisions:\n",
4985
for revision in iter_log_revisions(local_extra,
4986
local_branch.repository,
4988
lf.log_revision(revision)
4989
printed_local = True
4992
printed_local = False
4994
if remote_extra and not mine_only:
4995
if printed_local is True:
4997
message(ngettext("You are missing %d revision:\n",
4998
"You are missing %d revisions:\n",
4999
len(remote_extra)) %
5001
for revision in iter_log_revisions(remote_extra,
5002
remote_branch.repository,
5004
lf.log_revision(revision)
5007
if mine_only and not local_extra:
5008
# We checked local, and found nothing extra
5009
message(gettext('This branch has no new revisions.\n'))
5010
elif theirs_only and not remote_extra:
5011
# We checked remote, and found nothing extra
5012
message(gettext('Other branch has no new revisions.\n'))
5013
elif not (mine_only or theirs_only or local_extra or
5015
# We checked both branches, and neither one had extra
5017
message(gettext("Branches are up to date.\n"))
5019
if not status_code and parent is None and other_branch is not None:
5020
self.add_cleanup(local_branch.lock_write().unlock)
5021
# handle race conditions - a parent might be set while we run.
5022
if local_branch.get_parent() is None:
5023
local_branch.set_parent(remote_branch.base)
5027
class cmd_pack(Command):
5028
__doc__ = """Compress the data within a repository.
5030
This operation compresses the data within a bazaar repository. As
5031
bazaar supports automatic packing of repository, this operation is
5032
normally not required to be done manually.
5034
During the pack operation, bazaar takes a backup of existing repository
5035
data, i.e. pack files. This backup is eventually removed by bazaar
5036
automatically when it is safe to do so. To save disk space by removing
5037
the backed up pack files, the --clean-obsolete-packs option may be
5040
Warning: If you use --clean-obsolete-packs and your machine crashes
5041
during or immediately after repacking, you may be left with a state
5042
where the deletion has been written to disk but the new packs have not
5043
been. In this case the repository may be unusable.
5046
_see_also = ['repositories']
5047
takes_args = ['branch_or_repo?']
5049
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5052
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5053
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5055
branch = dir.open_branch()
5056
repository = branch.repository
5057
except errors.NotBranchError:
5058
repository = dir.open_repository()
5059
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5062
class cmd_plugins(Command):
5063
__doc__ = """List the installed plugins.
5065
This command displays the list of installed plugins including
5066
version of plugin and a short description of each.
5068
--verbose shows the path where each plugin is located.
5070
A plugin is an external component for Bazaar that extends the
5071
revision control system, by adding or replacing code in Bazaar.
5072
Plugins can do a variety of things, including overriding commands,
5073
adding new commands, providing additional network transports and
5074
customizing log output.
5076
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5077
for further information on plugins including where to find them and how to
5078
install them. Instructions are also provided there on how to write new
5079
plugins using the Python programming language.
5081
takes_options = ['verbose']
5084
def run(self, verbose=False):
5085
from bzrlib import plugin
5086
# Don't give writelines a generator as some codecs don't like that
5087
self.outf.writelines(
5088
list(plugin.describe_plugins(show_paths=verbose)))
5091
class cmd_testament(Command):
5092
__doc__ = """Show testament (signing-form) of a revision."""
5095
Option('long', help='Produce long-format testament.'),
5097
help='Produce a strict-format testament.')]
5098
takes_args = ['branch?']
5100
def run(self, branch=u'.', revision=None, long=False, strict=False):
5101
from bzrlib.testament import Testament, StrictTestament
5103
testament_class = StrictTestament
5105
testament_class = Testament
5107
b = Branch.open_containing(branch)[0]
5109
b = Branch.open(branch)
5110
self.add_cleanup(b.lock_read().unlock)
5111
if revision is None:
5112
rev_id = b.last_revision()
5114
rev_id = revision[0].as_revision_id(b)
5115
t = testament_class.from_revision(b.repository, rev_id)
5117
sys.stdout.writelines(t.as_text_lines())
5119
sys.stdout.write(t.as_short_text())
5122
class cmd_annotate(Command):
5123
__doc__ = """Show the origin of each line in a file.
5125
This prints out the given file with an annotation on the left side
5126
indicating which revision, author and date introduced the change.
5128
If the origin is the same for a run of consecutive lines, it is
5129
shown only at the top, unless the --all option is given.
5131
# TODO: annotate directories; showing when each file was last changed
5132
# TODO: if the working copy is modified, show annotations on that
5133
# with new uncommitted lines marked
5134
aliases = ['ann', 'blame', 'praise']
5135
takes_args = ['filename']
5136
takes_options = [Option('all', help='Show annotations on all lines.'),
5137
Option('long', help='Show commit date in annotations.'),
5142
encoding_type = 'exact'
5145
def run(self, filename, all=False, long=False, revision=None,
5146
show_ids=False, directory=None):
5147
from bzrlib.annotate import (
5150
wt, branch, relpath = \
5151
_open_directory_or_containing_tree_or_branch(filename, directory)
5153
self.add_cleanup(wt.lock_read().unlock)
5155
self.add_cleanup(branch.lock_read().unlock)
5156
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5157
self.add_cleanup(tree.lock_read().unlock)
5158
if wt is not None and revision is None:
5159
file_id = wt.path2id(relpath)
5161
file_id = tree.path2id(relpath)
5163
raise errors.NotVersionedError(filename)
5164
if wt is not None and revision is None:
5165
# If there is a tree and we're not annotating historical
5166
# versions, annotate the working tree's content.
5167
annotate_file_tree(wt, file_id, self.outf, long, all,
5170
annotate_file_tree(tree, file_id, self.outf, long, all,
5171
show_ids=show_ids, branch=branch)
5174
class cmd_re_sign(Command):
5175
__doc__ = """Create a digital signature for an existing revision."""
5176
# TODO be able to replace existing ones.
5178
hidden = True # is this right ?
5179
takes_args = ['revision_id*']
5180
takes_options = ['directory', 'revision']
5182
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5183
if revision_id_list is not None and revision is not None:
5184
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5185
if revision_id_list is None and revision is None:
5186
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5187
b = WorkingTree.open_containing(directory)[0].branch
5188
self.add_cleanup(b.lock_write().unlock)
5189
return self._run(b, revision_id_list, revision)
5191
def _run(self, b, revision_id_list, revision):
5192
import bzrlib.gpg as gpg
5193
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5194
if revision_id_list is not None:
5195
b.repository.start_write_group()
5197
for revision_id in revision_id_list:
5198
b.repository.sign_revision(revision_id, gpg_strategy)
5200
b.repository.abort_write_group()
5203
b.repository.commit_write_group()
5204
elif revision is not None:
5205
if len(revision) == 1:
5206
revno, rev_id = revision[0].in_history(b)
5207
b.repository.start_write_group()
5209
b.repository.sign_revision(rev_id, gpg_strategy)
5211
b.repository.abort_write_group()
5214
b.repository.commit_write_group()
5215
elif len(revision) == 2:
5216
# are they both on rh- if so we can walk between them
5217
# might be nice to have a range helper for arbitrary
5218
# revision paths. hmm.
5219
from_revno, from_revid = revision[0].in_history(b)
5220
to_revno, to_revid = revision[1].in_history(b)
5221
if to_revid is None:
5222
to_revno = b.revno()
5223
if from_revno is None or to_revno is None:
5224
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5225
b.repository.start_write_group()
5227
for revno in range(from_revno, to_revno + 1):
5228
b.repository.sign_revision(b.get_rev_id(revno),
5231
b.repository.abort_write_group()
5234
b.repository.commit_write_group()
5236
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5239
class cmd_bind(Command):
5240
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5241
If no branch is supplied, rebind to the last bound location.
5243
Once converted into a checkout, commits must succeed on the master branch
5244
before they will be applied to the local branch.
5246
Bound branches use the nickname of its master branch unless it is set
5247
locally, in which case binding will update the local nickname to be
5251
_see_also = ['checkouts', 'unbind']
5252
takes_args = ['location?']
5253
takes_options = ['directory']
5255
def run(self, location=None, directory=u'.'):
5256
b, relpath = Branch.open_containing(directory)
5257
if location is None:
5259
location = b.get_old_bound_location()
5260
except errors.UpgradeRequired:
5261
raise errors.BzrCommandError(gettext('No location supplied. '
5262
'This format does not remember old locations.'))
5264
if location is None:
5265
if b.get_bound_location() is not None:
5266
raise errors.BzrCommandError(
5267
gettext('Branch is already bound'))
5269
raise errors.BzrCommandError(
5270
gettext('No location supplied'
5271
' and no previous location known'))
5272
b_other = Branch.open(location)
5275
except errors.DivergedBranches:
5276
raise errors.BzrCommandError(gettext('These branches have diverged.'
5277
' Try merging, and then bind again.'))
5278
if b.get_config().has_explicit_nickname():
5279
b.nick = b_other.nick
5282
class cmd_unbind(Command):
5283
__doc__ = """Convert the current checkout into a regular branch.
5285
After unbinding, the local branch is considered independent and subsequent
5286
commits will be local only.
5289
_see_also = ['checkouts', 'bind']
5291
takes_options = ['directory']
5293
def run(self, directory=u'.'):
5294
b, relpath = Branch.open_containing(directory)
5296
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5299
class cmd_uncommit(Command):
5300
__doc__ = """Remove the last committed revision.
5302
--verbose will print out what is being removed.
5303
--dry-run will go through all the motions, but not actually
5306
If --revision is specified, uncommit revisions to leave the branch at the
5307
specified revision. For example, "bzr uncommit -r 15" will leave the
5308
branch at revision 15.
5310
Uncommit leaves the working tree ready for a new commit. The only change
5311
it may make is to restore any pending merges that were present before
5315
# TODO: jam 20060108 Add an option to allow uncommit to remove
5316
# unreferenced information in 'branch-as-repository' branches.
5317
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5318
# information in shared branches as well.
5319
_see_also = ['commit']
5320
takes_options = ['verbose', 'revision',
5321
Option('dry-run', help='Don\'t actually make changes.'),
5322
Option('force', help='Say yes to all questions.'),
5324
help='Keep tags that point to removed revisions.'),
5326
help="Only remove the commits from the local branch"
5327
" when in a checkout."
5330
takes_args = ['location?']
5332
encoding_type = 'replace'
5334
def run(self, location=None, dry_run=False, verbose=False,
5335
revision=None, force=False, local=False, keep_tags=False):
5336
if location is None:
5338
control, relpath = controldir.ControlDir.open_containing(location)
5340
tree = control.open_workingtree()
5342
except (errors.NoWorkingTree, errors.NotLocalUrl):
5344
b = control.open_branch()
5346
if tree is not None:
5347
self.add_cleanup(tree.lock_write().unlock)
5349
self.add_cleanup(b.lock_write().unlock)
5350
return self._run(b, tree, dry_run, verbose, revision, force,
5353
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5355
from bzrlib.log import log_formatter, show_log
5356
from bzrlib.uncommit import uncommit
5358
last_revno, last_rev_id = b.last_revision_info()
5361
if revision is None:
5363
rev_id = last_rev_id
5365
# 'bzr uncommit -r 10' actually means uncommit
5366
# so that the final tree is at revno 10.
5367
# but bzrlib.uncommit.uncommit() actually uncommits
5368
# the revisions that are supplied.
5369
# So we need to offset it by one
5370
revno = revision[0].in_history(b).revno + 1
5371
if revno <= last_revno:
5372
rev_id = b.get_rev_id(revno)
5374
if rev_id is None or _mod_revision.is_null(rev_id):
5375
self.outf.write(gettext('No revisions to uncommit.\n'))
5378
lf = log_formatter('short',
5380
show_timezone='original')
5385
direction='forward',
5386
start_revision=revno,
5387
end_revision=last_revno)
5390
self.outf.write(gettext('Dry-run, pretending to remove'
5391
' the above revisions.\n'))
5393
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5396
if not ui.ui_factory.confirm_action(
5397
gettext(u'Uncommit these revisions'),
5398
'bzrlib.builtins.uncommit',
5400
self.outf.write(gettext('Canceled\n'))
5403
mutter('Uncommitting from {%s} to {%s}',
5404
last_rev_id, rev_id)
5405
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5406
revno=revno, local=local, keep_tags=keep_tags)
5407
self.outf.write(gettext('You can restore the old tip by running:\n'
5408
' bzr pull . -r revid:%s\n') % last_rev_id)
5411
class cmd_break_lock(Command):
5412
__doc__ = """Break a dead lock.
5414
This command breaks a lock on a repository, branch, working directory or
5417
CAUTION: Locks should only be broken when you are sure that the process
5418
holding the lock has been stopped.
5420
You can get information on what locks are open via the 'bzr info
5421
[location]' command.
5425
bzr break-lock bzr+ssh://example.com/bzr/foo
5426
bzr break-lock --conf ~/.bazaar
5429
takes_args = ['location?']
5432
help='LOCATION is the directory where the config lock is.'),
5434
help='Do not ask for confirmation before breaking the lock.'),
5437
def run(self, location=None, config=False, force=False):
5438
if location is None:
5441
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5443
{'bzrlib.lockdir.break': True})
5445
conf = _mod_config.LockableConfig(file_name=location)
5448
control, relpath = controldir.ControlDir.open_containing(location)
5450
control.break_lock()
5451
except NotImplementedError:
5455
class cmd_wait_until_signalled(Command):
5456
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5458
This just prints a line to signal when it is ready, then blocks on stdin.
5464
sys.stdout.write("running\n")
5466
sys.stdin.readline()
5469
class cmd_serve(Command):
5470
__doc__ = """Run the bzr server."""
5472
aliases = ['server']
5476
help='Serve on stdin/out for use from inetd or sshd.'),
5477
RegistryOption('protocol',
5478
help="Protocol to serve.",
5479
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5480
value_switches=True),
5482
help='Listen for connections on nominated port of the form '
5483
'[hostname:]portnumber. Passing 0 as the port number will '
5484
'result in a dynamically allocated port. The default port '
5485
'depends on the protocol.',
5487
custom_help('directory',
5488
help='Serve contents of this directory.'),
5489
Option('allow-writes',
5490
help='By default the server is a readonly server. Supplying '
5491
'--allow-writes enables write access to the contents of '
5492
'the served directory and below. Note that ``bzr serve`` '
5493
'does not perform authentication, so unless some form of '
5494
'external authentication is arranged supplying this '
5495
'option leads to global uncontrolled write access to your '
5498
Option('client-timeout', type=float,
5499
help='Override the default idle client timeout (5min).'),
5502
def get_host_and_port(self, port):
5503
"""Return the host and port to run the smart server on.
5505
If 'port' is None, None will be returned for the host and port.
5507
If 'port' has a colon in it, the string before the colon will be
5508
interpreted as the host.
5510
:param port: A string of the port to run the server on.
5511
:return: A tuple of (host, port), where 'host' is a host name or IP,
5512
and port is an integer TCP/IP port.
5515
if port is not None:
5517
host, port = port.split(':')
5521
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5522
protocol=None, client_timeout=None):
5523
from bzrlib import transport
5524
if directory is None:
5525
directory = os.getcwd()
5526
if protocol is None:
5527
protocol = transport.transport_server_registry.get()
5528
host, port = self.get_host_and_port(port)
5529
url = transport.location_to_url(directory)
5530
if not allow_writes:
5531
url = 'readonly+' + url
5532
t = transport.get_transport_from_url(url)
5534
protocol(t, host, port, inet, client_timeout)
5535
except TypeError, e:
5536
# We use symbol_versioning.deprecated_in just so that people
5537
# grepping can find it here.
5538
# symbol_versioning.deprecated_in((2, 5, 0))
5539
symbol_versioning.warn(
5540
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5541
'Most likely it needs to be updated to support a'
5542
' "timeout" parameter (added in bzr 2.5.0)'
5543
% (e, protocol.__module__, protocol),
5545
protocol(t, host, port, inet)
5548
class cmd_join(Command):
5549
__doc__ = """Combine a tree into its containing tree.
5551
This command requires the target tree to be in a rich-root format.
5553
The TREE argument should be an independent tree, inside another tree, but
5554
not part of it. (Such trees can be produced by "bzr split", but also by
5555
running "bzr branch" with the target inside a tree.)
5557
The result is a combined tree, with the subtree no longer an independent
5558
part. This is marked as a merge of the subtree into the containing tree,
5559
and all history is preserved.
5562
_see_also = ['split']
5563
takes_args = ['tree']
5565
Option('reference', help='Join by reference.', hidden=True),
5568
def run(self, tree, reference=False):
5569
sub_tree = WorkingTree.open(tree)
5570
parent_dir = osutils.dirname(sub_tree.basedir)
5571
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5572
repo = containing_tree.branch.repository
5573
if not repo.supports_rich_root():
5574
raise errors.BzrCommandError(gettext(
5575
"Can't join trees because %s doesn't support rich root data.\n"
5576
"You can use bzr upgrade on the repository.")
5580
containing_tree.add_reference(sub_tree)
5581
except errors.BadReferenceTarget, e:
5582
# XXX: Would be better to just raise a nicely printable
5583
# exception from the real origin. Also below. mbp 20070306
5584
raise errors.BzrCommandError(
5585
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5588
containing_tree.subsume(sub_tree)
5589
except errors.BadSubsumeSource, e:
5590
raise errors.BzrCommandError(
5591
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5594
class cmd_split(Command):
5595
__doc__ = """Split a subdirectory of a tree into a separate tree.
5597
This command will produce a target tree in a format that supports
5598
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5599
converted into earlier formats like 'dirstate-tags'.
5601
The TREE argument should be a subdirectory of a working tree. That
5602
subdirectory will be converted into an independent tree, with its own
5603
branch. Commits in the top-level tree will not apply to the new subtree.
5606
_see_also = ['join']
5607
takes_args = ['tree']
5609
def run(self, tree):
5610
containing_tree, subdir = WorkingTree.open_containing(tree)
5611
sub_id = containing_tree.path2id(subdir)
5613
raise errors.NotVersionedError(subdir)
5615
containing_tree.extract(sub_id)
5616
except errors.RootNotRich:
5617
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5620
class cmd_merge_directive(Command):
5621
__doc__ = """Generate a merge directive for auto-merge tools.
5623
A directive requests a merge to be performed, and also provides all the
5624
information necessary to do so. This means it must either include a
5625
revision bundle, or the location of a branch containing the desired
5628
A submit branch (the location to merge into) must be supplied the first
5629
time the command is issued. After it has been supplied once, it will
5630
be remembered as the default.
5632
A public branch is optional if a revision bundle is supplied, but required
5633
if --diff or --plain is specified. It will be remembered as the default
5634
after the first use.
5637
takes_args = ['submit_branch?', 'public_branch?']
5641
_see_also = ['send']
5645
RegistryOption.from_kwargs('patch-type',
5646
'The type of patch to include in the directive.',
5648
value_switches=True,
5650
bundle='Bazaar revision bundle (default).',
5651
diff='Normal unified diff.',
5652
plain='No patch, just directive.'),
5653
Option('sign', help='GPG-sign the directive.'), 'revision',
5654
Option('mail-to', type=str,
5655
help='Instead of printing the directive, email to this address.'),
5656
Option('message', type=str, short_name='m',
5657
help='Message to use when committing this merge.')
5660
encoding_type = 'exact'
5662
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5663
sign=False, revision=None, mail_to=None, message=None,
5665
from bzrlib.revision import ensure_null, NULL_REVISION
5666
include_patch, include_bundle = {
5667
'plain': (False, False),
5668
'diff': (True, False),
5669
'bundle': (True, True),
5671
branch = Branch.open(directory)
5672
stored_submit_branch = branch.get_submit_branch()
5673
if submit_branch is None:
5674
submit_branch = stored_submit_branch
5676
if stored_submit_branch is None:
5677
branch.set_submit_branch(submit_branch)
5678
if submit_branch is None:
5679
submit_branch = branch.get_parent()
5680
if submit_branch is None:
5681
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5683
stored_public_branch = branch.get_public_branch()
5684
if public_branch is None:
5685
public_branch = stored_public_branch
5686
elif stored_public_branch is None:
5687
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5688
branch.set_public_branch(public_branch)
5689
if not include_bundle and public_branch is None:
5690
raise errors.BzrCommandError(gettext('No public branch specified or'
5692
base_revision_id = None
5693
if revision is not None:
5694
if len(revision) > 2:
5695
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5696
'at most two one revision identifiers'))
5697
revision_id = revision[-1].as_revision_id(branch)
5698
if len(revision) == 2:
5699
base_revision_id = revision[0].as_revision_id(branch)
5701
revision_id = branch.last_revision()
5702
revision_id = ensure_null(revision_id)
5703
if revision_id == NULL_REVISION:
5704
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5705
directive = merge_directive.MergeDirective2.from_objects(
5706
branch.repository, revision_id, time.time(),
5707
osutils.local_time_offset(), submit_branch,
5708
public_branch=public_branch, include_patch=include_patch,
5709
include_bundle=include_bundle, message=message,
5710
base_revision_id=base_revision_id)
5713
self.outf.write(directive.to_signed(branch))
5715
self.outf.writelines(directive.to_lines())
5717
message = directive.to_email(mail_to, branch, sign)
5718
s = SMTPConnection(branch.get_config_stack())
5719
s.send_email(message)
5722
class cmd_send(Command):
5723
__doc__ = """Mail or create a merge-directive for submitting changes.
5725
A merge directive provides many things needed for requesting merges:
5727
* A machine-readable description of the merge to perform
5729
* An optional patch that is a preview of the changes requested
5731
* An optional bundle of revision data, so that the changes can be applied
5732
directly from the merge directive, without retrieving data from a
5735
`bzr send` creates a compact data set that, when applied using bzr
5736
merge, has the same effect as merging from the source branch.
5738
By default the merge directive is self-contained and can be applied to any
5739
branch containing submit_branch in its ancestory without needing access to
5742
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5743
revisions, but only a structured request to merge from the
5744
public_location. In that case the public_branch is needed and it must be
5745
up-to-date and accessible to the recipient. The public_branch is always
5746
included if known, so that people can check it later.
5748
The submit branch defaults to the parent of the source branch, but can be
5749
overridden. Both submit branch and public branch will be remembered in
5750
branch.conf the first time they are used for a particular branch. The
5751
source branch defaults to that containing the working directory, but can
5752
be changed using --from.
5754
Both the submit branch and the public branch follow the usual behavior with
5755
respect to --remember: If there is no default location set, the first send
5756
will set it (use --no-remember to avoid setting it). After that, you can
5757
omit the location to use the default. To change the default, use
5758
--remember. The value will only be saved if the location can be accessed.
5760
In order to calculate those changes, bzr must analyse the submit branch.
5761
Therefore it is most efficient for the submit branch to be a local mirror.
5762
If a public location is known for the submit_branch, that location is used
5763
in the merge directive.
5765
The default behaviour is to send the merge directive by mail, unless -o is
5766
given, in which case it is sent to a file.
5768
Mail is sent using your preferred mail program. This should be transparent
5769
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5770
If the preferred client can't be found (or used), your editor will be used.
5772
To use a specific mail program, set the mail_client configuration option.
5773
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5774
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5775
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5776
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5779
If mail is being sent, a to address is required. This can be supplied
5780
either on the commandline, by setting the submit_to configuration
5781
option in the branch itself or the child_submit_to configuration option
5782
in the submit branch.
5784
Two formats are currently supported: "4" uses revision bundle format 4 and
5785
merge directive format 2. It is significantly faster and smaller than
5786
older formats. It is compatible with Bazaar 0.19 and later. It is the
5787
default. "0.9" uses revision bundle format 0.9 and merge directive
5788
format 1. It is compatible with Bazaar 0.12 - 0.18.
5790
The merge directives created by bzr send may be applied using bzr merge or
5791
bzr pull by specifying a file containing a merge directive as the location.
5793
bzr send makes extensive use of public locations to map local locations into
5794
URLs that can be used by other people. See `bzr help configuration` to
5795
set them, and use `bzr info` to display them.
5798
encoding_type = 'exact'
5800
_see_also = ['merge', 'pull']
5802
takes_args = ['submit_branch?', 'public_branch?']
5806
help='Do not include a bundle in the merge directive.'),
5807
Option('no-patch', help='Do not include a preview patch in the merge'
5810
help='Remember submit and public branch.'),
5812
help='Branch to generate the submission from, '
5813
'rather than the one containing the working directory.',
5816
Option('output', short_name='o',
5817
help='Write merge directive to this file or directory; '
5818
'use - for stdout.',
5821
help='Refuse to send if there are uncommitted changes in'
5822
' the working tree, --no-strict disables the check.'),
5823
Option('mail-to', help='Mail the request to this address.',
5827
Option('body', help='Body for the email.', type=unicode),
5828
RegistryOption('format',
5829
help='Use the specified output format.',
5830
lazy_registry=('bzrlib.send', 'format_registry')),
5833
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5834
no_patch=False, revision=None, remember=None, output=None,
5835
format=None, mail_to=None, message=None, body=None,
5836
strict=None, **kwargs):
5837
from bzrlib.send import send
5838
return send(submit_branch, revision, public_branch, remember,
5839
format, no_bundle, no_patch, output,
5840
kwargs.get('from', '.'), mail_to, message, body,
5845
class cmd_bundle_revisions(cmd_send):
5846
__doc__ = """Create a merge-directive for submitting changes.
5848
A merge directive provides many things needed for requesting merges:
5850
* A machine-readable description of the merge to perform
5852
* An optional patch that is a preview of the changes requested
5854
* An optional bundle of revision data, so that the changes can be applied
5855
directly from the merge directive, without retrieving data from a
5858
If --no-bundle is specified, then public_branch is needed (and must be
5859
up-to-date), so that the receiver can perform the merge using the
5860
public_branch. The public_branch is always included if known, so that
5861
people can check it later.
5863
The submit branch defaults to the parent, but can be overridden. Both
5864
submit branch and public branch will be remembered if supplied.
5866
If a public_branch is known for the submit_branch, that public submit
5867
branch is used in the merge instructions. This means that a local mirror
5868
can be used as your actual submit branch, once you have set public_branch
5871
Two formats are currently supported: "4" uses revision bundle format 4 and
5872
merge directive format 2. It is significantly faster and smaller than
5873
older formats. It is compatible with Bazaar 0.19 and later. It is the
5874
default. "0.9" uses revision bundle format 0.9 and merge directive
5875
format 1. It is compatible with Bazaar 0.12 - 0.18.
5880
help='Do not include a bundle in the merge directive.'),
5881
Option('no-patch', help='Do not include a preview patch in the merge'
5884
help='Remember submit and public branch.'),
5886
help='Branch to generate the submission from, '
5887
'rather than the one containing the working directory.',
5890
Option('output', short_name='o', help='Write directive to this file.',
5893
help='Refuse to bundle revisions if there are uncommitted'
5894
' changes in the working tree, --no-strict disables the check.'),
5896
RegistryOption('format',
5897
help='Use the specified output format.',
5898
lazy_registry=('bzrlib.send', 'format_registry')),
5900
aliases = ['bundle']
5902
_see_also = ['send', 'merge']
5906
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5907
no_patch=False, revision=None, remember=False, output=None,
5908
format=None, strict=None, **kwargs):
5911
from bzrlib.send import send
5912
return send(submit_branch, revision, public_branch, remember,
5913
format, no_bundle, no_patch, output,
5914
kwargs.get('from', '.'), None, None, None,
5915
self.outf, strict=strict)
5918
class cmd_tag(Command):
5919
__doc__ = """Create, remove or modify a tag naming a revision.
5921
Tags give human-meaningful names to revisions. Commands that take a -r
5922
(--revision) option can be given -rtag:X, where X is any previously
5925
Tags are stored in the branch. Tags are copied from one branch to another
5926
along when you branch, push, pull or merge.
5928
It is an error to give a tag name that already exists unless you pass
5929
--force, in which case the tag is moved to point to the new revision.
5931
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5932
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5934
If no tag name is specified it will be determined through the
5935
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5936
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5940
_see_also = ['commit', 'tags']
5941
takes_args = ['tag_name?']
5944
help='Delete this tag rather than placing it.',
5946
custom_help('directory',
5947
help='Branch in which to place the tag.'),
5949
help='Replace existing tags.',
5954
def run(self, tag_name=None,
5960
branch, relpath = Branch.open_containing(directory)
5961
self.add_cleanup(branch.lock_write().unlock)
5963
if tag_name is None:
5964
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5965
branch.tags.delete_tag(tag_name)
5966
note(gettext('Deleted tag %s.') % tag_name)
5969
if len(revision) != 1:
5970
raise errors.BzrCommandError(gettext(
5971
"Tags can only be placed on a single revision, "
5973
revision_id = revision[0].as_revision_id(branch)
5975
revision_id = branch.last_revision()
5976
if tag_name is None:
5977
tag_name = branch.automatic_tag_name(revision_id)
5978
if tag_name is None:
5979
raise errors.BzrCommandError(gettext(
5980
"Please specify a tag name."))
5982
existing_target = branch.tags.lookup_tag(tag_name)
5983
except errors.NoSuchTag:
5984
existing_target = None
5985
if not force and existing_target not in (None, revision_id):
5986
raise errors.TagAlreadyExists(tag_name)
5987
if existing_target == revision_id:
5988
note(gettext('Tag %s already exists for that revision.') % tag_name)
5990
branch.tags.set_tag(tag_name, revision_id)
5991
if existing_target is None:
5992
note(gettext('Created tag %s.') % tag_name)
5994
note(gettext('Updated tag %s.') % tag_name)
5997
class cmd_tags(Command):
5998
__doc__ = """List tags.
6000
This command shows a table of tag names and the revisions they reference.
6005
custom_help('directory',
6006
help='Branch whose tags should be displayed.'),
6007
RegistryOption('sort',
6008
'Sort tags by different criteria.', title='Sorting',
6009
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
6016
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6017
from bzrlib.tag import tag_sort_methods
6018
branch, relpath = Branch.open_containing(directory)
6020
tags = branch.tags.get_tag_dict().items()
6024
self.add_cleanup(branch.lock_read().unlock)
6026
# Restrict to the specified range
6027
tags = self._tags_for_range(branch, revision)
6029
sort = tag_sort_methods.get()
6032
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6033
for index, (tag, revid) in enumerate(tags):
6035
revno = branch.revision_id_to_dotted_revno(revid)
6036
if isinstance(revno, tuple):
6037
revno = '.'.join(map(str, revno))
6038
except (errors.NoSuchRevision,
6039
errors.GhostRevisionsHaveNoRevno,
6040
errors.UnsupportedOperation):
6041
# Bad tag data/merges can lead to tagged revisions
6042
# which are not in this branch. Fail gracefully ...
6044
tags[index] = (tag, revno)
6046
for tag, revspec in tags:
6047
self.outf.write('%-20s %s\n' % (tag, revspec))
6049
def _tags_for_range(self, branch, revision):
6051
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6052
revid1, revid2 = rev1.rev_id, rev2.rev_id
6053
# _get_revision_range will always set revid2 if it's not specified.
6054
# If revid1 is None, it means we want to start from the branch
6055
# origin which is always a valid ancestor. If revid1 == revid2, the
6056
# ancestry check is useless.
6057
if revid1 and revid1 != revid2:
6058
# FIXME: We really want to use the same graph than
6059
# branch.iter_merge_sorted_revisions below, but this is not
6060
# easily available -- vila 2011-09-23
6061
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6062
# We don't want to output anything in this case...
6064
# only show revisions between revid1 and revid2 (inclusive)
6065
tagged_revids = branch.tags.get_reverse_tag_dict()
6067
for r in branch.iter_merge_sorted_revisions(
6068
start_revision_id=revid2, stop_revision_id=revid1,
6069
stop_rule='include'):
6070
revid_tags = tagged_revids.get(r[0], None)
6072
found.extend([(tag, r[0]) for tag in revid_tags])
6076
class cmd_reconfigure(Command):
6077
__doc__ = """Reconfigure the type of a bzr directory.
6079
A target configuration must be specified.
6081
For checkouts, the bind-to location will be auto-detected if not specified.
6082
The order of preference is
6083
1. For a lightweight checkout, the current bound location.
6084
2. For branches that used to be checkouts, the previously-bound location.
6085
3. The push location.
6086
4. The parent location.
6087
If none of these is available, --bind-to must be specified.
6090
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6091
takes_args = ['location?']
6093
RegistryOption.from_kwargs(
6096
help='The relation between branch and tree.',
6097
value_switches=True, enum_switch=False,
6098
branch='Reconfigure to be an unbound branch with no working tree.',
6099
tree='Reconfigure to be an unbound branch with a working tree.',
6100
checkout='Reconfigure to be a bound branch with a working tree.',
6101
lightweight_checkout='Reconfigure to be a lightweight'
6102
' checkout (with no local history).',
6104
RegistryOption.from_kwargs(
6106
title='Repository type',
6107
help='Location fo the repository.',
6108
value_switches=True, enum_switch=False,
6109
standalone='Reconfigure to be a standalone branch '
6110
'(i.e. stop using shared repository).',
6111
use_shared='Reconfigure to use a shared repository.',
6113
RegistryOption.from_kwargs(
6115
title='Trees in Repository',
6116
help='Whether new branches in the repository have trees.',
6117
value_switches=True, enum_switch=False,
6118
with_trees='Reconfigure repository to create '
6119
'working trees on branches by default.',
6120
with_no_trees='Reconfigure repository to not create '
6121
'working trees on branches by default.'
6123
Option('bind-to', help='Branch to bind checkout to.', type=str),
6125
help='Perform reconfiguration even if local changes'
6127
Option('stacked-on',
6128
help='Reconfigure a branch to be stacked on another branch.',
6132
help='Reconfigure a branch to be unstacked. This '
6133
'may require copying substantial data into it.',
6137
def run(self, location=None, bind_to=None, force=False,
6138
tree_type=None, repository_type=None, repository_trees=None,
6139
stacked_on=None, unstacked=None):
6140
directory = controldir.ControlDir.open(location)
6141
if stacked_on and unstacked:
6142
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6143
elif stacked_on is not None:
6144
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6146
reconfigure.ReconfigureUnstacked().apply(directory)
6147
# At the moment you can use --stacked-on and a different
6148
# reconfiguration shape at the same time; there seems no good reason
6150
if (tree_type is None and
6151
repository_type is None and
6152
repository_trees is None):
6153
if stacked_on or unstacked:
6156
raise errors.BzrCommandError(gettext('No target configuration '
6158
reconfiguration = None
6159
if tree_type == 'branch':
6160
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6161
elif tree_type == 'tree':
6162
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6163
elif tree_type == 'checkout':
6164
reconfiguration = reconfigure.Reconfigure.to_checkout(
6166
elif tree_type == 'lightweight-checkout':
6167
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6170
reconfiguration.apply(force)
6171
reconfiguration = None
6172
if repository_type == 'use-shared':
6173
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6174
elif repository_type == 'standalone':
6175
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6177
reconfiguration.apply(force)
6178
reconfiguration = None
6179
if repository_trees == 'with-trees':
6180
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6182
elif repository_trees == 'with-no-trees':
6183
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6186
reconfiguration.apply(force)
6187
reconfiguration = None
6190
class cmd_switch(Command):
6191
__doc__ = """Set the branch of a checkout and update.
6193
For lightweight checkouts, this changes the branch being referenced.
6194
For heavyweight checkouts, this checks that there are no local commits
6195
versus the current bound branch, then it makes the local branch a mirror
6196
of the new location and binds to it.
6198
In both cases, the working tree is updated and uncommitted changes
6199
are merged. The user can commit or revert these as they desire.
6201
Pending merges need to be committed or reverted before using switch.
6203
The path to the branch to switch to can be specified relative to the parent
6204
directory of the current branch. For example, if you are currently in a
6205
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6208
Bound branches use the nickname of its master branch unless it is set
6209
locally, in which case switching will update the local nickname to be
6213
takes_args = ['to_location?']
6214
takes_options = ['directory',
6216
help='Switch even if local commits will be lost.'),
6218
Option('create-branch', short_name='b',
6219
help='Create the target branch from this one before'
6220
' switching to it.'),
6223
def run(self, to_location=None, force=False, create_branch=False,
6224
revision=None, directory=u'.'):
6225
from bzrlib import switch
6226
tree_location = directory
6227
revision = _get_one_revision('switch', revision)
6228
possible_transports = []
6229
control_dir = controldir.ControlDir.open_containing(tree_location,
6230
possible_transports=possible_transports)[0]
6231
if to_location is None:
6232
if revision is None:
6233
raise errors.BzrCommandError(gettext('You must supply either a'
6234
' revision or a location'))
6235
to_location = tree_location
6237
branch = control_dir.open_branch(
6238
possible_transports=possible_transports)
6239
had_explicit_nick = branch.get_config().has_explicit_nickname()
6240
except errors.NotBranchError:
6242
had_explicit_nick = False
6245
raise errors.BzrCommandError(
6246
gettext('cannot create branch without source branch'))
6247
to_location = lookup_new_sibling_branch(control_dir, to_location,
6248
possible_transports=possible_transports)
6249
to_branch = branch.bzrdir.sprout(to_location,
6250
possible_transports=possible_transports,
6251
source_branch=branch).open_branch()
6253
to_branch = lookup_sibling_branch(control_dir, to_location)
6254
if revision is not None:
6255
revision = revision.as_revision_id(to_branch)
6256
switch.switch(control_dir, to_branch, force, revision_id=revision)
6257
if had_explicit_nick:
6258
branch = control_dir.open_branch() #get the new branch!
6259
branch.nick = to_branch.nick
6260
note(gettext('Switched to branch: %s'),
6261
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6265
class cmd_view(Command):
6266
__doc__ = """Manage filtered views.
6268
Views provide a mask over the tree so that users can focus on
6269
a subset of a tree when doing their work. After creating a view,
6270
commands that support a list of files - status, diff, commit, etc -
6271
effectively have that list of files implicitly given each time.
6272
An explicit list of files can still be given but those files
6273
must be within the current view.
6275
In most cases, a view has a short life-span: it is created to make
6276
a selected change and is deleted once that change is committed.
6277
At other times, you may wish to create one or more named views
6278
and switch between them.
6280
To disable the current view without deleting it, you can switch to
6281
the pseudo view called ``off``. This can be useful when you need
6282
to see the whole tree for an operation or two (e.g. merge) but
6283
want to switch back to your view after that.
6286
To define the current view::
6288
bzr view file1 dir1 ...
6290
To list the current view::
6294
To delete the current view::
6298
To disable the current view without deleting it::
6300
bzr view --switch off
6302
To define a named view and switch to it::
6304
bzr view --name view-name file1 dir1 ...
6306
To list a named view::
6308
bzr view --name view-name
6310
To delete a named view::
6312
bzr view --name view-name --delete
6314
To switch to a named view::
6316
bzr view --switch view-name
6318
To list all views defined::
6322
To delete all views::
6324
bzr view --delete --all
6328
takes_args = ['file*']
6331
help='Apply list or delete action to all views.',
6334
help='Delete the view.',
6337
help='Name of the view to define, list or delete.',
6341
help='Name of the view to switch to.',
6346
def run(self, file_list,
6352
tree, file_list = WorkingTree.open_containing_paths(file_list,
6354
current_view, view_dict = tree.views.get_view_info()
6359
raise errors.BzrCommandError(gettext(
6360
"Both --delete and a file list specified"))
6362
raise errors.BzrCommandError(gettext(
6363
"Both --delete and --switch specified"))
6365
tree.views.set_view_info(None, {})
6366
self.outf.write(gettext("Deleted all views.\n"))
6368
raise errors.BzrCommandError(gettext("No current view to delete"))
6370
tree.views.delete_view(name)
6371
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6374
raise errors.BzrCommandError(gettext(
6375
"Both --switch and a file list specified"))
6377
raise errors.BzrCommandError(gettext(
6378
"Both --switch and --all specified"))
6379
elif switch == 'off':
6380
if current_view is None:
6381
raise errors.BzrCommandError(gettext("No current view to disable"))
6382
tree.views.set_view_info(None, view_dict)
6383
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6385
tree.views.set_view_info(switch, view_dict)
6386
view_str = views.view_display_str(tree.views.lookup_view())
6387
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6390
self.outf.write(gettext('Views defined:\n'))
6391
for view in sorted(view_dict):
6392
if view == current_view:
6396
view_str = views.view_display_str(view_dict[view])
6397
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6399
self.outf.write(gettext('No views defined.\n'))
6402
# No name given and no current view set
6405
raise errors.BzrCommandError(gettext(
6406
"Cannot change the 'off' pseudo view"))
6407
tree.views.set_view(name, sorted(file_list))
6408
view_str = views.view_display_str(tree.views.lookup_view())
6409
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6413
# No name given and no current view set
6414
self.outf.write(gettext('No current view.\n'))
6416
view_str = views.view_display_str(tree.views.lookup_view(name))
6417
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6420
class cmd_hooks(Command):
6421
__doc__ = """Show hooks."""
6426
for hook_key in sorted(hooks.known_hooks.keys()):
6427
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6428
self.outf.write("%s:\n" % type(some_hooks).__name__)
6429
for hook_name, hook_point in sorted(some_hooks.items()):
6430
self.outf.write(" %s:\n" % (hook_name,))
6431
found_hooks = list(hook_point)
6433
for hook in found_hooks:
6434
self.outf.write(" %s\n" %
6435
(some_hooks.get_hook_name(hook),))
6437
self.outf.write(gettext(" <no hooks installed>\n"))
6440
class cmd_remove_branch(Command):
6441
__doc__ = """Remove a branch.
6443
This will remove the branch from the specified location but
6444
will keep any working tree or repository in place.
6448
Remove the branch at repo/trunk::
6450
bzr remove-branch repo/trunk
6454
takes_args = ["location?"]
6456
aliases = ["rmbranch"]
6458
def run(self, location=None):
6459
if location is None:
6461
cdir = controldir.ControlDir.open_containing(location)[0]
6462
cdir.destroy_branch()
6465
class cmd_shelve(Command):
6466
__doc__ = """Temporarily set aside some changes from the current tree.
6468
Shelve allows you to temporarily put changes you've made "on the shelf",
6469
ie. out of the way, until a later time when you can bring them back from
6470
the shelf with the 'unshelve' command. The changes are stored alongside
6471
your working tree, and so they aren't propagated along with your branch nor
6472
will they survive its deletion.
6474
If shelve --list is specified, previously-shelved changes are listed.
6476
Shelve is intended to help separate several sets of changes that have
6477
been inappropriately mingled. If you just want to get rid of all changes
6478
and you don't need to restore them later, use revert. If you want to
6479
shelve all text changes at once, use shelve --all.
6481
If filenames are specified, only the changes to those files will be
6482
shelved. Other files will be left untouched.
6484
If a revision is specified, changes since that revision will be shelved.
6486
You can put multiple items on the shelf, and by default, 'unshelve' will
6487
restore the most recently shelved changes.
6489
For complicated changes, it is possible to edit the changes in a separate
6490
editor program to decide what the file remaining in the working copy
6491
should look like. To do this, add the configuration option
6493
change_editor = PROGRAM @new_path @old_path
6495
where @new_path is replaced with the path of the new version of the
6496
file and @old_path is replaced with the path of the old version of
6497
the file. The PROGRAM should save the new file with the desired
6498
contents of the file in the working tree.
6502
takes_args = ['file*']
6507
Option('all', help='Shelve all changes.'),
6509
RegistryOption('writer', 'Method to use for writing diffs.',
6510
bzrlib.option.diff_writer_registry,
6511
value_switches=True, enum_switch=False),
6513
Option('list', help='List shelved changes.'),
6515
help='Destroy removed changes instead of shelving them.'),
6517
_see_also = ['unshelve', 'configuration']
6519
def run(self, revision=None, all=False, file_list=None, message=None,
6520
writer=None, list=False, destroy=False, directory=None):
6522
return self.run_for_list(directory=directory)
6523
from bzrlib.shelf_ui import Shelver
6525
writer = bzrlib.option.diff_writer_registry.get()
6527
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6528
file_list, message, destroy=destroy, directory=directory)
6533
except errors.UserAbort:
6536
def run_for_list(self, directory=None):
6537
if directory is None:
6539
tree = WorkingTree.open_containing(directory)[0]
6540
self.add_cleanup(tree.lock_read().unlock)
6541
manager = tree.get_shelf_manager()
6542
shelves = manager.active_shelves()
6543
if len(shelves) == 0:
6544
note(gettext('No shelved changes.'))
6546
for shelf_id in reversed(shelves):
6547
message = manager.get_metadata(shelf_id).get('message')
6549
message = '<no message>'
6550
self.outf.write('%3d: %s\n' % (shelf_id, message))
6554
class cmd_unshelve(Command):
6555
__doc__ = """Restore shelved changes.
6557
By default, the most recently shelved changes are restored. However if you
6558
specify a shelf by id those changes will be restored instead. This works
6559
best when the changes don't depend on each other.
6562
takes_args = ['shelf_id?']
6565
RegistryOption.from_kwargs(
6566
'action', help="The action to perform.",
6567
enum_switch=False, value_switches=True,
6568
apply="Apply changes and remove from the shelf.",
6569
dry_run="Show changes, but do not apply or remove them.",
6570
preview="Instead of unshelving the changes, show the diff that "
6571
"would result from unshelving.",
6572
delete_only="Delete changes without applying them.",
6573
keep="Apply changes but don't delete them.",
6576
_see_also = ['shelve']
6578
def run(self, shelf_id=None, action='apply', directory=u'.'):
6579
from bzrlib.shelf_ui import Unshelver
6580
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6584
unshelver.tree.unlock()
6587
class cmd_clean_tree(Command):
6588
__doc__ = """Remove unwanted files from working tree.
6590
By default, only unknown files, not ignored files, are deleted. Versioned
6591
files are never deleted.
6593
Another class is 'detritus', which includes files emitted by bzr during
6594
normal operations and selftests. (The value of these files decreases with
6597
If no options are specified, unknown files are deleted. Otherwise, option
6598
flags are respected, and may be combined.
6600
To check what clean-tree will do, use --dry-run.
6602
takes_options = ['directory',
6603
Option('ignored', help='Delete all ignored files.'),
6604
Option('detritus', help='Delete conflict files, merge and revert'
6605
' backups, and failed selftest dirs.'),
6607
help='Delete files unknown to bzr (default).'),
6608
Option('dry-run', help='Show files to delete instead of'
6610
Option('force', help='Do not prompt before deleting.')]
6611
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6612
force=False, directory=u'.'):
6613
from bzrlib.clean_tree import clean_tree
6614
if not (unknown or ignored or detritus):
6618
clean_tree(directory, unknown=unknown, ignored=ignored,
6619
detritus=detritus, dry_run=dry_run, no_prompt=force)
6622
class cmd_reference(Command):
6623
__doc__ = """list, view and set branch locations for nested trees.
6625
If no arguments are provided, lists the branch locations for nested trees.
6626
If one argument is provided, display the branch location for that tree.
6627
If two arguments are provided, set the branch location for that tree.
6632
takes_args = ['path?', 'location?']
6634
def run(self, path=None, location=None):
6636
if path is not None:
6638
tree, branch, relpath =(
6639
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6640
if path is not None:
6643
tree = branch.basis_tree()
6645
info = branch._get_all_reference_info().iteritems()
6646
self._display_reference_info(tree, branch, info)
6648
file_id = tree.path2id(path)
6650
raise errors.NotVersionedError(path)
6651
if location is None:
6652
info = [(file_id, branch.get_reference_info(file_id))]
6653
self._display_reference_info(tree, branch, info)
6655
branch.set_reference_info(file_id, path, location)
6657
def _display_reference_info(self, tree, branch, info):
6659
for file_id, (path, location) in info:
6661
path = tree.id2path(file_id)
6662
except errors.NoSuchId:
6664
ref_list.append((path, location))
6665
for path, location in sorted(ref_list):
6666
self.outf.write('%s %s\n' % (path, location))
6669
class cmd_export_pot(Command):
6670
__doc__ = """Export command helps and error messages in po format."""
6673
takes_options = [Option('plugin',
6674
help='Export help text from named command '\
6675
'(defaults to all built in commands).',
6677
Option('include-duplicates',
6678
help='Output multiple copies of the same msgid '
6679
'string if it appears more than once.'),
6682
def run(self, plugin=None, include_duplicates=False):
6683
from bzrlib.export_pot import export_pot
6684
export_pot(self.outf, plugin, include_duplicates)
6687
def _register_lazy_builtins():
6688
# register lazy builtins from other modules; called at startup and should
6689
# be only called once.
6690
for (name, aliases, module_name) in [
6691
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6692
('cmd_config', [], 'bzrlib.config'),
6693
('cmd_dpush', [], 'bzrlib.foreign'),
6694
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6695
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6696
('cmd_conflicts', [], 'bzrlib.conflicts'),
6697
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6698
('cmd_verify_signatures', [],
6699
'bzrlib.commit_signature_commands'),
6700
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6702
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
