1
# Copyright (C) 2005-2010 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"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import (
70
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
73
def tree_files(file_list, default_branch=u'.', canonicalize=True,
76
return internal_tree_files(file_list, default_branch, canonicalize,
78
except errors.FileInWrongBranch, e:
79
raise errors.BzrCommandError("%s is not in the same branch as %s" %
80
(e.path, file_list[0]))
83
def tree_files_for_add(file_list):
85
Return a tree and list of absolute paths from a file list.
87
Similar to tree_files, but add handles files a bit differently, so it a
88
custom implementation. In particular, MutableTreeTree.smart_add expects
89
absolute paths, which it immediately converts to relative paths.
91
# FIXME Would be nice to just return the relative paths like
92
# internal_tree_files does, but there are a large number of unit tests
93
# that assume the current interface to mutabletree.smart_add
95
tree, relpath = WorkingTree.open_containing(file_list[0])
96
if tree.supports_views():
97
view_files = tree.views.lookup_view()
99
for filename in file_list:
100
if not osutils.is_inside_any(view_files, filename):
101
raise errors.FileOutsideView(filename, view_files)
102
file_list = file_list[:]
103
file_list[0] = tree.abspath(relpath)
105
tree = WorkingTree.open_containing(u'.')[0]
106
if tree.supports_views():
107
view_files = tree.views.lookup_view()
109
file_list = view_files
110
view_str = views.view_display_str(view_files)
111
note("Ignoring files outside view. View is %s" % view_str)
112
return tree, file_list
115
def _get_one_revision(command_name, revisions):
116
if revisions is None:
118
if len(revisions) != 1:
119
raise errors.BzrCommandError(
120
'bzr %s --revision takes exactly one revision identifier' % (
125
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
126
"""Get a revision tree. Not suitable for commands that change the tree.
128
Specifically, the basis tree in dirstate trees is coupled to the dirstate
129
and doing a commit/uncommit/pull will at best fail due to changing the
132
If tree is passed in, it should be already locked, for lifetime management
133
of the trees internal cached state.
137
if revisions is None:
139
rev_tree = tree.basis_tree()
141
rev_tree = branch.basis_tree()
143
revision = _get_one_revision(command_name, revisions)
144
rev_tree = revision.as_tree(branch)
148
# XXX: Bad function name; should possibly also be a class method of
149
# WorkingTree rather than a function.
150
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
152
"""Convert command-line paths to a WorkingTree and relative paths.
154
This is typically used for command-line processors that take one or
155
more filenames, and infer the workingtree that contains them.
157
The filenames given are not required to exist.
159
:param file_list: Filenames to convert.
161
:param default_branch: Fallback tree path to use if file_list is empty or
164
:param apply_view: if True and a view is set, apply it or check that
165
specified files are within it
167
:return: workingtree, [relative_paths]
169
if file_list is None or len(file_list) == 0:
170
tree = WorkingTree.open_containing(default_branch)[0]
171
if tree.supports_views() and apply_view:
172
view_files = tree.views.lookup_view()
174
file_list = view_files
175
view_str = views.view_display_str(view_files)
176
note("Ignoring files outside view. View is %s" % view_str)
177
return tree, file_list
178
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
179
return tree, safe_relpath_files(tree, file_list, canonicalize,
180
apply_view=apply_view)
183
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
184
"""Convert file_list into a list of relpaths in tree.
186
:param tree: A tree to operate on.
187
:param file_list: A list of user provided paths or None.
188
:param apply_view: if True and a view is set, apply it or check that
189
specified files are within it
190
:return: A list of relative paths.
191
:raises errors.PathNotChild: When a provided path is in a different tree
194
if file_list is None:
196
if tree.supports_views() and apply_view:
197
view_files = tree.views.lookup_view()
201
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
202
# doesn't - fix that up here before we enter the loop.
204
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
207
for filename in file_list:
209
relpath = fixer(osutils.dereference_path(filename))
210
if view_files and not osutils.is_inside_any(view_files, relpath):
211
raise errors.FileOutsideView(filename, view_files)
212
new_list.append(relpath)
213
except errors.PathNotChild:
214
raise errors.FileInWrongBranch(tree.branch, filename)
218
def _get_view_info_for_change_reporter(tree):
219
"""Get the view information from a tree for change reporting."""
222
current_view = tree.views.get_view_info()[0]
223
if current_view is not None:
224
view_info = (current_view, tree.views.lookup_view())
225
except errors.ViewsNotSupported:
230
# TODO: Make sure no commands unconditionally use the working directory as a
231
# branch. If a filename argument is used, the first of them should be used to
232
# specify the branch. (Perhaps this can be factored out into some kind of
233
# Argument class, representing a file in a branch, where the first occurrence
236
class cmd_status(Command):
237
"""Display status summary.
239
This reports on versioned and unknown files, reporting them
240
grouped by state. Possible states are:
243
Versioned in the working copy but not in the previous revision.
246
Versioned in the previous revision but removed or deleted
250
Path of this file changed from the previous revision;
251
the text may also have changed. This includes files whose
252
parent directory was renamed.
255
Text has changed since the previous revision.
258
File kind has been changed (e.g. from file to directory).
261
Not versioned and not matching an ignore pattern.
263
Additionally for directories, symlinks and files with an executable
264
bit, Bazaar indicates their type using a trailing character: '/', '@'
267
To see ignored files use 'bzr ignored'. For details on the
268
changes to file texts, use 'bzr diff'.
270
Note that --short or -S gives status flags for each item, similar
271
to Subversion's status command. To get output similar to svn -q,
274
If no arguments are specified, the status of the entire working
275
directory is shown. Otherwise, only the status of the specified
276
files or directories is reported. If a directory is given, status
277
is reported for everything inside that directory.
279
Before merges are committed, the pending merge tip revisions are
280
shown. To see all pending merge revisions, use the -v option.
281
To skip the display of pending merge information altogether, use
282
the no-pending option or specify a file/directory.
284
If a revision argument is given, the status is calculated against
285
that revision, or between two revisions if two are provided.
288
# TODO: --no-recurse, --recurse options
290
takes_args = ['file*']
291
takes_options = ['show-ids', 'revision', 'change', 'verbose',
292
Option('short', help='Use short status indicators.',
294
Option('versioned', help='Only show versioned files.',
296
Option('no-pending', help='Don\'t show pending merges.',
299
aliases = ['st', 'stat']
301
encoding_type = 'replace'
302
_see_also = ['diff', 'revert', 'status-flags']
305
def run(self, show_ids=False, file_list=None, revision=None, short=False,
306
versioned=False, no_pending=False, verbose=False):
307
from bzrlib.status import show_tree_status
309
if revision and len(revision) > 2:
310
raise errors.BzrCommandError('bzr status --revision takes exactly'
311
' one or two revision specifiers')
313
tree, relfile_list = tree_files(file_list)
314
# Avoid asking for specific files when that is not needed.
315
if relfile_list == ['']:
317
# Don't disable pending merges for full trees other than '.'.
318
if file_list == ['.']:
320
# A specific path within a tree was given.
321
elif relfile_list is not None:
323
show_tree_status(tree, show_ids=show_ids,
324
specific_files=relfile_list, revision=revision,
325
to_file=self.outf, short=short, versioned=versioned,
326
show_pending=(not no_pending), verbose=verbose)
329
class cmd_cat_revision(Command):
330
"""Write out metadata for a revision.
332
The revision to print can either be specified by a specific
333
revision identifier, or you can use --revision.
337
takes_args = ['revision_id?']
338
takes_options = ['revision']
339
# cat-revision is more for frontends so should be exact
343
def run(self, revision_id=None, revision=None):
344
if revision_id is not None and revision is not None:
345
raise errors.BzrCommandError('You can only supply one of'
346
' revision_id or --revision')
347
if revision_id is None and revision is None:
348
raise errors.BzrCommandError('You must supply either'
349
' --revision or a revision_id')
350
b = WorkingTree.open_containing(u'.')[0].branch
352
# TODO: jam 20060112 should cat-revision always output utf-8?
353
if revision_id is not None:
354
revision_id = osutils.safe_revision_id(revision_id, warn=False)
356
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
357
except errors.NoSuchRevision:
358
msg = "The repository %s contains no revision %s." % (b.repository.base,
360
raise errors.BzrCommandError(msg)
361
elif revision is not None:
364
raise errors.BzrCommandError('You cannot specify a NULL'
366
rev_id = rev.as_revision_id(b)
367
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
370
class cmd_dump_btree(Command):
371
"""Dump the contents of a btree index file to stdout.
373
PATH is a btree index file, it can be any URL. This includes things like
374
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
376
By default, the tuples stored in the index file will be displayed. With
377
--raw, we will uncompress the pages, but otherwise display the raw bytes
381
# TODO: Do we want to dump the internal nodes as well?
382
# TODO: It would be nice to be able to dump the un-parsed information,
383
# rather than only going through iter_all_entries. However, this is
384
# good enough for a start
386
encoding_type = 'exact'
387
takes_args = ['path']
388
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
389
' rather than the parsed tuples.'),
392
def run(self, path, raw=False):
393
dirname, basename = osutils.split(path)
394
t = transport.get_transport(dirname)
396
self._dump_raw_bytes(t, basename)
398
self._dump_entries(t, basename)
400
def _get_index_and_bytes(self, trans, basename):
401
"""Create a BTreeGraphIndex and raw bytes."""
402
bt = btree_index.BTreeGraphIndex(trans, basename, None)
403
bytes = trans.get_bytes(basename)
404
bt._file = cStringIO.StringIO(bytes)
405
bt._size = len(bytes)
408
def _dump_raw_bytes(self, trans, basename):
411
# We need to parse at least the root node.
412
# This is because the first page of every row starts with an
413
# uncompressed header.
414
bt, bytes = self._get_index_and_bytes(trans, basename)
415
for page_idx, page_start in enumerate(xrange(0, len(bytes),
416
btree_index._PAGE_SIZE)):
417
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
418
page_bytes = bytes[page_start:page_end]
420
self.outf.write('Root node:\n')
421
header_end, data = bt._parse_header_from_bytes(page_bytes)
422
self.outf.write(page_bytes[:header_end])
424
self.outf.write('\nPage %d\n' % (page_idx,))
425
decomp_bytes = zlib.decompress(page_bytes)
426
self.outf.write(decomp_bytes)
427
self.outf.write('\n')
429
def _dump_entries(self, trans, basename):
431
st = trans.stat(basename)
432
except errors.TransportNotPossible:
433
# We can't stat, so we'll fake it because we have to do the 'get()'
435
bt, _ = self._get_index_and_bytes(trans, basename)
437
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
438
for node in bt.iter_all_entries():
439
# Node is made up of:
440
# (index, key, value, [references])
441
refs_as_tuples = static_tuple.as_tuples(node[3])
442
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
443
self.outf.write('%s\n' % (as_tuple,))
446
class cmd_remove_tree(Command):
447
"""Remove the working tree from a given branch/checkout.
449
Since a lightweight checkout is little more than a working tree
450
this will refuse to run against one.
452
To re-create the working tree, use "bzr checkout".
454
_see_also = ['checkout', 'working-trees']
455
takes_args = ['location?']
458
help='Remove the working tree even if it has '
459
'uncommitted changes.'),
462
def run(self, location='.', force=False):
463
d = bzrdir.BzrDir.open(location)
466
working = d.open_workingtree()
467
except errors.NoWorkingTree:
468
raise errors.BzrCommandError("No working tree to remove")
469
except errors.NotLocalUrl:
470
raise errors.BzrCommandError("You cannot remove the working tree"
473
if (working.has_changes()):
474
raise errors.UncommittedChanges(working)
476
working_path = working.bzrdir.root_transport.base
477
branch_path = working.branch.bzrdir.root_transport.base
478
if working_path != branch_path:
479
raise errors.BzrCommandError("You cannot remove the working tree"
480
" from a lightweight checkout")
482
d.destroy_workingtree()
485
class cmd_revno(Command):
486
"""Show current revision number.
488
This is equal to the number of revisions on this branch.
492
takes_args = ['location?']
494
Option('tree', help='Show revno of working tree'),
498
def run(self, tree=False, location=u'.'):
501
wt = WorkingTree.open_containing(location)[0]
503
except (errors.NoWorkingTree, errors.NotLocalUrl):
504
raise errors.NoWorkingTree(location)
505
self.add_cleanup(wt.unlock)
506
revid = wt.last_revision()
508
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
509
except errors.NoSuchRevision:
511
revno = ".".join(str(n) for n in revno_t)
513
b = Branch.open_containing(location)[0]
515
self.add_cleanup(b.unlock)
518
self.outf.write(str(revno) + '\n')
521
class cmd_revision_info(Command):
522
"""Show revision number and revision id for a given revision identifier.
525
takes_args = ['revision_info*']
529
help='Branch to examine, '
530
'rather than the one containing the working directory.',
534
Option('tree', help='Show revno of working tree'),
538
def run(self, revision=None, directory=u'.', tree=False,
539
revision_info_list=[]):
542
wt = WorkingTree.open_containing(directory)[0]
545
self.add_cleanup(wt.unlock)
546
except (errors.NoWorkingTree, errors.NotLocalUrl):
548
b = Branch.open_containing(directory)[0]
550
self.add_cleanup(b.unlock)
552
if revision is not None:
553
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
554
if revision_info_list is not None:
555
for rev_str in revision_info_list:
556
rev_spec = RevisionSpec.from_string(rev_str)
557
revision_ids.append(rev_spec.as_revision_id(b))
558
# No arguments supplied, default to the last revision
559
if len(revision_ids) == 0:
562
raise errors.NoWorkingTree(directory)
563
revision_ids.append(wt.last_revision())
565
revision_ids.append(b.last_revision())
569
for revision_id in revision_ids:
571
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
572
revno = '.'.join(str(i) for i in dotted_revno)
573
except errors.NoSuchRevision:
575
maxlen = max(maxlen, len(revno))
576
revinfos.append([revno, revision_id])
580
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
583
class cmd_add(Command):
584
"""Add specified files or directories.
586
In non-recursive mode, all the named items are added, regardless
587
of whether they were previously ignored. A warning is given if
588
any of the named files are already versioned.
590
In recursive mode (the default), files are treated the same way
591
but the behaviour for directories is different. Directories that
592
are already versioned do not give a warning. All directories,
593
whether already versioned or not, are searched for files or
594
subdirectories that are neither versioned or ignored, and these
595
are added. This search proceeds recursively into versioned
596
directories. If no names are given '.' is assumed.
598
Therefore simply saying 'bzr add' will version all files that
599
are currently unknown.
601
Adding a file whose parent directory is not versioned will
602
implicitly add the parent, and so on up to the root. This means
603
you should never need to explicitly add a directory, they'll just
604
get added when you add a file in the directory.
606
--dry-run will show which files would be added, but not actually
609
--file-ids-from will try to use the file ids from the supplied path.
610
It looks up ids trying to find a matching parent directory with the
611
same filename, and then by pure path. This option is rarely needed
612
but can be useful when adding the same logical file into two
613
branches that will be merged later (without showing the two different
614
adds as a conflict). It is also useful when merging another project
615
into a subdirectory of this one.
617
Any files matching patterns in the ignore list will not be added
618
unless they are explicitly mentioned.
620
takes_args = ['file*']
623
help="Don't recursively add the contents of directories."),
625
help="Show what would be done, but don't actually do anything."),
627
Option('file-ids-from',
629
help='Lookup file ids from this tree.'),
631
encoding_type = 'replace'
632
_see_also = ['remove', 'ignore']
634
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
639
if file_ids_from is not None:
641
base_tree, base_path = WorkingTree.open_containing(
643
except errors.NoWorkingTree:
644
base_branch, base_path = Branch.open_containing(
646
base_tree = base_branch.basis_tree()
648
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
649
to_file=self.outf, should_print=(not is_quiet()))
651
action = bzrlib.add.AddAction(to_file=self.outf,
652
should_print=(not is_quiet()))
655
base_tree.lock_read()
656
self.add_cleanup(base_tree.unlock)
657
tree, file_list = tree_files_for_add(file_list)
658
added, ignored = tree.smart_add(file_list, not
659
no_recurse, action=action, save=not dry_run)
663
for glob in sorted(ignored.keys()):
664
for path in ignored[glob]:
665
self.outf.write("ignored %s matching \"%s\"\n"
669
class cmd_mkdir(Command):
670
"""Create a new versioned directory.
672
This is equivalent to creating the directory and then adding it.
675
takes_args = ['dir+']
676
encoding_type = 'replace'
678
def run(self, dir_list):
681
wt, dd = WorkingTree.open_containing(d)
683
self.outf.write('added %s\n' % d)
686
class cmd_relpath(Command):
687
"""Show path of a file relative to root"""
689
takes_args = ['filename']
693
def run(self, filename):
694
# TODO: jam 20050106 Can relpath return a munged path if
695
# sys.stdout encoding cannot represent it?
696
tree, relpath = WorkingTree.open_containing(filename)
697
self.outf.write(relpath)
698
self.outf.write('\n')
701
class cmd_inventory(Command):
702
"""Show inventory of the current working copy or a revision.
704
It is possible to limit the output to a particular entry
705
type using the --kind option. For example: --kind file.
707
It is also possible to restrict the list of files to a specific
708
set. For example: bzr inventory --show-ids this/file
717
help='List entries of a particular kind: file, directory, symlink.',
720
takes_args = ['file*']
723
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
724
if kind and kind not in ['file', 'directory', 'symlink']:
725
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
727
revision = _get_one_revision('inventory', revision)
728
work_tree, file_list = tree_files(file_list)
729
work_tree.lock_read()
730
self.add_cleanup(work_tree.unlock)
731
if revision is not None:
732
tree = revision.as_tree(work_tree.branch)
734
extra_trees = [work_tree]
736
self.add_cleanup(tree.unlock)
741
if file_list is not None:
742
file_ids = tree.paths2ids(file_list, trees=extra_trees,
743
require_versioned=True)
744
# find_ids_across_trees may include some paths that don't
746
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
747
for file_id in file_ids if file_id in tree)
749
entries = tree.inventory.entries()
752
for path, entry in entries:
753
if kind and kind != entry.kind:
756
self.outf.write('%-50s %s\n' % (path, entry.file_id))
758
self.outf.write(path)
759
self.outf.write('\n')
762
class cmd_mv(Command):
763
"""Move or rename a file.
766
bzr mv OLDNAME NEWNAME
768
bzr mv SOURCE... DESTINATION
770
If the last argument is a versioned directory, all the other names
771
are moved into it. Otherwise, there must be exactly two arguments
772
and the file is changed to a new name.
774
If OLDNAME does not exist on the filesystem but is versioned and
775
NEWNAME does exist on the filesystem but is not versioned, mv
776
assumes that the file has been manually moved and only updates
777
its internal inventory to reflect that change.
778
The same is valid when moving many SOURCE files to a DESTINATION.
780
Files cannot be moved between branches.
783
takes_args = ['names*']
784
takes_options = [Option("after", help="Move only the bzr identifier"
785
" of the file, because the file has already been moved."),
786
Option('auto', help='Automatically guess renames.'),
787
Option('dry-run', help='Avoid making changes when guessing renames.'),
789
aliases = ['move', 'rename']
790
encoding_type = 'replace'
792
def run(self, names_list, after=False, auto=False, dry_run=False):
794
return self.run_auto(names_list, after, dry_run)
796
raise errors.BzrCommandError('--dry-run requires --auto.')
797
if names_list is None:
799
if len(names_list) < 2:
800
raise errors.BzrCommandError("missing file argument")
801
tree, rel_names = tree_files(names_list, canonicalize=False)
802
tree.lock_tree_write()
803
self.add_cleanup(tree.unlock)
804
self._run(tree, names_list, rel_names, after)
806
def run_auto(self, names_list, after, dry_run):
807
if names_list is not None and len(names_list) > 1:
808
raise errors.BzrCommandError('Only one path may be specified to'
811
raise errors.BzrCommandError('--after cannot be specified with'
813
work_tree, file_list = tree_files(names_list, default_branch='.')
814
work_tree.lock_tree_write()
815
self.add_cleanup(work_tree.unlock)
816
rename_map.RenameMap.guess_renames(work_tree, dry_run)
818
def _run(self, tree, names_list, rel_names, after):
819
into_existing = osutils.isdir(names_list[-1])
820
if into_existing and len(names_list) == 2:
822
# a. case-insensitive filesystem and change case of dir
823
# b. move directory after the fact (if the source used to be
824
# a directory, but now doesn't exist in the working tree
825
# and the target is an existing directory, just rename it)
826
if (not tree.case_sensitive
827
and rel_names[0].lower() == rel_names[1].lower()):
828
into_existing = False
831
# 'fix' the case of a potential 'from'
832
from_id = tree.path2id(
833
tree.get_canonical_inventory_path(rel_names[0]))
834
if (not osutils.lexists(names_list[0]) and
835
from_id and inv.get_file_kind(from_id) == "directory"):
836
into_existing = False
839
# move into existing directory
840
# All entries reference existing inventory items, so fix them up
841
# for cicp file-systems.
842
rel_names = tree.get_canonical_inventory_paths(rel_names)
843
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
845
self.outf.write("%s => %s\n" % (src, dest))
847
if len(names_list) != 2:
848
raise errors.BzrCommandError('to mv multiple files the'
849
' destination must be a versioned'
852
# for cicp file-systems: the src references an existing inventory
854
src = tree.get_canonical_inventory_path(rel_names[0])
855
# Find the canonical version of the destination: In all cases, the
856
# parent of the target must be in the inventory, so we fetch the
857
# canonical version from there (we do not always *use* the
858
# canonicalized tail portion - we may be attempting to rename the
860
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
861
dest_parent = osutils.dirname(canon_dest)
862
spec_tail = osutils.basename(rel_names[1])
863
# For a CICP file-system, we need to avoid creating 2 inventory
864
# entries that differ only by case. So regardless of the case
865
# we *want* to use (ie, specified by the user or the file-system),
866
# we must always choose to use the case of any existing inventory
867
# items. The only exception to this is when we are attempting a
868
# case-only rename (ie, canonical versions of src and dest are
870
dest_id = tree.path2id(canon_dest)
871
if dest_id is None or tree.path2id(src) == dest_id:
872
# No existing item we care about, so work out what case we
873
# are actually going to use.
875
# If 'after' is specified, the tail must refer to a file on disk.
877
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
879
# pathjoin with an empty tail adds a slash, which breaks
881
dest_parent_fq = tree.basedir
883
dest_tail = osutils.canonical_relpath(
885
osutils.pathjoin(dest_parent_fq, spec_tail))
887
# not 'after', so case as specified is used
888
dest_tail = spec_tail
890
# Use the existing item so 'mv' fails with AlreadyVersioned.
891
dest_tail = os.path.basename(canon_dest)
892
dest = osutils.pathjoin(dest_parent, dest_tail)
893
mutter("attempting to move %s => %s", src, dest)
894
tree.rename_one(src, dest, after=after)
896
self.outf.write("%s => %s\n" % (src, dest))
899
class cmd_pull(Command):
900
"""Turn this branch into a mirror of another branch.
902
By default, this command only works on branches that have not diverged.
903
Branches are considered diverged if the destination branch's most recent
904
commit is one that has not been merged (directly or indirectly) into the
907
If branches have diverged, you can use 'bzr merge' to integrate the changes
908
from one into the other. Once one branch has merged, the other should
909
be able to pull it again.
911
If you want to replace your local changes and just want your branch to
912
match the remote one, use pull --overwrite. This will work even if the two
913
branches have diverged.
915
If there is no default location set, the first pull will set it. After
916
that, you can omit the location to use the default. To change the
917
default, use --remember. The value will only be saved if the remote
918
location can be accessed.
920
Note: The location can be specified either in the form of a branch,
921
or in the form of a path to a file containing a merge directive generated
925
_see_also = ['push', 'update', 'status-flags', 'send']
926
takes_options = ['remember', 'overwrite', 'revision',
927
custom_help('verbose',
928
help='Show logs of pulled revisions.'),
930
help='Branch to pull into, '
931
'rather than the one containing the working directory.',
936
help="Perform a local pull in a bound "
937
"branch. Local pulls are not applied to "
941
takes_args = ['location?']
942
encoding_type = 'replace'
944
def run(self, location=None, remember=False, overwrite=False,
945
revision=None, verbose=False,
946
directory=None, local=False):
947
# FIXME: too much stuff is in the command class
950
if directory is None:
953
tree_to = WorkingTree.open_containing(directory)[0]
954
branch_to = tree_to.branch
955
except errors.NoWorkingTree:
957
branch_to = Branch.open_containing(directory)[0]
959
if local and not branch_to.get_bound_location():
960
raise errors.LocalRequiresBoundBranch()
962
possible_transports = []
963
if location is not None:
965
mergeable = bundle.read_mergeable_from_url(location,
966
possible_transports=possible_transports)
967
except errors.NotABundle:
970
stored_loc = branch_to.get_parent()
972
if stored_loc is None:
973
raise errors.BzrCommandError("No pull location known or"
976
display_url = urlutils.unescape_for_display(stored_loc,
979
self.outf.write("Using saved parent location: %s\n" % display_url)
980
location = stored_loc
982
revision = _get_one_revision('pull', revision)
983
if mergeable is not None:
984
if revision is not None:
985
raise errors.BzrCommandError(
986
'Cannot use -r with merge directives or bundles')
987
mergeable.install_revisions(branch_to.repository)
988
base_revision_id, revision_id, verified = \
989
mergeable.get_merge_request(branch_to.repository)
990
branch_from = branch_to
992
branch_from = Branch.open(location,
993
possible_transports=possible_transports)
995
if branch_to.get_parent() is None or remember:
996
branch_to.set_parent(branch_from.base)
998
if branch_from is not branch_to:
999
branch_from.lock_read()
1000
self.add_cleanup(branch_from.unlock)
1001
if revision is not None:
1002
revision_id = revision.as_revision_id(branch_from)
1004
branch_to.lock_write()
1005
self.add_cleanup(branch_to.unlock)
1006
if tree_to is not None:
1007
view_info = _get_view_info_for_change_reporter(tree_to)
1008
change_reporter = delta._ChangeReporter(
1009
unversioned_filter=tree_to.is_ignored,
1010
view_info=view_info)
1011
result = tree_to.pull(
1012
branch_from, overwrite, revision_id, change_reporter,
1013
possible_transports=possible_transports, local=local)
1015
result = branch_to.pull(
1016
branch_from, overwrite, revision_id, local=local)
1018
result.report(self.outf)
1019
if verbose and result.old_revid != result.new_revid:
1020
log.show_branch_change(
1021
branch_to, self.outf, result.old_revno,
1025
class cmd_push(Command):
1026
"""Update a mirror of this branch.
1028
The target branch will not have its working tree populated because this
1029
is both expensive, and is not supported on remote file systems.
1031
Some smart servers or protocols *may* put the working tree in place in
1034
This command only works on branches that have not diverged. Branches are
1035
considered diverged if the destination branch's most recent commit is one
1036
that has not been merged (directly or indirectly) by the source branch.
1038
If branches have diverged, you can use 'bzr push --overwrite' to replace
1039
the other branch completely, discarding its unmerged changes.
1041
If you want to ensure you have the different changes in the other branch,
1042
do a merge (see bzr help merge) from the other branch, and commit that.
1043
After that you will be able to do a push without '--overwrite'.
1045
If there is no default push location set, the first push will set it.
1046
After that, you can omit the location to use the default. To change the
1047
default, use --remember. The value will only be saved if the remote
1048
location can be accessed.
1051
_see_also = ['pull', 'update', 'working-trees']
1052
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1053
Option('create-prefix',
1054
help='Create the path leading up to the branch '
1055
'if it does not already exist.'),
1057
help='Branch to push from, '
1058
'rather than the one containing the working directory.',
1062
Option('use-existing-dir',
1063
help='By default push will fail if the target'
1064
' directory exists, but does not already'
1065
' have a control directory. This flag will'
1066
' allow push to proceed.'),
1068
help='Create a stacked branch that references the public location '
1069
'of the parent branch.'),
1070
Option('stacked-on',
1071
help='Create a stacked branch that refers to another branch '
1072
'for the commit history. Only the work not present in the '
1073
'referenced branch is included in the branch created.',
1076
help='Refuse to push if there are uncommitted changes in'
1077
' the working tree, --no-strict disables the check.'),
1079
takes_args = ['location?']
1080
encoding_type = 'replace'
1082
def run(self, location=None, remember=False, overwrite=False,
1083
create_prefix=False, verbose=False, revision=None,
1084
use_existing_dir=False, directory=None, stacked_on=None,
1085
stacked=False, strict=None):
1086
from bzrlib.push import _show_push_branch
1088
if directory is None:
1090
# Get the source branch
1092
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1094
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1095
if strict is None: strict = True # default value
1096
# Get the tip's revision_id
1097
revision = _get_one_revision('push', revision)
1098
if revision is not None:
1099
revision_id = revision.in_history(br_from).rev_id
1102
if strict and tree is not None and revision_id is None:
1103
if (tree.has_changes()):
1104
raise errors.UncommittedChanges(
1105
tree, more='Use --no-strict to force the push.')
1106
if tree.last_revision() != tree.branch.last_revision():
1107
# The tree has lost sync with its branch, there is little
1108
# chance that the user is aware of it but he can still force
1109
# the push with --no-strict
1110
raise errors.OutOfDateTree(
1111
tree, more='Use --no-strict to force the push.')
1113
# Get the stacked_on branch, if any
1114
if stacked_on is not None:
1115
stacked_on = urlutils.normalize_url(stacked_on)
1117
parent_url = br_from.get_parent()
1119
parent = Branch.open(parent_url)
1120
stacked_on = parent.get_public_branch()
1122
# I considered excluding non-http url's here, thus forcing
1123
# 'public' branches only, but that only works for some
1124
# users, so it's best to just depend on the user spotting an
1125
# error by the feedback given to them. RBC 20080227.
1126
stacked_on = parent_url
1128
raise errors.BzrCommandError(
1129
"Could not determine branch to refer to.")
1131
# Get the destination location
1132
if location is None:
1133
stored_loc = br_from.get_push_location()
1134
if stored_loc is None:
1135
raise errors.BzrCommandError(
1136
"No push location known or specified.")
1138
display_url = urlutils.unescape_for_display(stored_loc,
1140
self.outf.write("Using saved push location: %s\n" % display_url)
1141
location = stored_loc
1143
_show_push_branch(br_from, revision_id, location, self.outf,
1144
verbose=verbose, overwrite=overwrite, remember=remember,
1145
stacked_on=stacked_on, create_prefix=create_prefix,
1146
use_existing_dir=use_existing_dir)
1149
class cmd_branch(Command):
1150
"""Create a new branch that is a copy of an existing branch.
1152
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1153
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1154
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1155
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1156
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1159
To retrieve the branch as of a particular revision, supply the --revision
1160
parameter, as in "branch foo/bar -r 5".
1163
_see_also = ['checkout']
1164
takes_args = ['from_location', 'to_location?']
1165
takes_options = ['revision', Option('hardlink',
1166
help='Hard-link working tree files where possible.'),
1168
help="Create a branch without a working-tree."),
1170
help="Switch the checkout in the current directory "
1171
"to the new branch."),
1173
help='Create a stacked branch referring to the source branch. '
1174
'The new branch will depend on the availability of the source '
1175
'branch for all operations.'),
1176
Option('standalone',
1177
help='Do not use a shared repository, even if available.'),
1178
Option('use-existing-dir',
1179
help='By default branch will fail if the target'
1180
' directory exists, but does not already'
1181
' have a control directory. This flag will'
1182
' allow branch to proceed.'),
1184
help="Bind new branch to from location."),
1186
aliases = ['get', 'clone']
1188
def run(self, from_location, to_location=None, revision=None,
1189
hardlink=False, stacked=False, standalone=False, no_tree=False,
1190
use_existing_dir=False, switch=False, bind=False):
1191
from bzrlib import switch as _mod_switch
1192
from bzrlib.tag import _merge_tags_if_possible
1193
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1195
revision = _get_one_revision('branch', revision)
1197
self.add_cleanup(br_from.unlock)
1198
if revision is not None:
1199
revision_id = revision.as_revision_id(br_from)
1201
# FIXME - wt.last_revision, fallback to branch, fall back to
1202
# None or perhaps NULL_REVISION to mean copy nothing
1204
revision_id = br_from.last_revision()
1205
if to_location is None:
1206
to_location = urlutils.derive_to_location(from_location)
1207
to_transport = transport.get_transport(to_location)
1209
to_transport.mkdir('.')
1210
except errors.FileExists:
1211
if not use_existing_dir:
1212
raise errors.BzrCommandError('Target directory "%s" '
1213
'already exists.' % to_location)
1216
bzrdir.BzrDir.open_from_transport(to_transport)
1217
except errors.NotBranchError:
1220
raise errors.AlreadyBranchError(to_location)
1221
except errors.NoSuchFile:
1222
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1225
# preserve whatever source format we have.
1226
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1227
possible_transports=[to_transport],
1228
accelerator_tree=accelerator_tree,
1229
hardlink=hardlink, stacked=stacked,
1230
force_new_repo=standalone,
1231
create_tree_if_local=not no_tree,
1232
source_branch=br_from)
1233
branch = dir.open_branch()
1234
except errors.NoSuchRevision:
1235
to_transport.delete_tree('.')
1236
msg = "The branch %s has no revision %s." % (from_location,
1238
raise errors.BzrCommandError(msg)
1239
_merge_tags_if_possible(br_from, branch)
1240
# If the source branch is stacked, the new branch may
1241
# be stacked whether we asked for that explicitly or not.
1242
# We therefore need a try/except here and not just 'if stacked:'
1244
note('Created new stacked branch referring to %s.' %
1245
branch.get_stacked_on_url())
1246
except (errors.NotStacked, errors.UnstackableBranchFormat,
1247
errors.UnstackableRepositoryFormat), e:
1248
note('Branched %d revision(s).' % branch.revno())
1250
# Bind to the parent
1251
parent_branch = Branch.open(from_location)
1252
branch.bind(parent_branch)
1253
note('New branch bound to %s' % from_location)
1255
# Switch to the new branch
1256
wt, _ = WorkingTree.open_containing('.')
1257
_mod_switch.switch(wt.bzrdir, branch)
1258
note('Switched to branch: %s',
1259
urlutils.unescape_for_display(branch.base, 'utf-8'))
1262
class cmd_checkout(Command):
1263
"""Create a new checkout of an existing branch.
1265
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1266
the branch found in '.'. This is useful if you have removed the working tree
1267
or if it was never created - i.e. if you pushed the branch to its current
1268
location using SFTP.
1270
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1271
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1272
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1273
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1274
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1277
To retrieve the branch as of a particular revision, supply the --revision
1278
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1279
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1283
_see_also = ['checkouts', 'branch']
1284
takes_args = ['branch_location?', 'to_location?']
1285
takes_options = ['revision',
1286
Option('lightweight',
1287
help="Perform a lightweight checkout. Lightweight "
1288
"checkouts depend on access to the branch for "
1289
"every operation. Normal checkouts can perform "
1290
"common operations like diff and status without "
1291
"such access, and also support local commits."
1293
Option('files-from', type=str,
1294
help="Get file contents from this tree."),
1296
help='Hard-link working tree files where possible.'
1301
def run(self, branch_location=None, to_location=None, revision=None,
1302
lightweight=False, files_from=None, hardlink=False):
1303
if branch_location is None:
1304
branch_location = osutils.getcwd()
1305
to_location = branch_location
1306
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1308
revision = _get_one_revision('checkout', revision)
1309
if files_from is not None:
1310
accelerator_tree = WorkingTree.open(files_from)
1311
if revision is not None:
1312
revision_id = revision.as_revision_id(source)
1315
if to_location is None:
1316
to_location = urlutils.derive_to_location(branch_location)
1317
# if the source and to_location are the same,
1318
# and there is no working tree,
1319
# then reconstitute a branch
1320
if (osutils.abspath(to_location) ==
1321
osutils.abspath(branch_location)):
1323
source.bzrdir.open_workingtree()
1324
except errors.NoWorkingTree:
1325
source.bzrdir.create_workingtree(revision_id)
1327
source.create_checkout(to_location, revision_id, lightweight,
1328
accelerator_tree, hardlink)
1331
class cmd_renames(Command):
1332
"""Show list of renamed files.
1334
# TODO: Option to show renames between two historical versions.
1336
# TODO: Only show renames under dir, rather than in the whole branch.
1337
_see_also = ['status']
1338
takes_args = ['dir?']
1341
def run(self, dir=u'.'):
1342
tree = WorkingTree.open_containing(dir)[0]
1344
self.add_cleanup(tree.unlock)
1345
new_inv = tree.inventory
1346
old_tree = tree.basis_tree()
1347
old_tree.lock_read()
1348
self.add_cleanup(old_tree.unlock)
1349
old_inv = old_tree.inventory
1351
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1352
for f, paths, c, v, p, n, k, e in iterator:
1353
if paths[0] == paths[1]:
1357
renames.append(paths)
1359
for old_name, new_name in renames:
1360
self.outf.write("%s => %s\n" % (old_name, new_name))
1363
class cmd_update(Command):
1364
"""Update a tree to have the latest code committed to its branch.
1366
This will perform a merge into the working tree, and may generate
1367
conflicts. If you have any local changes, you will still
1368
need to commit them after the update for the update to be complete.
1370
If you want to discard your local changes, you can just do a
1371
'bzr revert' instead of 'bzr commit' after the update.
1373
If the tree's branch is bound to a master branch, it will also update
1374
the branch from the master.
1377
_see_also = ['pull', 'working-trees', 'status-flags']
1378
takes_args = ['dir?']
1379
takes_options = ['revision']
1382
def run(self, dir='.', revision=None):
1383
if revision is not None and len(revision) != 1:
1384
raise errors.BzrCommandError(
1385
"bzr update --revision takes exactly one revision")
1386
tree = WorkingTree.open_containing(dir)[0]
1387
branch = tree.branch
1388
possible_transports = []
1389
master = branch.get_master_branch(
1390
possible_transports=possible_transports)
1391
if master is not None:
1393
branch_location = master.base
1395
tree.lock_tree_write()
1396
branch_location = tree.branch.base
1397
self.add_cleanup(tree.unlock)
1398
# get rid of the final '/' and be ready for display
1399
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1401
existing_pending_merges = tree.get_parent_ids()[1:]
1405
# may need to fetch data into a heavyweight checkout
1406
# XXX: this may take some time, maybe we should display a
1408
old_tip = branch.update(possible_transports)
1409
if revision is not None:
1410
revision_id = revision[0].as_revision_id(branch)
1412
revision_id = branch.last_revision()
1413
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1414
revno = branch.revision_id_to_revno(revision_id)
1415
note("Tree is up to date at revision %d of branch %s" %
1416
(revno, branch_location))
1418
view_info = _get_view_info_for_change_reporter(tree)
1419
change_reporter = delta._ChangeReporter(
1420
unversioned_filter=tree.is_ignored,
1421
view_info=view_info)
1423
conflicts = tree.update(
1425
possible_transports=possible_transports,
1426
revision=revision_id,
1428
except errors.NoSuchRevision, e:
1429
raise errors.BzrCommandError(
1430
"branch has no revision %s\n"
1431
"bzr update --revision only works"
1432
" for a revision in the branch history"
1434
revno = tree.branch.revision_id_to_revno(
1435
_mod_revision.ensure_null(tree.last_revision()))
1436
note('Updated to revision %d of branch %s' %
1437
(revno, branch_location))
1438
if tree.get_parent_ids()[1:] != existing_pending_merges:
1439
note('Your local commits will now show as pending merges with '
1440
"'bzr status', and can be committed with 'bzr commit'.")
1447
class cmd_info(Command):
1448
"""Show information about a working tree, branch or repository.
1450
This command will show all known locations and formats associated to the
1451
tree, branch or repository.
1453
In verbose mode, statistical information is included with each report.
1454
To see extended statistic information, use a verbosity level of 2 or
1455
higher by specifying the verbose option multiple times, e.g. -vv.
1457
Branches and working trees will also report any missing revisions.
1461
Display information on the format and related locations:
1465
Display the above together with extended format information and
1466
basic statistics (like the number of files in the working tree and
1467
number of revisions in the branch and repository):
1471
Display the above together with number of committers to the branch:
1475
_see_also = ['revno', 'working-trees', 'repositories']
1476
takes_args = ['location?']
1477
takes_options = ['verbose']
1478
encoding_type = 'replace'
1481
def run(self, location=None, verbose=False):
1483
noise_level = get_verbosity_level()
1486
from bzrlib.info import show_bzrdir_info
1487
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1488
verbose=noise_level, outfile=self.outf)
1491
class cmd_remove(Command):
1492
"""Remove files or directories.
1494
This makes bzr stop tracking changes to the specified files. bzr will delete
1495
them if they can easily be recovered using revert. If no options or
1496
parameters are given bzr will scan for files that are being tracked by bzr
1497
but missing in your tree and stop tracking them for you.
1499
takes_args = ['file*']
1500
takes_options = ['verbose',
1501
Option('new', help='Only remove files that have never been committed.'),
1502
RegistryOption.from_kwargs('file-deletion-strategy',
1503
'The file deletion mode to be used.',
1504
title='Deletion Strategy', value_switches=True, enum_switch=False,
1505
safe='Only delete files if they can be'
1506
' safely recovered (default).',
1507
keep='Delete from bzr but leave the working copy.',
1508
force='Delete all the specified files, even if they can not be '
1509
'recovered and even if they are non-empty directories.')]
1510
aliases = ['rm', 'del']
1511
encoding_type = 'replace'
1513
def run(self, file_list, verbose=False, new=False,
1514
file_deletion_strategy='safe'):
1515
tree, file_list = tree_files(file_list)
1517
if file_list is not None:
1518
file_list = [f for f in file_list]
1521
self.add_cleanup(tree.unlock)
1522
# Heuristics should probably all move into tree.remove_smart or
1525
added = tree.changes_from(tree.basis_tree(),
1526
specific_files=file_list).added
1527
file_list = sorted([f[0] for f in added], reverse=True)
1528
if len(file_list) == 0:
1529
raise errors.BzrCommandError('No matching files.')
1530
elif file_list is None:
1531
# missing files show up in iter_changes(basis) as
1532
# versioned-with-no-kind.
1534
for change in tree.iter_changes(tree.basis_tree()):
1535
# Find paths in the working tree that have no kind:
1536
if change[1][1] is not None and change[6][1] is None:
1537
missing.append(change[1][1])
1538
file_list = sorted(missing, reverse=True)
1539
file_deletion_strategy = 'keep'
1540
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1541
keep_files=file_deletion_strategy=='keep',
1542
force=file_deletion_strategy=='force')
1545
class cmd_file_id(Command):
1546
"""Print file_id of a particular file or directory.
1548
The file_id is assigned when the file is first added and remains the
1549
same through all revisions where the file exists, even when it is
1554
_see_also = ['inventory', 'ls']
1555
takes_args = ['filename']
1558
def run(self, filename):
1559
tree, relpath = WorkingTree.open_containing(filename)
1560
i = tree.path2id(relpath)
1562
raise errors.NotVersionedError(filename)
1564
self.outf.write(i + '\n')
1567
class cmd_file_path(Command):
1568
"""Print path of file_ids to a file or directory.
1570
This prints one line for each directory down to the target,
1571
starting at the branch root.
1575
takes_args = ['filename']
1578
def run(self, filename):
1579
tree, relpath = WorkingTree.open_containing(filename)
1580
fid = tree.path2id(relpath)
1582
raise errors.NotVersionedError(filename)
1583
segments = osutils.splitpath(relpath)
1584
for pos in range(1, len(segments) + 1):
1585
path = osutils.joinpath(segments[:pos])
1586
self.outf.write("%s\n" % tree.path2id(path))
1589
class cmd_reconcile(Command):
1590
"""Reconcile bzr metadata in a branch.
1592
This can correct data mismatches that may have been caused by
1593
previous ghost operations or bzr upgrades. You should only
1594
need to run this command if 'bzr check' or a bzr developer
1595
advises you to run it.
1597
If a second branch is provided, cross-branch reconciliation is
1598
also attempted, which will check that data like the tree root
1599
id which was not present in very early bzr versions is represented
1600
correctly in both branches.
1602
At the same time it is run it may recompress data resulting in
1603
a potential saving in disk space or performance gain.
1605
The branch *MUST* be on a listable system such as local disk or sftp.
1608
_see_also = ['check']
1609
takes_args = ['branch?']
1611
def run(self, branch="."):
1612
from bzrlib.reconcile import reconcile
1613
dir = bzrdir.BzrDir.open(branch)
1617
class cmd_revision_history(Command):
1618
"""Display the list of revision ids on a branch."""
1621
takes_args = ['location?']
1626
def run(self, location="."):
1627
branch = Branch.open_containing(location)[0]
1628
for revid in branch.revision_history():
1629
self.outf.write(revid)
1630
self.outf.write('\n')
1633
class cmd_ancestry(Command):
1634
"""List all revisions merged into this branch."""
1636
_see_also = ['log', 'revision-history']
1637
takes_args = ['location?']
1642
def run(self, location="."):
1644
wt = WorkingTree.open_containing(location)[0]
1645
except errors.NoWorkingTree:
1646
b = Branch.open(location)
1647
last_revision = b.last_revision()
1650
last_revision = wt.last_revision()
1652
revision_ids = b.repository.get_ancestry(last_revision)
1654
for revision_id in revision_ids:
1655
self.outf.write(revision_id + '\n')
1658
class cmd_init(Command):
1659
"""Make a directory into a versioned branch.
1661
Use this to create an empty branch, or before importing an
1664
If there is a repository in a parent directory of the location, then
1665
the history of the branch will be stored in the repository. Otherwise
1666
init creates a standalone branch which carries its own history
1667
in the .bzr directory.
1669
If there is already a branch at the location but it has no working tree,
1670
the tree can be populated with 'bzr checkout'.
1672
Recipe for importing a tree of files::
1678
bzr commit -m "imported project"
1681
_see_also = ['init-repository', 'branch', 'checkout']
1682
takes_args = ['location?']
1684
Option('create-prefix',
1685
help='Create the path leading up to the branch '
1686
'if it does not already exist.'),
1687
RegistryOption('format',
1688
help='Specify a format for this branch. '
1689
'See "help formats".',
1690
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1691
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1692
value_switches=True,
1693
title="Branch format",
1695
Option('append-revisions-only',
1696
help='Never change revnos or the existing log.'
1697
' Append revisions to it only.')
1699
def run(self, location=None, format=None, append_revisions_only=False,
1700
create_prefix=False):
1702
format = bzrdir.format_registry.make_bzrdir('default')
1703
if location is None:
1706
to_transport = transport.get_transport(location)
1708
# The path has to exist to initialize a
1709
# branch inside of it.
1710
# Just using os.mkdir, since I don't
1711
# believe that we want to create a bunch of
1712
# locations if the user supplies an extended path
1714
to_transport.ensure_base()
1715
except errors.NoSuchFile:
1716
if not create_prefix:
1717
raise errors.BzrCommandError("Parent directory of %s"
1719
"\nYou may supply --create-prefix to create all"
1720
" leading parent directories."
1722
to_transport.create_prefix()
1725
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1726
except errors.NotBranchError:
1727
# really a NotBzrDir error...
1728
create_branch = bzrdir.BzrDir.create_branch_convenience
1729
branch = create_branch(to_transport.base, format=format,
1730
possible_transports=[to_transport])
1731
a_bzrdir = branch.bzrdir
1733
from bzrlib.transport.local import LocalTransport
1734
if a_bzrdir.has_branch():
1735
if (isinstance(to_transport, LocalTransport)
1736
and not a_bzrdir.has_workingtree()):
1737
raise errors.BranchExistsWithoutWorkingTree(location)
1738
raise errors.AlreadyBranchError(location)
1739
branch = a_bzrdir.create_branch()
1740
a_bzrdir.create_workingtree()
1741
if append_revisions_only:
1743
branch.set_append_revisions_only(True)
1744
except errors.UpgradeRequired:
1745
raise errors.BzrCommandError('This branch format cannot be set'
1746
' to append-revisions-only. Try --default.')
1748
from bzrlib.info import describe_layout, describe_format
1750
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1751
except (errors.NoWorkingTree, errors.NotLocalUrl):
1753
repository = branch.repository
1754
layout = describe_layout(repository, branch, tree).lower()
1755
format = describe_format(a_bzrdir, repository, branch, tree)
1756
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1757
if repository.is_shared():
1758
#XXX: maybe this can be refactored into transport.path_or_url()
1759
url = repository.bzrdir.root_transport.external_url()
1761
url = urlutils.local_path_from_url(url)
1762
except errors.InvalidURL:
1764
self.outf.write("Using shared repository: %s\n" % url)
1767
class cmd_init_repository(Command):
1768
"""Create a shared repository for branches to share storage space.
1770
New branches created under the repository directory will store their
1771
revisions in the repository, not in the branch directory. For branches
1772
with shared history, this reduces the amount of storage needed and
1773
speeds up the creation of new branches.
1775
If the --no-trees option is given then the branches in the repository
1776
will not have working trees by default. They will still exist as
1777
directories on disk, but they will not have separate copies of the
1778
files at a certain revision. This can be useful for repositories that
1779
store branches which are interacted with through checkouts or remote
1780
branches, such as on a server.
1783
Create a shared repository holding just branches::
1785
bzr init-repo --no-trees repo
1788
Make a lightweight checkout elsewhere::
1790
bzr checkout --lightweight repo/trunk trunk-checkout
1795
_see_also = ['init', 'branch', 'checkout', 'repositories']
1796
takes_args = ["location"]
1797
takes_options = [RegistryOption('format',
1798
help='Specify a format for this repository. See'
1799
' "bzr help formats" for details.',
1800
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1801
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1802
value_switches=True, title='Repository format'),
1804
help='Branches in the repository will default to'
1805
' not having a working tree.'),
1807
aliases = ["init-repo"]
1809
def run(self, location, format=None, no_trees=False):
1811
format = bzrdir.format_registry.make_bzrdir('default')
1813
if location is None:
1816
to_transport = transport.get_transport(location)
1817
to_transport.ensure_base()
1819
newdir = format.initialize_on_transport(to_transport)
1820
repo = newdir.create_repository(shared=True)
1821
repo.set_make_working_trees(not no_trees)
1823
from bzrlib.info import show_bzrdir_info
1824
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1827
class cmd_diff(Command):
1828
"""Show differences in the working tree, between revisions or branches.
1830
If no arguments are given, all changes for the current tree are listed.
1831
If files are given, only the changes in those files are listed.
1832
Remote and multiple branches can be compared by using the --old and
1833
--new options. If not provided, the default for both is derived from
1834
the first argument, if any, or the current tree if no arguments are
1837
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1838
produces patches suitable for "patch -p1".
1842
2 - unrepresentable changes
1847
Shows the difference in the working tree versus the last commit::
1851
Difference between the working tree and revision 1::
1855
Difference between revision 3 and revision 1::
1859
Difference between revision 3 and revision 1 for branch xxx::
1863
To see the changes introduced in revision X::
1867
Note that in the case of a merge, the -c option shows the changes
1868
compared to the left hand parent. To see the changes against
1869
another parent, use::
1871
bzr diff -r<chosen_parent>..X
1873
The changes introduced by revision 2 (equivalent to -r1..2)::
1877
Show just the differences for file NEWS::
1881
Show the differences in working tree xxx for file NEWS::
1885
Show the differences from branch xxx to this working tree:
1889
Show the differences between two branches for file NEWS::
1891
bzr diff --old xxx --new yyy NEWS
1893
Same as 'bzr diff' but prefix paths with old/ and new/::
1895
bzr diff --prefix old/:new/
1897
_see_also = ['status']
1898
takes_args = ['file*']
1900
Option('diff-options', type=str,
1901
help='Pass these options to the external diff program.'),
1902
Option('prefix', type=str,
1904
help='Set prefixes added to old and new filenames, as '
1905
'two values separated by a colon. (eg "old/:new/").'),
1907
help='Branch/tree to compare from.',
1911
help='Branch/tree to compare to.',
1917
help='Use this command to compare files.',
1921
aliases = ['di', 'dif']
1922
encoding_type = 'exact'
1925
def run(self, revision=None, file_list=None, diff_options=None,
1926
prefix=None, old=None, new=None, using=None):
1927
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1929
if (prefix is None) or (prefix == '0'):
1937
old_label, new_label = prefix.split(":")
1939
raise errors.BzrCommandError(
1940
'--prefix expects two values separated by a colon'
1941
' (eg "old/:new/")')
1943
if revision and len(revision) > 2:
1944
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1945
' one or two revision specifiers')
1947
(old_tree, new_tree,
1948
old_branch, new_branch,
1949
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1950
file_list, revision, old, new, apply_view=True)
1951
return show_diff_trees(old_tree, new_tree, sys.stdout,
1952
specific_files=specific_files,
1953
external_diff_options=diff_options,
1954
old_label=old_label, new_label=new_label,
1955
extra_trees=extra_trees, using=using)
1958
class cmd_deleted(Command):
1959
"""List files deleted in the working tree.
1961
# TODO: Show files deleted since a previous revision, or
1962
# between two revisions.
1963
# TODO: Much more efficient way to do this: read in new
1964
# directories with readdir, rather than stating each one. Same
1965
# level of effort but possibly much less IO. (Or possibly not,
1966
# if the directories are very large...)
1967
_see_also = ['status', 'ls']
1968
takes_options = ['show-ids']
1971
def run(self, show_ids=False):
1972
tree = WorkingTree.open_containing(u'.')[0]
1974
self.add_cleanup(tree.unlock)
1975
old = tree.basis_tree()
1977
self.add_cleanup(old.unlock)
1978
for path, ie in old.inventory.iter_entries():
1979
if not tree.has_id(ie.file_id):
1980
self.outf.write(path)
1982
self.outf.write(' ')
1983
self.outf.write(ie.file_id)
1984
self.outf.write('\n')
1987
class cmd_modified(Command):
1988
"""List files modified in working tree.
1992
_see_also = ['status', 'ls']
1995
help='Write an ascii NUL (\\0) separator '
1996
'between files rather than a newline.')
2000
def run(self, null=False):
2001
tree = WorkingTree.open_containing(u'.')[0]
2002
td = tree.changes_from(tree.basis_tree())
2003
for path, id, kind, text_modified, meta_modified in td.modified:
2005
self.outf.write(path + '\0')
2007
self.outf.write(osutils.quotefn(path) + '\n')
2010
class cmd_added(Command):
2011
"""List files added in working tree.
2015
_see_also = ['status', 'ls']
2018
help='Write an ascii NUL (\\0) separator '
2019
'between files rather than a newline.')
2023
def run(self, null=False):
2024
wt = WorkingTree.open_containing(u'.')[0]
2026
self.add_cleanup(wt.unlock)
2027
basis = wt.basis_tree()
2029
self.add_cleanup(basis.unlock)
2030
basis_inv = basis.inventory
2033
if file_id in basis_inv:
2035
if inv.is_root(file_id) and len(basis_inv) == 0:
2037
path = inv.id2path(file_id)
2038
if not os.access(osutils.abspath(path), os.F_OK):
2041
self.outf.write(path + '\0')
2043
self.outf.write(osutils.quotefn(path) + '\n')
2046
class cmd_root(Command):
2047
"""Show the tree root directory.
2049
The root is the nearest enclosing directory with a .bzr control
2052
takes_args = ['filename?']
2054
def run(self, filename=None):
2055
"""Print the branch root."""
2056
tree = WorkingTree.open_containing(filename)[0]
2057
self.outf.write(tree.basedir + '\n')
2060
def _parse_limit(limitstring):
2062
return int(limitstring)
2064
msg = "The limit argument must be an integer."
2065
raise errors.BzrCommandError(msg)
2068
def _parse_levels(s):
2072
msg = "The levels argument must be an integer."
2073
raise errors.BzrCommandError(msg)
2076
class cmd_log(Command):
2077
"""Show historical log for a branch or subset of a branch.
2079
log is bzr's default tool for exploring the history of a branch.
2080
The branch to use is taken from the first parameter. If no parameters
2081
are given, the branch containing the working directory is logged.
2082
Here are some simple examples::
2084
bzr log log the current branch
2085
bzr log foo.py log a file in its branch
2086
bzr log http://server/branch log a branch on a server
2088
The filtering, ordering and information shown for each revision can
2089
be controlled as explained below. By default, all revisions are
2090
shown sorted (topologically) so that newer revisions appear before
2091
older ones and descendants always appear before ancestors. If displayed,
2092
merged revisions are shown indented under the revision in which they
2097
The log format controls how information about each revision is
2098
displayed. The standard log formats are called ``long``, ``short``
2099
and ``line``. The default is long. See ``bzr help log-formats``
2100
for more details on log formats.
2102
The following options can be used to control what information is
2105
-l N display a maximum of N revisions
2106
-n N display N levels of revisions (0 for all, 1 for collapsed)
2107
-v display a status summary (delta) for each revision
2108
-p display a diff (patch) for each revision
2109
--show-ids display revision-ids (and file-ids), not just revnos
2111
Note that the default number of levels to display is a function of the
2112
log format. If the -n option is not used, the standard log formats show
2113
just the top level (mainline).
2115
Status summaries are shown using status flags like A, M, etc. To see
2116
the changes explained using words like ``added`` and ``modified``
2117
instead, use the -vv option.
2121
To display revisions from oldest to newest, use the --forward option.
2122
In most cases, using this option will have little impact on the total
2123
time taken to produce a log, though --forward does not incrementally
2124
display revisions like --reverse does when it can.
2126
:Revision filtering:
2128
The -r option can be used to specify what revision or range of revisions
2129
to filter against. The various forms are shown below::
2131
-rX display revision X
2132
-rX.. display revision X and later
2133
-r..Y display up to and including revision Y
2134
-rX..Y display from X to Y inclusive
2136
See ``bzr help revisionspec`` for details on how to specify X and Y.
2137
Some common examples are given below::
2139
-r-1 show just the tip
2140
-r-10.. show the last 10 mainline revisions
2141
-rsubmit:.. show what's new on this branch
2142
-rancestor:path.. show changes since the common ancestor of this
2143
branch and the one at location path
2144
-rdate:yesterday.. show changes since yesterday
2146
When logging a range of revisions using -rX..Y, log starts at
2147
revision Y and searches back in history through the primary
2148
("left-hand") parents until it finds X. When logging just the
2149
top level (using -n1), an error is reported if X is not found
2150
along the way. If multi-level logging is used (-n0), X may be
2151
a nested merge revision and the log will be truncated accordingly.
2155
If parameters are given and the first one is not a branch, the log
2156
will be filtered to show only those revisions that changed the
2157
nominated files or directories.
2159
Filenames are interpreted within their historical context. To log a
2160
deleted file, specify a revision range so that the file existed at
2161
the end or start of the range.
2163
Historical context is also important when interpreting pathnames of
2164
renamed files/directories. Consider the following example:
2166
* revision 1: add tutorial.txt
2167
* revision 2: modify tutorial.txt
2168
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2172
* ``bzr log guide.txt`` will log the file added in revision 1
2174
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2176
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2177
the original file in revision 2.
2179
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2180
was no file called guide.txt in revision 2.
2182
Renames are always followed by log. By design, there is no need to
2183
explicitly ask for this (and no way to stop logging a file back
2184
until it was last renamed).
2188
The --message option can be used for finding revisions that match a
2189
regular expression in a commit message.
2193
GUI tools and IDEs are often better at exploring history than command
2194
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2195
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2196
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2197
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2199
You may find it useful to add the aliases below to ``bazaar.conf``::
2203
top = log -l10 --line
2206
``bzr tip`` will then show the latest revision while ``bzr top``
2207
will show the last 10 mainline revisions. To see the details of a
2208
particular revision X, ``bzr show -rX``.
2210
If you are interested in looking deeper into a particular merge X,
2211
use ``bzr log -n0 -rX``.
2213
``bzr log -v`` on a branch with lots of history is currently
2214
very slow. A fix for this issue is currently under development.
2215
With or without that fix, it is recommended that a revision range
2216
be given when using the -v option.
2218
bzr has a generic full-text matching plugin, bzr-search, that can be
2219
used to find revisions matching user names, commit messages, etc.
2220
Among other features, this plugin can find all revisions containing
2221
a list of words but not others.
2223
When exploring non-mainline history on large projects with deep
2224
history, the performance of log can be greatly improved by installing
2225
the historycache plugin. This plugin buffers historical information
2226
trading disk space for faster speed.
2228
takes_args = ['file*']
2229
_see_also = ['log-formats', 'revisionspec']
2232
help='Show from oldest to newest.'),
2234
custom_help('verbose',
2235
help='Show files changed in each revision.'),
2239
type=bzrlib.option._parse_revision_str,
2241
help='Show just the specified revision.'
2242
' See also "help revisionspec".'),
2246
help='Number of levels to display - 0 for all, 1 for flat.',
2248
type=_parse_levels),
2251
help='Show revisions whose message matches this '
2252
'regular expression.',
2256
help='Limit the output to the first N revisions.',
2261
help='Show changes made in each revision as a patch.'),
2262
Option('include-merges',
2263
help='Show merged revisions like --levels 0 does.'),
2265
encoding_type = 'replace'
2268
def run(self, file_list=None, timezone='original',
2279
include_merges=False):
2280
from bzrlib.log import (
2282
make_log_request_dict,
2283
_get_info_for_log_files,
2285
direction = (forward and 'forward') or 'reverse'
2290
raise errors.BzrCommandError(
2291
'--levels and --include-merges are mutually exclusive')
2293
if change is not None:
2295
raise errors.RangeInChangeOption()
2296
if revision is not None:
2297
raise errors.BzrCommandError(
2298
'--revision and --change are mutually exclusive')
2303
filter_by_dir = False
2305
# find the file ids to log and check for directory filtering
2306
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2307
revision, file_list)
2308
self.add_cleanup(b.unlock)
2309
for relpath, file_id, kind in file_info_list:
2311
raise errors.BzrCommandError(
2312
"Path unknown at end or start of revision range: %s" %
2314
# If the relpath is the top of the tree, we log everything
2319
file_ids.append(file_id)
2320
filter_by_dir = filter_by_dir or (
2321
kind in ['directory', 'tree-reference'])
2324
# FIXME ? log the current subdir only RBC 20060203
2325
if revision is not None \
2326
and len(revision) > 0 and revision[0].get_branch():
2327
location = revision[0].get_branch()
2330
dir, relpath = bzrdir.BzrDir.open_containing(location)
2331
b = dir.open_branch()
2333
self.add_cleanup(b.unlock)
2334
rev1, rev2 = _get_revision_range(revision, b, self.name())
2336
# Decide on the type of delta & diff filtering to use
2337
# TODO: add an --all-files option to make this configurable & consistent
2345
diff_type = 'partial'
2349
# Build the log formatter
2350
if log_format is None:
2351
log_format = log.log_formatter_registry.get_default(b)
2352
# Make a non-encoding output to include the diffs - bug 328007
2353
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2354
lf = log_format(show_ids=show_ids, to_file=self.outf,
2355
to_exact_file=unencoded_output,
2356
show_timezone=timezone,
2357
delta_format=get_verbosity_level(),
2359
show_advice=levels is None)
2361
# Choose the algorithm for doing the logging. It's annoying
2362
# having multiple code paths like this but necessary until
2363
# the underlying repository format is faster at generating
2364
# deltas or can provide everything we need from the indices.
2365
# The default algorithm - match-using-deltas - works for
2366
# multiple files and directories and is faster for small
2367
# amounts of history (200 revisions say). However, it's too
2368
# slow for logging a single file in a repository with deep
2369
# history, i.e. > 10K revisions. In the spirit of "do no
2370
# evil when adding features", we continue to use the
2371
# original algorithm - per-file-graph - for the "single
2372
# file that isn't a directory without showing a delta" case.
2373
partial_history = revision and b.repository._format.supports_chks
2374
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2375
or delta_type or partial_history)
2377
# Build the LogRequest and execute it
2378
if len(file_ids) == 0:
2380
rqst = make_log_request_dict(
2381
direction=direction, specific_fileids=file_ids,
2382
start_revision=rev1, end_revision=rev2, limit=limit,
2383
message_search=message, delta_type=delta_type,
2384
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2385
Logger(b, rqst).show(lf)
2388
def _get_revision_range(revisionspec_list, branch, command_name):
2389
"""Take the input of a revision option and turn it into a revision range.
2391
It returns RevisionInfo objects which can be used to obtain the rev_id's
2392
of the desired revisions. It does some user input validations.
2394
if revisionspec_list is None:
2397
elif len(revisionspec_list) == 1:
2398
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2399
elif len(revisionspec_list) == 2:
2400
start_spec = revisionspec_list[0]
2401
end_spec = revisionspec_list[1]
2402
if end_spec.get_branch() != start_spec.get_branch():
2403
# b is taken from revision[0].get_branch(), and
2404
# show_log will use its revision_history. Having
2405
# different branches will lead to weird behaviors.
2406
raise errors.BzrCommandError(
2407
"bzr %s doesn't accept two revisions in different"
2408
" branches." % command_name)
2409
rev1 = start_spec.in_history(branch)
2410
# Avoid loading all of history when we know a missing
2411
# end of range means the last revision ...
2412
if end_spec.spec is None:
2413
last_revno, last_revision_id = branch.last_revision_info()
2414
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2416
rev2 = end_spec.in_history(branch)
2418
raise errors.BzrCommandError(
2419
'bzr %s --revision takes one or two values.' % command_name)
2423
def _revision_range_to_revid_range(revision_range):
2426
if revision_range[0] is not None:
2427
rev_id1 = revision_range[0].rev_id
2428
if revision_range[1] is not None:
2429
rev_id2 = revision_range[1].rev_id
2430
return rev_id1, rev_id2
2432
def get_log_format(long=False, short=False, line=False, default='long'):
2433
log_format = default
2437
log_format = 'short'
2443
class cmd_touching_revisions(Command):
2444
"""Return revision-ids which affected a particular file.
2446
A more user-friendly interface is "bzr log FILE".
2450
takes_args = ["filename"]
2453
def run(self, filename):
2454
tree, relpath = WorkingTree.open_containing(filename)
2455
file_id = tree.path2id(relpath)
2458
self.add_cleanup(b.unlock)
2459
touching_revs = log.find_touching_revisions(b, file_id)
2460
for revno, revision_id, what in touching_revs:
2461
self.outf.write("%6d %s\n" % (revno, what))
2464
class cmd_ls(Command):
2465
"""List files in a tree.
2468
_see_also = ['status', 'cat']
2469
takes_args = ['path?']
2473
Option('recursive', short_name='R',
2474
help='Recurse into subdirectories.'),
2476
help='Print paths relative to the root of the branch.'),
2477
Option('unknown', help='Print unknown files.'),
2478
Option('versioned', help='Print versioned files.',
2480
Option('ignored', help='Print ignored files.'),
2482
help='Write an ascii NUL (\\0) separator '
2483
'between files rather than a newline.'),
2485
help='List entries of a particular kind: file, directory, symlink.',
2490
def run(self, revision=None, verbose=False,
2491
recursive=False, from_root=False,
2492
unknown=False, versioned=False, ignored=False,
2493
null=False, kind=None, show_ids=False, path=None):
2495
if kind and kind not in ('file', 'directory', 'symlink'):
2496
raise errors.BzrCommandError('invalid kind specified')
2498
if verbose and null:
2499
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2500
all = not (unknown or versioned or ignored)
2502
selection = {'I':ignored, '?':unknown, 'V':versioned}
2508
raise errors.BzrCommandError('cannot specify both --from-root'
2511
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2514
# Calculate the prefix to use
2518
prefix = relpath + '/'
2519
elif fs_path != '.' and not fs_path.endswith('/'):
2520
prefix = fs_path + '/'
2522
if revision is not None or tree is None:
2523
tree = _get_one_revision_tree('ls', revision, branch=branch)
2526
if isinstance(tree, WorkingTree) and tree.supports_views():
2527
view_files = tree.views.lookup_view()
2530
view_str = views.view_display_str(view_files)
2531
note("Ignoring files outside view. View is %s" % view_str)
2534
self.add_cleanup(tree.unlock)
2535
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2536
from_dir=relpath, recursive=recursive):
2537
# Apply additional masking
2538
if not all and not selection[fc]:
2540
if kind is not None and fkind != kind:
2545
fullpath = osutils.pathjoin(relpath, fp)
2548
views.check_path_in_view(tree, fullpath)
2549
except errors.FileOutsideView:
2554
fp = osutils.pathjoin(prefix, fp)
2555
kindch = entry.kind_character()
2556
outstring = fp + kindch
2557
ui.ui_factory.clear_term()
2559
outstring = '%-8s %s' % (fc, outstring)
2560
if show_ids and fid is not None:
2561
outstring = "%-50s %s" % (outstring, fid)
2562
self.outf.write(outstring + '\n')
2564
self.outf.write(fp + '\0')
2567
self.outf.write(fid)
2568
self.outf.write('\0')
2576
self.outf.write('%-50s %s\n' % (outstring, my_id))
2578
self.outf.write(outstring + '\n')
2581
class cmd_unknowns(Command):
2582
"""List unknown files.
2590
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2591
self.outf.write(osutils.quotefn(f) + '\n')
2594
class cmd_ignore(Command):
2595
"""Ignore specified files or patterns.
2597
See ``bzr help patterns`` for details on the syntax of patterns.
2599
If a .bzrignore file does not exist, the ignore command
2600
will create one and add the specified files or patterns to the newly
2601
created file. The ignore command will also automatically add the
2602
.bzrignore file to be versioned. Creating a .bzrignore file without
2603
the use of the ignore command will require an explicit add command.
2605
To remove patterns from the ignore list, edit the .bzrignore file.
2606
After adding, editing or deleting that file either indirectly by
2607
using this command or directly by using an editor, be sure to commit
2610
Patterns prefixed with '!' are exceptions to ignore patterns and take
2611
precedence over regular ignores. Such exceptions are used to specify
2612
files that should be versioned which would otherwise be ignored.
2614
Patterns prefixed with '!!' act as regular ignore patterns, but have
2615
precedence over the '!' exception patterns.
2617
Note: ignore patterns containing shell wildcards must be quoted from
2621
Ignore the top level Makefile::
2623
bzr ignore ./Makefile
2625
Ignore .class files in all directories...::
2627
bzr ignore "*.class"
2629
...but do not ignore "special.class"::
2631
bzr ignore "!special.class"
2633
Ignore .o files under the lib directory::
2635
bzr ignore "lib/**/*.o"
2637
Ignore .o files under the lib directory::
2639
bzr ignore "RE:lib/.*\.o"
2641
Ignore everything but the "debian" toplevel directory::
2643
bzr ignore "RE:(?!debian/).*"
2645
Ignore everything except the "local" toplevel directory,
2646
but always ignore "*~" autosave files, even under local/::
2649
bzr ignore "!./local"
2653
_see_also = ['status', 'ignored', 'patterns']
2654
takes_args = ['name_pattern*']
2656
Option('old-default-rules',
2657
help='Write out the ignore rules bzr < 0.9 always used.')
2660
def run(self, name_pattern_list=None, old_default_rules=None):
2661
from bzrlib import ignores
2662
if old_default_rules is not None:
2663
# dump the rules and exit
2664
for pattern in ignores.OLD_DEFAULTS:
2667
if not name_pattern_list:
2668
raise errors.BzrCommandError("ignore requires at least one "
2669
"NAME_PATTERN or --old-default-rules")
2670
name_pattern_list = [globbing.normalize_pattern(p)
2671
for p in name_pattern_list]
2672
for name_pattern in name_pattern_list:
2673
if (name_pattern[0] == '/' or
2674
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2675
raise errors.BzrCommandError(
2676
"NAME_PATTERN should not be an absolute path")
2677
tree, relpath = WorkingTree.open_containing(u'.')
2678
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2679
ignored = globbing.Globster(name_pattern_list)
2682
for entry in tree.list_files():
2686
if ignored.match(filename):
2687
matches.append(filename.encode('utf-8'))
2689
if len(matches) > 0:
2690
print "Warning: the following files are version controlled and" \
2691
" match your ignore pattern:\n%s" \
2692
"\nThese files will continue to be version controlled" \
2693
" unless you 'bzr remove' them." % ("\n".join(matches),)
2696
class cmd_ignored(Command):
2697
"""List ignored files and the patterns that matched them.
2699
List all the ignored files and the ignore pattern that caused the file to
2702
Alternatively, to list just the files::
2707
encoding_type = 'replace'
2708
_see_also = ['ignore', 'ls']
2712
tree = WorkingTree.open_containing(u'.')[0]
2714
self.add_cleanup(tree.unlock)
2715
for path, file_class, kind, file_id, entry in tree.list_files():
2716
if file_class != 'I':
2718
## XXX: Slightly inefficient since this was already calculated
2719
pat = tree.is_ignored(path)
2720
self.outf.write('%-50s %s\n' % (path, pat))
2723
class cmd_lookup_revision(Command):
2724
"""Lookup the revision-id from a revision-number
2727
bzr lookup-revision 33
2730
takes_args = ['revno']
2733
def run(self, revno):
2737
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2739
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2742
class cmd_export(Command):
2743
"""Export current or past revision to a destination directory or archive.
2745
If no revision is specified this exports the last committed revision.
2747
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2748
given, try to find the format with the extension. If no extension
2749
is found exports to a directory (equivalent to --format=dir).
2751
If root is supplied, it will be used as the root directory inside
2752
container formats (tar, zip, etc). If it is not supplied it will default
2753
to the exported filename. The root option has no effect for 'dir' format.
2755
If branch is omitted then the branch containing the current working
2756
directory will be used.
2758
Note: Export of tree with non-ASCII filenames to zip is not supported.
2760
================= =========================
2761
Supported formats Autodetected by extension
2762
================= =========================
2765
tbz2 .tar.bz2, .tbz2
2768
================= =========================
2770
takes_args = ['dest', 'branch_or_subdir?']
2773
help="Type of file to export to.",
2776
Option('filters', help='Apply content filters to export the '
2777
'convenient form.'),
2780
help="Name of the root directory inside the exported file."),
2782
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2783
root=None, filters=False):
2784
from bzrlib.export import export
2786
if branch_or_subdir is None:
2787
tree = WorkingTree.open_containing(u'.')[0]
2791
b, subdir = Branch.open_containing(branch_or_subdir)
2794
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2796
export(rev_tree, dest, format, root, subdir, filtered=filters)
2797
except errors.NoSuchExportFormat, e:
2798
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2801
class cmd_cat(Command):
2802
"""Write the contents of a file as of a given revision to standard output.
2804
If no revision is nominated, the last revision is used.
2806
Note: Take care to redirect standard output when using this command on a
2812
Option('name-from-revision', help='The path name in the old tree.'),
2813
Option('filters', help='Apply content filters to display the '
2814
'convenience form.'),
2817
takes_args = ['filename']
2818
encoding_type = 'exact'
2821
def run(self, filename, revision=None, name_from_revision=False,
2823
if revision is not None and len(revision) != 1:
2824
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2825
" one revision specifier")
2826
tree, branch, relpath = \
2827
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2829
self.add_cleanup(branch.unlock)
2830
return self._run(tree, branch, relpath, filename, revision,
2831
name_from_revision, filters)
2833
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2836
tree = b.basis_tree()
2837
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2838
rev_tree.lock_read()
2839
self.add_cleanup(rev_tree.unlock)
2841
old_file_id = rev_tree.path2id(relpath)
2843
if name_from_revision:
2844
# Try in revision if requested
2845
if old_file_id is None:
2846
raise errors.BzrCommandError(
2847
"%r is not present in revision %s" % (
2848
filename, rev_tree.get_revision_id()))
2850
content = rev_tree.get_file_text(old_file_id)
2852
cur_file_id = tree.path2id(relpath)
2854
if cur_file_id is not None:
2855
# Then try with the actual file id
2857
content = rev_tree.get_file_text(cur_file_id)
2859
except errors.NoSuchId:
2860
# The actual file id didn't exist at that time
2862
if not found and old_file_id is not None:
2863
# Finally try with the old file id
2864
content = rev_tree.get_file_text(old_file_id)
2867
# Can't be found anywhere
2868
raise errors.BzrCommandError(
2869
"%r is not present in revision %s" % (
2870
filename, rev_tree.get_revision_id()))
2872
from bzrlib.filters import (
2873
ContentFilterContext,
2874
filtered_output_bytes,
2876
filters = rev_tree._content_filter_stack(relpath)
2877
chunks = content.splitlines(True)
2878
content = filtered_output_bytes(chunks, filters,
2879
ContentFilterContext(relpath, rev_tree))
2881
self.outf.writelines(content)
2884
self.outf.write(content)
2887
class cmd_local_time_offset(Command):
2888
"""Show the offset in seconds from GMT to local time."""
2892
print osutils.local_time_offset()
2896
class cmd_commit(Command):
2897
"""Commit changes into a new revision.
2899
An explanatory message needs to be given for each commit. This is
2900
often done by using the --message option (getting the message from the
2901
command line) or by using the --file option (getting the message from
2902
a file). If neither of these options is given, an editor is opened for
2903
the user to enter the message. To see the changed files in the
2904
boilerplate text loaded into the editor, use the --show-diff option.
2906
By default, the entire tree is committed and the person doing the
2907
commit is assumed to be the author. These defaults can be overridden
2912
If selected files are specified, only changes to those files are
2913
committed. If a directory is specified then the directory and
2914
everything within it is committed.
2916
When excludes are given, they take precedence over selected files.
2917
For example, to commit only changes within foo, but not changes
2920
bzr commit foo -x foo/bar
2922
A selective commit after a merge is not yet supported.
2926
If the author of the change is not the same person as the committer,
2927
you can specify the author's name using the --author option. The
2928
name should be in the same format as a committer-id, e.g.
2929
"John Doe <jdoe@example.com>". If there is more than one author of
2930
the change you can specify the option multiple times, once for each
2935
A common mistake is to forget to add a new file or directory before
2936
running the commit command. The --strict option checks for unknown
2937
files and aborts the commit if any are found. More advanced pre-commit
2938
checks can be implemented by defining hooks. See ``bzr help hooks``
2943
If you accidentially commit the wrong changes or make a spelling
2944
mistake in the commit message say, you can use the uncommit command
2945
to undo it. See ``bzr help uncommit`` for details.
2947
Hooks can also be configured to run after a commit. This allows you
2948
to trigger updates to external systems like bug trackers. The --fixes
2949
option can be used to record the association between a revision and
2950
one or more bugs. See ``bzr help bugs`` for details.
2952
A selective commit may fail in some cases where the committed
2953
tree would be invalid. Consider::
2958
bzr commit foo -m "committing foo"
2959
bzr mv foo/bar foo/baz
2962
bzr commit foo/bar -m "committing bar but not baz"
2964
In the example above, the last commit will fail by design. This gives
2965
the user the opportunity to decide whether they want to commit the
2966
rename at the same time, separately first, or not at all. (As a general
2967
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2969
# TODO: Run hooks on tree to-be-committed, and after commit.
2971
# TODO: Strict commit that fails if there are deleted files.
2972
# (what does "deleted files" mean ??)
2974
# TODO: Give better message for -s, --summary, used by tla people
2976
# XXX: verbose currently does nothing
2978
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2979
takes_args = ['selected*']
2981
ListOption('exclude', type=str, short_name='x',
2982
help="Do not consider changes made to a given path."),
2983
Option('message', type=unicode,
2985
help="Description of the new revision."),
2988
help='Commit even if nothing has changed.'),
2989
Option('file', type=str,
2992
help='Take commit message from this file.'),
2994
help="Refuse to commit if there are unknown "
2995
"files in the working tree."),
2996
Option('commit-time', type=str,
2997
help="Manually set a commit time using commit date "
2998
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2999
ListOption('fixes', type=str,
3000
help="Mark a bug as being fixed by this revision "
3001
"(see \"bzr help bugs\")."),
3002
ListOption('author', type=unicode,
3003
help="Set the author's name, if it's different "
3004
"from the committer."),
3006
help="Perform a local commit in a bound "
3007
"branch. Local commits are not pushed to "
3008
"the master branch until a normal commit "
3012
help='When no message is supplied, show the diff along'
3013
' with the status summary in the message editor.'),
3015
aliases = ['ci', 'checkin']
3017
def _iter_bug_fix_urls(self, fixes, branch):
3018
# Configure the properties for bug fixing attributes.
3019
for fixed_bug in fixes:
3020
tokens = fixed_bug.split(':')
3021
if len(tokens) != 2:
3022
raise errors.BzrCommandError(
3023
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3024
"See \"bzr help bugs\" for more information on this "
3025
"feature.\nCommit refused." % fixed_bug)
3026
tag, bug_id = tokens
3028
yield bugtracker.get_bug_url(tag, branch, bug_id)
3029
except errors.UnknownBugTrackerAbbreviation:
3030
raise errors.BzrCommandError(
3031
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3032
except errors.MalformedBugIdentifier, e:
3033
raise errors.BzrCommandError(
3034
"%s\nCommit refused." % (str(e),))
3036
def run(self, message=None, file=None, verbose=False, selected_list=None,
3037
unchanged=False, strict=False, local=False, fixes=None,
3038
author=None, show_diff=False, exclude=None, commit_time=None):
3039
from bzrlib.errors import (
3044
from bzrlib.msgeditor import (
3045
edit_commit_message_encoded,
3046
generate_commit_message_template,
3047
make_commit_message_template_encoded
3050
commit_stamp = offset = None
3051
if commit_time is not None:
3053
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3054
except ValueError, e:
3055
raise errors.BzrCommandError(
3056
"Could not parse --commit-time: " + str(e))
3058
# TODO: Need a blackbox test for invoking the external editor; may be
3059
# slightly problematic to run this cross-platform.
3061
# TODO: do more checks that the commit will succeed before
3062
# spending the user's valuable time typing a commit message.
3066
tree, selected_list = tree_files(selected_list)
3067
if selected_list == ['']:
3068
# workaround - commit of root of tree should be exactly the same
3069
# as just default commit in that tree, and succeed even though
3070
# selected-file merge commit is not done yet
3075
bug_property = bugtracker.encode_fixes_bug_urls(
3076
self._iter_bug_fix_urls(fixes, tree.branch))
3078
properties['bugs'] = bug_property
3080
if local and not tree.branch.get_bound_location():
3081
raise errors.LocalRequiresBoundBranch()
3083
if message is not None:
3085
file_exists = osutils.lexists(message)
3086
except UnicodeError:
3087
# The commit message contains unicode characters that can't be
3088
# represented in the filesystem encoding, so that can't be a
3093
'The commit message is a file name: "%(f)s".\n'
3094
'(use --file "%(f)s" to take commit message from that file)'
3096
ui.ui_factory.show_warning(warning_msg)
3098
def get_message(commit_obj):
3099
"""Callback to get commit message"""
3100
my_message = message
3101
if my_message is not None and '\r' in my_message:
3102
my_message = my_message.replace('\r\n', '\n')
3103
my_message = my_message.replace('\r', '\n')
3104
if my_message is None and not file:
3105
t = make_commit_message_template_encoded(tree,
3106
selected_list, diff=show_diff,
3107
output_encoding=osutils.get_user_encoding())
3108
start_message = generate_commit_message_template(commit_obj)
3109
my_message = edit_commit_message_encoded(t,
3110
start_message=start_message)
3111
if my_message is None:
3112
raise errors.BzrCommandError("please specify a commit"
3113
" message with either --message or --file")
3114
elif my_message and file:
3115
raise errors.BzrCommandError(
3116
"please specify either --message or --file")
3118
my_message = codecs.open(file, 'rt',
3119
osutils.get_user_encoding()).read()
3120
if my_message == "":
3121
raise errors.BzrCommandError("empty commit message specified")
3124
# The API permits a commit with a filter of [] to mean 'select nothing'
3125
# but the command line should not do that.
3126
if not selected_list:
3127
selected_list = None
3129
tree.commit(message_callback=get_message,
3130
specific_files=selected_list,
3131
allow_pointless=unchanged, strict=strict, local=local,
3132
reporter=None, verbose=verbose, revprops=properties,
3133
authors=author, timestamp=commit_stamp,
3135
exclude=safe_relpath_files(tree, exclude))
3136
except PointlessCommit:
3137
# FIXME: This should really happen before the file is read in;
3138
# perhaps prepare the commit; get the message; then actually commit
3139
raise errors.BzrCommandError("No changes to commit."
3140
" Use --unchanged to commit anyhow.")
3141
except ConflictsInTree:
3142
raise errors.BzrCommandError('Conflicts detected in working '
3143
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3145
except StrictCommitFailed:
3146
raise errors.BzrCommandError("Commit refused because there are"
3147
" unknown files in the working tree.")
3148
except errors.BoundBranchOutOfDate, e:
3149
raise errors.BzrCommandError(str(e) + "\n"
3150
'To commit to master branch, run update and then commit.\n'
3151
'You can also pass --local to commit to continue working '
3155
class cmd_check(Command):
3156
"""Validate working tree structure, branch consistency and repository history.
3158
This command checks various invariants about branch and repository storage
3159
to detect data corruption or bzr bugs.
3161
The working tree and branch checks will only give output if a problem is
3162
detected. The output fields of the repository check are:
3165
This is just the number of revisions checked. It doesn't
3169
This is just the number of versionedfiles checked. It
3170
doesn't indicate a problem.
3172
unreferenced ancestors
3173
Texts that are ancestors of other texts, but
3174
are not properly referenced by the revision ancestry. This is a
3175
subtle problem that Bazaar can work around.
3178
This is the total number of unique file contents
3179
seen in the checked revisions. It does not indicate a problem.
3182
This is the total number of repeated texts seen
3183
in the checked revisions. Texts can be repeated when their file
3184
entries are modified, but the file contents are not. It does not
3187
If no restrictions are specified, all Bazaar data that is found at the given
3188
location will be checked.
3192
Check the tree and branch at 'foo'::
3194
bzr check --tree --branch foo
3196
Check only the repository at 'bar'::
3198
bzr check --repo bar
3200
Check everything at 'baz'::
3205
_see_also = ['reconcile']
3206
takes_args = ['path?']
3207
takes_options = ['verbose',
3208
Option('branch', help="Check the branch related to the"
3209
" current directory."),
3210
Option('repo', help="Check the repository related to the"
3211
" current directory."),
3212
Option('tree', help="Check the working tree related to"
3213
" the current directory.")]
3215
def run(self, path=None, verbose=False, branch=False, repo=False,
3217
from bzrlib.check import check_dwim
3220
if not branch and not repo and not tree:
3221
branch = repo = tree = True
3222
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3225
class cmd_upgrade(Command):
3226
"""Upgrade branch storage to current format.
3228
The check command or bzr developers may sometimes advise you to run
3229
this command. When the default format has changed you may also be warned
3230
during other operations to upgrade.
3233
_see_also = ['check']
3234
takes_args = ['url?']
3236
RegistryOption('format',
3237
help='Upgrade to a specific format. See "bzr help'
3238
' formats" for details.',
3239
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3240
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3241
value_switches=True, title='Branch format'),
3244
def run(self, url='.', format=None):
3245
from bzrlib.upgrade import upgrade
3246
upgrade(url, format)
3249
class cmd_whoami(Command):
3250
"""Show or set bzr user id.
3253
Show the email of the current user::
3257
Set the current user::
3259
bzr whoami "Frank Chu <fchu@example.com>"
3261
takes_options = [ Option('email',
3262
help='Display email address only.'),
3264
help='Set identity for the current branch instead of '
3267
takes_args = ['name?']
3268
encoding_type = 'replace'
3271
def run(self, email=False, branch=False, name=None):
3273
# use branch if we're inside one; otherwise global config
3275
c = Branch.open_containing('.')[0].get_config()
3276
except errors.NotBranchError:
3277
c = config.GlobalConfig()
3279
self.outf.write(c.user_email() + '\n')
3281
self.outf.write(c.username() + '\n')
3284
# display a warning if an email address isn't included in the given name.
3286
config.extract_email_address(name)
3287
except errors.NoEmailInUsername, e:
3288
warning('"%s" does not seem to contain an email address. '
3289
'This is allowed, but not recommended.', name)
3291
# use global config unless --branch given
3293
c = Branch.open_containing('.')[0].get_config()
3295
c = config.GlobalConfig()
3296
c.set_user_option('email', name)
3299
class cmd_nick(Command):
3300
"""Print or set the branch nickname.
3302
If unset, the tree root directory name is used as the nickname.
3303
To print the current nickname, execute with no argument.
3305
Bound branches use the nickname of its master branch unless it is set
3309
_see_also = ['info']
3310
takes_args = ['nickname?']
3311
def run(self, nickname=None):
3312
branch = Branch.open_containing(u'.')[0]
3313
if nickname is None:
3314
self.printme(branch)
3316
branch.nick = nickname
3319
def printme(self, branch):
3323
class cmd_alias(Command):
3324
"""Set/unset and display aliases.
3327
Show the current aliases::
3331
Show the alias specified for 'll'::
3335
Set an alias for 'll'::
3337
bzr alias ll="log --line -r-10..-1"
3339
To remove an alias for 'll'::
3341
bzr alias --remove ll
3344
takes_args = ['name?']
3346
Option('remove', help='Remove the alias.'),
3349
def run(self, name=None, remove=False):
3351
self.remove_alias(name)
3353
self.print_aliases()
3355
equal_pos = name.find('=')
3357
self.print_alias(name)
3359
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3361
def remove_alias(self, alias_name):
3362
if alias_name is None:
3363
raise errors.BzrCommandError(
3364
'bzr alias --remove expects an alias to remove.')
3365
# If alias is not found, print something like:
3366
# unalias: foo: not found
3367
c = config.GlobalConfig()
3368
c.unset_alias(alias_name)
3371
def print_aliases(self):
3372
"""Print out the defined aliases in a similar format to bash."""
3373
aliases = config.GlobalConfig().get_aliases()
3374
for key, value in sorted(aliases.iteritems()):
3375
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3378
def print_alias(self, alias_name):
3379
from bzrlib.commands import get_alias
3380
alias = get_alias(alias_name)
3382
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3385
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3387
def set_alias(self, alias_name, alias_command):
3388
"""Save the alias in the global config."""
3389
c = config.GlobalConfig()
3390
c.set_alias(alias_name, alias_command)
3393
class cmd_selftest(Command):
3394
"""Run internal test suite.
3396
If arguments are given, they are regular expressions that say which tests
3397
should run. Tests matching any expression are run, and other tests are
3400
Alternatively if --first is given, matching tests are run first and then
3401
all other tests are run. This is useful if you have been working in a
3402
particular area, but want to make sure nothing else was broken.
3404
If --exclude is given, tests that match that regular expression are
3405
excluded, regardless of whether they match --first or not.
3407
To help catch accidential dependencies between tests, the --randomize
3408
option is useful. In most cases, the argument used is the word 'now'.
3409
Note that the seed used for the random number generator is displayed
3410
when this option is used. The seed can be explicitly passed as the
3411
argument to this option if required. This enables reproduction of the
3412
actual ordering used if and when an order sensitive problem is encountered.
3414
If --list-only is given, the tests that would be run are listed. This is
3415
useful when combined with --first, --exclude and/or --randomize to
3416
understand their impact. The test harness reports "Listed nn tests in ..."
3417
instead of "Ran nn tests in ..." when list mode is enabled.
3419
If the global option '--no-plugins' is given, plugins are not loaded
3420
before running the selftests. This has two effects: features provided or
3421
modified by plugins will not be tested, and tests provided by plugins will
3424
Tests that need working space on disk use a common temporary directory,
3425
typically inside $TMPDIR or /tmp.
3427
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3428
into a pdb postmortem session.
3431
Run only tests relating to 'ignore'::
3435
Disable plugins and list tests as they're run::
3437
bzr --no-plugins selftest -v
3439
# NB: this is used from the class without creating an instance, which is
3440
# why it does not have a self parameter.
3441
def get_transport_type(typestring):
3442
"""Parse and return a transport specifier."""
3443
if typestring == "sftp":
3444
from bzrlib.tests import stub_sftp
3445
return stub_sftp.SFTPAbsoluteServer
3446
if typestring == "memory":
3447
from bzrlib.transport.memory import MemoryServer
3449
if typestring == "fakenfs":
3450
from bzrlib.transport.fakenfs import FakeNFSServer
3451
return FakeNFSServer
3452
msg = "No known transport type %s. Supported types are: sftp\n" %\
3454
raise errors.BzrCommandError(msg)
3457
takes_args = ['testspecs*']
3458
takes_options = ['verbose',
3460
help='Stop when one test fails.',
3464
help='Use a different transport by default '
3465
'throughout the test suite.',
3466
type=get_transport_type),
3468
help='Run the benchmarks rather than selftests.'),
3469
Option('lsprof-timed',
3470
help='Generate lsprof output for benchmarked'
3471
' sections of code.'),
3472
Option('lsprof-tests',
3473
help='Generate lsprof output for each test.'),
3474
Option('cache-dir', type=str,
3475
help='Cache intermediate benchmark output in this '
3478
help='Run all tests, but run specified tests first.',
3482
help='List the tests instead of running them.'),
3483
RegistryOption('parallel',
3484
help="Run the test suite in parallel.",
3485
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3486
value_switches=False,
3488
Option('randomize', type=str, argname="SEED",
3489
help='Randomize the order of tests using the given'
3490
' seed or "now" for the current time.'),
3491
Option('exclude', type=str, argname="PATTERN",
3493
help='Exclude tests that match this regular'
3496
help='Output test progress via subunit.'),
3497
Option('strict', help='Fail on missing dependencies or '
3499
Option('load-list', type=str, argname='TESTLISTFILE',
3500
help='Load a test id list from a text file.'),
3501
ListOption('debugflag', type=str, short_name='E',
3502
help='Turn on a selftest debug flag.'),
3503
ListOption('starting-with', type=str, argname='TESTID',
3504
param_name='starting_with', short_name='s',
3506
'Load only the tests starting with TESTID.'),
3508
encoding_type = 'replace'
3511
Command.__init__(self)
3512
self.additional_selftest_args = {}
3514
def run(self, testspecs_list=None, verbose=False, one=False,
3515
transport=None, benchmark=None,
3516
lsprof_timed=None, cache_dir=None,
3517
first=False, list_only=False,
3518
randomize=None, exclude=None, strict=False,
3519
load_list=None, debugflag=None, starting_with=None, subunit=False,
3520
parallel=None, lsprof_tests=False):
3521
from bzrlib.tests import selftest
3522
import bzrlib.benchmarks as benchmarks
3523
from bzrlib.benchmarks import tree_creator
3525
# Make deprecation warnings visible, unless -Werror is set
3526
symbol_versioning.activate_deprecation_warnings(override=False)
3528
if cache_dir is not None:
3529
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3530
if testspecs_list is not None:
3531
pattern = '|'.join(testspecs_list)
3536
from bzrlib.tests import SubUnitBzrRunner
3538
raise errors.BzrCommandError("subunit not available. subunit "
3539
"needs to be installed to use --subunit.")
3540
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3542
self.additional_selftest_args.setdefault(
3543
'suite_decorators', []).append(parallel)
3545
test_suite_factory = benchmarks.test_suite
3546
# Unless user explicitly asks for quiet, be verbose in benchmarks
3547
verbose = not is_quiet()
3548
# TODO: should possibly lock the history file...
3549
benchfile = open(".perf_history", "at", buffering=1)
3550
self.add_cleanup(benchfile.close)
3552
test_suite_factory = None
3554
selftest_kwargs = {"verbose": verbose,
3556
"stop_on_failure": one,
3557
"transport": transport,
3558
"test_suite_factory": test_suite_factory,
3559
"lsprof_timed": lsprof_timed,
3560
"lsprof_tests": lsprof_tests,
3561
"bench_history": benchfile,
3562
"matching_tests_first": first,
3563
"list_only": list_only,
3564
"random_seed": randomize,
3565
"exclude_pattern": exclude,
3567
"load_list": load_list,
3568
"debug_flags": debugflag,
3569
"starting_with": starting_with
3571
selftest_kwargs.update(self.additional_selftest_args)
3572
result = selftest(**selftest_kwargs)
3573
return int(not result)
3576
class cmd_version(Command):
3577
"""Show version of bzr."""
3579
encoding_type = 'replace'
3581
Option("short", help="Print just the version number."),
3585
def run(self, short=False):
3586
from bzrlib.version import show_version
3588
self.outf.write(bzrlib.version_string + '\n')
3590
show_version(to_file=self.outf)
3593
class cmd_rocks(Command):
3594
"""Statement of optimism."""
3600
print "It sure does!"
3603
class cmd_find_merge_base(Command):
3604
"""Find and print a base revision for merging two branches."""
3605
# TODO: Options to specify revisions on either side, as if
3606
# merging only part of the history.
3607
takes_args = ['branch', 'other']
3611
def run(self, branch, other):
3612
from bzrlib.revision import ensure_null
3614
branch1 = Branch.open_containing(branch)[0]
3615
branch2 = Branch.open_containing(other)[0]
3617
self.add_cleanup(branch1.unlock)
3619
self.add_cleanup(branch2.unlock)
3620
last1 = ensure_null(branch1.last_revision())
3621
last2 = ensure_null(branch2.last_revision())
3623
graph = branch1.repository.get_graph(branch2.repository)
3624
base_rev_id = graph.find_unique_lca(last1, last2)
3626
print 'merge base is revision %s' % base_rev_id
3629
class cmd_merge(Command):
3630
"""Perform a three-way merge.
3632
The source of the merge can be specified either in the form of a branch,
3633
or in the form of a path to a file containing a merge directive generated
3634
with bzr send. If neither is specified, the default is the upstream branch
3635
or the branch most recently merged using --remember.
3637
When merging a branch, by default the tip will be merged. To pick a different
3638
revision, pass --revision. If you specify two values, the first will be used as
3639
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3640
available revisions, like this is commonly referred to as "cherrypicking".
3642
Revision numbers are always relative to the branch being merged.
3644
By default, bzr will try to merge in all new work from the other
3645
branch, automatically determining an appropriate base. If this
3646
fails, you may need to give an explicit base.
3648
Merge will do its best to combine the changes in two branches, but there
3649
are some kinds of problems only a human can fix. When it encounters those,
3650
it will mark a conflict. A conflict means that you need to fix something,
3651
before you should commit.
3653
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3655
If there is no default branch set, the first merge will set it. After
3656
that, you can omit the branch to use the default. To change the
3657
default, use --remember. The value will only be saved if the remote
3658
location can be accessed.
3660
The results of the merge are placed into the destination working
3661
directory, where they can be reviewed (with bzr diff), tested, and then
3662
committed to record the result of the merge.
3664
merge refuses to run if there are any uncommitted changes, unless
3665
--force is given. The --force option can also be used to create a
3666
merge revision which has more than two parents.
3668
If one would like to merge changes from the working tree of the other
3669
branch without merging any committed revisions, the --uncommitted option
3672
To select only some changes to merge, use "merge -i", which will prompt
3673
you to apply each diff hunk and file change, similar to "shelve".
3676
To merge the latest revision from bzr.dev::
3678
bzr merge ../bzr.dev
3680
To merge changes up to and including revision 82 from bzr.dev::
3682
bzr merge -r 82 ../bzr.dev
3684
To merge the changes introduced by 82, without previous changes::
3686
bzr merge -r 81..82 ../bzr.dev
3688
To apply a merge directive contained in /tmp/merge::
3690
bzr merge /tmp/merge
3692
To create a merge revision with three parents from two branches
3693
feature1a and feature1b:
3695
bzr merge ../feature1a
3696
bzr merge ../feature1b --force
3697
bzr commit -m 'revision with three parents'
3700
encoding_type = 'exact'
3701
_see_also = ['update', 'remerge', 'status-flags', 'send']
3702
takes_args = ['location?']
3707
help='Merge even if the destination tree has uncommitted changes.'),
3711
Option('show-base', help="Show base revision text in "
3713
Option('uncommitted', help='Apply uncommitted changes'
3714
' from a working copy, instead of branch changes.'),
3715
Option('pull', help='If the destination is already'
3716
' completely merged into the source, pull from the'
3717
' source rather than merging. When this happens,'
3718
' you do not need to commit the result.'),
3720
help='Branch to merge into, '
3721
'rather than the one containing the working directory.',
3725
Option('preview', help='Instead of merging, show a diff of the'
3727
Option('interactive', help='Select changes interactively.',
3731
def run(self, location=None, revision=None, force=False,
3732
merge_type=None, show_base=False, reprocess=None, remember=False,
3733
uncommitted=False, pull=False,
3738
if merge_type is None:
3739
merge_type = _mod_merge.Merge3Merger
3741
if directory is None: directory = u'.'
3742
possible_transports = []
3744
allow_pending = True
3745
verified = 'inapplicable'
3746
tree = WorkingTree.open_containing(directory)[0]
3749
basis_tree = tree.revision_tree(tree.last_revision())
3750
except errors.NoSuchRevision:
3751
basis_tree = tree.basis_tree()
3753
# die as quickly as possible if there are uncommitted changes
3755
if tree.has_changes():
3756
raise errors.UncommittedChanges(tree)
3758
view_info = _get_view_info_for_change_reporter(tree)
3759
change_reporter = delta._ChangeReporter(
3760
unversioned_filter=tree.is_ignored, view_info=view_info)
3761
pb = ui.ui_factory.nested_progress_bar()
3762
self.add_cleanup(pb.finished)
3764
self.add_cleanup(tree.unlock)
3765
if location is not None:
3767
mergeable = bundle.read_mergeable_from_url(location,
3768
possible_transports=possible_transports)
3769
except errors.NotABundle:
3773
raise errors.BzrCommandError('Cannot use --uncommitted'
3774
' with bundles or merge directives.')
3776
if revision is not None:
3777
raise errors.BzrCommandError(
3778
'Cannot use -r with merge directives or bundles')
3779
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3782
if merger is None and uncommitted:
3783
if revision is not None and len(revision) > 0:
3784
raise errors.BzrCommandError('Cannot use --uncommitted and'
3785
' --revision at the same time.')
3786
merger = self.get_merger_from_uncommitted(tree, location, None)
3787
allow_pending = False
3790
merger, allow_pending = self._get_merger_from_branch(tree,
3791
location, revision, remember, possible_transports, None)
3793
merger.merge_type = merge_type
3794
merger.reprocess = reprocess
3795
merger.show_base = show_base
3796
self.sanity_check_merger(merger)
3797
if (merger.base_rev_id == merger.other_rev_id and
3798
merger.other_rev_id is not None):
3799
note('Nothing to do.')
3802
if merger.interesting_files is not None:
3803
raise errors.BzrCommandError('Cannot pull individual files')
3804
if (merger.base_rev_id == tree.last_revision()):
3805
result = tree.pull(merger.other_branch, False,
3806
merger.other_rev_id)
3807
result.report(self.outf)
3809
if merger.this_basis is None:
3810
raise errors.BzrCommandError(
3811
"This branch has no commits."
3812
" (perhaps you would prefer 'bzr pull')")
3814
return self._do_preview(merger)
3816
return self._do_interactive(merger)
3818
return self._do_merge(merger, change_reporter, allow_pending,
3821
def _get_preview(self, merger):
3822
tree_merger = merger.make_merger()
3823
tt = tree_merger.make_preview_transform()
3824
self.add_cleanup(tt.finalize)
3825
result_tree = tt.get_preview_tree()
3828
def _do_preview(self, merger):
3829
from bzrlib.diff import show_diff_trees
3830
result_tree = self._get_preview(merger)
3831
show_diff_trees(merger.this_tree, result_tree, self.outf,
3832
old_label='', new_label='')
3834
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3835
merger.change_reporter = change_reporter
3836
conflict_count = merger.do_merge()
3838
merger.set_pending()
3839
if verified == 'failed':
3840
warning('Preview patch does not match changes')
3841
if conflict_count != 0:
3846
def _do_interactive(self, merger):
3847
"""Perform an interactive merge.
3849
This works by generating a preview tree of the merge, then using
3850
Shelver to selectively remove the differences between the working tree
3851
and the preview tree.
3853
from bzrlib import shelf_ui
3854
result_tree = self._get_preview(merger)
3855
writer = bzrlib.option.diff_writer_registry.get()
3856
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3857
reporter=shelf_ui.ApplyReporter(),
3858
diff_writer=writer(sys.stdout))
3864
def sanity_check_merger(self, merger):
3865
if (merger.show_base and
3866
not merger.merge_type is _mod_merge.Merge3Merger):
3867
raise errors.BzrCommandError("Show-base is not supported for this"
3868
" merge type. %s" % merger.merge_type)
3869
if merger.reprocess is None:
3870
if merger.show_base:
3871
merger.reprocess = False
3873
# Use reprocess if the merger supports it
3874
merger.reprocess = merger.merge_type.supports_reprocess
3875
if merger.reprocess and not merger.merge_type.supports_reprocess:
3876
raise errors.BzrCommandError("Conflict reduction is not supported"
3877
" for merge type %s." %
3879
if merger.reprocess and merger.show_base:
3880
raise errors.BzrCommandError("Cannot do conflict reduction and"
3883
def _get_merger_from_branch(self, tree, location, revision, remember,
3884
possible_transports, pb):
3885
"""Produce a merger from a location, assuming it refers to a branch."""
3886
from bzrlib.tag import _merge_tags_if_possible
3887
# find the branch locations
3888
other_loc, user_location = self._select_branch_location(tree, location,
3890
if revision is not None and len(revision) == 2:
3891
base_loc, _unused = self._select_branch_location(tree,
3892
location, revision, 0)
3894
base_loc = other_loc
3896
other_branch, other_path = Branch.open_containing(other_loc,
3897
possible_transports)
3898
if base_loc == other_loc:
3899
base_branch = other_branch
3901
base_branch, base_path = Branch.open_containing(base_loc,
3902
possible_transports)
3903
# Find the revision ids
3904
other_revision_id = None
3905
base_revision_id = None
3906
if revision is not None:
3907
if len(revision) >= 1:
3908
other_revision_id = revision[-1].as_revision_id(other_branch)
3909
if len(revision) == 2:
3910
base_revision_id = revision[0].as_revision_id(base_branch)
3911
if other_revision_id is None:
3912
other_revision_id = _mod_revision.ensure_null(
3913
other_branch.last_revision())
3914
# Remember where we merge from
3915
if ((remember or tree.branch.get_submit_branch() is None) and
3916
user_location is not None):
3917
tree.branch.set_submit_branch(other_branch.base)
3918
_merge_tags_if_possible(other_branch, tree.branch)
3919
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3920
other_revision_id, base_revision_id, other_branch, base_branch)
3921
if other_path != '':
3922
allow_pending = False
3923
merger.interesting_files = [other_path]
3925
allow_pending = True
3926
return merger, allow_pending
3928
def get_merger_from_uncommitted(self, tree, location, pb):
3929
"""Get a merger for uncommitted changes.
3931
:param tree: The tree the merger should apply to.
3932
:param location: The location containing uncommitted changes.
3933
:param pb: The progress bar to use for showing progress.
3935
location = self._select_branch_location(tree, location)[0]
3936
other_tree, other_path = WorkingTree.open_containing(location)
3937
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3938
if other_path != '':
3939
merger.interesting_files = [other_path]
3942
def _select_branch_location(self, tree, user_location, revision=None,
3944
"""Select a branch location, according to possible inputs.
3946
If provided, branches from ``revision`` are preferred. (Both
3947
``revision`` and ``index`` must be supplied.)
3949
Otherwise, the ``location`` parameter is used. If it is None, then the
3950
``submit`` or ``parent`` location is used, and a note is printed.
3952
:param tree: The working tree to select a branch for merging into
3953
:param location: The location entered by the user
3954
:param revision: The revision parameter to the command
3955
:param index: The index to use for the revision parameter. Negative
3956
indices are permitted.
3957
:return: (selected_location, user_location). The default location
3958
will be the user-entered location.
3960
if (revision is not None and index is not None
3961
and revision[index] is not None):
3962
branch = revision[index].get_branch()
3963
if branch is not None:
3964
return branch, branch
3965
if user_location is None:
3966
location = self._get_remembered(tree, 'Merging from')
3968
location = user_location
3969
return location, user_location
3971
def _get_remembered(self, tree, verb_string):
3972
"""Use tree.branch's parent if none was supplied.
3974
Report if the remembered location was used.
3976
stored_location = tree.branch.get_submit_branch()
3977
stored_location_type = "submit"
3978
if stored_location is None:
3979
stored_location = tree.branch.get_parent()
3980
stored_location_type = "parent"
3981
mutter("%s", stored_location)
3982
if stored_location is None:
3983
raise errors.BzrCommandError("No location specified or remembered")
3984
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3985
note(u"%s remembered %s location %s", verb_string,
3986
stored_location_type, display_url)
3987
return stored_location
3990
class cmd_remerge(Command):
3993
Use this if you want to try a different merge technique while resolving
3994
conflicts. Some merge techniques are better than others, and remerge
3995
lets you try different ones on different files.
3997
The options for remerge have the same meaning and defaults as the ones for
3998
merge. The difference is that remerge can (only) be run when there is a
3999
pending merge, and it lets you specify particular files.
4002
Re-do the merge of all conflicted files, and show the base text in
4003
conflict regions, in addition to the usual THIS and OTHER texts::
4005
bzr remerge --show-base
4007
Re-do the merge of "foobar", using the weave merge algorithm, with
4008
additional processing to reduce the size of conflict regions::
4010
bzr remerge --merge-type weave --reprocess foobar
4012
takes_args = ['file*']
4017
help="Show base revision text in conflicts."),
4020
def run(self, file_list=None, merge_type=None, show_base=False,
4022
if merge_type is None:
4023
merge_type = _mod_merge.Merge3Merger
4024
tree, file_list = tree_files(file_list)
4026
self.add_cleanup(tree.unlock)
4027
parents = tree.get_parent_ids()
4028
if len(parents) != 2:
4029
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4030
" merges. Not cherrypicking or"
4032
repository = tree.branch.repository
4033
interesting_ids = None
4035
conflicts = tree.conflicts()
4036
if file_list is not None:
4037
interesting_ids = set()
4038
for filename in file_list:
4039
file_id = tree.path2id(filename)
4041
raise errors.NotVersionedError(filename)
4042
interesting_ids.add(file_id)
4043
if tree.kind(file_id) != "directory":
4046
for name, ie in tree.inventory.iter_entries(file_id):
4047
interesting_ids.add(ie.file_id)
4048
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4050
# Remerge only supports resolving contents conflicts
4051
allowed_conflicts = ('text conflict', 'contents conflict')
4052
restore_files = [c.path for c in conflicts
4053
if c.typestring in allowed_conflicts]
4054
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4055
tree.set_conflicts(ConflictList(new_conflicts))
4056
if file_list is not None:
4057
restore_files = file_list
4058
for filename in restore_files:
4060
restore(tree.abspath(filename))
4061
except errors.NotConflicted:
4063
# Disable pending merges, because the file texts we are remerging
4064
# have not had those merges performed. If we use the wrong parents
4065
# list, we imply that the working tree text has seen and rejected
4066
# all the changes from the other tree, when in fact those changes
4067
# have not yet been seen.
4068
tree.set_parent_ids(parents[:1])
4070
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4071
merger.interesting_ids = interesting_ids
4072
merger.merge_type = merge_type
4073
merger.show_base = show_base
4074
merger.reprocess = reprocess
4075
conflicts = merger.do_merge()
4077
tree.set_parent_ids(parents)
4084
class cmd_revert(Command):
4085
"""Revert files to a previous revision.
4087
Giving a list of files will revert only those files. Otherwise, all files
4088
will be reverted. If the revision is not specified with '--revision', the
4089
last committed revision is used.
4091
To remove only some changes, without reverting to a prior version, use
4092
merge instead. For example, "merge . --revision -2..-3" will remove the
4093
changes introduced by -2, without affecting the changes introduced by -1.
4094
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4096
By default, any files that have been manually changed will be backed up
4097
first. (Files changed only by merge are not backed up.) Backup files have
4098
'.~#~' appended to their name, where # is a number.
4100
When you provide files, you can use their current pathname or the pathname
4101
from the target revision. So you can use revert to "undelete" a file by
4102
name. If you name a directory, all the contents of that directory will be
4105
If you have newly added files since the target revision, they will be
4106
removed. If the files to be removed have been changed, backups will be
4107
created as above. Directories containing unknown files will not be
4110
The working tree contains a list of revisions that have been merged but
4111
not yet committed. These revisions will be included as additional parents
4112
of the next commit. Normally, using revert clears that list as well as
4113
reverting the files. If any files are specified, revert leaves the list
4114
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4115
.`` in the tree root to revert all files but keep the recorded merges,
4116
and ``bzr revert --forget-merges`` to clear the pending merge list without
4117
reverting any files.
4119
Using "bzr revert --forget-merges", it is possible to apply all of the
4120
changes from a branch in a single revision. To do this, perform the merge
4121
as desired. Then doing revert with the "--forget-merges" option will keep
4122
the content of the tree as it was, but it will clear the list of pending
4123
merges. The next commit will then contain all of the changes that are
4124
present in the other branch, but without any other parent revisions.
4125
Because this technique forgets where these changes originated, it may
4126
cause additional conflicts on later merges involving the same source and
4130
_see_also = ['cat', 'export']
4133
Option('no-backup', "Do not save backups of reverted files."),
4134
Option('forget-merges',
4135
'Remove pending merge marker, without changing any files.'),
4137
takes_args = ['file*']
4139
def run(self, revision=None, no_backup=False, file_list=None,
4140
forget_merges=None):
4141
tree, file_list = tree_files(file_list)
4143
self.add_cleanup(tree.unlock)
4145
tree.set_parent_ids(tree.get_parent_ids()[:1])
4147
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4150
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4151
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4152
tree.revert(file_list, rev_tree, not no_backup, None,
4153
report_changes=True)
4156
class cmd_assert_fail(Command):
4157
"""Test reporting of assertion failures"""
4158
# intended just for use in testing
4163
raise AssertionError("always fails")
4166
class cmd_help(Command):
4167
"""Show help on a command or other topic.
4170
_see_also = ['topics']
4172
Option('long', 'Show help on all commands.'),
4174
takes_args = ['topic?']
4175
aliases = ['?', '--help', '-?', '-h']
4178
def run(self, topic=None, long=False):
4180
if topic is None and long:
4182
bzrlib.help.help(topic)
4185
class cmd_shell_complete(Command):
4186
"""Show appropriate completions for context.
4188
For a list of all available commands, say 'bzr shell-complete'.
4190
takes_args = ['context?']
4195
def run(self, context=None):
4196
import shellcomplete
4197
shellcomplete.shellcomplete(context)
4200
class cmd_missing(Command):
4201
"""Show unmerged/unpulled revisions between two branches.
4203
OTHER_BRANCH may be local or remote.
4205
To filter on a range of revisions, you can use the command -r begin..end
4206
-r revision requests a specific revision, -r ..end or -r begin.. are
4210
1 - some missing revisions
4211
0 - no missing revisions
4215
Determine the missing revisions between this and the branch at the
4216
remembered pull location::
4220
Determine the missing revisions between this and another branch::
4222
bzr missing http://server/branch
4224
Determine the missing revisions up to a specific revision on the other
4227
bzr missing -r ..-10
4229
Determine the missing revisions up to a specific revision on this
4232
bzr missing --my-revision ..-10
4235
_see_also = ['merge', 'pull']
4236
takes_args = ['other_branch?']
4238
Option('reverse', 'Reverse the order of revisions.'),
4240
'Display changes in the local branch only.'),
4241
Option('this' , 'Same as --mine-only.'),
4242
Option('theirs-only',
4243
'Display changes in the remote branch only.'),
4244
Option('other', 'Same as --theirs-only.'),
4248
custom_help('revision',
4249
help='Filter on other branch revisions (inclusive). '
4250
'See "help revisionspec" for details.'),
4251
Option('my-revision',
4252
type=_parse_revision_str,
4253
help='Filter on local branch revisions (inclusive). '
4254
'See "help revisionspec" for details.'),
4255
Option('include-merges',
4256
'Show all revisions in addition to the mainline ones.'),
4258
encoding_type = 'replace'
4261
def run(self, other_branch=None, reverse=False, mine_only=False,
4263
log_format=None, long=False, short=False, line=False,
4264
show_ids=False, verbose=False, this=False, other=False,
4265
include_merges=False, revision=None, my_revision=None):
4266
from bzrlib.missing import find_unmerged, iter_log_revisions
4275
# TODO: We should probably check that we don't have mine-only and
4276
# theirs-only set, but it gets complicated because we also have
4277
# this and other which could be used.
4284
local_branch = Branch.open_containing(u".")[0]
4285
parent = local_branch.get_parent()
4286
if other_branch is None:
4287
other_branch = parent
4288
if other_branch is None:
4289
raise errors.BzrCommandError("No peer location known"
4291
display_url = urlutils.unescape_for_display(parent,
4293
message("Using saved parent location: "
4294
+ display_url + "\n")
4296
remote_branch = Branch.open(other_branch)
4297
if remote_branch.base == local_branch.base:
4298
remote_branch = local_branch
4300
local_branch.lock_read()
4301
self.add_cleanup(local_branch.unlock)
4302
local_revid_range = _revision_range_to_revid_range(
4303
_get_revision_range(my_revision, local_branch,
4306
remote_branch.lock_read()
4307
self.add_cleanup(remote_branch.unlock)
4308
remote_revid_range = _revision_range_to_revid_range(
4309
_get_revision_range(revision,
4310
remote_branch, self.name()))
4312
local_extra, remote_extra = find_unmerged(
4313
local_branch, remote_branch, restrict,
4314
backward=not reverse,
4315
include_merges=include_merges,
4316
local_revid_range=local_revid_range,
4317
remote_revid_range=remote_revid_range)
4319
if log_format is None:
4320
registry = log.log_formatter_registry
4321
log_format = registry.get_default(local_branch)
4322
lf = log_format(to_file=self.outf,
4324
show_timezone='original')
4327
if local_extra and not theirs_only:
4328
message("You have %d extra revision(s):\n" %
4330
for revision in iter_log_revisions(local_extra,
4331
local_branch.repository,
4333
lf.log_revision(revision)
4334
printed_local = True
4337
printed_local = False
4339
if remote_extra and not mine_only:
4340
if printed_local is True:
4342
message("You are missing %d revision(s):\n" %
4344
for revision in iter_log_revisions(remote_extra,
4345
remote_branch.repository,
4347
lf.log_revision(revision)
4350
if mine_only and not local_extra:
4351
# We checked local, and found nothing extra
4352
message('This branch is up to date.\n')
4353
elif theirs_only and not remote_extra:
4354
# We checked remote, and found nothing extra
4355
message('Other branch is up to date.\n')
4356
elif not (mine_only or theirs_only or local_extra or
4358
# We checked both branches, and neither one had extra
4360
message("Branches are up to date.\n")
4362
if not status_code and parent is None and other_branch is not None:
4363
local_branch.lock_write()
4364
self.add_cleanup(local_branch.unlock)
4365
# handle race conditions - a parent might be set while we run.
4366
if local_branch.get_parent() is None:
4367
local_branch.set_parent(remote_branch.base)
4371
class cmd_pack(Command):
4372
"""Compress the data within a repository."""
4374
_see_also = ['repositories']
4375
takes_args = ['branch_or_repo?']
4377
def run(self, branch_or_repo='.'):
4378
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4380
branch = dir.open_branch()
4381
repository = branch.repository
4382
except errors.NotBranchError:
4383
repository = dir.open_repository()
4387
class cmd_plugins(Command):
4388
"""List the installed plugins.
4390
This command displays the list of installed plugins including
4391
version of plugin and a short description of each.
4393
--verbose shows the path where each plugin is located.
4395
A plugin is an external component for Bazaar that extends the
4396
revision control system, by adding or replacing code in Bazaar.
4397
Plugins can do a variety of things, including overriding commands,
4398
adding new commands, providing additional network transports and
4399
customizing log output.
4401
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4402
for further information on plugins including where to find them and how to
4403
install them. Instructions are also provided there on how to write new
4404
plugins using the Python programming language.
4406
takes_options = ['verbose']
4409
def run(self, verbose=False):
4410
import bzrlib.plugin
4411
from inspect import getdoc
4413
for name, plugin in bzrlib.plugin.plugins().items():
4414
version = plugin.__version__
4415
if version == 'unknown':
4417
name_ver = '%s %s' % (name, version)
4418
d = getdoc(plugin.module)
4420
doc = d.split('\n')[0]
4422
doc = '(no description)'
4423
result.append((name_ver, doc, plugin.path()))
4424
for name_ver, doc, path in sorted(result):
4432
class cmd_testament(Command):
4433
"""Show testament (signing-form) of a revision."""
4436
Option('long', help='Produce long-format testament.'),
4438
help='Produce a strict-format testament.')]
4439
takes_args = ['branch?']
4441
def run(self, branch=u'.', revision=None, long=False, strict=False):
4442
from bzrlib.testament import Testament, StrictTestament
4444
testament_class = StrictTestament
4446
testament_class = Testament
4448
b = Branch.open_containing(branch)[0]
4450
b = Branch.open(branch)
4452
self.add_cleanup(b.unlock)
4453
if revision is None:
4454
rev_id = b.last_revision()
4456
rev_id = revision[0].as_revision_id(b)
4457
t = testament_class.from_revision(b.repository, rev_id)
4459
sys.stdout.writelines(t.as_text_lines())
4461
sys.stdout.write(t.as_short_text())
4464
class cmd_annotate(Command):
4465
"""Show the origin of each line in a file.
4467
This prints out the given file with an annotation on the left side
4468
indicating which revision, author and date introduced the change.
4470
If the origin is the same for a run of consecutive lines, it is
4471
shown only at the top, unless the --all option is given.
4473
# TODO: annotate directories; showing when each file was last changed
4474
# TODO: if the working copy is modified, show annotations on that
4475
# with new uncommitted lines marked
4476
aliases = ['ann', 'blame', 'praise']
4477
takes_args = ['filename']
4478
takes_options = [Option('all', help='Show annotations on all lines.'),
4479
Option('long', help='Show commit date in annotations.'),
4483
encoding_type = 'exact'
4486
def run(self, filename, all=False, long=False, revision=None,
4488
from bzrlib.annotate import annotate_file, annotate_file_tree
4489
wt, branch, relpath = \
4490
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4493
self.add_cleanup(wt.unlock)
4496
self.add_cleanup(branch.unlock)
4497
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4499
self.add_cleanup(tree.unlock)
4501
file_id = wt.path2id(relpath)
4503
file_id = tree.path2id(relpath)
4505
raise errors.NotVersionedError(filename)
4506
file_version = tree.inventory[file_id].revision
4507
if wt is not None and revision is None:
4508
# If there is a tree and we're not annotating historical
4509
# versions, annotate the working tree's content.
4510
annotate_file_tree(wt, file_id, self.outf, long, all,
4513
annotate_file(branch, file_version, file_id, long, all, self.outf,
4517
class cmd_re_sign(Command):
4518
"""Create a digital signature for an existing revision."""
4519
# TODO be able to replace existing ones.
4521
hidden = True # is this right ?
4522
takes_args = ['revision_id*']
4523
takes_options = ['revision']
4525
def run(self, revision_id_list=None, revision=None):
4526
if revision_id_list is not None and revision is not None:
4527
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4528
if revision_id_list is None and revision is None:
4529
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4530
b = WorkingTree.open_containing(u'.')[0].branch
4532
self.add_cleanup(b.unlock)
4533
return self._run(b, revision_id_list, revision)
4535
def _run(self, b, revision_id_list, revision):
4536
import bzrlib.gpg as gpg
4537
gpg_strategy = gpg.GPGStrategy(b.get_config())
4538
if revision_id_list is not None:
4539
b.repository.start_write_group()
4541
for revision_id in revision_id_list:
4542
b.repository.sign_revision(revision_id, gpg_strategy)
4544
b.repository.abort_write_group()
4547
b.repository.commit_write_group()
4548
elif revision is not None:
4549
if len(revision) == 1:
4550
revno, rev_id = revision[0].in_history(b)
4551
b.repository.start_write_group()
4553
b.repository.sign_revision(rev_id, gpg_strategy)
4555
b.repository.abort_write_group()
4558
b.repository.commit_write_group()
4559
elif len(revision) == 2:
4560
# are they both on rh- if so we can walk between them
4561
# might be nice to have a range helper for arbitrary
4562
# revision paths. hmm.
4563
from_revno, from_revid = revision[0].in_history(b)
4564
to_revno, to_revid = revision[1].in_history(b)
4565
if to_revid is None:
4566
to_revno = b.revno()
4567
if from_revno is None or to_revno is None:
4568
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4569
b.repository.start_write_group()
4571
for revno in range(from_revno, to_revno + 1):
4572
b.repository.sign_revision(b.get_rev_id(revno),
4575
b.repository.abort_write_group()
4578
b.repository.commit_write_group()
4580
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4583
class cmd_bind(Command):
4584
"""Convert the current branch into a checkout of the supplied branch.
4586
Once converted into a checkout, commits must succeed on the master branch
4587
before they will be applied to the local branch.
4589
Bound branches use the nickname of its master branch unless it is set
4590
locally, in which case binding will update the local nickname to be
4594
_see_also = ['checkouts', 'unbind']
4595
takes_args = ['location?']
4598
def run(self, location=None):
4599
b, relpath = Branch.open_containing(u'.')
4600
if location is None:
4602
location = b.get_old_bound_location()
4603
except errors.UpgradeRequired:
4604
raise errors.BzrCommandError('No location supplied. '
4605
'This format does not remember old locations.')
4607
if location is None:
4608
if b.get_bound_location() is not None:
4609
raise errors.BzrCommandError('Branch is already bound')
4611
raise errors.BzrCommandError('No location supplied '
4612
'and no previous location known')
4613
b_other = Branch.open(location)
4616
except errors.DivergedBranches:
4617
raise errors.BzrCommandError('These branches have diverged.'
4618
' Try merging, and then bind again.')
4619
if b.get_config().has_explicit_nickname():
4620
b.nick = b_other.nick
4623
class cmd_unbind(Command):
4624
"""Convert the current checkout into a regular branch.
4626
After unbinding, the local branch is considered independent and subsequent
4627
commits will be local only.
4630
_see_also = ['checkouts', 'bind']
4635
b, relpath = Branch.open_containing(u'.')
4637
raise errors.BzrCommandError('Local branch is not bound')
4640
class cmd_uncommit(Command):
4641
"""Remove the last committed revision.
4643
--verbose will print out what is being removed.
4644
--dry-run will go through all the motions, but not actually
4647
If --revision is specified, uncommit revisions to leave the branch at the
4648
specified revision. For example, "bzr uncommit -r 15" will leave the
4649
branch at revision 15.
4651
Uncommit leaves the working tree ready for a new commit. The only change
4652
it may make is to restore any pending merges that were present before
4656
# TODO: jam 20060108 Add an option to allow uncommit to remove
4657
# unreferenced information in 'branch-as-repository' branches.
4658
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4659
# information in shared branches as well.
4660
_see_also = ['commit']
4661
takes_options = ['verbose', 'revision',
4662
Option('dry-run', help='Don\'t actually make changes.'),
4663
Option('force', help='Say yes to all questions.'),
4665
help="Only remove the commits from the local branch"
4666
" when in a checkout."
4669
takes_args = ['location?']
4671
encoding_type = 'replace'
4673
def run(self, location=None,
4674
dry_run=False, verbose=False,
4675
revision=None, force=False, local=False):
4676
if location is None:
4678
control, relpath = bzrdir.BzrDir.open_containing(location)
4680
tree = control.open_workingtree()
4682
except (errors.NoWorkingTree, errors.NotLocalUrl):
4684
b = control.open_branch()
4686
if tree is not None:
4688
self.add_cleanup(tree.unlock)
4691
self.add_cleanup(b.unlock)
4692
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4694
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4695
from bzrlib.log import log_formatter, show_log
4696
from bzrlib.uncommit import uncommit
4698
last_revno, last_rev_id = b.last_revision_info()
4701
if revision is None:
4703
rev_id = last_rev_id
4705
# 'bzr uncommit -r 10' actually means uncommit
4706
# so that the final tree is at revno 10.
4707
# but bzrlib.uncommit.uncommit() actually uncommits
4708
# the revisions that are supplied.
4709
# So we need to offset it by one
4710
revno = revision[0].in_history(b).revno + 1
4711
if revno <= last_revno:
4712
rev_id = b.get_rev_id(revno)
4714
if rev_id is None or _mod_revision.is_null(rev_id):
4715
ui.ui_factory.note('No revisions to uncommit.')
4718
log_collector = ui.ui_factory.make_output_stream()
4719
lf = log_formatter('short',
4720
to_file=log_collector,
4721
show_timezone='original')
4726
direction='forward',
4727
start_revision=revno,
4728
end_revision=last_revno)
4731
ui.ui_factory.note('Dry-run, pretending to remove the above revisions.')
4733
ui.ui_factory.note('The above revision(s) will be removed.')
4736
if not ui.ui_factory.get_boolean('Are you sure [y/N]? '):
4737
ui.ui_factory.note('Canceled')
4740
mutter('Uncommitting from {%s} to {%s}',
4741
last_rev_id, rev_id)
4742
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4743
revno=revno, local=local)
4744
ui.ui_factory.note('You can restore the old tip by running:\n'
4745
' bzr pull . -r revid:%s' % last_rev_id)
4748
class cmd_break_lock(Command):
4749
"""Break a dead lock on a repository, branch or working directory.
4751
CAUTION: Locks should only be broken when you are sure that the process
4752
holding the lock has been stopped.
4754
You can get information on what locks are open via the 'bzr info
4755
[location]' command.
4759
bzr break-lock bzr+ssh://example.com/bzr/foo
4761
takes_args = ['location?']
4763
def run(self, location=None, show=False):
4764
if location is None:
4766
control, relpath = bzrdir.BzrDir.open_containing(location)
4768
control.break_lock()
4769
except NotImplementedError:
4773
class cmd_wait_until_signalled(Command):
4774
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4776
This just prints a line to signal when it is ready, then blocks on stdin.
4782
sys.stdout.write("running\n")
4784
sys.stdin.readline()
4787
class cmd_serve(Command):
4788
"""Run the bzr server."""
4790
aliases = ['server']
4794
help='Serve on stdin/out for use from inetd or sshd.'),
4795
RegistryOption('protocol',
4796
help="Protocol to serve.",
4797
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4798
value_switches=True),
4800
help='Listen for connections on nominated port of the form '
4801
'[hostname:]portnumber. Passing 0 as the port number will '
4802
'result in a dynamically allocated port. The default port '
4803
'depends on the protocol.',
4806
help='Serve contents of this directory.',
4808
Option('allow-writes',
4809
help='By default the server is a readonly server. Supplying '
4810
'--allow-writes enables write access to the contents of '
4811
'the served directory and below. Note that ``bzr serve`` '
4812
'does not perform authentication, so unless some form of '
4813
'external authentication is arranged supplying this '
4814
'option leads to global uncontrolled write access to your '
4819
def get_host_and_port(self, port):
4820
"""Return the host and port to run the smart server on.
4822
If 'port' is None, None will be returned for the host and port.
4824
If 'port' has a colon in it, the string before the colon will be
4825
interpreted as the host.
4827
:param port: A string of the port to run the server on.
4828
:return: A tuple of (host, port), where 'host' is a host name or IP,
4829
and port is an integer TCP/IP port.
4832
if port is not None:
4834
host, port = port.split(':')
4838
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4840
from bzrlib.transport import get_transport, transport_server_registry
4841
if directory is None:
4842
directory = os.getcwd()
4843
if protocol is None:
4844
protocol = transport_server_registry.get()
4845
host, port = self.get_host_and_port(port)
4846
url = urlutils.local_path_to_url(directory)
4847
if not allow_writes:
4848
url = 'readonly+' + url
4849
transport = get_transport(url)
4850
protocol(transport, host, port, inet)
4853
class cmd_join(Command):
4854
"""Combine a tree into its containing tree.
4856
This command requires the target tree to be in a rich-root format.
4858
The TREE argument should be an independent tree, inside another tree, but
4859
not part of it. (Such trees can be produced by "bzr split", but also by
4860
running "bzr branch" with the target inside a tree.)
4862
The result is a combined tree, with the subtree no longer an independant
4863
part. This is marked as a merge of the subtree into the containing tree,
4864
and all history is preserved.
4867
_see_also = ['split']
4868
takes_args = ['tree']
4870
Option('reference', help='Join by reference.', hidden=True),
4873
def run(self, tree, reference=False):
4874
sub_tree = WorkingTree.open(tree)
4875
parent_dir = osutils.dirname(sub_tree.basedir)
4876
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4877
repo = containing_tree.branch.repository
4878
if not repo.supports_rich_root():
4879
raise errors.BzrCommandError(
4880
"Can't join trees because %s doesn't support rich root data.\n"
4881
"You can use bzr upgrade on the repository."
4885
containing_tree.add_reference(sub_tree)
4886
except errors.BadReferenceTarget, e:
4887
# XXX: Would be better to just raise a nicely printable
4888
# exception from the real origin. Also below. mbp 20070306
4889
raise errors.BzrCommandError("Cannot join %s. %s" %
4893
containing_tree.subsume(sub_tree)
4894
except errors.BadSubsumeSource, e:
4895
raise errors.BzrCommandError("Cannot join %s. %s" %
4899
class cmd_split(Command):
4900
"""Split a subdirectory of a tree into a separate tree.
4902
This command will produce a target tree in a format that supports
4903
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4904
converted into earlier formats like 'dirstate-tags'.
4906
The TREE argument should be a subdirectory of a working tree. That
4907
subdirectory will be converted into an independent tree, with its own
4908
branch. Commits in the top-level tree will not apply to the new subtree.
4911
_see_also = ['join']
4912
takes_args = ['tree']
4914
def run(self, tree):
4915
containing_tree, subdir = WorkingTree.open_containing(tree)
4916
sub_id = containing_tree.path2id(subdir)
4918
raise errors.NotVersionedError(subdir)
4920
containing_tree.extract(sub_id)
4921
except errors.RootNotRich:
4922
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4925
class cmd_merge_directive(Command):
4926
"""Generate a merge directive for auto-merge tools.
4928
A directive requests a merge to be performed, and also provides all the
4929
information necessary to do so. This means it must either include a
4930
revision bundle, or the location of a branch containing the desired
4933
A submit branch (the location to merge into) must be supplied the first
4934
time the command is issued. After it has been supplied once, it will
4935
be remembered as the default.
4937
A public branch is optional if a revision bundle is supplied, but required
4938
if --diff or --plain is specified. It will be remembered as the default
4939
after the first use.
4942
takes_args = ['submit_branch?', 'public_branch?']
4946
_see_also = ['send']
4949
RegistryOption.from_kwargs('patch-type',
4950
'The type of patch to include in the directive.',
4952
value_switches=True,
4954
bundle='Bazaar revision bundle (default).',
4955
diff='Normal unified diff.',
4956
plain='No patch, just directive.'),
4957
Option('sign', help='GPG-sign the directive.'), 'revision',
4958
Option('mail-to', type=str,
4959
help='Instead of printing the directive, email to this address.'),
4960
Option('message', type=str, short_name='m',
4961
help='Message to use when committing this merge.')
4964
encoding_type = 'exact'
4966
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4967
sign=False, revision=None, mail_to=None, message=None):
4968
from bzrlib.revision import ensure_null, NULL_REVISION
4969
include_patch, include_bundle = {
4970
'plain': (False, False),
4971
'diff': (True, False),
4972
'bundle': (True, True),
4974
branch = Branch.open('.')
4975
stored_submit_branch = branch.get_submit_branch()
4976
if submit_branch is None:
4977
submit_branch = stored_submit_branch
4979
if stored_submit_branch is None:
4980
branch.set_submit_branch(submit_branch)
4981
if submit_branch is None:
4982
submit_branch = branch.get_parent()
4983
if submit_branch is None:
4984
raise errors.BzrCommandError('No submit branch specified or known')
4986
stored_public_branch = branch.get_public_branch()
4987
if public_branch is None:
4988
public_branch = stored_public_branch
4989
elif stored_public_branch is None:
4990
branch.set_public_branch(public_branch)
4991
if not include_bundle and public_branch is None:
4992
raise errors.BzrCommandError('No public branch specified or'
4994
base_revision_id = None
4995
if revision is not None:
4996
if len(revision) > 2:
4997
raise errors.BzrCommandError('bzr merge-directive takes '
4998
'at most two one revision identifiers')
4999
revision_id = revision[-1].as_revision_id(branch)
5000
if len(revision) == 2:
5001
base_revision_id = revision[0].as_revision_id(branch)
5003
revision_id = branch.last_revision()
5004
revision_id = ensure_null(revision_id)
5005
if revision_id == NULL_REVISION:
5006
raise errors.BzrCommandError('No revisions to bundle.')
5007
directive = merge_directive.MergeDirective2.from_objects(
5008
branch.repository, revision_id, time.time(),
5009
osutils.local_time_offset(), submit_branch,
5010
public_branch=public_branch, include_patch=include_patch,
5011
include_bundle=include_bundle, message=message,
5012
base_revision_id=base_revision_id)
5015
self.outf.write(directive.to_signed(branch))
5017
self.outf.writelines(directive.to_lines())
5019
message = directive.to_email(mail_to, branch, sign)
5020
s = SMTPConnection(branch.get_config())
5021
s.send_email(message)
5024
class cmd_send(Command):
5025
"""Mail or create a merge-directive for submitting changes.
5027
A merge directive provides many things needed for requesting merges:
5029
* A machine-readable description of the merge to perform
5031
* An optional patch that is a preview of the changes requested
5033
* An optional bundle of revision data, so that the changes can be applied
5034
directly from the merge directive, without retrieving data from a
5037
`bzr send` creates a compact data set that, when applied using bzr
5038
merge, has the same effect as merging from the source branch.
5040
By default the merge directive is self-contained and can be applied to any
5041
branch containing submit_branch in its ancestory without needing access to
5044
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5045
revisions, but only a structured request to merge from the
5046
public_location. In that case the public_branch is needed and it must be
5047
up-to-date and accessible to the recipient. The public_branch is always
5048
included if known, so that people can check it later.
5050
The submit branch defaults to the parent of the source branch, but can be
5051
overridden. Both submit branch and public branch will be remembered in
5052
branch.conf the first time they are used for a particular branch. The
5053
source branch defaults to that containing the working directory, but can
5054
be changed using --from.
5056
In order to calculate those changes, bzr must analyse the submit branch.
5057
Therefore it is most efficient for the submit branch to be a local mirror.
5058
If a public location is known for the submit_branch, that location is used
5059
in the merge directive.
5061
The default behaviour is to send the merge directive by mail, unless -o is
5062
given, in which case it is sent to a file.
5064
Mail is sent using your preferred mail program. This should be transparent
5065
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5066
If the preferred client can't be found (or used), your editor will be used.
5068
To use a specific mail program, set the mail_client configuration option.
5069
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5070
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5071
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5072
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5075
If mail is being sent, a to address is required. This can be supplied
5076
either on the commandline, by setting the submit_to configuration
5077
option in the branch itself or the child_submit_to configuration option
5078
in the submit branch.
5080
Two formats are currently supported: "4" uses revision bundle format 4 and
5081
merge directive format 2. It is significantly faster and smaller than
5082
older formats. It is compatible with Bazaar 0.19 and later. It is the
5083
default. "0.9" uses revision bundle format 0.9 and merge directive
5084
format 1. It is compatible with Bazaar 0.12 - 0.18.
5086
The merge directives created by bzr send may be applied using bzr merge or
5087
bzr pull by specifying a file containing a merge directive as the location.
5089
bzr send makes extensive use of public locations to map local locations into
5090
URLs that can be used by other people. See `bzr help configuration` to
5091
set them, and use `bzr info` to display them.
5094
encoding_type = 'exact'
5096
_see_also = ['merge', 'pull']
5098
takes_args = ['submit_branch?', 'public_branch?']
5102
help='Do not include a bundle in the merge directive.'),
5103
Option('no-patch', help='Do not include a preview patch in the merge'
5106
help='Remember submit and public branch.'),
5108
help='Branch to generate the submission from, '
5109
'rather than the one containing the working directory.',
5112
Option('output', short_name='o',
5113
help='Write merge directive to this file; '
5114
'use - for stdout.',
5117
help='Refuse to send if there are uncommitted changes in'
5118
' the working tree, --no-strict disables the check.'),
5119
Option('mail-to', help='Mail the request to this address.',
5123
Option('body', help='Body for the email.', type=unicode),
5124
RegistryOption('format',
5125
help='Use the specified output format.',
5126
lazy_registry=('bzrlib.send', 'format_registry')),
5129
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5130
no_patch=False, revision=None, remember=False, output=None,
5131
format=None, mail_to=None, message=None, body=None,
5132
strict=None, **kwargs):
5133
from bzrlib.send import send
5134
return send(submit_branch, revision, public_branch, remember,
5135
format, no_bundle, no_patch, output,
5136
kwargs.get('from', '.'), mail_to, message, body,
5141
class cmd_bundle_revisions(cmd_send):
5142
"""Create a merge-directive for submitting changes.
5144
A merge directive provides many things needed for requesting merges:
5146
* A machine-readable description of the merge to perform
5148
* An optional patch that is a preview of the changes requested
5150
* An optional bundle of revision data, so that the changes can be applied
5151
directly from the merge directive, without retrieving data from a
5154
If --no-bundle is specified, then public_branch is needed (and must be
5155
up-to-date), so that the receiver can perform the merge using the
5156
public_branch. The public_branch is always included if known, so that
5157
people can check it later.
5159
The submit branch defaults to the parent, but can be overridden. Both
5160
submit branch and public branch will be remembered if supplied.
5162
If a public_branch is known for the submit_branch, that public submit
5163
branch is used in the merge instructions. This means that a local mirror
5164
can be used as your actual submit branch, once you have set public_branch
5167
Two formats are currently supported: "4" uses revision bundle format 4 and
5168
merge directive format 2. It is significantly faster and smaller than
5169
older formats. It is compatible with Bazaar 0.19 and later. It is the
5170
default. "0.9" uses revision bundle format 0.9 and merge directive
5171
format 1. It is compatible with Bazaar 0.12 - 0.18.
5176
help='Do not include a bundle in the merge directive.'),
5177
Option('no-patch', help='Do not include a preview patch in the merge'
5180
help='Remember submit and public branch.'),
5182
help='Branch to generate the submission from, '
5183
'rather than the one containing the working directory.',
5186
Option('output', short_name='o', help='Write directive to this file.',
5189
help='Refuse to bundle revisions if there are uncommitted'
5190
' changes in the working tree, --no-strict disables the check.'),
5192
RegistryOption('format',
5193
help='Use the specified output format.',
5194
lazy_registry=('bzrlib.send', 'format_registry')),
5196
aliases = ['bundle']
5198
_see_also = ['send', 'merge']
5202
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5203
no_patch=False, revision=None, remember=False, output=None,
5204
format=None, strict=None, **kwargs):
5207
from bzrlib.send import send
5208
return send(submit_branch, revision, public_branch, remember,
5209
format, no_bundle, no_patch, output,
5210
kwargs.get('from', '.'), None, None, None,
5211
self.outf, strict=strict)
5214
class cmd_tag(Command):
5215
"""Create, remove or modify a tag naming a revision.
5217
Tags give human-meaningful names to revisions. Commands that take a -r
5218
(--revision) option can be given -rtag:X, where X is any previously
5221
Tags are stored in the branch. Tags are copied from one branch to another
5222
along when you branch, push, pull or merge.
5224
It is an error to give a tag name that already exists unless you pass
5225
--force, in which case the tag is moved to point to the new revision.
5227
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5228
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5231
_see_also = ['commit', 'tags']
5232
takes_args = ['tag_name']
5235
help='Delete this tag rather than placing it.',
5238
help='Branch in which to place the tag.',
5243
help='Replace existing tags.',
5248
def run(self, tag_name,
5254
branch, relpath = Branch.open_containing(directory)
5256
self.add_cleanup(branch.unlock)
5258
branch.tags.delete_tag(tag_name)
5259
self.outf.write('Deleted tag %s.\n' % tag_name)
5262
if len(revision) != 1:
5263
raise errors.BzrCommandError(
5264
"Tags can only be placed on a single revision, "
5266
revision_id = revision[0].as_revision_id(branch)
5268
revision_id = branch.last_revision()
5269
if (not force) and branch.tags.has_tag(tag_name):
5270
raise errors.TagAlreadyExists(tag_name)
5271
branch.tags.set_tag(tag_name, revision_id)
5272
self.outf.write('Created tag %s.\n' % tag_name)
5275
class cmd_tags(Command):
5278
This command shows a table of tag names and the revisions they reference.
5284
help='Branch whose tags should be displayed.',
5288
RegistryOption.from_kwargs('sort',
5289
'Sort tags by different criteria.', title='Sorting',
5290
alpha='Sort tags lexicographically (default).',
5291
time='Sort tags chronologically.',
5304
branch, relpath = Branch.open_containing(directory)
5306
tags = branch.tags.get_tag_dict().items()
5311
self.add_cleanup(branch.unlock)
5313
graph = branch.repository.get_graph()
5314
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5315
revid1, revid2 = rev1.rev_id, rev2.rev_id
5316
# only show revisions between revid1 and revid2 (inclusive)
5317
tags = [(tag, revid) for tag, revid in tags if
5318
graph.is_between(revid, revid1, revid2)]
5321
elif sort == 'time':
5323
for tag, revid in tags:
5325
revobj = branch.repository.get_revision(revid)
5326
except errors.NoSuchRevision:
5327
timestamp = sys.maxint # place them at the end
5329
timestamp = revobj.timestamp
5330
timestamps[revid] = timestamp
5331
tags.sort(key=lambda x: timestamps[x[1]])
5333
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5334
for index, (tag, revid) in enumerate(tags):
5336
revno = branch.revision_id_to_dotted_revno(revid)
5337
if isinstance(revno, tuple):
5338
revno = '.'.join(map(str, revno))
5339
except errors.NoSuchRevision:
5340
# Bad tag data/merges can lead to tagged revisions
5341
# which are not in this branch. Fail gracefully ...
5343
tags[index] = (tag, revno)
5345
for tag, revspec in tags:
5346
self.outf.write('%-20s %s\n' % (tag, revspec))
5349
class cmd_reconfigure(Command):
5350
"""Reconfigure the type of a bzr directory.
5352
A target configuration must be specified.
5354
For checkouts, the bind-to location will be auto-detected if not specified.
5355
The order of preference is
5356
1. For a lightweight checkout, the current bound location.
5357
2. For branches that used to be checkouts, the previously-bound location.
5358
3. The push location.
5359
4. The parent location.
5360
If none of these is available, --bind-to must be specified.
5363
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5364
takes_args = ['location?']
5366
RegistryOption.from_kwargs(
5368
title='Target type',
5369
help='The type to reconfigure the directory to.',
5370
value_switches=True, enum_switch=False,
5371
branch='Reconfigure to be an unbound branch with no working tree.',
5372
tree='Reconfigure to be an unbound branch with a working tree.',
5373
checkout='Reconfigure to be a bound branch with a working tree.',
5374
lightweight_checkout='Reconfigure to be a lightweight'
5375
' checkout (with no local history).',
5376
standalone='Reconfigure to be a standalone branch '
5377
'(i.e. stop using shared repository).',
5378
use_shared='Reconfigure to use a shared repository.',
5379
with_trees='Reconfigure repository to create '
5380
'working trees on branches by default.',
5381
with_no_trees='Reconfigure repository to not create '
5382
'working trees on branches by default.'
5384
Option('bind-to', help='Branch to bind checkout to.', type=str),
5386
help='Perform reconfiguration even if local changes'
5388
Option('stacked-on',
5389
help='Reconfigure a branch to be stacked on another branch.',
5393
help='Reconfigure a branch to be unstacked. This '
5394
'may require copying substantial data into it.',
5398
def run(self, location=None, target_type=None, bind_to=None, force=False,
5401
directory = bzrdir.BzrDir.open(location)
5402
if stacked_on and unstacked:
5403
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5404
elif stacked_on is not None:
5405
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5407
reconfigure.ReconfigureUnstacked().apply(directory)
5408
# At the moment you can use --stacked-on and a different
5409
# reconfiguration shape at the same time; there seems no good reason
5411
if target_type is None:
5412
if stacked_on or unstacked:
5415
raise errors.BzrCommandError('No target configuration '
5417
elif target_type == 'branch':
5418
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5419
elif target_type == 'tree':
5420
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5421
elif target_type == 'checkout':
5422
reconfiguration = reconfigure.Reconfigure.to_checkout(
5424
elif target_type == 'lightweight-checkout':
5425
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5427
elif target_type == 'use-shared':
5428
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5429
elif target_type == 'standalone':
5430
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5431
elif target_type == 'with-trees':
5432
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5434
elif target_type == 'with-no-trees':
5435
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5437
reconfiguration.apply(force)
5440
class cmd_switch(Command):
5441
"""Set the branch of a checkout and update.
5443
For lightweight checkouts, this changes the branch being referenced.
5444
For heavyweight checkouts, this checks that there are no local commits
5445
versus the current bound branch, then it makes the local branch a mirror
5446
of the new location and binds to it.
5448
In both cases, the working tree is updated and uncommitted changes
5449
are merged. The user can commit or revert these as they desire.
5451
Pending merges need to be committed or reverted before using switch.
5453
The path to the branch to switch to can be specified relative to the parent
5454
directory of the current branch. For example, if you are currently in a
5455
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5458
Bound branches use the nickname of its master branch unless it is set
5459
locally, in which case switching will update the local nickname to be
5463
takes_args = ['to_location?']
5464
takes_options = [Option('force',
5465
help='Switch even if local commits will be lost.'),
5467
Option('create-branch', short_name='b',
5468
help='Create the target branch from this one before'
5469
' switching to it.'),
5472
def run(self, to_location=None, force=False, create_branch=False,
5474
from bzrlib import switch
5476
revision = _get_one_revision('switch', revision)
5477
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5478
if to_location is None:
5479
if revision is None:
5480
raise errors.BzrCommandError('You must supply either a'
5481
' revision or a location')
5484
branch = control_dir.open_branch()
5485
had_explicit_nick = branch.get_config().has_explicit_nickname()
5486
except errors.NotBranchError:
5488
had_explicit_nick = False
5491
raise errors.BzrCommandError('cannot create branch without'
5493
to_location = directory_service.directories.dereference(
5495
if '/' not in to_location and '\\' not in to_location:
5496
# This path is meant to be relative to the existing branch
5497
this_url = self._get_branch_location(control_dir)
5498
to_location = urlutils.join(this_url, '..', to_location)
5499
to_branch = branch.bzrdir.sprout(to_location,
5500
possible_transports=[branch.bzrdir.root_transport],
5501
source_branch=branch).open_branch()
5504
to_branch = Branch.open(to_location)
5505
except errors.NotBranchError:
5506
this_url = self._get_branch_location(control_dir)
5507
to_branch = Branch.open(
5508
urlutils.join(this_url, '..', to_location))
5509
if revision is not None:
5510
revision = revision.as_revision_id(to_branch)
5511
switch.switch(control_dir, to_branch, force, revision_id=revision)
5512
if had_explicit_nick:
5513
branch = control_dir.open_branch() #get the new branch!
5514
branch.nick = to_branch.nick
5515
note('Switched to branch: %s',
5516
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5518
def _get_branch_location(self, control_dir):
5519
"""Return location of branch for this control dir."""
5521
this_branch = control_dir.open_branch()
5522
# This may be a heavy checkout, where we want the master branch
5523
master_location = this_branch.get_bound_location()
5524
if master_location is not None:
5525
return master_location
5526
# If not, use a local sibling
5527
return this_branch.base
5528
except errors.NotBranchError:
5529
format = control_dir.find_branch_format()
5530
if getattr(format, 'get_reference', None) is not None:
5531
return format.get_reference(control_dir)
5533
return control_dir.root_transport.base
5536
class cmd_view(Command):
5537
"""Manage filtered views.
5539
Views provide a mask over the tree so that users can focus on
5540
a subset of a tree when doing their work. After creating a view,
5541
commands that support a list of files - status, diff, commit, etc -
5542
effectively have that list of files implicitly given each time.
5543
An explicit list of files can still be given but those files
5544
must be within the current view.
5546
In most cases, a view has a short life-span: it is created to make
5547
a selected change and is deleted once that change is committed.
5548
At other times, you may wish to create one or more named views
5549
and switch between them.
5551
To disable the current view without deleting it, you can switch to
5552
the pseudo view called ``off``. This can be useful when you need
5553
to see the whole tree for an operation or two (e.g. merge) but
5554
want to switch back to your view after that.
5557
To define the current view::
5559
bzr view file1 dir1 ...
5561
To list the current view::
5565
To delete the current view::
5569
To disable the current view without deleting it::
5571
bzr view --switch off
5573
To define a named view and switch to it::
5575
bzr view --name view-name file1 dir1 ...
5577
To list a named view::
5579
bzr view --name view-name
5581
To delete a named view::
5583
bzr view --name view-name --delete
5585
To switch to a named view::
5587
bzr view --switch view-name
5589
To list all views defined::
5593
To delete all views::
5595
bzr view --delete --all
5599
takes_args = ['file*']
5602
help='Apply list or delete action to all views.',
5605
help='Delete the view.',
5608
help='Name of the view to define, list or delete.',
5612
help='Name of the view to switch to.',
5617
def run(self, file_list,
5623
tree, file_list = tree_files(file_list, apply_view=False)
5624
current_view, view_dict = tree.views.get_view_info()
5629
raise errors.BzrCommandError(
5630
"Both --delete and a file list specified")
5632
raise errors.BzrCommandError(
5633
"Both --delete and --switch specified")
5635
tree.views.set_view_info(None, {})
5636
self.outf.write("Deleted all views.\n")
5638
raise errors.BzrCommandError("No current view to delete")
5640
tree.views.delete_view(name)
5641
self.outf.write("Deleted '%s' view.\n" % name)
5644
raise errors.BzrCommandError(
5645
"Both --switch and a file list specified")
5647
raise errors.BzrCommandError(
5648
"Both --switch and --all specified")
5649
elif switch == 'off':
5650
if current_view is None:
5651
raise errors.BzrCommandError("No current view to disable")
5652
tree.views.set_view_info(None, view_dict)
5653
self.outf.write("Disabled '%s' view.\n" % (current_view))
5655
tree.views.set_view_info(switch, view_dict)
5656
view_str = views.view_display_str(tree.views.lookup_view())
5657
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5660
self.outf.write('Views defined:\n')
5661
for view in sorted(view_dict):
5662
if view == current_view:
5666
view_str = views.view_display_str(view_dict[view])
5667
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5669
self.outf.write('No views defined.\n')
5672
# No name given and no current view set
5675
raise errors.BzrCommandError(
5676
"Cannot change the 'off' pseudo view")
5677
tree.views.set_view(name, sorted(file_list))
5678
view_str = views.view_display_str(tree.views.lookup_view())
5679
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5683
# No name given and no current view set
5684
self.outf.write('No current view.\n')
5686
view_str = views.view_display_str(tree.views.lookup_view(name))
5687
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5690
class cmd_hooks(Command):
5696
for hook_key in sorted(hooks.known_hooks.keys()):
5697
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5698
self.outf.write("%s:\n" % type(some_hooks).__name__)
5699
for hook_name, hook_point in sorted(some_hooks.items()):
5700
self.outf.write(" %s:\n" % (hook_name,))
5701
found_hooks = list(hook_point)
5703
for hook in found_hooks:
5704
self.outf.write(" %s\n" %
5705
(some_hooks.get_hook_name(hook),))
5707
self.outf.write(" <no hooks installed>\n")
5710
class cmd_shelve(Command):
5711
"""Temporarily set aside some changes from the current tree.
5713
Shelve allows you to temporarily put changes you've made "on the shelf",
5714
ie. out of the way, until a later time when you can bring them back from
5715
the shelf with the 'unshelve' command. The changes are stored alongside
5716
your working tree, and so they aren't propagated along with your branch nor
5717
will they survive its deletion.
5719
If shelve --list is specified, previously-shelved changes are listed.
5721
Shelve is intended to help separate several sets of changes that have
5722
been inappropriately mingled. If you just want to get rid of all changes
5723
and you don't need to restore them later, use revert. If you want to
5724
shelve all text changes at once, use shelve --all.
5726
If filenames are specified, only the changes to those files will be
5727
shelved. Other files will be left untouched.
5729
If a revision is specified, changes since that revision will be shelved.
5731
You can put multiple items on the shelf, and by default, 'unshelve' will
5732
restore the most recently shelved changes.
5735
takes_args = ['file*']
5739
Option('all', help='Shelve all changes.'),
5741
RegistryOption('writer', 'Method to use for writing diffs.',
5742
bzrlib.option.diff_writer_registry,
5743
value_switches=True, enum_switch=False),
5745
Option('list', help='List shelved changes.'),
5747
help='Destroy removed changes instead of shelving them.'),
5749
_see_also = ['unshelve']
5751
def run(self, revision=None, all=False, file_list=None, message=None,
5752
writer=None, list=False, destroy=False):
5754
return self.run_for_list()
5755
from bzrlib.shelf_ui import Shelver
5757
writer = bzrlib.option.diff_writer_registry.get()
5759
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5760
file_list, message, destroy=destroy)
5765
except errors.UserAbort:
5768
def run_for_list(self):
5769
tree = WorkingTree.open_containing('.')[0]
5771
self.add_cleanup(tree.unlock)
5772
manager = tree.get_shelf_manager()
5773
shelves = manager.active_shelves()
5774
if len(shelves) == 0:
5775
note('No shelved changes.')
5777
for shelf_id in reversed(shelves):
5778
message = manager.get_metadata(shelf_id).get('message')
5780
message = '<no message>'
5781
self.outf.write('%3d: %s\n' % (shelf_id, message))
5785
class cmd_unshelve(Command):
5786
"""Restore shelved changes.
5788
By default, the most recently shelved changes are restored. However if you
5789
specify a shelf by id those changes will be restored instead. This works
5790
best when the changes don't depend on each other.
5793
takes_args = ['shelf_id?']
5795
RegistryOption.from_kwargs(
5796
'action', help="The action to perform.",
5797
enum_switch=False, value_switches=True,
5798
apply="Apply changes and remove from the shelf.",
5799
dry_run="Show changes, but do not apply or remove them.",
5800
preview="Instead of unshelving the changes, show the diff that "
5801
"would result from unshelving.",
5802
delete_only="Delete changes without applying them.",
5803
keep="Apply changes but don't delete them.",
5806
_see_also = ['shelve']
5808
def run(self, shelf_id=None, action='apply'):
5809
from bzrlib.shelf_ui import Unshelver
5810
unshelver = Unshelver.from_args(shelf_id, action)
5814
unshelver.tree.unlock()
5817
class cmd_clean_tree(Command):
5818
"""Remove unwanted files from working tree.
5820
By default, only unknown files, not ignored files, are deleted. Versioned
5821
files are never deleted.
5823
Another class is 'detritus', which includes files emitted by bzr during
5824
normal operations and selftests. (The value of these files decreases with
5827
If no options are specified, unknown files are deleted. Otherwise, option
5828
flags are respected, and may be combined.
5830
To check what clean-tree will do, use --dry-run.
5832
takes_options = [Option('ignored', help='Delete all ignored files.'),
5833
Option('detritus', help='Delete conflict files, merge'
5834
' backups, and failed selftest dirs.'),
5836
help='Delete files unknown to bzr (default).'),
5837
Option('dry-run', help='Show files to delete instead of'
5839
Option('force', help='Do not prompt before deleting.')]
5840
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5842
from bzrlib.clean_tree import clean_tree
5843
if not (unknown or ignored or detritus):
5847
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5848
dry_run=dry_run, no_prompt=force)
5851
class cmd_reference(Command):
5852
"""list, view and set branch locations for nested trees.
5854
If no arguments are provided, lists the branch locations for nested trees.
5855
If one argument is provided, display the branch location for that tree.
5856
If two arguments are provided, set the branch location for that tree.
5861
takes_args = ['path?', 'location?']
5863
def run(self, path=None, location=None):
5865
if path is not None:
5867
tree, branch, relpath =(
5868
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5869
if path is not None:
5872
tree = branch.basis_tree()
5874
info = branch._get_all_reference_info().iteritems()
5875
self._display_reference_info(tree, branch, info)
5877
file_id = tree.path2id(path)
5879
raise errors.NotVersionedError(path)
5880
if location is None:
5881
info = [(file_id, branch.get_reference_info(file_id))]
5882
self._display_reference_info(tree, branch, info)
5884
branch.set_reference_info(file_id, path, location)
5886
def _display_reference_info(self, tree, branch, info):
5888
for file_id, (path, location) in info:
5890
path = tree.id2path(file_id)
5891
except errors.NoSuchId:
5893
ref_list.append((path, location))
5894
for path, location in sorted(ref_list):
5895
self.outf.write('%s %s\n' % (path, location))
5898
# these get imported and then picked up by the scan for cmd_*
5899
# TODO: Some more consistent way to split command definitions across files;
5900
# we do need to load at least some information about them to know of
5901
# aliases. ideally we would avoid loading the implementation until the
5902
# details were needed.
5903
from bzrlib.cmd_version_info import cmd_version_info
5904
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5905
from bzrlib.bundle.commands import (
5908
from bzrlib.foreign import cmd_dpush
5909
from bzrlib.sign_my_commits import cmd_sign_my_commits
5910
from bzrlib.weave_commands import cmd_versionedfile_list, \
5911
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
