1
# Copyright (C) 2004-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 the QBzr and Bzr-Gtk packages
2195
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2196
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2198
Web interfaces are often better at exploring history than command line
2199
tools, particularly for branches on servers. You may prefer Loggerhead
2200
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2202
You may find it useful to add the aliases below to ``bazaar.conf``::
2206
top = log -l10 --line
2209
``bzr tip`` will then show the latest revision while ``bzr top``
2210
will show the last 10 mainline revisions. To see the details of a
2211
particular revision X, ``bzr show -rX``.
2213
If you are interested in looking deeper into a particular merge X,
2214
use ``bzr log -n0 -rX``.
2216
``bzr log -v`` on a branch with lots of history is currently
2217
very slow. A fix for this issue is currently under development.
2218
With or without that fix, it is recommended that a revision range
2219
be given when using the -v option.
2221
bzr has a generic full-text matching plugin, bzr-search, that can be
2222
used to find revisions matching user names, commit messages, etc.
2223
Among other features, this plugin can find all revisions containing
2224
a list of words but not others.
2226
When exploring non-mainline history on large projects with deep
2227
history, the performance of log can be greatly improved by installing
2228
the historycache plugin. This plugin buffers historical information
2229
trading disk space for faster speed.
2231
takes_args = ['file*']
2232
_see_also = ['log-formats', 'revisionspec']
2235
help='Show from oldest to newest.'),
2237
custom_help('verbose',
2238
help='Show files changed in each revision.'),
2242
type=bzrlib.option._parse_revision_str,
2244
help='Show just the specified revision.'
2245
' See also "help revisionspec".'),
2249
help='Number of levels to display - 0 for all, 1 for flat.',
2251
type=_parse_levels),
2254
help='Show revisions whose message matches this '
2255
'regular expression.',
2259
help='Limit the output to the first N revisions.',
2264
help='Show changes made in each revision as a patch.'),
2265
Option('include-merges',
2266
help='Show merged revisions like --levels 0 does.'),
2268
encoding_type = 'replace'
2271
def run(self, file_list=None, timezone='original',
2282
include_merges=False):
2283
from bzrlib.log import (
2285
make_log_request_dict,
2286
_get_info_for_log_files,
2288
direction = (forward and 'forward') or 'reverse'
2293
raise errors.BzrCommandError(
2294
'--levels and --include-merges are mutually exclusive')
2296
if change is not None:
2298
raise errors.RangeInChangeOption()
2299
if revision is not None:
2300
raise errors.BzrCommandError(
2301
'--revision and --change are mutually exclusive')
2306
filter_by_dir = False
2308
# find the file ids to log and check for directory filtering
2309
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2310
revision, file_list)
2311
self.add_cleanup(b.unlock)
2312
for relpath, file_id, kind in file_info_list:
2314
raise errors.BzrCommandError(
2315
"Path unknown at end or start of revision range: %s" %
2317
# If the relpath is the top of the tree, we log everything
2322
file_ids.append(file_id)
2323
filter_by_dir = filter_by_dir or (
2324
kind in ['directory', 'tree-reference'])
2327
# FIXME ? log the current subdir only RBC 20060203
2328
if revision is not None \
2329
and len(revision) > 0 and revision[0].get_branch():
2330
location = revision[0].get_branch()
2333
dir, relpath = bzrdir.BzrDir.open_containing(location)
2334
b = dir.open_branch()
2336
self.add_cleanup(b.unlock)
2337
rev1, rev2 = _get_revision_range(revision, b, self.name())
2339
# Decide on the type of delta & diff filtering to use
2340
# TODO: add an --all-files option to make this configurable & consistent
2348
diff_type = 'partial'
2352
# Build the log formatter
2353
if log_format is None:
2354
log_format = log.log_formatter_registry.get_default(b)
2355
# Make a non-encoding output to include the diffs - bug 328007
2356
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2357
lf = log_format(show_ids=show_ids, to_file=self.outf,
2358
to_exact_file=unencoded_output,
2359
show_timezone=timezone,
2360
delta_format=get_verbosity_level(),
2362
show_advice=levels is None)
2364
# Choose the algorithm for doing the logging. It's annoying
2365
# having multiple code paths like this but necessary until
2366
# the underlying repository format is faster at generating
2367
# deltas or can provide everything we need from the indices.
2368
# The default algorithm - match-using-deltas - works for
2369
# multiple files and directories and is faster for small
2370
# amounts of history (200 revisions say). However, it's too
2371
# slow for logging a single file in a repository with deep
2372
# history, i.e. > 10K revisions. In the spirit of "do no
2373
# evil when adding features", we continue to use the
2374
# original algorithm - per-file-graph - for the "single
2375
# file that isn't a directory without showing a delta" case.
2376
partial_history = revision and b.repository._format.supports_chks
2377
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2378
or delta_type or partial_history)
2380
# Build the LogRequest and execute it
2381
if len(file_ids) == 0:
2383
rqst = make_log_request_dict(
2384
direction=direction, specific_fileids=file_ids,
2385
start_revision=rev1, end_revision=rev2, limit=limit,
2386
message_search=message, delta_type=delta_type,
2387
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2388
Logger(b, rqst).show(lf)
2391
def _get_revision_range(revisionspec_list, branch, command_name):
2392
"""Take the input of a revision option and turn it into a revision range.
2394
It returns RevisionInfo objects which can be used to obtain the rev_id's
2395
of the desired revisions. It does some user input validations.
2397
if revisionspec_list is None:
2400
elif len(revisionspec_list) == 1:
2401
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2402
elif len(revisionspec_list) == 2:
2403
start_spec = revisionspec_list[0]
2404
end_spec = revisionspec_list[1]
2405
if end_spec.get_branch() != start_spec.get_branch():
2406
# b is taken from revision[0].get_branch(), and
2407
# show_log will use its revision_history. Having
2408
# different branches will lead to weird behaviors.
2409
raise errors.BzrCommandError(
2410
"bzr %s doesn't accept two revisions in different"
2411
" branches." % command_name)
2412
rev1 = start_spec.in_history(branch)
2413
# Avoid loading all of history when we know a missing
2414
# end of range means the last revision ...
2415
if end_spec.spec is None:
2416
last_revno, last_revision_id = branch.last_revision_info()
2417
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2419
rev2 = end_spec.in_history(branch)
2421
raise errors.BzrCommandError(
2422
'bzr %s --revision takes one or two values.' % command_name)
2426
def _revision_range_to_revid_range(revision_range):
2429
if revision_range[0] is not None:
2430
rev_id1 = revision_range[0].rev_id
2431
if revision_range[1] is not None:
2432
rev_id2 = revision_range[1].rev_id
2433
return rev_id1, rev_id2
2435
def get_log_format(long=False, short=False, line=False, default='long'):
2436
log_format = default
2440
log_format = 'short'
2446
class cmd_touching_revisions(Command):
2447
"""Return revision-ids which affected a particular file.
2449
A more user-friendly interface is "bzr log FILE".
2453
takes_args = ["filename"]
2456
def run(self, filename):
2457
tree, relpath = WorkingTree.open_containing(filename)
2458
file_id = tree.path2id(relpath)
2461
self.add_cleanup(b.unlock)
2462
touching_revs = log.find_touching_revisions(b, file_id)
2463
for revno, revision_id, what in touching_revs:
2464
self.outf.write("%6d %s\n" % (revno, what))
2467
class cmd_ls(Command):
2468
"""List files in a tree.
2471
_see_also = ['status', 'cat']
2472
takes_args = ['path?']
2476
Option('recursive', short_name='R',
2477
help='Recurse into subdirectories.'),
2479
help='Print paths relative to the root of the branch.'),
2480
Option('unknown', help='Print unknown files.'),
2481
Option('versioned', help='Print versioned files.',
2483
Option('ignored', help='Print ignored files.'),
2485
help='Write an ascii NUL (\\0) separator '
2486
'between files rather than a newline.'),
2488
help='List entries of a particular kind: file, directory, symlink.',
2493
def run(self, revision=None, verbose=False,
2494
recursive=False, from_root=False,
2495
unknown=False, versioned=False, ignored=False,
2496
null=False, kind=None, show_ids=False, path=None):
2498
if kind and kind not in ('file', 'directory', 'symlink'):
2499
raise errors.BzrCommandError('invalid kind specified')
2501
if verbose and null:
2502
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2503
all = not (unknown or versioned or ignored)
2505
selection = {'I':ignored, '?':unknown, 'V':versioned}
2511
raise errors.BzrCommandError('cannot specify both --from-root'
2514
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2517
# Calculate the prefix to use
2521
prefix = relpath + '/'
2522
elif fs_path != '.' and not fs_path.endswith('/'):
2523
prefix = fs_path + '/'
2525
if revision is not None or tree is None:
2526
tree = _get_one_revision_tree('ls', revision, branch=branch)
2529
if isinstance(tree, WorkingTree) and tree.supports_views():
2530
view_files = tree.views.lookup_view()
2533
view_str = views.view_display_str(view_files)
2534
note("Ignoring files outside view. View is %s" % view_str)
2537
self.add_cleanup(tree.unlock)
2538
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2539
from_dir=relpath, recursive=recursive):
2540
# Apply additional masking
2541
if not all and not selection[fc]:
2543
if kind is not None and fkind != kind:
2548
fullpath = osutils.pathjoin(relpath, fp)
2551
views.check_path_in_view(tree, fullpath)
2552
except errors.FileOutsideView:
2557
fp = osutils.pathjoin(prefix, fp)
2558
kindch = entry.kind_character()
2559
outstring = fp + kindch
2560
ui.ui_factory.clear_term()
2562
outstring = '%-8s %s' % (fc, outstring)
2563
if show_ids and fid is not None:
2564
outstring = "%-50s %s" % (outstring, fid)
2565
self.outf.write(outstring + '\n')
2567
self.outf.write(fp + '\0')
2570
self.outf.write(fid)
2571
self.outf.write('\0')
2579
self.outf.write('%-50s %s\n' % (outstring, my_id))
2581
self.outf.write(outstring + '\n')
2584
class cmd_unknowns(Command):
2585
"""List unknown files.
2593
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2594
self.outf.write(osutils.quotefn(f) + '\n')
2597
class cmd_ignore(Command):
2598
"""Ignore specified files or patterns.
2600
See ``bzr help patterns`` for details on the syntax of patterns.
2602
If a .bzrignore file does not exist, the ignore command
2603
will create one and add the specified files or patterns to the newly
2604
created file. The ignore command will also automatically add the
2605
.bzrignore file to be versioned. Creating a .bzrignore file without
2606
the use of the ignore command will require an explicit add command.
2608
To remove patterns from the ignore list, edit the .bzrignore file.
2609
After adding, editing or deleting that file either indirectly by
2610
using this command or directly by using an editor, be sure to commit
2613
Patterns prefixed with '!' are exceptions to ignore patterns and take
2614
precedence over regular ignores. Such exceptions are used to specify
2615
files that should be versioned which would otherwise be ignored.
2617
Patterns prefixed with '!!' act as regular ignore patterns, but have
2618
precedence over the '!' exception patterns.
2620
Note: ignore patterns containing shell wildcards must be quoted from
2624
Ignore the top level Makefile::
2626
bzr ignore ./Makefile
2628
Ignore .class files in all directories...::
2630
bzr ignore "*.class"
2632
...but do not ignore "special.class"::
2634
bzr ignore "!special.class"
2636
Ignore .o files under the lib directory::
2638
bzr ignore "lib/**/*.o"
2640
Ignore .o files under the lib directory::
2642
bzr ignore "RE:lib/.*\.o"
2644
Ignore everything but the "debian" toplevel directory::
2646
bzr ignore "RE:(?!debian/).*"
2648
Ignore everything except the "local" toplevel directory,
2649
but always ignore "*~" autosave files, even under local/::
2652
bzr ignore "!./local"
2656
_see_also = ['status', 'ignored', 'patterns']
2657
takes_args = ['name_pattern*']
2659
Option('old-default-rules',
2660
help='Write out the ignore rules bzr < 0.9 always used.')
2663
def run(self, name_pattern_list=None, old_default_rules=None):
2664
from bzrlib import ignores
2665
if old_default_rules is not None:
2666
# dump the rules and exit
2667
for pattern in ignores.OLD_DEFAULTS:
2668
self.outf.write("%s\n" % pattern)
2670
if not name_pattern_list:
2671
raise errors.BzrCommandError("ignore requires at least one "
2672
"NAME_PATTERN or --old-default-rules")
2673
name_pattern_list = [globbing.normalize_pattern(p)
2674
for p in name_pattern_list]
2675
for name_pattern in name_pattern_list:
2676
if (name_pattern[0] == '/' or
2677
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2678
raise errors.BzrCommandError(
2679
"NAME_PATTERN should not be an absolute path")
2680
tree, relpath = WorkingTree.open_containing(u'.')
2681
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2682
ignored = globbing.Globster(name_pattern_list)
2685
for entry in tree.list_files():
2689
if ignored.match(filename):
2690
matches.append(filename)
2692
if len(matches) > 0:
2693
self.outf.write("Warning: the following files are version controlled and"
2694
" match your ignore pattern:\n%s"
2695
"\nThese files will continue to be version controlled"
2696
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2699
class cmd_ignored(Command):
2700
"""List ignored files and the patterns that matched them.
2702
List all the ignored files and the ignore pattern that caused the file to
2705
Alternatively, to list just the files::
2710
encoding_type = 'replace'
2711
_see_also = ['ignore', 'ls']
2715
tree = WorkingTree.open_containing(u'.')[0]
2717
self.add_cleanup(tree.unlock)
2718
for path, file_class, kind, file_id, entry in tree.list_files():
2719
if file_class != 'I':
2721
## XXX: Slightly inefficient since this was already calculated
2722
pat = tree.is_ignored(path)
2723
self.outf.write('%-50s %s\n' % (path, pat))
2726
class cmd_lookup_revision(Command):
2727
"""Lookup the revision-id from a revision-number
2730
bzr lookup-revision 33
2733
takes_args = ['revno']
2736
def run(self, revno):
2740
raise errors.BzrCommandError("not a valid revision-number: %r"
2742
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2743
self.outf.write("%s\n" % revid)
2746
class cmd_export(Command):
2747
"""Export current or past revision to a destination directory or archive.
2749
If no revision is specified this exports the last committed revision.
2751
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2752
given, try to find the format with the extension. If no extension
2753
is found exports to a directory (equivalent to --format=dir).
2755
If root is supplied, it will be used as the root directory inside
2756
container formats (tar, zip, etc). If it is not supplied it will default
2757
to the exported filename. The root option has no effect for 'dir' format.
2759
If branch is omitted then the branch containing the current working
2760
directory will be used.
2762
Note: Export of tree with non-ASCII filenames to zip is not supported.
2764
================= =========================
2765
Supported formats Autodetected by extension
2766
================= =========================
2769
tbz2 .tar.bz2, .tbz2
2772
================= =========================
2774
takes_args = ['dest', 'branch_or_subdir?']
2777
help="Type of file to export to.",
2780
Option('filters', help='Apply content filters to export the '
2781
'convenient form.'),
2784
help="Name of the root directory inside the exported file."),
2786
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2787
root=None, filters=False):
2788
from bzrlib.export import export
2790
if branch_or_subdir is None:
2791
tree = WorkingTree.open_containing(u'.')[0]
2795
b, subdir = Branch.open_containing(branch_or_subdir)
2798
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2800
export(rev_tree, dest, format, root, subdir, filtered=filters)
2801
except errors.NoSuchExportFormat, e:
2802
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2805
class cmd_cat(Command):
2806
"""Write the contents of a file as of a given revision to standard output.
2808
If no revision is nominated, the last revision is used.
2810
Note: Take care to redirect standard output when using this command on a
2816
Option('name-from-revision', help='The path name in the old tree.'),
2817
Option('filters', help='Apply content filters to display the '
2818
'convenience form.'),
2821
takes_args = ['filename']
2822
encoding_type = 'exact'
2825
def run(self, filename, revision=None, name_from_revision=False,
2827
if revision is not None and len(revision) != 1:
2828
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2829
" one revision specifier")
2830
tree, branch, relpath = \
2831
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2833
self.add_cleanup(branch.unlock)
2834
return self._run(tree, branch, relpath, filename, revision,
2835
name_from_revision, filters)
2837
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2840
tree = b.basis_tree()
2841
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2842
rev_tree.lock_read()
2843
self.add_cleanup(rev_tree.unlock)
2845
old_file_id = rev_tree.path2id(relpath)
2847
if name_from_revision:
2848
# Try in revision if requested
2849
if old_file_id is None:
2850
raise errors.BzrCommandError(
2851
"%r is not present in revision %s" % (
2852
filename, rev_tree.get_revision_id()))
2854
content = rev_tree.get_file_text(old_file_id)
2856
cur_file_id = tree.path2id(relpath)
2858
if cur_file_id is not None:
2859
# Then try with the actual file id
2861
content = rev_tree.get_file_text(cur_file_id)
2863
except errors.NoSuchId:
2864
# The actual file id didn't exist at that time
2866
if not found and old_file_id is not None:
2867
# Finally try with the old file id
2868
content = rev_tree.get_file_text(old_file_id)
2871
# Can't be found anywhere
2872
raise errors.BzrCommandError(
2873
"%r is not present in revision %s" % (
2874
filename, rev_tree.get_revision_id()))
2876
from bzrlib.filters import (
2877
ContentFilterContext,
2878
filtered_output_bytes,
2880
filters = rev_tree._content_filter_stack(relpath)
2881
chunks = content.splitlines(True)
2882
content = filtered_output_bytes(chunks, filters,
2883
ContentFilterContext(relpath, rev_tree))
2885
self.outf.writelines(content)
2888
self.outf.write(content)
2891
class cmd_local_time_offset(Command):
2892
"""Show the offset in seconds from GMT to local time."""
2896
self.outf.write("%s\n" % osutils.local_time_offset())
2900
class cmd_commit(Command):
2901
"""Commit changes into a new revision.
2903
An explanatory message needs to be given for each commit. This is
2904
often done by using the --message option (getting the message from the
2905
command line) or by using the --file option (getting the message from
2906
a file). If neither of these options is given, an editor is opened for
2907
the user to enter the message. To see the changed files in the
2908
boilerplate text loaded into the editor, use the --show-diff option.
2910
By default, the entire tree is committed and the person doing the
2911
commit is assumed to be the author. These defaults can be overridden
2916
If selected files are specified, only changes to those files are
2917
committed. If a directory is specified then the directory and
2918
everything within it is committed.
2920
When excludes are given, they take precedence over selected files.
2921
For example, to commit only changes within foo, but not changes
2924
bzr commit foo -x foo/bar
2926
A selective commit after a merge is not yet supported.
2930
If the author of the change is not the same person as the committer,
2931
you can specify the author's name using the --author option. The
2932
name should be in the same format as a committer-id, e.g.
2933
"John Doe <jdoe@example.com>". If there is more than one author of
2934
the change you can specify the option multiple times, once for each
2939
A common mistake is to forget to add a new file or directory before
2940
running the commit command. The --strict option checks for unknown
2941
files and aborts the commit if any are found. More advanced pre-commit
2942
checks can be implemented by defining hooks. See ``bzr help hooks``
2947
If you accidentially commit the wrong changes or make a spelling
2948
mistake in the commit message say, you can use the uncommit command
2949
to undo it. See ``bzr help uncommit`` for details.
2951
Hooks can also be configured to run after a commit. This allows you
2952
to trigger updates to external systems like bug trackers. The --fixes
2953
option can be used to record the association between a revision and
2954
one or more bugs. See ``bzr help bugs`` for details.
2956
A selective commit may fail in some cases where the committed
2957
tree would be invalid. Consider::
2962
bzr commit foo -m "committing foo"
2963
bzr mv foo/bar foo/baz
2966
bzr commit foo/bar -m "committing bar but not baz"
2968
In the example above, the last commit will fail by design. This gives
2969
the user the opportunity to decide whether they want to commit the
2970
rename at the same time, separately first, or not at all. (As a general
2971
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2973
# TODO: Run hooks on tree to-be-committed, and after commit.
2975
# TODO: Strict commit that fails if there are deleted files.
2976
# (what does "deleted files" mean ??)
2978
# TODO: Give better message for -s, --summary, used by tla people
2980
# XXX: verbose currently does nothing
2982
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2983
takes_args = ['selected*']
2985
ListOption('exclude', type=str, short_name='x',
2986
help="Do not consider changes made to a given path."),
2987
Option('message', type=unicode,
2989
help="Description of the new revision."),
2992
help='Commit even if nothing has changed.'),
2993
Option('file', type=str,
2996
help='Take commit message from this file.'),
2998
help="Refuse to commit if there are unknown "
2999
"files in the working tree."),
3000
Option('commit-time', type=str,
3001
help="Manually set a commit time using commit date "
3002
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3003
ListOption('fixes', type=str,
3004
help="Mark a bug as being fixed by this revision "
3005
"(see \"bzr help bugs\")."),
3006
ListOption('author', type=unicode,
3007
help="Set the author's name, if it's different "
3008
"from the committer."),
3010
help="Perform a local commit in a bound "
3011
"branch. Local commits are not pushed to "
3012
"the master branch until a normal commit "
3016
help='When no message is supplied, show the diff along'
3017
' with the status summary in the message editor.'),
3019
aliases = ['ci', 'checkin']
3021
def _iter_bug_fix_urls(self, fixes, branch):
3022
# Configure the properties for bug fixing attributes.
3023
for fixed_bug in fixes:
3024
tokens = fixed_bug.split(':')
3025
if len(tokens) != 2:
3026
raise errors.BzrCommandError(
3027
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3028
"See \"bzr help bugs\" for more information on this "
3029
"feature.\nCommit refused." % fixed_bug)
3030
tag, bug_id = tokens
3032
yield bugtracker.get_bug_url(tag, branch, bug_id)
3033
except errors.UnknownBugTrackerAbbreviation:
3034
raise errors.BzrCommandError(
3035
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3036
except errors.MalformedBugIdentifier, e:
3037
raise errors.BzrCommandError(
3038
"%s\nCommit refused." % (str(e),))
3040
def run(self, message=None, file=None, verbose=False, selected_list=None,
3041
unchanged=False, strict=False, local=False, fixes=None,
3042
author=None, show_diff=False, exclude=None, commit_time=None):
3043
from bzrlib.errors import (
3048
from bzrlib.msgeditor import (
3049
edit_commit_message_encoded,
3050
generate_commit_message_template,
3051
make_commit_message_template_encoded
3054
commit_stamp = offset = None
3055
if commit_time is not None:
3057
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3058
except ValueError, e:
3059
raise errors.BzrCommandError(
3060
"Could not parse --commit-time: " + str(e))
3062
# TODO: Need a blackbox test for invoking the external editor; may be
3063
# slightly problematic to run this cross-platform.
3065
# TODO: do more checks that the commit will succeed before
3066
# spending the user's valuable time typing a commit message.
3070
tree, selected_list = tree_files(selected_list)
3071
if selected_list == ['']:
3072
# workaround - commit of root of tree should be exactly the same
3073
# as just default commit in that tree, and succeed even though
3074
# selected-file merge commit is not done yet
3079
bug_property = bugtracker.encode_fixes_bug_urls(
3080
self._iter_bug_fix_urls(fixes, tree.branch))
3082
properties['bugs'] = bug_property
3084
if local and not tree.branch.get_bound_location():
3085
raise errors.LocalRequiresBoundBranch()
3087
if message is not None:
3089
file_exists = osutils.lexists(message)
3090
except UnicodeError:
3091
# The commit message contains unicode characters that can't be
3092
# represented in the filesystem encoding, so that can't be a
3097
'The commit message is a file name: "%(f)s".\n'
3098
'(use --file "%(f)s" to take commit message from that file)'
3100
ui.ui_factory.show_warning(warning_msg)
3102
def get_message(commit_obj):
3103
"""Callback to get commit message"""
3104
my_message = message
3105
if my_message is not None and '\r' in my_message:
3106
my_message = my_message.replace('\r\n', '\n')
3107
my_message = my_message.replace('\r', '\n')
3108
if my_message is None and not file:
3109
t = make_commit_message_template_encoded(tree,
3110
selected_list, diff=show_diff,
3111
output_encoding=osutils.get_user_encoding())
3112
start_message = generate_commit_message_template(commit_obj)
3113
my_message = edit_commit_message_encoded(t,
3114
start_message=start_message)
3115
if my_message is None:
3116
raise errors.BzrCommandError("please specify a commit"
3117
" message with either --message or --file")
3118
elif my_message and file:
3119
raise errors.BzrCommandError(
3120
"please specify either --message or --file")
3122
my_message = codecs.open(file, 'rt',
3123
osutils.get_user_encoding()).read()
3124
if my_message == "":
3125
raise errors.BzrCommandError("empty commit message specified")
3128
# The API permits a commit with a filter of [] to mean 'select nothing'
3129
# but the command line should not do that.
3130
if not selected_list:
3131
selected_list = None
3133
tree.commit(message_callback=get_message,
3134
specific_files=selected_list,
3135
allow_pointless=unchanged, strict=strict, local=local,
3136
reporter=None, verbose=verbose, revprops=properties,
3137
authors=author, timestamp=commit_stamp,
3139
exclude=safe_relpath_files(tree, exclude))
3140
except PointlessCommit:
3141
# FIXME: This should really happen before the file is read in;
3142
# perhaps prepare the commit; get the message; then actually commit
3143
raise errors.BzrCommandError("No changes to commit."
3144
" Use --unchanged to commit anyhow.")
3145
except ConflictsInTree:
3146
raise errors.BzrCommandError('Conflicts detected in working '
3147
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3149
except StrictCommitFailed:
3150
raise errors.BzrCommandError("Commit refused because there are"
3151
" unknown files in the working tree.")
3152
except errors.BoundBranchOutOfDate, e:
3153
raise errors.BzrCommandError(str(e) + "\n"
3154
'To commit to master branch, run update and then commit.\n'
3155
'You can also pass --local to commit to continue working '
3159
class cmd_check(Command):
3160
"""Validate working tree structure, branch consistency and repository history.
3162
This command checks various invariants about branch and repository storage
3163
to detect data corruption or bzr bugs.
3165
The working tree and branch checks will only give output if a problem is
3166
detected. The output fields of the repository check are:
3169
This is just the number of revisions checked. It doesn't
3173
This is just the number of versionedfiles checked. It
3174
doesn't indicate a problem.
3176
unreferenced ancestors
3177
Texts that are ancestors of other texts, but
3178
are not properly referenced by the revision ancestry. This is a
3179
subtle problem that Bazaar can work around.
3182
This is the total number of unique file contents
3183
seen in the checked revisions. It does not indicate a problem.
3186
This is the total number of repeated texts seen
3187
in the checked revisions. Texts can be repeated when their file
3188
entries are modified, but the file contents are not. It does not
3191
If no restrictions are specified, all Bazaar data that is found at the given
3192
location will be checked.
3196
Check the tree and branch at 'foo'::
3198
bzr check --tree --branch foo
3200
Check only the repository at 'bar'::
3202
bzr check --repo bar
3204
Check everything at 'baz'::
3209
_see_also = ['reconcile']
3210
takes_args = ['path?']
3211
takes_options = ['verbose',
3212
Option('branch', help="Check the branch related to the"
3213
" current directory."),
3214
Option('repo', help="Check the repository related to the"
3215
" current directory."),
3216
Option('tree', help="Check the working tree related to"
3217
" the current directory.")]
3219
def run(self, path=None, verbose=False, branch=False, repo=False,
3221
from bzrlib.check import check_dwim
3224
if not branch and not repo and not tree:
3225
branch = repo = tree = True
3226
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3229
class cmd_upgrade(Command):
3230
"""Upgrade branch storage to current format.
3232
The check command or bzr developers may sometimes advise you to run
3233
this command. When the default format has changed you may also be warned
3234
during other operations to upgrade.
3237
_see_also = ['check']
3238
takes_args = ['url?']
3240
RegistryOption('format',
3241
help='Upgrade to a specific format. See "bzr help'
3242
' formats" for details.',
3243
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3244
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3245
value_switches=True, title='Branch format'),
3248
def run(self, url='.', format=None):
3249
from bzrlib.upgrade import upgrade
3250
upgrade(url, format)
3253
class cmd_whoami(Command):
3254
"""Show or set bzr user id.
3257
Show the email of the current user::
3261
Set the current user::
3263
bzr whoami "Frank Chu <fchu@example.com>"
3265
takes_options = [ Option('email',
3266
help='Display email address only.'),
3268
help='Set identity for the current branch instead of '
3271
takes_args = ['name?']
3272
encoding_type = 'replace'
3275
def run(self, email=False, branch=False, name=None):
3277
# use branch if we're inside one; otherwise global config
3279
c = Branch.open_containing('.')[0].get_config()
3280
except errors.NotBranchError:
3281
c = config.GlobalConfig()
3283
self.outf.write(c.user_email() + '\n')
3285
self.outf.write(c.username() + '\n')
3288
# display a warning if an email address isn't included in the given name.
3290
config.extract_email_address(name)
3291
except errors.NoEmailInUsername, e:
3292
warning('"%s" does not seem to contain an email address. '
3293
'This is allowed, but not recommended.', name)
3295
# use global config unless --branch given
3297
c = Branch.open_containing('.')[0].get_config()
3299
c = config.GlobalConfig()
3300
c.set_user_option('email', name)
3303
class cmd_nick(Command):
3304
"""Print or set the branch nickname.
3306
If unset, the tree root directory name is used as the nickname.
3307
To print the current nickname, execute with no argument.
3309
Bound branches use the nickname of its master branch unless it is set
3313
_see_also = ['info']
3314
takes_args = ['nickname?']
3315
def run(self, nickname=None):
3316
branch = Branch.open_containing(u'.')[0]
3317
if nickname is None:
3318
self.printme(branch)
3320
branch.nick = nickname
3323
def printme(self, branch):
3324
self.outf.write('%s\n' % branch.nick)
3327
class cmd_alias(Command):
3328
"""Set/unset and display aliases.
3331
Show the current aliases::
3335
Show the alias specified for 'll'::
3339
Set an alias for 'll'::
3341
bzr alias ll="log --line -r-10..-1"
3343
To remove an alias for 'll'::
3345
bzr alias --remove ll
3348
takes_args = ['name?']
3350
Option('remove', help='Remove the alias.'),
3353
def run(self, name=None, remove=False):
3355
self.remove_alias(name)
3357
self.print_aliases()
3359
equal_pos = name.find('=')
3361
self.print_alias(name)
3363
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3365
def remove_alias(self, alias_name):
3366
if alias_name is None:
3367
raise errors.BzrCommandError(
3368
'bzr alias --remove expects an alias to remove.')
3369
# If alias is not found, print something like:
3370
# unalias: foo: not found
3371
c = config.GlobalConfig()
3372
c.unset_alias(alias_name)
3375
def print_aliases(self):
3376
"""Print out the defined aliases in a similar format to bash."""
3377
aliases = config.GlobalConfig().get_aliases()
3378
for key, value in sorted(aliases.iteritems()):
3379
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3382
def print_alias(self, alias_name):
3383
from bzrlib.commands import get_alias
3384
alias = get_alias(alias_name)
3386
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3389
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3391
def set_alias(self, alias_name, alias_command):
3392
"""Save the alias in the global config."""
3393
c = config.GlobalConfig()
3394
c.set_alias(alias_name, alias_command)
3397
class cmd_selftest(Command):
3398
"""Run internal test suite.
3400
If arguments are given, they are regular expressions that say which tests
3401
should run. Tests matching any expression are run, and other tests are
3404
Alternatively if --first is given, matching tests are run first and then
3405
all other tests are run. This is useful if you have been working in a
3406
particular area, but want to make sure nothing else was broken.
3408
If --exclude is given, tests that match that regular expression are
3409
excluded, regardless of whether they match --first or not.
3411
To help catch accidential dependencies between tests, the --randomize
3412
option is useful. In most cases, the argument used is the word 'now'.
3413
Note that the seed used for the random number generator is displayed
3414
when this option is used. The seed can be explicitly passed as the
3415
argument to this option if required. This enables reproduction of the
3416
actual ordering used if and when an order sensitive problem is encountered.
3418
If --list-only is given, the tests that would be run are listed. This is
3419
useful when combined with --first, --exclude and/or --randomize to
3420
understand their impact. The test harness reports "Listed nn tests in ..."
3421
instead of "Ran nn tests in ..." when list mode is enabled.
3423
If the global option '--no-plugins' is given, plugins are not loaded
3424
before running the selftests. This has two effects: features provided or
3425
modified by plugins will not be tested, and tests provided by plugins will
3428
Tests that need working space on disk use a common temporary directory,
3429
typically inside $TMPDIR or /tmp.
3431
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3432
into a pdb postmortem session.
3435
Run only tests relating to 'ignore'::
3439
Disable plugins and list tests as they're run::
3441
bzr --no-plugins selftest -v
3443
# NB: this is used from the class without creating an instance, which is
3444
# why it does not have a self parameter.
3445
def get_transport_type(typestring):
3446
"""Parse and return a transport specifier."""
3447
if typestring == "sftp":
3448
from bzrlib.transport.sftp import SFTPAbsoluteServer
3449
return SFTPAbsoluteServer
3450
if typestring == "memory":
3451
from bzrlib.transport.memory import MemoryServer
3453
if typestring == "fakenfs":
3454
from bzrlib.transport.fakenfs import FakeNFSServer
3455
return FakeNFSServer
3456
msg = "No known transport type %s. Supported types are: sftp\n" %\
3458
raise errors.BzrCommandError(msg)
3461
takes_args = ['testspecs*']
3462
takes_options = ['verbose',
3464
help='Stop when one test fails.',
3468
help='Use a different transport by default '
3469
'throughout the test suite.',
3470
type=get_transport_type),
3472
help='Run the benchmarks rather than selftests.'),
3473
Option('lsprof-timed',
3474
help='Generate lsprof output for benchmarked'
3475
' sections of code.'),
3476
Option('lsprof-tests',
3477
help='Generate lsprof output for each test.'),
3478
Option('cache-dir', type=str,
3479
help='Cache intermediate benchmark output in this '
3482
help='Run all tests, but run specified tests first.',
3486
help='List the tests instead of running them.'),
3487
RegistryOption('parallel',
3488
help="Run the test suite in parallel.",
3489
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3490
value_switches=False,
3492
Option('randomize', type=str, argname="SEED",
3493
help='Randomize the order of tests using the given'
3494
' seed or "now" for the current time.'),
3495
Option('exclude', type=str, argname="PATTERN",
3497
help='Exclude tests that match this regular'
3500
help='Output test progress via subunit.'),
3501
Option('strict', help='Fail on missing dependencies or '
3503
Option('load-list', type=str, argname='TESTLISTFILE',
3504
help='Load a test id list from a text file.'),
3505
ListOption('debugflag', type=str, short_name='E',
3506
help='Turn on a selftest debug flag.'),
3507
ListOption('starting-with', type=str, argname='TESTID',
3508
param_name='starting_with', short_name='s',
3510
'Load only the tests starting with TESTID.'),
3512
encoding_type = 'replace'
3515
Command.__init__(self)
3516
self.additional_selftest_args = {}
3518
def run(self, testspecs_list=None, verbose=False, one=False,
3519
transport=None, benchmark=None,
3520
lsprof_timed=None, cache_dir=None,
3521
first=False, list_only=False,
3522
randomize=None, exclude=None, strict=False,
3523
load_list=None, debugflag=None, starting_with=None, subunit=False,
3524
parallel=None, lsprof_tests=False):
3525
from bzrlib.tests import selftest
3526
import bzrlib.benchmarks as benchmarks
3527
from bzrlib.benchmarks import tree_creator
3529
# Make deprecation warnings visible, unless -Werror is set
3530
symbol_versioning.activate_deprecation_warnings(override=False)
3532
if cache_dir is not None:
3533
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3534
if testspecs_list is not None:
3535
pattern = '|'.join(testspecs_list)
3540
from bzrlib.tests import SubUnitBzrRunner
3542
raise errors.BzrCommandError("subunit not available. subunit "
3543
"needs to be installed to use --subunit.")
3544
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3546
self.additional_selftest_args.setdefault(
3547
'suite_decorators', []).append(parallel)
3549
test_suite_factory = benchmarks.test_suite
3550
# Unless user explicitly asks for quiet, be verbose in benchmarks
3551
verbose = not is_quiet()
3552
# TODO: should possibly lock the history file...
3553
benchfile = open(".perf_history", "at", buffering=1)
3554
self.add_cleanup(benchfile.close)
3556
test_suite_factory = None
3558
selftest_kwargs = {"verbose": verbose,
3560
"stop_on_failure": one,
3561
"transport": transport,
3562
"test_suite_factory": test_suite_factory,
3563
"lsprof_timed": lsprof_timed,
3564
"lsprof_tests": lsprof_tests,
3565
"bench_history": benchfile,
3566
"matching_tests_first": first,
3567
"list_only": list_only,
3568
"random_seed": randomize,
3569
"exclude_pattern": exclude,
3571
"load_list": load_list,
3572
"debug_flags": debugflag,
3573
"starting_with": starting_with
3575
selftest_kwargs.update(self.additional_selftest_args)
3576
result = selftest(**selftest_kwargs)
3577
return int(not result)
3580
class cmd_version(Command):
3581
"""Show version of bzr."""
3583
encoding_type = 'replace'
3585
Option("short", help="Print just the version number."),
3589
def run(self, short=False):
3590
from bzrlib.version import show_version
3592
self.outf.write(bzrlib.version_string + '\n')
3594
show_version(to_file=self.outf)
3597
class cmd_rocks(Command):
3598
"""Statement of optimism."""
3604
self.outf.write("It sure does!\n")
3607
class cmd_find_merge_base(Command):
3608
"""Find and print a base revision for merging two branches."""
3609
# TODO: Options to specify revisions on either side, as if
3610
# merging only part of the history.
3611
takes_args = ['branch', 'other']
3615
def run(self, branch, other):
3616
from bzrlib.revision import ensure_null
3618
branch1 = Branch.open_containing(branch)[0]
3619
branch2 = Branch.open_containing(other)[0]
3621
self.add_cleanup(branch1.unlock)
3623
self.add_cleanup(branch2.unlock)
3624
last1 = ensure_null(branch1.last_revision())
3625
last2 = ensure_null(branch2.last_revision())
3627
graph = branch1.repository.get_graph(branch2.repository)
3628
base_rev_id = graph.find_unique_lca(last1, last2)
3630
self.outf.write('merge base is revision %s\n' % base_rev_id)
3633
class cmd_merge(Command):
3634
"""Perform a three-way merge.
3636
The source of the merge can be specified either in the form of a branch,
3637
or in the form of a path to a file containing a merge directive generated
3638
with bzr send. If neither is specified, the default is the upstream branch
3639
or the branch most recently merged using --remember.
3641
When merging a branch, by default the tip will be merged. To pick a different
3642
revision, pass --revision. If you specify two values, the first will be used as
3643
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3644
available revisions, like this is commonly referred to as "cherrypicking".
3646
Revision numbers are always relative to the branch being merged.
3648
By default, bzr will try to merge in all new work from the other
3649
branch, automatically determining an appropriate base. If this
3650
fails, you may need to give an explicit base.
3652
Merge will do its best to combine the changes in two branches, but there
3653
are some kinds of problems only a human can fix. When it encounters those,
3654
it will mark a conflict. A conflict means that you need to fix something,
3655
before you should commit.
3657
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3659
If there is no default branch set, the first merge will set it. After
3660
that, you can omit the branch to use the default. To change the
3661
default, use --remember. The value will only be saved if the remote
3662
location can be accessed.
3664
The results of the merge are placed into the destination working
3665
directory, where they can be reviewed (with bzr diff), tested, and then
3666
committed to record the result of the merge.
3668
merge refuses to run if there are any uncommitted changes, unless
3669
--force is given. The --force option can also be used to create a
3670
merge revision which has more than two parents.
3672
If one would like to merge changes from the working tree of the other
3673
branch without merging any committed revisions, the --uncommitted option
3676
To select only some changes to merge, use "merge -i", which will prompt
3677
you to apply each diff hunk and file change, similar to "shelve".
3680
To merge the latest revision from bzr.dev::
3682
bzr merge ../bzr.dev
3684
To merge changes up to and including revision 82 from bzr.dev::
3686
bzr merge -r 82 ../bzr.dev
3688
To merge the changes introduced by 82, without previous changes::
3690
bzr merge -r 81..82 ../bzr.dev
3692
To apply a merge directive contained in /tmp/merge::
3694
bzr merge /tmp/merge
3696
To create a merge revision with three parents from two branches
3697
feature1a and feature1b:
3699
bzr merge ../feature1a
3700
bzr merge ../feature1b --force
3701
bzr commit -m 'revision with three parents'
3704
encoding_type = 'exact'
3705
_see_also = ['update', 'remerge', 'status-flags', 'send']
3706
takes_args = ['location?']
3711
help='Merge even if the destination tree has uncommitted changes.'),
3715
Option('show-base', help="Show base revision text in "
3717
Option('uncommitted', help='Apply uncommitted changes'
3718
' from a working copy, instead of branch changes.'),
3719
Option('pull', help='If the destination is already'
3720
' completely merged into the source, pull from the'
3721
' source rather than merging. When this happens,'
3722
' you do not need to commit the result.'),
3724
help='Branch to merge into, '
3725
'rather than the one containing the working directory.',
3729
Option('preview', help='Instead of merging, show a diff of the'
3731
Option('interactive', help='Select changes interactively.',
3735
def run(self, location=None, revision=None, force=False,
3736
merge_type=None, show_base=False, reprocess=None, remember=False,
3737
uncommitted=False, pull=False,
3742
if merge_type is None:
3743
merge_type = _mod_merge.Merge3Merger
3745
if directory is None: directory = u'.'
3746
possible_transports = []
3748
allow_pending = True
3749
verified = 'inapplicable'
3750
tree = WorkingTree.open_containing(directory)[0]
3753
basis_tree = tree.revision_tree(tree.last_revision())
3754
except errors.NoSuchRevision:
3755
basis_tree = tree.basis_tree()
3757
# die as quickly as possible if there are uncommitted changes
3759
if tree.has_changes():
3760
raise errors.UncommittedChanges(tree)
3762
view_info = _get_view_info_for_change_reporter(tree)
3763
change_reporter = delta._ChangeReporter(
3764
unversioned_filter=tree.is_ignored, view_info=view_info)
3765
pb = ui.ui_factory.nested_progress_bar()
3766
self.add_cleanup(pb.finished)
3768
self.add_cleanup(tree.unlock)
3769
if location is not None:
3771
mergeable = bundle.read_mergeable_from_url(location,
3772
possible_transports=possible_transports)
3773
except errors.NotABundle:
3777
raise errors.BzrCommandError('Cannot use --uncommitted'
3778
' with bundles or merge directives.')
3780
if revision is not None:
3781
raise errors.BzrCommandError(
3782
'Cannot use -r with merge directives or bundles')
3783
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3786
if merger is None and uncommitted:
3787
if revision is not None and len(revision) > 0:
3788
raise errors.BzrCommandError('Cannot use --uncommitted and'
3789
' --revision at the same time.')
3790
merger = self.get_merger_from_uncommitted(tree, location, pb)
3791
allow_pending = False
3794
merger, allow_pending = self._get_merger_from_branch(tree,
3795
location, revision, remember, possible_transports, pb)
3797
merger.merge_type = merge_type
3798
merger.reprocess = reprocess
3799
merger.show_base = show_base
3800
self.sanity_check_merger(merger)
3801
if (merger.base_rev_id == merger.other_rev_id and
3802
merger.other_rev_id is not None):
3803
note('Nothing to do.')
3806
if merger.interesting_files is not None:
3807
raise errors.BzrCommandError('Cannot pull individual files')
3808
if (merger.base_rev_id == tree.last_revision()):
3809
result = tree.pull(merger.other_branch, False,
3810
merger.other_rev_id)
3811
result.report(self.outf)
3813
if merger.this_basis is None:
3814
raise errors.BzrCommandError(
3815
"This branch has no commits."
3816
" (perhaps you would prefer 'bzr pull')")
3818
return self._do_preview(merger)
3820
return self._do_interactive(merger)
3822
return self._do_merge(merger, change_reporter, allow_pending,
3825
def _get_preview(self, merger):
3826
tree_merger = merger.make_merger()
3827
tt = tree_merger.make_preview_transform()
3828
self.add_cleanup(tt.finalize)
3829
result_tree = tt.get_preview_tree()
3832
def _do_preview(self, merger):
3833
from bzrlib.diff import show_diff_trees
3834
result_tree = self._get_preview(merger)
3835
show_diff_trees(merger.this_tree, result_tree, self.outf,
3836
old_label='', new_label='')
3838
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3839
merger.change_reporter = change_reporter
3840
conflict_count = merger.do_merge()
3842
merger.set_pending()
3843
if verified == 'failed':
3844
warning('Preview patch does not match changes')
3845
if conflict_count != 0:
3850
def _do_interactive(self, merger):
3851
"""Perform an interactive merge.
3853
This works by generating a preview tree of the merge, then using
3854
Shelver to selectively remove the differences between the working tree
3855
and the preview tree.
3857
from bzrlib import shelf_ui
3858
result_tree = self._get_preview(merger)
3859
writer = bzrlib.option.diff_writer_registry.get()
3860
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3861
reporter=shelf_ui.ApplyReporter(),
3862
diff_writer=writer(sys.stdout))
3868
def sanity_check_merger(self, merger):
3869
if (merger.show_base and
3870
not merger.merge_type is _mod_merge.Merge3Merger):
3871
raise errors.BzrCommandError("Show-base is not supported for this"
3872
" merge type. %s" % merger.merge_type)
3873
if merger.reprocess is None:
3874
if merger.show_base:
3875
merger.reprocess = False
3877
# Use reprocess if the merger supports it
3878
merger.reprocess = merger.merge_type.supports_reprocess
3879
if merger.reprocess and not merger.merge_type.supports_reprocess:
3880
raise errors.BzrCommandError("Conflict reduction is not supported"
3881
" for merge type %s." %
3883
if merger.reprocess and merger.show_base:
3884
raise errors.BzrCommandError("Cannot do conflict reduction and"
3887
def _get_merger_from_branch(self, tree, location, revision, remember,
3888
possible_transports, pb):
3889
"""Produce a merger from a location, assuming it refers to a branch."""
3890
from bzrlib.tag import _merge_tags_if_possible
3891
# find the branch locations
3892
other_loc, user_location = self._select_branch_location(tree, location,
3894
if revision is not None and len(revision) == 2:
3895
base_loc, _unused = self._select_branch_location(tree,
3896
location, revision, 0)
3898
base_loc = other_loc
3900
other_branch, other_path = Branch.open_containing(other_loc,
3901
possible_transports)
3902
if base_loc == other_loc:
3903
base_branch = other_branch
3905
base_branch, base_path = Branch.open_containing(base_loc,
3906
possible_transports)
3907
# Find the revision ids
3908
other_revision_id = None
3909
base_revision_id = None
3910
if revision is not None:
3911
if len(revision) >= 1:
3912
other_revision_id = revision[-1].as_revision_id(other_branch)
3913
if len(revision) == 2:
3914
base_revision_id = revision[0].as_revision_id(base_branch)
3915
if other_revision_id is None:
3916
other_revision_id = _mod_revision.ensure_null(
3917
other_branch.last_revision())
3918
# Remember where we merge from
3919
if ((remember or tree.branch.get_submit_branch() is None) and
3920
user_location is not None):
3921
tree.branch.set_submit_branch(other_branch.base)
3922
_merge_tags_if_possible(other_branch, tree.branch)
3923
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3924
other_revision_id, base_revision_id, other_branch, base_branch)
3925
if other_path != '':
3926
allow_pending = False
3927
merger.interesting_files = [other_path]
3929
allow_pending = True
3930
return merger, allow_pending
3932
def get_merger_from_uncommitted(self, tree, location, pb):
3933
"""Get a merger for uncommitted changes.
3935
:param tree: The tree the merger should apply to.
3936
:param location: The location containing uncommitted changes.
3937
:param pb: The progress bar to use for showing progress.
3939
location = self._select_branch_location(tree, location)[0]
3940
other_tree, other_path = WorkingTree.open_containing(location)
3941
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3942
if other_path != '':
3943
merger.interesting_files = [other_path]
3946
def _select_branch_location(self, tree, user_location, revision=None,
3948
"""Select a branch location, according to possible inputs.
3950
If provided, branches from ``revision`` are preferred. (Both
3951
``revision`` and ``index`` must be supplied.)
3953
Otherwise, the ``location`` parameter is used. If it is None, then the
3954
``submit`` or ``parent`` location is used, and a note is printed.
3956
:param tree: The working tree to select a branch for merging into
3957
:param location: The location entered by the user
3958
:param revision: The revision parameter to the command
3959
:param index: The index to use for the revision parameter. Negative
3960
indices are permitted.
3961
:return: (selected_location, user_location). The default location
3962
will be the user-entered location.
3964
if (revision is not None and index is not None
3965
and revision[index] is not None):
3966
branch = revision[index].get_branch()
3967
if branch is not None:
3968
return branch, branch
3969
if user_location is None:
3970
location = self._get_remembered(tree, 'Merging from')
3972
location = user_location
3973
return location, user_location
3975
def _get_remembered(self, tree, verb_string):
3976
"""Use tree.branch's parent if none was supplied.
3978
Report if the remembered location was used.
3980
stored_location = tree.branch.get_submit_branch()
3981
stored_location_type = "submit"
3982
if stored_location is None:
3983
stored_location = tree.branch.get_parent()
3984
stored_location_type = "parent"
3985
mutter("%s", stored_location)
3986
if stored_location is None:
3987
raise errors.BzrCommandError("No location specified or remembered")
3988
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3989
note(u"%s remembered %s location %s", verb_string,
3990
stored_location_type, display_url)
3991
return stored_location
3994
class cmd_remerge(Command):
3997
Use this if you want to try a different merge technique while resolving
3998
conflicts. Some merge techniques are better than others, and remerge
3999
lets you try different ones on different files.
4001
The options for remerge have the same meaning and defaults as the ones for
4002
merge. The difference is that remerge can (only) be run when there is a
4003
pending merge, and it lets you specify particular files.
4006
Re-do the merge of all conflicted files, and show the base text in
4007
conflict regions, in addition to the usual THIS and OTHER texts::
4009
bzr remerge --show-base
4011
Re-do the merge of "foobar", using the weave merge algorithm, with
4012
additional processing to reduce the size of conflict regions::
4014
bzr remerge --merge-type weave --reprocess foobar
4016
takes_args = ['file*']
4021
help="Show base revision text in conflicts."),
4024
def run(self, file_list=None, merge_type=None, show_base=False,
4026
if merge_type is None:
4027
merge_type = _mod_merge.Merge3Merger
4028
tree, file_list = tree_files(file_list)
4030
self.add_cleanup(tree.unlock)
4031
parents = tree.get_parent_ids()
4032
if len(parents) != 2:
4033
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4034
" merges. Not cherrypicking or"
4036
repository = tree.branch.repository
4037
interesting_ids = None
4039
conflicts = tree.conflicts()
4040
if file_list is not None:
4041
interesting_ids = set()
4042
for filename in file_list:
4043
file_id = tree.path2id(filename)
4045
raise errors.NotVersionedError(filename)
4046
interesting_ids.add(file_id)
4047
if tree.kind(file_id) != "directory":
4050
for name, ie in tree.inventory.iter_entries(file_id):
4051
interesting_ids.add(ie.file_id)
4052
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4054
# Remerge only supports resolving contents conflicts
4055
allowed_conflicts = ('text conflict', 'contents conflict')
4056
restore_files = [c.path for c in conflicts
4057
if c.typestring in allowed_conflicts]
4058
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4059
tree.set_conflicts(ConflictList(new_conflicts))
4060
if file_list is not None:
4061
restore_files = file_list
4062
for filename in restore_files:
4064
restore(tree.abspath(filename))
4065
except errors.NotConflicted:
4067
# Disable pending merges, because the file texts we are remerging
4068
# have not had those merges performed. If we use the wrong parents
4069
# list, we imply that the working tree text has seen and rejected
4070
# all the changes from the other tree, when in fact those changes
4071
# have not yet been seen.
4072
pb = ui.ui_factory.nested_progress_bar()
4073
tree.set_parent_ids(parents[:1])
4075
merger = _mod_merge.Merger.from_revision_ids(pb,
4077
merger.interesting_ids = interesting_ids
4078
merger.merge_type = merge_type
4079
merger.show_base = show_base
4080
merger.reprocess = reprocess
4081
conflicts = merger.do_merge()
4083
tree.set_parent_ids(parents)
4091
class cmd_revert(Command):
4092
"""Revert files to a previous revision.
4094
Giving a list of files will revert only those files. Otherwise, all files
4095
will be reverted. If the revision is not specified with '--revision', the
4096
last committed revision is used.
4098
To remove only some changes, without reverting to a prior version, use
4099
merge instead. For example, "merge . --revision -2..-3" will remove the
4100
changes introduced by -2, without affecting the changes introduced by -1.
4101
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4103
By default, any files that have been manually changed will be backed up
4104
first. (Files changed only by merge are not backed up.) Backup files have
4105
'.~#~' appended to their name, where # is a number.
4107
When you provide files, you can use their current pathname or the pathname
4108
from the target revision. So you can use revert to "undelete" a file by
4109
name. If you name a directory, all the contents of that directory will be
4112
If you have newly added files since the target revision, they will be
4113
removed. If the files to be removed have been changed, backups will be
4114
created as above. Directories containing unknown files will not be
4117
The working tree contains a list of revisions that have been merged but
4118
not yet committed. These revisions will be included as additional parents
4119
of the next commit. Normally, using revert clears that list as well as
4120
reverting the files. If any files are specified, revert leaves the list
4121
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4122
.`` in the tree root to revert all files but keep the recorded merges,
4123
and ``bzr revert --forget-merges`` to clear the pending merge list without
4124
reverting any files.
4126
Using "bzr revert --forget-merges", it is possible to apply all of the
4127
changes from a branch in a single revision. To do this, perform the merge
4128
as desired. Then doing revert with the "--forget-merges" option will keep
4129
the content of the tree as it was, but it will clear the list of pending
4130
merges. The next commit will then contain all of the changes that are
4131
present in the other branch, but without any other parent revisions.
4132
Because this technique forgets where these changes originated, it may
4133
cause additional conflicts on later merges involving the same source and
4137
_see_also = ['cat', 'export']
4140
Option('no-backup', "Do not save backups of reverted files."),
4141
Option('forget-merges',
4142
'Remove pending merge marker, without changing any files.'),
4144
takes_args = ['file*']
4146
def run(self, revision=None, no_backup=False, file_list=None,
4147
forget_merges=None):
4148
tree, file_list = tree_files(file_list)
4150
self.add_cleanup(tree.unlock)
4152
tree.set_parent_ids(tree.get_parent_ids()[:1])
4154
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4157
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4158
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4159
pb = ui.ui_factory.nested_progress_bar()
4161
tree.revert(file_list, rev_tree, not no_backup, pb,
4162
report_changes=True)
4167
class cmd_assert_fail(Command):
4168
"""Test reporting of assertion failures"""
4169
# intended just for use in testing
4174
raise AssertionError("always fails")
4177
class cmd_help(Command):
4178
"""Show help on a command or other topic.
4181
_see_also = ['topics']
4183
Option('long', 'Show help on all commands.'),
4185
takes_args = ['topic?']
4186
aliases = ['?', '--help', '-?', '-h']
4189
def run(self, topic=None, long=False):
4191
if topic is None and long:
4193
bzrlib.help.help(topic)
4196
class cmd_shell_complete(Command):
4197
"""Show appropriate completions for context.
4199
For a list of all available commands, say 'bzr shell-complete'.
4201
takes_args = ['context?']
4206
def run(self, context=None):
4207
import shellcomplete
4208
shellcomplete.shellcomplete(context)
4211
class cmd_missing(Command):
4212
"""Show unmerged/unpulled revisions between two branches.
4214
OTHER_BRANCH may be local or remote.
4216
To filter on a range of revisions, you can use the command -r begin..end
4217
-r revision requests a specific revision, -r ..end or -r begin.. are
4221
1 - some missing revisions
4222
0 - no missing revisions
4226
Determine the missing revisions between this and the branch at the
4227
remembered pull location::
4231
Determine the missing revisions between this and another branch::
4233
bzr missing http://server/branch
4235
Determine the missing revisions up to a specific revision on the other
4238
bzr missing -r ..-10
4240
Determine the missing revisions up to a specific revision on this
4243
bzr missing --my-revision ..-10
4246
_see_also = ['merge', 'pull']
4247
takes_args = ['other_branch?']
4249
Option('reverse', 'Reverse the order of revisions.'),
4251
'Display changes in the local branch only.'),
4252
Option('this' , 'Same as --mine-only.'),
4253
Option('theirs-only',
4254
'Display changes in the remote branch only.'),
4255
Option('other', 'Same as --theirs-only.'),
4259
custom_help('revision',
4260
help='Filter on other branch revisions (inclusive). '
4261
'See "help revisionspec" for details.'),
4262
Option('my-revision',
4263
type=_parse_revision_str,
4264
help='Filter on local branch revisions (inclusive). '
4265
'See "help revisionspec" for details.'),
4266
Option('include-merges',
4267
'Show all revisions in addition to the mainline ones.'),
4269
encoding_type = 'replace'
4272
def run(self, other_branch=None, reverse=False, mine_only=False,
4274
log_format=None, long=False, short=False, line=False,
4275
show_ids=False, verbose=False, this=False, other=False,
4276
include_merges=False, revision=None, my_revision=None):
4277
from bzrlib.missing import find_unmerged, iter_log_revisions
4286
# TODO: We should probably check that we don't have mine-only and
4287
# theirs-only set, but it gets complicated because we also have
4288
# this and other which could be used.
4295
local_branch = Branch.open_containing(u".")[0]
4296
parent = local_branch.get_parent()
4297
if other_branch is None:
4298
other_branch = parent
4299
if other_branch is None:
4300
raise errors.BzrCommandError("No peer location known"
4302
display_url = urlutils.unescape_for_display(parent,
4304
message("Using saved parent location: "
4305
+ display_url + "\n")
4307
remote_branch = Branch.open(other_branch)
4308
if remote_branch.base == local_branch.base:
4309
remote_branch = local_branch
4311
local_branch.lock_read()
4312
self.add_cleanup(local_branch.unlock)
4313
local_revid_range = _revision_range_to_revid_range(
4314
_get_revision_range(my_revision, local_branch,
4317
remote_branch.lock_read()
4318
self.add_cleanup(remote_branch.unlock)
4319
remote_revid_range = _revision_range_to_revid_range(
4320
_get_revision_range(revision,
4321
remote_branch, self.name()))
4323
local_extra, remote_extra = find_unmerged(
4324
local_branch, remote_branch, restrict,
4325
backward=not reverse,
4326
include_merges=include_merges,
4327
local_revid_range=local_revid_range,
4328
remote_revid_range=remote_revid_range)
4330
if log_format is None:
4331
registry = log.log_formatter_registry
4332
log_format = registry.get_default(local_branch)
4333
lf = log_format(to_file=self.outf,
4335
show_timezone='original')
4338
if local_extra and not theirs_only:
4339
message("You have %d extra revision(s):\n" %
4341
for revision in iter_log_revisions(local_extra,
4342
local_branch.repository,
4344
lf.log_revision(revision)
4345
printed_local = True
4348
printed_local = False
4350
if remote_extra and not mine_only:
4351
if printed_local is True:
4353
message("You are missing %d revision(s):\n" %
4355
for revision in iter_log_revisions(remote_extra,
4356
remote_branch.repository,
4358
lf.log_revision(revision)
4361
if mine_only and not local_extra:
4362
# We checked local, and found nothing extra
4363
message('This branch is up to date.\n')
4364
elif theirs_only and not remote_extra:
4365
# We checked remote, and found nothing extra
4366
message('Other branch is up to date.\n')
4367
elif not (mine_only or theirs_only or local_extra or
4369
# We checked both branches, and neither one had extra
4371
message("Branches are up to date.\n")
4373
if not status_code and parent is None and other_branch is not None:
4374
local_branch.lock_write()
4375
self.add_cleanup(local_branch.unlock)
4376
# handle race conditions - a parent might be set while we run.
4377
if local_branch.get_parent() is None:
4378
local_branch.set_parent(remote_branch.base)
4382
class cmd_pack(Command):
4383
"""Compress the data within a repository."""
4385
_see_also = ['repositories']
4386
takes_args = ['branch_or_repo?']
4388
def run(self, branch_or_repo='.'):
4389
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4391
branch = dir.open_branch()
4392
repository = branch.repository
4393
except errors.NotBranchError:
4394
repository = dir.open_repository()
4398
class cmd_plugins(Command):
4399
"""List the installed plugins.
4401
This command displays the list of installed plugins including
4402
version of plugin and a short description of each.
4404
--verbose shows the path where each plugin is located.
4406
A plugin is an external component for Bazaar that extends the
4407
revision control system, by adding or replacing code in Bazaar.
4408
Plugins can do a variety of things, including overriding commands,
4409
adding new commands, providing additional network transports and
4410
customizing log output.
4412
See the Bazaar web site, http://bazaar-vcs.org, for further
4413
information on plugins including where to find them and how to
4414
install them. Instructions are also provided there on how to
4415
write new plugins using the Python programming language.
4417
takes_options = ['verbose']
4420
def run(self, verbose=False):
4421
import bzrlib.plugin
4422
from inspect import getdoc
4424
for name, plugin in bzrlib.plugin.plugins().items():
4425
version = plugin.__version__
4426
if version == 'unknown':
4428
name_ver = '%s %s' % (name, version)
4429
d = getdoc(plugin.module)
4431
doc = d.split('\n')[0]
4433
doc = '(no description)'
4434
result.append((name_ver, doc, plugin.path()))
4435
for name_ver, doc, path in sorted(result):
4436
self.outf.write("%s\n" % name_ver)
4437
self.outf.write(" %s\n" % doc)
4439
self.outf.write(" %s\n" % path)
4440
self.outf.write("\n")
4443
class cmd_testament(Command):
4444
"""Show testament (signing-form) of a revision."""
4447
Option('long', help='Produce long-format testament.'),
4449
help='Produce a strict-format testament.')]
4450
takes_args = ['branch?']
4452
def run(self, branch=u'.', revision=None, long=False, strict=False):
4453
from bzrlib.testament import Testament, StrictTestament
4455
testament_class = StrictTestament
4457
testament_class = Testament
4459
b = Branch.open_containing(branch)[0]
4461
b = Branch.open(branch)
4463
self.add_cleanup(b.unlock)
4464
if revision is None:
4465
rev_id = b.last_revision()
4467
rev_id = revision[0].as_revision_id(b)
4468
t = testament_class.from_revision(b.repository, rev_id)
4470
sys.stdout.writelines(t.as_text_lines())
4472
sys.stdout.write(t.as_short_text())
4475
class cmd_annotate(Command):
4476
"""Show the origin of each line in a file.
4478
This prints out the given file with an annotation on the left side
4479
indicating which revision, author and date introduced the change.
4481
If the origin is the same for a run of consecutive lines, it is
4482
shown only at the top, unless the --all option is given.
4484
# TODO: annotate directories; showing when each file was last changed
4485
# TODO: if the working copy is modified, show annotations on that
4486
# with new uncommitted lines marked
4487
aliases = ['ann', 'blame', 'praise']
4488
takes_args = ['filename']
4489
takes_options = [Option('all', help='Show annotations on all lines.'),
4490
Option('long', help='Show commit date in annotations.'),
4494
encoding_type = 'exact'
4497
def run(self, filename, all=False, long=False, revision=None,
4499
from bzrlib.annotate import annotate_file, annotate_file_tree
4500
wt, branch, relpath = \
4501
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4504
self.add_cleanup(wt.unlock)
4507
self.add_cleanup(branch.unlock)
4508
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4510
self.add_cleanup(tree.unlock)
4512
file_id = wt.path2id(relpath)
4514
file_id = tree.path2id(relpath)
4516
raise errors.NotVersionedError(filename)
4517
file_version = tree.inventory[file_id].revision
4518
if wt is not None and revision is None:
4519
# If there is a tree and we're not annotating historical
4520
# versions, annotate the working tree's content.
4521
annotate_file_tree(wt, file_id, self.outf, long, all,
4524
annotate_file(branch, file_version, file_id, long, all, self.outf,
4528
class cmd_re_sign(Command):
4529
"""Create a digital signature for an existing revision."""
4530
# TODO be able to replace existing ones.
4532
hidden = True # is this right ?
4533
takes_args = ['revision_id*']
4534
takes_options = ['revision']
4536
def run(self, revision_id_list=None, revision=None):
4537
if revision_id_list is not None and revision is not None:
4538
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4539
if revision_id_list is None and revision is None:
4540
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4541
b = WorkingTree.open_containing(u'.')[0].branch
4543
self.add_cleanup(b.unlock)
4544
return self._run(b, revision_id_list, revision)
4546
def _run(self, b, revision_id_list, revision):
4547
import bzrlib.gpg as gpg
4548
gpg_strategy = gpg.GPGStrategy(b.get_config())
4549
if revision_id_list is not None:
4550
b.repository.start_write_group()
4552
for revision_id in revision_id_list:
4553
b.repository.sign_revision(revision_id, gpg_strategy)
4555
b.repository.abort_write_group()
4558
b.repository.commit_write_group()
4559
elif revision is not None:
4560
if len(revision) == 1:
4561
revno, rev_id = revision[0].in_history(b)
4562
b.repository.start_write_group()
4564
b.repository.sign_revision(rev_id, gpg_strategy)
4566
b.repository.abort_write_group()
4569
b.repository.commit_write_group()
4570
elif len(revision) == 2:
4571
# are they both on rh- if so we can walk between them
4572
# might be nice to have a range helper for arbitrary
4573
# revision paths. hmm.
4574
from_revno, from_revid = revision[0].in_history(b)
4575
to_revno, to_revid = revision[1].in_history(b)
4576
if to_revid is None:
4577
to_revno = b.revno()
4578
if from_revno is None or to_revno is None:
4579
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4580
b.repository.start_write_group()
4582
for revno in range(from_revno, to_revno + 1):
4583
b.repository.sign_revision(b.get_rev_id(revno),
4586
b.repository.abort_write_group()
4589
b.repository.commit_write_group()
4591
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4594
class cmd_bind(Command):
4595
"""Convert the current branch into a checkout of the supplied branch.
4597
Once converted into a checkout, commits must succeed on the master branch
4598
before they will be applied to the local branch.
4600
Bound branches use the nickname of its master branch unless it is set
4601
locally, in which case binding will update the local nickname to be
4605
_see_also = ['checkouts', 'unbind']
4606
takes_args = ['location?']
4609
def run(self, location=None):
4610
b, relpath = Branch.open_containing(u'.')
4611
if location is None:
4613
location = b.get_old_bound_location()
4614
except errors.UpgradeRequired:
4615
raise errors.BzrCommandError('No location supplied. '
4616
'This format does not remember old locations.')
4618
if location is None:
4619
raise errors.BzrCommandError('No location supplied and no '
4620
'previous location known')
4621
b_other = Branch.open(location)
4624
except errors.DivergedBranches:
4625
raise errors.BzrCommandError('These branches have diverged.'
4626
' Try merging, and then bind again.')
4627
if b.get_config().has_explicit_nickname():
4628
b.nick = b_other.nick
4631
class cmd_unbind(Command):
4632
"""Convert the current checkout into a regular branch.
4634
After unbinding, the local branch is considered independent and subsequent
4635
commits will be local only.
4638
_see_also = ['checkouts', 'bind']
4643
b, relpath = Branch.open_containing(u'.')
4645
raise errors.BzrCommandError('Local branch is not bound')
4648
class cmd_uncommit(Command):
4649
"""Remove the last committed revision.
4651
--verbose will print out what is being removed.
4652
--dry-run will go through all the motions, but not actually
4655
If --revision is specified, uncommit revisions to leave the branch at the
4656
specified revision. For example, "bzr uncommit -r 15" will leave the
4657
branch at revision 15.
4659
Uncommit leaves the working tree ready for a new commit. The only change
4660
it may make is to restore any pending merges that were present before
4664
# TODO: jam 20060108 Add an option to allow uncommit to remove
4665
# unreferenced information in 'branch-as-repository' branches.
4666
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4667
# information in shared branches as well.
4668
_see_also = ['commit']
4669
takes_options = ['verbose', 'revision',
4670
Option('dry-run', help='Don\'t actually make changes.'),
4671
Option('force', help='Say yes to all questions.'),
4673
help="Only remove the commits from the local branch"
4674
" when in a checkout."
4677
takes_args = ['location?']
4679
encoding_type = 'replace'
4681
def run(self, location=None,
4682
dry_run=False, verbose=False,
4683
revision=None, force=False, local=False):
4684
if location is None:
4686
control, relpath = bzrdir.BzrDir.open_containing(location)
4688
tree = control.open_workingtree()
4690
except (errors.NoWorkingTree, errors.NotLocalUrl):
4692
b = control.open_branch()
4694
if tree is not None:
4696
self.add_cleanup(tree.unlock)
4699
self.add_cleanup(b.unlock)
4700
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4702
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4703
from bzrlib.log import log_formatter, show_log
4704
from bzrlib.uncommit import uncommit
4706
last_revno, last_rev_id = b.last_revision_info()
4709
if revision is None:
4711
rev_id = last_rev_id
4713
# 'bzr uncommit -r 10' actually means uncommit
4714
# so that the final tree is at revno 10.
4715
# but bzrlib.uncommit.uncommit() actually uncommits
4716
# the revisions that are supplied.
4717
# So we need to offset it by one
4718
revno = revision[0].in_history(b).revno + 1
4719
if revno <= last_revno:
4720
rev_id = b.get_rev_id(revno)
4722
if rev_id is None or _mod_revision.is_null(rev_id):
4723
self.outf.write('No revisions to uncommit.\n')
4726
lf = log_formatter('short',
4728
show_timezone='original')
4733
direction='forward',
4734
start_revision=revno,
4735
end_revision=last_revno)
4738
self.outf.write('Dry-run, pretending to remove'
4739
' the above revisions.\n')
4741
self.outf.write('The above revision(s) will be removed.\n')
4744
if not ui.ui_factory.get_boolean('Are you sure'):
4745
self.outf.write('Canceled')
4748
mutter('Uncommitting from {%s} to {%s}',
4749
last_rev_id, rev_id)
4750
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4751
revno=revno, local=local)
4752
self.outf.write('You can restore the old tip by running:\n'
4753
' bzr pull . -r revid:%s\n' % last_rev_id)
4756
class cmd_break_lock(Command):
4757
"""Break a dead lock on a repository, branch or working directory.
4759
CAUTION: Locks should only be broken when you are sure that the process
4760
holding the lock has been stopped.
4762
You can get information on what locks are open via the 'bzr info
4763
[location]' command.
4767
bzr break-lock bzr+ssh://example.com/bzr/foo
4769
takes_args = ['location?']
4771
def run(self, location=None, show=False):
4772
if location is None:
4774
control, relpath = bzrdir.BzrDir.open_containing(location)
4776
control.break_lock()
4777
except NotImplementedError:
4781
class cmd_wait_until_signalled(Command):
4782
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4784
This just prints a line to signal when it is ready, then blocks on stdin.
4790
sys.stdout.write("running\n")
4792
sys.stdin.readline()
4795
class cmd_serve(Command):
4796
"""Run the bzr server."""
4798
aliases = ['server']
4802
help='Serve on stdin/out for use from inetd or sshd.'),
4803
RegistryOption('protocol',
4804
help="Protocol to serve.",
4805
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4806
value_switches=True),
4808
help='Listen for connections on nominated port of the form '
4809
'[hostname:]portnumber. Passing 0 as the port number will '
4810
'result in a dynamically allocated port. The default port '
4811
'depends on the protocol.',
4814
help='Serve contents of this directory.',
4816
Option('allow-writes',
4817
help='By default the server is a readonly server. Supplying '
4818
'--allow-writes enables write access to the contents of '
4819
'the served directory and below. Note that ``bzr serve`` '
4820
'does not perform authentication, so unless some form of '
4821
'external authentication is arranged supplying this '
4822
'option leads to global uncontrolled write access to your '
4827
def get_host_and_port(self, port):
4828
"""Return the host and port to run the smart server on.
4830
If 'port' is None, None will be returned for the host and port.
4832
If 'port' has a colon in it, the string before the colon will be
4833
interpreted as the host.
4835
:param port: A string of the port to run the server on.
4836
:return: A tuple of (host, port), where 'host' is a host name or IP,
4837
and port is an integer TCP/IP port.
4840
if port is not None:
4842
host, port = port.split(':')
4846
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4848
from bzrlib.transport import get_transport, transport_server_registry
4849
if directory is None:
4850
directory = os.getcwd()
4851
if protocol is None:
4852
protocol = transport_server_registry.get()
4853
host, port = self.get_host_and_port(port)
4854
url = urlutils.local_path_to_url(directory)
4855
if not allow_writes:
4856
url = 'readonly+' + url
4857
transport = get_transport(url)
4858
protocol(transport, host, port, inet)
4861
class cmd_join(Command):
4862
"""Combine a tree into its containing tree.
4864
This command requires the target tree to be in a rich-root format.
4866
The TREE argument should be an independent tree, inside another tree, but
4867
not part of it. (Such trees can be produced by "bzr split", but also by
4868
running "bzr branch" with the target inside a tree.)
4870
The result is a combined tree, with the subtree no longer an independant
4871
part. This is marked as a merge of the subtree into the containing tree,
4872
and all history is preserved.
4875
_see_also = ['split']
4876
takes_args = ['tree']
4878
Option('reference', help='Join by reference.', hidden=True),
4881
def run(self, tree, reference=False):
4882
sub_tree = WorkingTree.open(tree)
4883
parent_dir = osutils.dirname(sub_tree.basedir)
4884
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4885
repo = containing_tree.branch.repository
4886
if not repo.supports_rich_root():
4887
raise errors.BzrCommandError(
4888
"Can't join trees because %s doesn't support rich root data.\n"
4889
"You can use bzr upgrade on the repository."
4893
containing_tree.add_reference(sub_tree)
4894
except errors.BadReferenceTarget, e:
4895
# XXX: Would be better to just raise a nicely printable
4896
# exception from the real origin. Also below. mbp 20070306
4897
raise errors.BzrCommandError("Cannot join %s. %s" %
4901
containing_tree.subsume(sub_tree)
4902
except errors.BadSubsumeSource, e:
4903
raise errors.BzrCommandError("Cannot join %s. %s" %
4907
class cmd_split(Command):
4908
"""Split a subdirectory of a tree into a separate tree.
4910
This command will produce a target tree in a format that supports
4911
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4912
converted into earlier formats like 'dirstate-tags'.
4914
The TREE argument should be a subdirectory of a working tree. That
4915
subdirectory will be converted into an independent tree, with its own
4916
branch. Commits in the top-level tree will not apply to the new subtree.
4919
_see_also = ['join']
4920
takes_args = ['tree']
4922
def run(self, tree):
4923
containing_tree, subdir = WorkingTree.open_containing(tree)
4924
sub_id = containing_tree.path2id(subdir)
4926
raise errors.NotVersionedError(subdir)
4928
containing_tree.extract(sub_id)
4929
except errors.RootNotRich:
4930
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4933
class cmd_merge_directive(Command):
4934
"""Generate a merge directive for auto-merge tools.
4936
A directive requests a merge to be performed, and also provides all the
4937
information necessary to do so. This means it must either include a
4938
revision bundle, or the location of a branch containing the desired
4941
A submit branch (the location to merge into) must be supplied the first
4942
time the command is issued. After it has been supplied once, it will
4943
be remembered as the default.
4945
A public branch is optional if a revision bundle is supplied, but required
4946
if --diff or --plain is specified. It will be remembered as the default
4947
after the first use.
4950
takes_args = ['submit_branch?', 'public_branch?']
4954
_see_also = ['send']
4957
RegistryOption.from_kwargs('patch-type',
4958
'The type of patch to include in the directive.',
4960
value_switches=True,
4962
bundle='Bazaar revision bundle (default).',
4963
diff='Normal unified diff.',
4964
plain='No patch, just directive.'),
4965
Option('sign', help='GPG-sign the directive.'), 'revision',
4966
Option('mail-to', type=str,
4967
help='Instead of printing the directive, email to this address.'),
4968
Option('message', type=str, short_name='m',
4969
help='Message to use when committing this merge.')
4972
encoding_type = 'exact'
4974
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4975
sign=False, revision=None, mail_to=None, message=None):
4976
from bzrlib.revision import ensure_null, NULL_REVISION
4977
include_patch, include_bundle = {
4978
'plain': (False, False),
4979
'diff': (True, False),
4980
'bundle': (True, True),
4982
branch = Branch.open('.')
4983
stored_submit_branch = branch.get_submit_branch()
4984
if submit_branch is None:
4985
submit_branch = stored_submit_branch
4987
if stored_submit_branch is None:
4988
branch.set_submit_branch(submit_branch)
4989
if submit_branch is None:
4990
submit_branch = branch.get_parent()
4991
if submit_branch is None:
4992
raise errors.BzrCommandError('No submit branch specified or known')
4994
stored_public_branch = branch.get_public_branch()
4995
if public_branch is None:
4996
public_branch = stored_public_branch
4997
elif stored_public_branch is None:
4998
branch.set_public_branch(public_branch)
4999
if not include_bundle and public_branch is None:
5000
raise errors.BzrCommandError('No public branch specified or'
5002
base_revision_id = None
5003
if revision is not None:
5004
if len(revision) > 2:
5005
raise errors.BzrCommandError('bzr merge-directive takes '
5006
'at most two one revision identifiers')
5007
revision_id = revision[-1].as_revision_id(branch)
5008
if len(revision) == 2:
5009
base_revision_id = revision[0].as_revision_id(branch)
5011
revision_id = branch.last_revision()
5012
revision_id = ensure_null(revision_id)
5013
if revision_id == NULL_REVISION:
5014
raise errors.BzrCommandError('No revisions to bundle.')
5015
directive = merge_directive.MergeDirective2.from_objects(
5016
branch.repository, revision_id, time.time(),
5017
osutils.local_time_offset(), submit_branch,
5018
public_branch=public_branch, include_patch=include_patch,
5019
include_bundle=include_bundle, message=message,
5020
base_revision_id=base_revision_id)
5023
self.outf.write(directive.to_signed(branch))
5025
self.outf.writelines(directive.to_lines())
5027
message = directive.to_email(mail_to, branch, sign)
5028
s = SMTPConnection(branch.get_config())
5029
s.send_email(message)
5032
class cmd_send(Command):
5033
"""Mail or create a merge-directive for submitting changes.
5035
A merge directive provides many things needed for requesting merges:
5037
* A machine-readable description of the merge to perform
5039
* An optional patch that is a preview of the changes requested
5041
* An optional bundle of revision data, so that the changes can be applied
5042
directly from the merge directive, without retrieving data from a
5045
`bzr send` creates a compact data set that, when applied using bzr
5046
merge, has the same effect as merging from the source branch.
5048
By default the merge directive is self-contained and can be applied to any
5049
branch containing submit_branch in its ancestory without needing access to
5052
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5053
revisions, but only a structured request to merge from the
5054
public_location. In that case the public_branch is needed and it must be
5055
up-to-date and accessible to the recipient. The public_branch is always
5056
included if known, so that people can check it later.
5058
The submit branch defaults to the parent of the source branch, but can be
5059
overridden. Both submit branch and public branch will be remembered in
5060
branch.conf the first time they are used for a particular branch. The
5061
source branch defaults to that containing the working directory, but can
5062
be changed using --from.
5064
In order to calculate those changes, bzr must analyse the submit branch.
5065
Therefore it is most efficient for the submit branch to be a local mirror.
5066
If a public location is known for the submit_branch, that location is used
5067
in the merge directive.
5069
The default behaviour is to send the merge directive by mail, unless -o is
5070
given, in which case it is sent to a file.
5072
Mail is sent using your preferred mail program. This should be transparent
5073
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5074
If the preferred client can't be found (or used), your editor will be used.
5076
To use a specific mail program, set the mail_client configuration option.
5077
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5078
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5079
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5080
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5083
If mail is being sent, a to address is required. This can be supplied
5084
either on the commandline, by setting the submit_to configuration
5085
option in the branch itself or the child_submit_to configuration option
5086
in the submit branch.
5088
Two formats are currently supported: "4" uses revision bundle format 4 and
5089
merge directive format 2. It is significantly faster and smaller than
5090
older formats. It is compatible with Bazaar 0.19 and later. It is the
5091
default. "0.9" uses revision bundle format 0.9 and merge directive
5092
format 1. It is compatible with Bazaar 0.12 - 0.18.
5094
The merge directives created by bzr send may be applied using bzr merge or
5095
bzr pull by specifying a file containing a merge directive as the location.
5097
bzr send makes extensive use of public locations to map local locations into
5098
URLs that can be used by other people. See `bzr help configuration` to
5099
set them, and use `bzr info` to display them.
5102
encoding_type = 'exact'
5104
_see_also = ['merge', 'pull']
5106
takes_args = ['submit_branch?', 'public_branch?']
5110
help='Do not include a bundle in the merge directive.'),
5111
Option('no-patch', help='Do not include a preview patch in the merge'
5114
help='Remember submit and public branch.'),
5116
help='Branch to generate the submission from, '
5117
'rather than the one containing the working directory.',
5120
Option('output', short_name='o',
5121
help='Write merge directive to this file; '
5122
'use - for stdout.',
5125
help='Refuse to send if there are uncommitted changes in'
5126
' the working tree, --no-strict disables the check.'),
5127
Option('mail-to', help='Mail the request to this address.',
5131
Option('body', help='Body for the email.', type=unicode),
5132
RegistryOption('format',
5133
help='Use the specified output format.',
5134
lazy_registry=('bzrlib.send', 'format_registry')),
5137
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5138
no_patch=False, revision=None, remember=False, output=None,
5139
format=None, mail_to=None, message=None, body=None,
5140
strict=None, **kwargs):
5141
from bzrlib.send import send
5142
return send(submit_branch, revision, public_branch, remember,
5143
format, no_bundle, no_patch, output,
5144
kwargs.get('from', '.'), mail_to, message, body,
5149
class cmd_bundle_revisions(cmd_send):
5150
"""Create a merge-directive for submitting changes.
5152
A merge directive provides many things needed for requesting merges:
5154
* A machine-readable description of the merge to perform
5156
* An optional patch that is a preview of the changes requested
5158
* An optional bundle of revision data, so that the changes can be applied
5159
directly from the merge directive, without retrieving data from a
5162
If --no-bundle is specified, then public_branch is needed (and must be
5163
up-to-date), so that the receiver can perform the merge using the
5164
public_branch. The public_branch is always included if known, so that
5165
people can check it later.
5167
The submit branch defaults to the parent, but can be overridden. Both
5168
submit branch and public branch will be remembered if supplied.
5170
If a public_branch is known for the submit_branch, that public submit
5171
branch is used in the merge instructions. This means that a local mirror
5172
can be used as your actual submit branch, once you have set public_branch
5175
Two formats are currently supported: "4" uses revision bundle format 4 and
5176
merge directive format 2. It is significantly faster and smaller than
5177
older formats. It is compatible with Bazaar 0.19 and later. It is the
5178
default. "0.9" uses revision bundle format 0.9 and merge directive
5179
format 1. It is compatible with Bazaar 0.12 - 0.18.
5184
help='Do not include a bundle in the merge directive.'),
5185
Option('no-patch', help='Do not include a preview patch in the merge'
5188
help='Remember submit and public branch.'),
5190
help='Branch to generate the submission from, '
5191
'rather than the one containing the working directory.',
5194
Option('output', short_name='o', help='Write directive to this file.',
5197
help='Refuse to bundle revisions if there are uncommitted'
5198
' changes in the working tree, --no-strict disables the check.'),
5200
RegistryOption('format',
5201
help='Use the specified output format.',
5202
lazy_registry=('bzrlib.send', 'format_registry')),
5204
aliases = ['bundle']
5206
_see_also = ['send', 'merge']
5210
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5211
no_patch=False, revision=None, remember=False, output=None,
5212
format=None, strict=None, **kwargs):
5215
from bzrlib.send import send
5216
return send(submit_branch, revision, public_branch, remember,
5217
format, no_bundle, no_patch, output,
5218
kwargs.get('from', '.'), None, None, None,
5219
self.outf, strict=strict)
5222
class cmd_tag(Command):
5223
"""Create, remove or modify a tag naming a revision.
5225
Tags give human-meaningful names to revisions. Commands that take a -r
5226
(--revision) option can be given -rtag:X, where X is any previously
5229
Tags are stored in the branch. Tags are copied from one branch to another
5230
along when you branch, push, pull or merge.
5232
It is an error to give a tag name that already exists unless you pass
5233
--force, in which case the tag is moved to point to the new revision.
5235
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5236
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5239
_see_also = ['commit', 'tags']
5240
takes_args = ['tag_name']
5243
help='Delete this tag rather than placing it.',
5246
help='Branch in which to place the tag.',
5251
help='Replace existing tags.',
5256
def run(self, tag_name,
5262
branch, relpath = Branch.open_containing(directory)
5264
self.add_cleanup(branch.unlock)
5266
branch.tags.delete_tag(tag_name)
5267
self.outf.write('Deleted tag %s.\n' % tag_name)
5270
if len(revision) != 1:
5271
raise errors.BzrCommandError(
5272
"Tags can only be placed on a single revision, "
5274
revision_id = revision[0].as_revision_id(branch)
5276
revision_id = branch.last_revision()
5277
if (not force) and branch.tags.has_tag(tag_name):
5278
raise errors.TagAlreadyExists(tag_name)
5279
branch.tags.set_tag(tag_name, revision_id)
5280
self.outf.write('Created tag %s.\n' % tag_name)
5283
class cmd_tags(Command):
5286
This command shows a table of tag names and the revisions they reference.
5292
help='Branch whose tags should be displayed.',
5296
RegistryOption.from_kwargs('sort',
5297
'Sort tags by different criteria.', title='Sorting',
5298
alpha='Sort tags lexicographically (default).',
5299
time='Sort tags chronologically.',
5312
branch, relpath = Branch.open_containing(directory)
5314
tags = branch.tags.get_tag_dict().items()
5319
self.add_cleanup(branch.unlock)
5321
graph = branch.repository.get_graph()
5322
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5323
revid1, revid2 = rev1.rev_id, rev2.rev_id
5324
# only show revisions between revid1 and revid2 (inclusive)
5325
tags = [(tag, revid) for tag, revid in tags if
5326
graph.is_between(revid, revid1, revid2)]
5329
elif sort == 'time':
5331
for tag, revid in tags:
5333
revobj = branch.repository.get_revision(revid)
5334
except errors.NoSuchRevision:
5335
timestamp = sys.maxint # place them at the end
5337
timestamp = revobj.timestamp
5338
timestamps[revid] = timestamp
5339
tags.sort(key=lambda x: timestamps[x[1]])
5341
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5342
for index, (tag, revid) in enumerate(tags):
5344
revno = branch.revision_id_to_dotted_revno(revid)
5345
if isinstance(revno, tuple):
5346
revno = '.'.join(map(str, revno))
5347
except errors.NoSuchRevision:
5348
# Bad tag data/merges can lead to tagged revisions
5349
# which are not in this branch. Fail gracefully ...
5351
tags[index] = (tag, revno)
5353
for tag, revspec in tags:
5354
self.outf.write('%-20s %s\n' % (tag, revspec))
5357
class cmd_reconfigure(Command):
5358
"""Reconfigure the type of a bzr directory.
5360
A target configuration must be specified.
5362
For checkouts, the bind-to location will be auto-detected if not specified.
5363
The order of preference is
5364
1. For a lightweight checkout, the current bound location.
5365
2. For branches that used to be checkouts, the previously-bound location.
5366
3. The push location.
5367
4. The parent location.
5368
If none of these is available, --bind-to must be specified.
5371
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5372
takes_args = ['location?']
5374
RegistryOption.from_kwargs(
5376
title='Target type',
5377
help='The type to reconfigure the directory to.',
5378
value_switches=True, enum_switch=False,
5379
branch='Reconfigure to be an unbound branch with no working tree.',
5380
tree='Reconfigure to be an unbound branch with a working tree.',
5381
checkout='Reconfigure to be a bound branch with a working tree.',
5382
lightweight_checkout='Reconfigure to be a lightweight'
5383
' checkout (with no local history).',
5384
standalone='Reconfigure to be a standalone branch '
5385
'(i.e. stop using shared repository).',
5386
use_shared='Reconfigure to use a shared repository.',
5387
with_trees='Reconfigure repository to create '
5388
'working trees on branches by default.',
5389
with_no_trees='Reconfigure repository to not create '
5390
'working trees on branches by default.'
5392
Option('bind-to', help='Branch to bind checkout to.', type=str),
5394
help='Perform reconfiguration even if local changes'
5396
Option('stacked-on',
5397
help='Reconfigure a branch to be stacked on another branch.',
5401
help='Reconfigure a branch to be unstacked. This '
5402
'may require copying substantial data into it.',
5406
def run(self, location=None, target_type=None, bind_to=None, force=False,
5409
directory = bzrdir.BzrDir.open(location)
5410
if stacked_on and unstacked:
5411
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5412
elif stacked_on is not None:
5413
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5415
reconfigure.ReconfigureUnstacked().apply(directory)
5416
# At the moment you can use --stacked-on and a different
5417
# reconfiguration shape at the same time; there seems no good reason
5419
if target_type is None:
5420
if stacked_on or unstacked:
5423
raise errors.BzrCommandError('No target configuration '
5425
elif target_type == 'branch':
5426
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5427
elif target_type == 'tree':
5428
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5429
elif target_type == 'checkout':
5430
reconfiguration = reconfigure.Reconfigure.to_checkout(
5432
elif target_type == 'lightweight-checkout':
5433
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5435
elif target_type == 'use-shared':
5436
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5437
elif target_type == 'standalone':
5438
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5439
elif target_type == 'with-trees':
5440
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5442
elif target_type == 'with-no-trees':
5443
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5445
reconfiguration.apply(force)
5448
class cmd_switch(Command):
5449
"""Set the branch of a checkout and update.
5451
For lightweight checkouts, this changes the branch being referenced.
5452
For heavyweight checkouts, this checks that there are no local commits
5453
versus the current bound branch, then it makes the local branch a mirror
5454
of the new location and binds to it.
5456
In both cases, the working tree is updated and uncommitted changes
5457
are merged. The user can commit or revert these as they desire.
5459
Pending merges need to be committed or reverted before using switch.
5461
The path to the branch to switch to can be specified relative to the parent
5462
directory of the current branch. For example, if you are currently in a
5463
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5466
Bound branches use the nickname of its master branch unless it is set
5467
locally, in which case switching will update the local nickname to be
5471
takes_args = ['to_location?']
5472
takes_options = [Option('force',
5473
help='Switch even if local commits will be lost.'),
5475
Option('create-branch', short_name='b',
5476
help='Create the target branch from this one before'
5477
' switching to it.'),
5480
def run(self, to_location=None, force=False, create_branch=False,
5482
from bzrlib import switch
5484
revision = _get_one_revision('switch', revision)
5485
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5486
if to_location is None:
5487
if revision is None:
5488
raise errors.BzrCommandError('You must supply either a'
5489
' revision or a location')
5492
branch = control_dir.open_branch()
5493
had_explicit_nick = branch.get_config().has_explicit_nickname()
5494
except errors.NotBranchError:
5496
had_explicit_nick = False
5499
raise errors.BzrCommandError('cannot create branch without'
5501
to_location = directory_service.directories.dereference(
5503
if '/' not in to_location and '\\' not in to_location:
5504
# This path is meant to be relative to the existing branch
5505
this_url = self._get_branch_location(control_dir)
5506
to_location = urlutils.join(this_url, '..', to_location)
5507
to_branch = branch.bzrdir.sprout(to_location,
5508
possible_transports=[branch.bzrdir.root_transport],
5509
source_branch=branch).open_branch()
5512
to_branch = Branch.open(to_location)
5513
except errors.NotBranchError:
5514
this_url = self._get_branch_location(control_dir)
5515
to_branch = Branch.open(
5516
urlutils.join(this_url, '..', to_location))
5517
if revision is not None:
5518
revision = revision.as_revision_id(to_branch)
5519
switch.switch(control_dir, to_branch, force, revision_id=revision)
5520
if had_explicit_nick:
5521
branch = control_dir.open_branch() #get the new branch!
5522
branch.nick = to_branch.nick
5523
note('Switched to branch: %s',
5524
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5526
def _get_branch_location(self, control_dir):
5527
"""Return location of branch for this control dir."""
5529
this_branch = control_dir.open_branch()
5530
# This may be a heavy checkout, where we want the master branch
5531
master_location = this_branch.get_bound_location()
5532
if master_location is not None:
5533
return master_location
5534
# If not, use a local sibling
5535
return this_branch.base
5536
except errors.NotBranchError:
5537
format = control_dir.find_branch_format()
5538
if getattr(format, 'get_reference', None) is not None:
5539
return format.get_reference(control_dir)
5541
return control_dir.root_transport.base
5544
class cmd_view(Command):
5545
"""Manage filtered views.
5547
Views provide a mask over the tree so that users can focus on
5548
a subset of a tree when doing their work. After creating a view,
5549
commands that support a list of files - status, diff, commit, etc -
5550
effectively have that list of files implicitly given each time.
5551
An explicit list of files can still be given but those files
5552
must be within the current view.
5554
In most cases, a view has a short life-span: it is created to make
5555
a selected change and is deleted once that change is committed.
5556
At other times, you may wish to create one or more named views
5557
and switch between them.
5559
To disable the current view without deleting it, you can switch to
5560
the pseudo view called ``off``. This can be useful when you need
5561
to see the whole tree for an operation or two (e.g. merge) but
5562
want to switch back to your view after that.
5565
To define the current view::
5567
bzr view file1 dir1 ...
5569
To list the current view::
5573
To delete the current view::
5577
To disable the current view without deleting it::
5579
bzr view --switch off
5581
To define a named view and switch to it::
5583
bzr view --name view-name file1 dir1 ...
5585
To list a named view::
5587
bzr view --name view-name
5589
To delete a named view::
5591
bzr view --name view-name --delete
5593
To switch to a named view::
5595
bzr view --switch view-name
5597
To list all views defined::
5601
To delete all views::
5603
bzr view --delete --all
5607
takes_args = ['file*']
5610
help='Apply list or delete action to all views.',
5613
help='Delete the view.',
5616
help='Name of the view to define, list or delete.',
5620
help='Name of the view to switch to.',
5625
def run(self, file_list,
5631
tree, file_list = tree_files(file_list, apply_view=False)
5632
current_view, view_dict = tree.views.get_view_info()
5637
raise errors.BzrCommandError(
5638
"Both --delete and a file list specified")
5640
raise errors.BzrCommandError(
5641
"Both --delete and --switch specified")
5643
tree.views.set_view_info(None, {})
5644
self.outf.write("Deleted all views.\n")
5646
raise errors.BzrCommandError("No current view to delete")
5648
tree.views.delete_view(name)
5649
self.outf.write("Deleted '%s' view.\n" % name)
5652
raise errors.BzrCommandError(
5653
"Both --switch and a file list specified")
5655
raise errors.BzrCommandError(
5656
"Both --switch and --all specified")
5657
elif switch == 'off':
5658
if current_view is None:
5659
raise errors.BzrCommandError("No current view to disable")
5660
tree.views.set_view_info(None, view_dict)
5661
self.outf.write("Disabled '%s' view.\n" % (current_view))
5663
tree.views.set_view_info(switch, view_dict)
5664
view_str = views.view_display_str(tree.views.lookup_view())
5665
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5668
self.outf.write('Views defined:\n')
5669
for view in sorted(view_dict):
5670
if view == current_view:
5674
view_str = views.view_display_str(view_dict[view])
5675
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5677
self.outf.write('No views defined.\n')
5680
# No name given and no current view set
5683
raise errors.BzrCommandError(
5684
"Cannot change the 'off' pseudo view")
5685
tree.views.set_view(name, sorted(file_list))
5686
view_str = views.view_display_str(tree.views.lookup_view())
5687
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5691
# No name given and no current view set
5692
self.outf.write('No current view.\n')
5694
view_str = views.view_display_str(tree.views.lookup_view(name))
5695
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5698
class cmd_hooks(Command):
5704
for hook_key in sorted(hooks.known_hooks.keys()):
5705
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5706
self.outf.write("%s:\n" % type(some_hooks).__name__)
5707
for hook_name, hook_point in sorted(some_hooks.items()):
5708
self.outf.write(" %s:\n" % (hook_name,))
5709
found_hooks = list(hook_point)
5711
for hook in found_hooks:
5712
self.outf.write(" %s\n" %
5713
(some_hooks.get_hook_name(hook),))
5715
self.outf.write(" <no hooks installed>\n")
5718
class cmd_shelve(Command):
5719
"""Temporarily set aside some changes from the current tree.
5721
Shelve allows you to temporarily put changes you've made "on the shelf",
5722
ie. out of the way, until a later time when you can bring them back from
5723
the shelf with the 'unshelve' command. The changes are stored alongside
5724
your working tree, and so they aren't propagated along with your branch nor
5725
will they survive its deletion.
5727
If shelve --list is specified, previously-shelved changes are listed.
5729
Shelve is intended to help separate several sets of changes that have
5730
been inappropriately mingled. If you just want to get rid of all changes
5731
and you don't need to restore them later, use revert. If you want to
5732
shelve all text changes at once, use shelve --all.
5734
If filenames are specified, only the changes to those files will be
5735
shelved. Other files will be left untouched.
5737
If a revision is specified, changes since that revision will be shelved.
5739
You can put multiple items on the shelf, and by default, 'unshelve' will
5740
restore the most recently shelved changes.
5743
takes_args = ['file*']
5747
Option('all', help='Shelve all changes.'),
5749
RegistryOption('writer', 'Method to use for writing diffs.',
5750
bzrlib.option.diff_writer_registry,
5751
value_switches=True, enum_switch=False),
5753
Option('list', help='List shelved changes.'),
5755
help='Destroy removed changes instead of shelving them.'),
5757
_see_also = ['unshelve']
5759
def run(self, revision=None, all=False, file_list=None, message=None,
5760
writer=None, list=False, destroy=False):
5762
return self.run_for_list()
5763
from bzrlib.shelf_ui import Shelver
5765
writer = bzrlib.option.diff_writer_registry.get()
5767
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5768
file_list, message, destroy=destroy)
5773
except errors.UserAbort:
5776
def run_for_list(self):
5777
tree = WorkingTree.open_containing('.')[0]
5779
self.add_cleanup(tree.unlock)
5780
manager = tree.get_shelf_manager()
5781
shelves = manager.active_shelves()
5782
if len(shelves) == 0:
5783
note('No shelved changes.')
5785
for shelf_id in reversed(shelves):
5786
message = manager.get_metadata(shelf_id).get('message')
5788
message = '<no message>'
5789
self.outf.write('%3d: %s\n' % (shelf_id, message))
5793
class cmd_unshelve(Command):
5794
"""Restore shelved changes.
5796
By default, the most recently shelved changes are restored. However if you
5797
specify a shelf by id those changes will be restored instead. This works
5798
best when the changes don't depend on each other.
5801
takes_args = ['shelf_id?']
5803
RegistryOption.from_kwargs(
5804
'action', help="The action to perform.",
5805
enum_switch=False, value_switches=True,
5806
apply="Apply changes and remove from the shelf.",
5807
dry_run="Show changes, but do not apply or remove them.",
5808
preview="Instead of unshelving the changes, show the diff that "
5809
"would result from unshelving.",
5810
delete_only="Delete changes without applying them.",
5811
keep="Apply changes but don't delete them.",
5814
_see_also = ['shelve']
5816
def run(self, shelf_id=None, action='apply'):
5817
from bzrlib.shelf_ui import Unshelver
5818
unshelver = Unshelver.from_args(shelf_id, action)
5822
unshelver.tree.unlock()
5825
class cmd_clean_tree(Command):
5826
"""Remove unwanted files from working tree.
5828
By default, only unknown files, not ignored files, are deleted. Versioned
5829
files are never deleted.
5831
Another class is 'detritus', which includes files emitted by bzr during
5832
normal operations and selftests. (The value of these files decreases with
5835
If no options are specified, unknown files are deleted. Otherwise, option
5836
flags are respected, and may be combined.
5838
To check what clean-tree will do, use --dry-run.
5840
takes_options = [Option('ignored', help='Delete all ignored files.'),
5841
Option('detritus', help='Delete conflict files, merge'
5842
' backups, and failed selftest dirs.'),
5844
help='Delete files unknown to bzr (default).'),
5845
Option('dry-run', help='Show files to delete instead of'
5847
Option('force', help='Do not prompt before deleting.')]
5848
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5850
from bzrlib.clean_tree import clean_tree
5851
if not (unknown or ignored or detritus):
5855
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5856
dry_run=dry_run, no_prompt=force)
5859
class cmd_reference(Command):
5860
"""list, view and set branch locations for nested trees.
5862
If no arguments are provided, lists the branch locations for nested trees.
5863
If one argument is provided, display the branch location for that tree.
5864
If two arguments are provided, set the branch location for that tree.
5869
takes_args = ['path?', 'location?']
5871
def run(self, path=None, location=None):
5873
if path is not None:
5875
tree, branch, relpath =(
5876
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5877
if path is not None:
5880
tree = branch.basis_tree()
5882
info = branch._get_all_reference_info().iteritems()
5883
self._display_reference_info(tree, branch, info)
5885
file_id = tree.path2id(path)
5887
raise errors.NotVersionedError(path)
5888
if location is None:
5889
info = [(file_id, branch.get_reference_info(file_id))]
5890
self._display_reference_info(tree, branch, info)
5892
branch.set_reference_info(file_id, path, location)
5894
def _display_reference_info(self, tree, branch, info):
5896
for file_id, (path, location) in info:
5898
path = tree.id2path(file_id)
5899
except errors.NoSuchId:
5901
ref_list.append((path, location))
5902
for path, location in sorted(ref_list):
5903
self.outf.write('%s %s\n' % (path, location))
5906
# these get imported and then picked up by the scan for cmd_*
5907
# TODO: Some more consistent way to split command definitions across files;
5908
# we do need to load at least some information about them to know of
5909
# aliases. ideally we would avoid loading the implementation until the
5910
# details were needed.
5911
from bzrlib.cmd_version_info import cmd_version_info
5912
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5913
from bzrlib.bundle.commands import (
5916
from bzrlib.foreign import cmd_dpush
5917
from bzrlib.sign_my_commits import cmd_sign_my_commits
5918
from bzrlib.weave_commands import cmd_versionedfile_list, \
5919
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
