1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import (
71
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
74
def tree_files(file_list, default_branch=u'.', canonicalize=True,
77
return internal_tree_files(file_list, default_branch, canonicalize,
79
except errors.FileInWrongBranch, e:
80
raise errors.BzrCommandError("%s is not in the same branch as %s" %
81
(e.path, file_list[0]))
84
def tree_files_for_add(file_list):
86
Return a tree and list of absolute paths from a file list.
88
Similar to tree_files, but add handles files a bit differently, so it a
89
custom implementation. In particular, MutableTreeTree.smart_add expects
90
absolute paths, which it immediately converts to relative paths.
92
# FIXME Would be nice to just return the relative paths like
93
# internal_tree_files does, but there are a large number of unit tests
94
# that assume the current interface to mutabletree.smart_add
96
tree, relpath = WorkingTree.open_containing(file_list[0])
97
if tree.supports_views():
98
view_files = tree.views.lookup_view()
100
for filename in file_list:
101
if not osutils.is_inside_any(view_files, filename):
102
raise errors.FileOutsideView(filename, view_files)
103
file_list = file_list[:]
104
file_list[0] = tree.abspath(relpath)
106
tree = WorkingTree.open_containing(u'.')[0]
107
if tree.supports_views():
108
view_files = tree.views.lookup_view()
110
file_list = view_files
111
view_str = views.view_display_str(view_files)
112
note("Ignoring files outside view. View is %s" % view_str)
113
return tree, file_list
116
def _get_one_revision(command_name, revisions):
117
if revisions is None:
119
if len(revisions) != 1:
120
raise errors.BzrCommandError(
121
'bzr %s --revision takes exactly one revision identifier' % (
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
127
"""Get a revision tree. Not suitable for commands that change the tree.
129
Specifically, the basis tree in dirstate trees is coupled to the dirstate
130
and doing a commit/uncommit/pull will at best fail due to changing the
133
If tree is passed in, it should be already locked, for lifetime management
134
of the trees internal cached state.
138
if revisions is None:
140
rev_tree = tree.basis_tree()
142
rev_tree = branch.basis_tree()
144
revision = _get_one_revision(command_name, revisions)
145
rev_tree = revision.as_tree(branch)
149
# XXX: Bad function name; should possibly also be a class method of
150
# WorkingTree rather than a function.
151
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
"""Convert command-line paths to a WorkingTree and relative paths.
155
This is typically used for command-line processors that take one or
156
more filenames, and infer the workingtree that contains them.
158
The filenames given are not required to exist.
160
:param file_list: Filenames to convert.
162
:param default_branch: Fallback tree path to use if file_list is empty or
165
:param apply_view: if True and a view is set, apply it or check that
166
specified files are within it
168
:return: workingtree, [relative_paths]
170
if file_list is None or len(file_list) == 0:
171
tree = WorkingTree.open_containing(default_branch)[0]
172
if tree.supports_views() and apply_view:
173
view_files = tree.views.lookup_view()
175
file_list = view_files
176
view_str = views.view_display_str(view_files)
177
note("Ignoring files outside view. View is %s" % view_str)
178
return tree, file_list
179
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
180
return tree, safe_relpath_files(tree, file_list, canonicalize,
181
apply_view=apply_view)
184
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
185
"""Convert file_list into a list of relpaths in tree.
187
:param tree: A tree to operate on.
188
:param file_list: A list of user provided paths or None.
189
:param apply_view: if True and a view is set, apply it or check that
190
specified files are within it
191
:return: A list of relative paths.
192
:raises errors.PathNotChild: When a provided path is in a different tree
195
if file_list is None:
197
if tree.supports_views() and apply_view:
198
view_files = tree.views.lookup_view()
202
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
203
# doesn't - fix that up here before we enter the loop.
205
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
208
for filename in file_list:
210
relpath = fixer(osutils.dereference_path(filename))
211
if view_files and not osutils.is_inside_any(view_files, relpath):
212
raise errors.FileOutsideView(filename, view_files)
213
new_list.append(relpath)
214
except errors.PathNotChild:
215
raise errors.FileInWrongBranch(tree.branch, filename)
219
def _get_view_info_for_change_reporter(tree):
220
"""Get the view information from a tree for change reporting."""
223
current_view = tree.views.get_view_info()[0]
224
if current_view is not None:
225
view_info = (current_view, tree.views.lookup_view())
226
except errors.ViewsNotSupported:
231
# TODO: Make sure no commands unconditionally use the working directory as a
232
# branch. If a filename argument is used, the first of them should be used to
233
# specify the branch. (Perhaps this can be factored out into some kind of
234
# Argument class, representing a file in a branch, where the first occurrence
237
class cmd_status(Command):
238
"""Display status summary.
240
This reports on versioned and unknown files, reporting them
241
grouped by state. Possible states are:
244
Versioned in the working copy but not in the previous revision.
247
Versioned in the previous revision but removed or deleted
251
Path of this file changed from the previous revision;
252
the text may also have changed. This includes files whose
253
parent directory was renamed.
256
Text has changed since the previous revision.
259
File kind has been changed (e.g. from file to directory).
262
Not versioned and not matching an ignore pattern.
264
Additionally for directories, symlinks and files with an executable
265
bit, Bazaar indicates their type using a trailing character: '/', '@'
268
To see ignored files use 'bzr ignored'. For details on the
269
changes to file texts, use 'bzr diff'.
271
Note that --short or -S gives status flags for each item, similar
272
to Subversion's status command. To get output similar to svn -q,
275
If no arguments are specified, the status of the entire working
276
directory is shown. Otherwise, only the status of the specified
277
files or directories is reported. If a directory is given, status
278
is reported for everything inside that directory.
280
Before merges are committed, the pending merge tip revisions are
281
shown. To see all pending merge revisions, use the -v option.
282
To skip the display of pending merge information altogether, use
283
the no-pending option or specify a file/directory.
285
If a revision argument is given, the status is calculated against
286
that revision, or between two revisions if two are provided.
289
# TODO: --no-recurse, --recurse options
291
takes_args = ['file*']
292
takes_options = ['show-ids', 'revision', 'change', 'verbose',
293
Option('short', help='Use short status indicators.',
295
Option('versioned', help='Only show versioned files.',
297
Option('no-pending', help='Don\'t show pending merges.',
300
aliases = ['st', 'stat']
302
encoding_type = 'replace'
303
_see_also = ['diff', 'revert', 'status-flags']
306
def run(self, show_ids=False, file_list=None, revision=None, short=False,
307
versioned=False, no_pending=False, verbose=False):
308
from bzrlib.status import show_tree_status
310
if revision and len(revision) > 2:
311
raise errors.BzrCommandError('bzr status --revision takes exactly'
312
' one or two revision specifiers')
314
tree, relfile_list = tree_files(file_list)
315
# Avoid asking for specific files when that is not needed.
316
if relfile_list == ['']:
318
# Don't disable pending merges for full trees other than '.'.
319
if file_list == ['.']:
321
# A specific path within a tree was given.
322
elif relfile_list is not None:
324
show_tree_status(tree, show_ids=show_ids,
325
specific_files=relfile_list, revision=revision,
326
to_file=self.outf, short=short, versioned=versioned,
327
show_pending=(not no_pending), verbose=verbose)
330
class cmd_cat_revision(Command):
331
"""Write out metadata for a revision.
333
The revision to print can either be specified by a specific
334
revision identifier, or you can use --revision.
338
takes_args = ['revision_id?']
339
takes_options = ['revision']
340
# cat-revision is more for frontends so should be exact
344
def run(self, revision_id=None, revision=None):
345
if revision_id is not None and revision is not None:
346
raise errors.BzrCommandError('You can only supply one of'
347
' revision_id or --revision')
348
if revision_id is None and revision is None:
349
raise errors.BzrCommandError('You must supply either'
350
' --revision or a revision_id')
351
b = WorkingTree.open_containing(u'.')[0].branch
353
# TODO: jam 20060112 should cat-revision always output utf-8?
354
if revision_id is not None:
355
revision_id = osutils.safe_revision_id(revision_id, warn=False)
357
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
358
except errors.NoSuchRevision:
359
msg = "The repository %s contains no revision %s." % (b.repository.base,
361
raise errors.BzrCommandError(msg)
362
elif revision is not None:
365
raise errors.BzrCommandError('You cannot specify a NULL'
367
rev_id = rev.as_revision_id(b)
368
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
371
class cmd_dump_btree(Command):
372
"""Dump the contents of a btree index file to stdout.
374
PATH is a btree index file, it can be any URL. This includes things like
375
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
377
By default, the tuples stored in the index file will be displayed. With
378
--raw, we will uncompress the pages, but otherwise display the raw bytes
382
# TODO: Do we want to dump the internal nodes as well?
383
# TODO: It would be nice to be able to dump the un-parsed information,
384
# rather than only going through iter_all_entries. However, this is
385
# good enough for a start
387
encoding_type = 'exact'
388
takes_args = ['path']
389
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
390
' rather than the parsed tuples.'),
393
def run(self, path, raw=False):
394
dirname, basename = osutils.split(path)
395
t = transport.get_transport(dirname)
397
self._dump_raw_bytes(t, basename)
399
self._dump_entries(t, basename)
401
def _get_index_and_bytes(self, trans, basename):
402
"""Create a BTreeGraphIndex and raw bytes."""
403
bt = btree_index.BTreeGraphIndex(trans, basename, None)
404
bytes = trans.get_bytes(basename)
405
bt._file = cStringIO.StringIO(bytes)
406
bt._size = len(bytes)
409
def _dump_raw_bytes(self, trans, basename):
412
# We need to parse at least the root node.
413
# This is because the first page of every row starts with an
414
# uncompressed header.
415
bt, bytes = self._get_index_and_bytes(trans, basename)
416
for page_idx, page_start in enumerate(xrange(0, len(bytes),
417
btree_index._PAGE_SIZE)):
418
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
419
page_bytes = bytes[page_start:page_end]
421
self.outf.write('Root node:\n')
422
header_end, data = bt._parse_header_from_bytes(page_bytes)
423
self.outf.write(page_bytes[:header_end])
425
self.outf.write('\nPage %d\n' % (page_idx,))
426
decomp_bytes = zlib.decompress(page_bytes)
427
self.outf.write(decomp_bytes)
428
self.outf.write('\n')
430
def _dump_entries(self, trans, basename):
432
st = trans.stat(basename)
433
except errors.TransportNotPossible:
434
# We can't stat, so we'll fake it because we have to do the 'get()'
436
bt, _ = self._get_index_and_bytes(trans, basename)
438
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
439
for node in bt.iter_all_entries():
440
# Node is made up of:
441
# (index, key, value, [references])
442
refs_as_tuples = static_tuple.as_tuples(node[3])
443
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
444
self.outf.write('%s\n' % (as_tuple,))
447
class cmd_remove_tree(Command):
448
"""Remove the working tree from a given branch/checkout.
450
Since a lightweight checkout is little more than a working tree
451
this will refuse to run against one.
453
To re-create the working tree, use "bzr checkout".
455
_see_also = ['checkout', 'working-trees']
456
takes_args = ['location*']
459
help='Remove the working tree even if it has '
460
'uncommitted changes.'),
463
def run(self, location_list, force=False):
464
if not location_list:
467
for location in location_list:
468
d = bzrdir.BzrDir.open(location)
471
working = d.open_workingtree()
472
except errors.NoWorkingTree:
473
raise errors.BzrCommandError("No working tree to remove")
474
except errors.NotLocalUrl:
475
raise errors.BzrCommandError("You cannot remove the working tree"
478
if (working.has_changes()):
479
raise errors.UncommittedChanges(working)
481
working_path = working.bzrdir.root_transport.base
482
branch_path = working.branch.bzrdir.root_transport.base
483
if working_path != branch_path:
484
raise errors.BzrCommandError("You cannot remove the working tree"
485
" from a lightweight checkout")
487
d.destroy_workingtree()
490
class cmd_revno(Command):
491
"""Show current revision number.
493
This is equal to the number of revisions on this branch.
497
takes_args = ['location?']
499
Option('tree', help='Show revno of working tree'),
503
def run(self, tree=False, location=u'.'):
506
wt = WorkingTree.open_containing(location)[0]
508
except (errors.NoWorkingTree, errors.NotLocalUrl):
509
raise errors.NoWorkingTree(location)
510
self.add_cleanup(wt.unlock)
511
revid = wt.last_revision()
513
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
514
except errors.NoSuchRevision:
516
revno = ".".join(str(n) for n in revno_t)
518
b = Branch.open_containing(location)[0]
520
self.add_cleanup(b.unlock)
523
self.outf.write(str(revno) + '\n')
526
class cmd_revision_info(Command):
527
"""Show revision number and revision id for a given revision identifier.
530
takes_args = ['revision_info*']
534
help='Branch to examine, '
535
'rather than the one containing the working directory.',
539
Option('tree', help='Show revno of working tree'),
543
def run(self, revision=None, directory=u'.', tree=False,
544
revision_info_list=[]):
547
wt = WorkingTree.open_containing(directory)[0]
550
self.add_cleanup(wt.unlock)
551
except (errors.NoWorkingTree, errors.NotLocalUrl):
553
b = Branch.open_containing(directory)[0]
555
self.add_cleanup(b.unlock)
557
if revision is not None:
558
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
559
if revision_info_list is not None:
560
for rev_str in revision_info_list:
561
rev_spec = RevisionSpec.from_string(rev_str)
562
revision_ids.append(rev_spec.as_revision_id(b))
563
# No arguments supplied, default to the last revision
564
if len(revision_ids) == 0:
567
raise errors.NoWorkingTree(directory)
568
revision_ids.append(wt.last_revision())
570
revision_ids.append(b.last_revision())
574
for revision_id in revision_ids:
576
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
577
revno = '.'.join(str(i) for i in dotted_revno)
578
except errors.NoSuchRevision:
580
maxlen = max(maxlen, len(revno))
581
revinfos.append([revno, revision_id])
585
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
588
class cmd_add(Command):
589
"""Add specified files or directories.
591
In non-recursive mode, all the named items are added, regardless
592
of whether they were previously ignored. A warning is given if
593
any of the named files are already versioned.
595
In recursive mode (the default), files are treated the same way
596
but the behaviour for directories is different. Directories that
597
are already versioned do not give a warning. All directories,
598
whether already versioned or not, are searched for files or
599
subdirectories that are neither versioned or ignored, and these
600
are added. This search proceeds recursively into versioned
601
directories. If no names are given '.' is assumed.
603
Therefore simply saying 'bzr add' will version all files that
604
are currently unknown.
606
Adding a file whose parent directory is not versioned will
607
implicitly add the parent, and so on up to the root. This means
608
you should never need to explicitly add a directory, they'll just
609
get added when you add a file in the directory.
611
--dry-run will show which files would be added, but not actually
614
--file-ids-from will try to use the file ids from the supplied path.
615
It looks up ids trying to find a matching parent directory with the
616
same filename, and then by pure path. This option is rarely needed
617
but can be useful when adding the same logical file into two
618
branches that will be merged later (without showing the two different
619
adds as a conflict). It is also useful when merging another project
620
into a subdirectory of this one.
622
Any files matching patterns in the ignore list will not be added
623
unless they are explicitly mentioned.
625
takes_args = ['file*']
628
help="Don't recursively add the contents of directories."),
630
help="Show what would be done, but don't actually do anything."),
632
Option('file-ids-from',
634
help='Lookup file ids from this tree.'),
636
encoding_type = 'replace'
637
_see_also = ['remove', 'ignore']
639
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
644
if file_ids_from is not None:
646
base_tree, base_path = WorkingTree.open_containing(
648
except errors.NoWorkingTree:
649
base_branch, base_path = Branch.open_containing(
651
base_tree = base_branch.basis_tree()
653
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
654
to_file=self.outf, should_print=(not is_quiet()))
656
action = bzrlib.add.AddAction(to_file=self.outf,
657
should_print=(not is_quiet()))
660
base_tree.lock_read()
661
self.add_cleanup(base_tree.unlock)
662
tree, file_list = tree_files_for_add(file_list)
663
added, ignored = tree.smart_add(file_list, not
664
no_recurse, action=action, save=not dry_run)
668
for glob in sorted(ignored.keys()):
669
for path in ignored[glob]:
670
self.outf.write("ignored %s matching \"%s\"\n"
674
class cmd_mkdir(Command):
675
"""Create a new versioned directory.
677
This is equivalent to creating the directory and then adding it.
680
takes_args = ['dir+']
681
encoding_type = 'replace'
683
def run(self, dir_list):
686
wt, dd = WorkingTree.open_containing(d)
688
self.outf.write('added %s\n' % d)
691
class cmd_relpath(Command):
692
"""Show path of a file relative to root"""
694
takes_args = ['filename']
698
def run(self, filename):
699
# TODO: jam 20050106 Can relpath return a munged path if
700
# sys.stdout encoding cannot represent it?
701
tree, relpath = WorkingTree.open_containing(filename)
702
self.outf.write(relpath)
703
self.outf.write('\n')
706
class cmd_inventory(Command):
707
"""Show inventory of the current working copy or a revision.
709
It is possible to limit the output to a particular entry
710
type using the --kind option. For example: --kind file.
712
It is also possible to restrict the list of files to a specific
713
set. For example: bzr inventory --show-ids this/file
722
help='List entries of a particular kind: file, directory, symlink.',
725
takes_args = ['file*']
728
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
729
if kind and kind not in ['file', 'directory', 'symlink']:
730
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
732
revision = _get_one_revision('inventory', revision)
733
work_tree, file_list = tree_files(file_list)
734
work_tree.lock_read()
735
self.add_cleanup(work_tree.unlock)
736
if revision is not None:
737
tree = revision.as_tree(work_tree.branch)
739
extra_trees = [work_tree]
741
self.add_cleanup(tree.unlock)
746
if file_list is not None:
747
file_ids = tree.paths2ids(file_list, trees=extra_trees,
748
require_versioned=True)
749
# find_ids_across_trees may include some paths that don't
751
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
752
for file_id in file_ids if file_id in tree)
754
entries = tree.inventory.entries()
757
for path, entry in entries:
758
if kind and kind != entry.kind:
761
self.outf.write('%-50s %s\n' % (path, entry.file_id))
763
self.outf.write(path)
764
self.outf.write('\n')
767
class cmd_mv(Command):
768
"""Move or rename a file.
771
bzr mv OLDNAME NEWNAME
773
bzr mv SOURCE... DESTINATION
775
If the last argument is a versioned directory, all the other names
776
are moved into it. Otherwise, there must be exactly two arguments
777
and the file is changed to a new name.
779
If OLDNAME does not exist on the filesystem but is versioned and
780
NEWNAME does exist on the filesystem but is not versioned, mv
781
assumes that the file has been manually moved and only updates
782
its internal inventory to reflect that change.
783
The same is valid when moving many SOURCE files to a DESTINATION.
785
Files cannot be moved between branches.
788
takes_args = ['names*']
789
takes_options = [Option("after", help="Move only the bzr identifier"
790
" of the file, because the file has already been moved."),
791
Option('auto', help='Automatically guess renames.'),
792
Option('dry-run', help='Avoid making changes when guessing renames.'),
794
aliases = ['move', 'rename']
795
encoding_type = 'replace'
797
def run(self, names_list, after=False, auto=False, dry_run=False):
799
return self.run_auto(names_list, after, dry_run)
801
raise errors.BzrCommandError('--dry-run requires --auto.')
802
if names_list is None:
804
if len(names_list) < 2:
805
raise errors.BzrCommandError("missing file argument")
806
tree, rel_names = tree_files(names_list, canonicalize=False)
807
tree.lock_tree_write()
808
self.add_cleanup(tree.unlock)
809
self._run(tree, names_list, rel_names, after)
811
def run_auto(self, names_list, after, dry_run):
812
if names_list is not None and len(names_list) > 1:
813
raise errors.BzrCommandError('Only one path may be specified to'
816
raise errors.BzrCommandError('--after cannot be specified with'
818
work_tree, file_list = tree_files(names_list, default_branch='.')
819
work_tree.lock_tree_write()
820
self.add_cleanup(work_tree.unlock)
821
rename_map.RenameMap.guess_renames(work_tree, dry_run)
823
def _run(self, tree, names_list, rel_names, after):
824
into_existing = osutils.isdir(names_list[-1])
825
if into_existing and len(names_list) == 2:
827
# a. case-insensitive filesystem and change case of dir
828
# b. move directory after the fact (if the source used to be
829
# a directory, but now doesn't exist in the working tree
830
# and the target is an existing directory, just rename it)
831
if (not tree.case_sensitive
832
and rel_names[0].lower() == rel_names[1].lower()):
833
into_existing = False
836
# 'fix' the case of a potential 'from'
837
from_id = tree.path2id(
838
tree.get_canonical_inventory_path(rel_names[0]))
839
if (not osutils.lexists(names_list[0]) and
840
from_id and inv.get_file_kind(from_id) == "directory"):
841
into_existing = False
844
# move into existing directory
845
# All entries reference existing inventory items, so fix them up
846
# for cicp file-systems.
847
rel_names = tree.get_canonical_inventory_paths(rel_names)
848
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
850
self.outf.write("%s => %s\n" % (src, dest))
852
if len(names_list) != 2:
853
raise errors.BzrCommandError('to mv multiple files the'
854
' destination must be a versioned'
857
# for cicp file-systems: the src references an existing inventory
859
src = tree.get_canonical_inventory_path(rel_names[0])
860
# Find the canonical version of the destination: In all cases, the
861
# parent of the target must be in the inventory, so we fetch the
862
# canonical version from there (we do not always *use* the
863
# canonicalized tail portion - we may be attempting to rename the
865
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
866
dest_parent = osutils.dirname(canon_dest)
867
spec_tail = osutils.basename(rel_names[1])
868
# For a CICP file-system, we need to avoid creating 2 inventory
869
# entries that differ only by case. So regardless of the case
870
# we *want* to use (ie, specified by the user or the file-system),
871
# we must always choose to use the case of any existing inventory
872
# items. The only exception to this is when we are attempting a
873
# case-only rename (ie, canonical versions of src and dest are
875
dest_id = tree.path2id(canon_dest)
876
if dest_id is None or tree.path2id(src) == dest_id:
877
# No existing item we care about, so work out what case we
878
# are actually going to use.
880
# If 'after' is specified, the tail must refer to a file on disk.
882
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
884
# pathjoin with an empty tail adds a slash, which breaks
886
dest_parent_fq = tree.basedir
888
dest_tail = osutils.canonical_relpath(
890
osutils.pathjoin(dest_parent_fq, spec_tail))
892
# not 'after', so case as specified is used
893
dest_tail = spec_tail
895
# Use the existing item so 'mv' fails with AlreadyVersioned.
896
dest_tail = os.path.basename(canon_dest)
897
dest = osutils.pathjoin(dest_parent, dest_tail)
898
mutter("attempting to move %s => %s", src, dest)
899
tree.rename_one(src, dest, after=after)
901
self.outf.write("%s => %s\n" % (src, dest))
904
class cmd_pull(Command):
905
"""Turn this branch into a mirror of another branch.
907
By default, this command only works on branches that have not diverged.
908
Branches are considered diverged if the destination branch's most recent
909
commit is one that has not been merged (directly or indirectly) into the
912
If branches have diverged, you can use 'bzr merge' to integrate the changes
913
from one into the other. Once one branch has merged, the other should
914
be able to pull it again.
916
If you want to replace your local changes and just want your branch to
917
match the remote one, use pull --overwrite. This will work even if the two
918
branches have diverged.
920
If there is no default location set, the first pull will set it. After
921
that, you can omit the location to use the default. To change the
922
default, use --remember. The value will only be saved if the remote
923
location can be accessed.
925
Note: The location can be specified either in the form of a branch,
926
or in the form of a path to a file containing a merge directive generated
930
_see_also = ['push', 'update', 'status-flags', 'send']
931
takes_options = ['remember', 'overwrite', 'revision',
932
custom_help('verbose',
933
help='Show logs of pulled revisions.'),
935
help='Branch to pull into, '
936
'rather than the one containing the working directory.',
941
help="Perform a local pull in a bound "
942
"branch. Local pulls are not applied to "
946
takes_args = ['location?']
947
encoding_type = 'replace'
949
def run(self, location=None, remember=False, overwrite=False,
950
revision=None, verbose=False,
951
directory=None, local=False):
952
# FIXME: too much stuff is in the command class
955
if directory is None:
958
tree_to = WorkingTree.open_containing(directory)[0]
959
branch_to = tree_to.branch
960
except errors.NoWorkingTree:
962
branch_to = Branch.open_containing(directory)[0]
964
if local and not branch_to.get_bound_location():
965
raise errors.LocalRequiresBoundBranch()
967
possible_transports = []
968
if location is not None:
970
mergeable = bundle.read_mergeable_from_url(location,
971
possible_transports=possible_transports)
972
except errors.NotABundle:
975
stored_loc = branch_to.get_parent()
977
if stored_loc is None:
978
raise errors.BzrCommandError("No pull location known or"
981
display_url = urlutils.unescape_for_display(stored_loc,
984
self.outf.write("Using saved parent location: %s\n" % display_url)
985
location = stored_loc
987
revision = _get_one_revision('pull', revision)
988
if mergeable is not None:
989
if revision is not None:
990
raise errors.BzrCommandError(
991
'Cannot use -r with merge directives or bundles')
992
mergeable.install_revisions(branch_to.repository)
993
base_revision_id, revision_id, verified = \
994
mergeable.get_merge_request(branch_to.repository)
995
branch_from = branch_to
997
branch_from = Branch.open(location,
998
possible_transports=possible_transports)
1000
if branch_to.get_parent() is None or remember:
1001
branch_to.set_parent(branch_from.base)
1003
if branch_from is not branch_to:
1004
branch_from.lock_read()
1005
self.add_cleanup(branch_from.unlock)
1006
if revision is not None:
1007
revision_id = revision.as_revision_id(branch_from)
1009
branch_to.lock_write()
1010
self.add_cleanup(branch_to.unlock)
1011
if tree_to is not None:
1012
view_info = _get_view_info_for_change_reporter(tree_to)
1013
change_reporter = delta._ChangeReporter(
1014
unversioned_filter=tree_to.is_ignored,
1015
view_info=view_info)
1016
result = tree_to.pull(
1017
branch_from, overwrite, revision_id, change_reporter,
1018
possible_transports=possible_transports, local=local)
1020
result = branch_to.pull(
1021
branch_from, overwrite, revision_id, local=local)
1023
result.report(self.outf)
1024
if verbose and result.old_revid != result.new_revid:
1025
log.show_branch_change(
1026
branch_to, self.outf, result.old_revno,
1030
class cmd_push(Command):
1031
"""Update a mirror of this branch.
1033
The target branch will not have its working tree populated because this
1034
is both expensive, and is not supported on remote file systems.
1036
Some smart servers or protocols *may* put the working tree in place in
1039
This command only works on branches that have not diverged. Branches are
1040
considered diverged if the destination branch's most recent commit is one
1041
that has not been merged (directly or indirectly) by the source branch.
1043
If branches have diverged, you can use 'bzr push --overwrite' to replace
1044
the other branch completely, discarding its unmerged changes.
1046
If you want to ensure you have the different changes in the other branch,
1047
do a merge (see bzr help merge) from the other branch, and commit that.
1048
After that you will be able to do a push without '--overwrite'.
1050
If there is no default push location set, the first push will set it.
1051
After that, you can omit the location to use the default. To change the
1052
default, use --remember. The value will only be saved if the remote
1053
location can be accessed.
1056
_see_also = ['pull', 'update', 'working-trees']
1057
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1058
Option('create-prefix',
1059
help='Create the path leading up to the branch '
1060
'if it does not already exist.'),
1062
help='Branch to push from, '
1063
'rather than the one containing the working directory.',
1067
Option('use-existing-dir',
1068
help='By default push will fail if the target'
1069
' directory exists, but does not already'
1070
' have a control directory. This flag will'
1071
' allow push to proceed.'),
1073
help='Create a stacked branch that references the public location '
1074
'of the parent branch.'),
1075
Option('stacked-on',
1076
help='Create a stacked branch that refers to another branch '
1077
'for the commit history. Only the work not present in the '
1078
'referenced branch is included in the branch created.',
1081
help='Refuse to push if there are uncommitted changes in'
1082
' the working tree, --no-strict disables the check.'),
1084
takes_args = ['location?']
1085
encoding_type = 'replace'
1087
def run(self, location=None, remember=False, overwrite=False,
1088
create_prefix=False, verbose=False, revision=None,
1089
use_existing_dir=False, directory=None, stacked_on=None,
1090
stacked=False, strict=None):
1091
from bzrlib.push import _show_push_branch
1093
if directory is None:
1095
# Get the source branch
1097
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1099
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1100
if strict is None: strict = True # default value
1101
# Get the tip's revision_id
1102
revision = _get_one_revision('push', revision)
1103
if revision is not None:
1104
revision_id = revision.in_history(br_from).rev_id
1107
if strict and tree is not None and revision_id is None:
1108
if (tree.has_changes()):
1109
raise errors.UncommittedChanges(
1110
tree, more='Use --no-strict to force the push.')
1111
if tree.last_revision() != tree.branch.last_revision():
1112
# The tree has lost sync with its branch, there is little
1113
# chance that the user is aware of it but he can still force
1114
# the push with --no-strict
1115
raise errors.OutOfDateTree(
1116
tree, more='Use --no-strict to force the push.')
1118
# Get the stacked_on branch, if any
1119
if stacked_on is not None:
1120
stacked_on = urlutils.normalize_url(stacked_on)
1122
parent_url = br_from.get_parent()
1124
parent = Branch.open(parent_url)
1125
stacked_on = parent.get_public_branch()
1127
# I considered excluding non-http url's here, thus forcing
1128
# 'public' branches only, but that only works for some
1129
# users, so it's best to just depend on the user spotting an
1130
# error by the feedback given to them. RBC 20080227.
1131
stacked_on = parent_url
1133
raise errors.BzrCommandError(
1134
"Could not determine branch to refer to.")
1136
# Get the destination location
1137
if location is None:
1138
stored_loc = br_from.get_push_location()
1139
if stored_loc is None:
1140
raise errors.BzrCommandError(
1141
"No push location known or specified.")
1143
display_url = urlutils.unescape_for_display(stored_loc,
1145
self.outf.write("Using saved push location: %s\n" % display_url)
1146
location = stored_loc
1148
_show_push_branch(br_from, revision_id, location, self.outf,
1149
verbose=verbose, overwrite=overwrite, remember=remember,
1150
stacked_on=stacked_on, create_prefix=create_prefix,
1151
use_existing_dir=use_existing_dir)
1154
class cmd_branch(Command):
1155
"""Create a new branch that is a copy of an existing branch.
1157
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1158
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1159
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1160
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1161
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1164
To retrieve the branch as of a particular revision, supply the --revision
1165
parameter, as in "branch foo/bar -r 5".
1168
_see_also = ['checkout']
1169
takes_args = ['from_location', 'to_location?']
1170
takes_options = ['revision', Option('hardlink',
1171
help='Hard-link working tree files where possible.'),
1173
help="Create a branch without a working-tree."),
1175
help="Switch the checkout in the current directory "
1176
"to the new branch."),
1178
help='Create a stacked branch referring to the source branch. '
1179
'The new branch will depend on the availability of the source '
1180
'branch for all operations.'),
1181
Option('standalone',
1182
help='Do not use a shared repository, even if available.'),
1183
Option('use-existing-dir',
1184
help='By default branch will fail if the target'
1185
' directory exists, but does not already'
1186
' have a control directory. This flag will'
1187
' allow branch to proceed.'),
1189
help="Bind new branch to from location."),
1191
aliases = ['get', 'clone']
1193
def run(self, from_location, to_location=None, revision=None,
1194
hardlink=False, stacked=False, standalone=False, no_tree=False,
1195
use_existing_dir=False, switch=False, bind=False):
1196
from bzrlib import switch as _mod_switch
1197
from bzrlib.tag import _merge_tags_if_possible
1198
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1200
revision = _get_one_revision('branch', revision)
1202
self.add_cleanup(br_from.unlock)
1203
if revision is not None:
1204
revision_id = revision.as_revision_id(br_from)
1206
# FIXME - wt.last_revision, fallback to branch, fall back to
1207
# None or perhaps NULL_REVISION to mean copy nothing
1209
revision_id = br_from.last_revision()
1210
if to_location is None:
1211
to_location = urlutils.derive_to_location(from_location)
1212
to_transport = transport.get_transport(to_location)
1214
to_transport.mkdir('.')
1215
except errors.FileExists:
1216
if not use_existing_dir:
1217
raise errors.BzrCommandError('Target directory "%s" '
1218
'already exists.' % to_location)
1221
bzrdir.BzrDir.open_from_transport(to_transport)
1222
except errors.NotBranchError:
1225
raise errors.AlreadyBranchError(to_location)
1226
except errors.NoSuchFile:
1227
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1230
# preserve whatever source format we have.
1231
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1232
possible_transports=[to_transport],
1233
accelerator_tree=accelerator_tree,
1234
hardlink=hardlink, stacked=stacked,
1235
force_new_repo=standalone,
1236
create_tree_if_local=not no_tree,
1237
source_branch=br_from)
1238
branch = dir.open_branch()
1239
except errors.NoSuchRevision:
1240
to_transport.delete_tree('.')
1241
msg = "The branch %s has no revision %s." % (from_location,
1243
raise errors.BzrCommandError(msg)
1244
_merge_tags_if_possible(br_from, branch)
1245
# If the source branch is stacked, the new branch may
1246
# be stacked whether we asked for that explicitly or not.
1247
# We therefore need a try/except here and not just 'if stacked:'
1249
note('Created new stacked branch referring to %s.' %
1250
branch.get_stacked_on_url())
1251
except (errors.NotStacked, errors.UnstackableBranchFormat,
1252
errors.UnstackableRepositoryFormat), e:
1253
note('Branched %d revision(s).' % branch.revno())
1255
# Bind to the parent
1256
parent_branch = Branch.open(from_location)
1257
branch.bind(parent_branch)
1258
note('New branch bound to %s' % from_location)
1260
# Switch to the new branch
1261
wt, _ = WorkingTree.open_containing('.')
1262
_mod_switch.switch(wt.bzrdir, branch)
1263
note('Switched to branch: %s',
1264
urlutils.unescape_for_display(branch.base, 'utf-8'))
1267
class cmd_checkout(Command):
1268
"""Create a new checkout of an existing branch.
1270
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1271
the branch found in '.'. This is useful if you have removed the working tree
1272
or if it was never created - i.e. if you pushed the branch to its current
1273
location using SFTP.
1275
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1276
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1277
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1278
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1279
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1282
To retrieve the branch as of a particular revision, supply the --revision
1283
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1284
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1288
_see_also = ['checkouts', 'branch']
1289
takes_args = ['branch_location?', 'to_location?']
1290
takes_options = ['revision',
1291
Option('lightweight',
1292
help="Perform a lightweight checkout. Lightweight "
1293
"checkouts depend on access to the branch for "
1294
"every operation. Normal checkouts can perform "
1295
"common operations like diff and status without "
1296
"such access, and also support local commits."
1298
Option('files-from', type=str,
1299
help="Get file contents from this tree."),
1301
help='Hard-link working tree files where possible.'
1306
def run(self, branch_location=None, to_location=None, revision=None,
1307
lightweight=False, files_from=None, hardlink=False):
1308
if branch_location is None:
1309
branch_location = osutils.getcwd()
1310
to_location = branch_location
1311
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1313
revision = _get_one_revision('checkout', revision)
1314
if files_from is not None:
1315
accelerator_tree = WorkingTree.open(files_from)
1316
if revision is not None:
1317
revision_id = revision.as_revision_id(source)
1320
if to_location is None:
1321
to_location = urlutils.derive_to_location(branch_location)
1322
# if the source and to_location are the same,
1323
# and there is no working tree,
1324
# then reconstitute a branch
1325
if (osutils.abspath(to_location) ==
1326
osutils.abspath(branch_location)):
1328
source.bzrdir.open_workingtree()
1329
except errors.NoWorkingTree:
1330
source.bzrdir.create_workingtree(revision_id)
1332
source.create_checkout(to_location, revision_id, lightweight,
1333
accelerator_tree, hardlink)
1336
class cmd_renames(Command):
1337
"""Show list of renamed files.
1339
# TODO: Option to show renames between two historical versions.
1341
# TODO: Only show renames under dir, rather than in the whole branch.
1342
_see_also = ['status']
1343
takes_args = ['dir?']
1346
def run(self, dir=u'.'):
1347
tree = WorkingTree.open_containing(dir)[0]
1349
self.add_cleanup(tree.unlock)
1350
new_inv = tree.inventory
1351
old_tree = tree.basis_tree()
1352
old_tree.lock_read()
1353
self.add_cleanup(old_tree.unlock)
1354
old_inv = old_tree.inventory
1356
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1357
for f, paths, c, v, p, n, k, e in iterator:
1358
if paths[0] == paths[1]:
1362
renames.append(paths)
1364
for old_name, new_name in renames:
1365
self.outf.write("%s => %s\n" % (old_name, new_name))
1368
class cmd_update(Command):
1369
"""Update a tree to have the latest code committed to its branch.
1371
This will perform a merge into the working tree, and may generate
1372
conflicts. If you have any local changes, you will still
1373
need to commit them after the update for the update to be complete.
1375
If you want to discard your local changes, you can just do a
1376
'bzr revert' instead of 'bzr commit' after the update.
1378
If the tree's branch is bound to a master branch, it will also update
1379
the branch from the master.
1382
_see_also = ['pull', 'working-trees', 'status-flags']
1383
takes_args = ['dir?']
1384
takes_options = ['revision']
1387
def run(self, dir='.', revision=None):
1388
if revision is not None and len(revision) != 1:
1389
raise errors.BzrCommandError(
1390
"bzr update --revision takes exactly one revision")
1391
tree = WorkingTree.open_containing(dir)[0]
1392
branch = tree.branch
1393
possible_transports = []
1394
master = branch.get_master_branch(
1395
possible_transports=possible_transports)
1396
if master is not None:
1398
branch_location = master.base
1400
tree.lock_tree_write()
1401
branch_location = tree.branch.base
1402
self.add_cleanup(tree.unlock)
1403
# get rid of the final '/' and be ready for display
1404
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1406
existing_pending_merges = tree.get_parent_ids()[1:]
1410
# may need to fetch data into a heavyweight checkout
1411
# XXX: this may take some time, maybe we should display a
1413
old_tip = branch.update(possible_transports)
1414
if revision is not None:
1415
revision_id = revision[0].as_revision_id(branch)
1417
revision_id = branch.last_revision()
1418
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1419
revno = branch.revision_id_to_revno(revision_id)
1420
note("Tree is up to date at revision %d of branch %s" %
1421
(revno, branch_location))
1423
view_info = _get_view_info_for_change_reporter(tree)
1424
change_reporter = delta._ChangeReporter(
1425
unversioned_filter=tree.is_ignored,
1426
view_info=view_info)
1428
conflicts = tree.update(
1430
possible_transports=possible_transports,
1431
revision=revision_id,
1433
except errors.NoSuchRevision, e:
1434
raise errors.BzrCommandError(
1435
"branch has no revision %s\n"
1436
"bzr update --revision only works"
1437
" for a revision in the branch history"
1439
revno = tree.branch.revision_id_to_revno(
1440
_mod_revision.ensure_null(tree.last_revision()))
1441
note('Updated to revision %d of branch %s' %
1442
(revno, branch_location))
1443
if tree.get_parent_ids()[1:] != existing_pending_merges:
1444
note('Your local commits will now show as pending merges with '
1445
"'bzr status', and can be committed with 'bzr commit'.")
1452
class cmd_info(Command):
1453
"""Show information about a working tree, branch or repository.
1455
This command will show all known locations and formats associated to the
1456
tree, branch or repository.
1458
In verbose mode, statistical information is included with each report.
1459
To see extended statistic information, use a verbosity level of 2 or
1460
higher by specifying the verbose option multiple times, e.g. -vv.
1462
Branches and working trees will also report any missing revisions.
1466
Display information on the format and related locations:
1470
Display the above together with extended format information and
1471
basic statistics (like the number of files in the working tree and
1472
number of revisions in the branch and repository):
1476
Display the above together with number of committers to the branch:
1480
_see_also = ['revno', 'working-trees', 'repositories']
1481
takes_args = ['location?']
1482
takes_options = ['verbose']
1483
encoding_type = 'replace'
1486
def run(self, location=None, verbose=False):
1488
noise_level = get_verbosity_level()
1491
from bzrlib.info import show_bzrdir_info
1492
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1493
verbose=noise_level, outfile=self.outf)
1496
class cmd_remove(Command):
1497
"""Remove files or directories.
1499
This makes bzr stop tracking changes to the specified files. bzr will delete
1500
them if they can easily be recovered using revert. If no options or
1501
parameters are given bzr will scan for files that are being tracked by bzr
1502
but missing in your tree and stop tracking them for you.
1504
takes_args = ['file*']
1505
takes_options = ['verbose',
1506
Option('new', help='Only remove files that have never been committed.'),
1507
RegistryOption.from_kwargs('file-deletion-strategy',
1508
'The file deletion mode to be used.',
1509
title='Deletion Strategy', value_switches=True, enum_switch=False,
1510
safe='Only delete files if they can be'
1511
' safely recovered (default).',
1512
keep='Delete from bzr but leave the working copy.',
1513
force='Delete all the specified files, even if they can not be '
1514
'recovered and even if they are non-empty directories.')]
1515
aliases = ['rm', 'del']
1516
encoding_type = 'replace'
1518
def run(self, file_list, verbose=False, new=False,
1519
file_deletion_strategy='safe'):
1520
tree, file_list = tree_files(file_list)
1522
if file_list is not None:
1523
file_list = [f for f in file_list]
1526
self.add_cleanup(tree.unlock)
1527
# Heuristics should probably all move into tree.remove_smart or
1530
added = tree.changes_from(tree.basis_tree(),
1531
specific_files=file_list).added
1532
file_list = sorted([f[0] for f in added], reverse=True)
1533
if len(file_list) == 0:
1534
raise errors.BzrCommandError('No matching files.')
1535
elif file_list is None:
1536
# missing files show up in iter_changes(basis) as
1537
# versioned-with-no-kind.
1539
for change in tree.iter_changes(tree.basis_tree()):
1540
# Find paths in the working tree that have no kind:
1541
if change[1][1] is not None and change[6][1] is None:
1542
missing.append(change[1][1])
1543
file_list = sorted(missing, reverse=True)
1544
file_deletion_strategy = 'keep'
1545
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1546
keep_files=file_deletion_strategy=='keep',
1547
force=file_deletion_strategy=='force')
1550
class cmd_file_id(Command):
1551
"""Print file_id of a particular file or directory.
1553
The file_id is assigned when the file is first added and remains the
1554
same through all revisions where the file exists, even when it is
1559
_see_also = ['inventory', 'ls']
1560
takes_args = ['filename']
1563
def run(self, filename):
1564
tree, relpath = WorkingTree.open_containing(filename)
1565
i = tree.path2id(relpath)
1567
raise errors.NotVersionedError(filename)
1569
self.outf.write(i + '\n')
1572
class cmd_file_path(Command):
1573
"""Print path of file_ids to a file or directory.
1575
This prints one line for each directory down to the target,
1576
starting at the branch root.
1580
takes_args = ['filename']
1583
def run(self, filename):
1584
tree, relpath = WorkingTree.open_containing(filename)
1585
fid = tree.path2id(relpath)
1587
raise errors.NotVersionedError(filename)
1588
segments = osutils.splitpath(relpath)
1589
for pos in range(1, len(segments) + 1):
1590
path = osutils.joinpath(segments[:pos])
1591
self.outf.write("%s\n" % tree.path2id(path))
1594
class cmd_reconcile(Command):
1595
"""Reconcile bzr metadata in a branch.
1597
This can correct data mismatches that may have been caused by
1598
previous ghost operations or bzr upgrades. You should only
1599
need to run this command if 'bzr check' or a bzr developer
1600
advises you to run it.
1602
If a second branch is provided, cross-branch reconciliation is
1603
also attempted, which will check that data like the tree root
1604
id which was not present in very early bzr versions is represented
1605
correctly in both branches.
1607
At the same time it is run it may recompress data resulting in
1608
a potential saving in disk space or performance gain.
1610
The branch *MUST* be on a listable system such as local disk or sftp.
1613
_see_also = ['check']
1614
takes_args = ['branch?']
1616
def run(self, branch="."):
1617
from bzrlib.reconcile import reconcile
1618
dir = bzrdir.BzrDir.open(branch)
1622
class cmd_revision_history(Command):
1623
"""Display the list of revision ids on a branch."""
1626
takes_args = ['location?']
1631
def run(self, location="."):
1632
branch = Branch.open_containing(location)[0]
1633
for revid in branch.revision_history():
1634
self.outf.write(revid)
1635
self.outf.write('\n')
1638
class cmd_ancestry(Command):
1639
"""List all revisions merged into this branch."""
1641
_see_also = ['log', 'revision-history']
1642
takes_args = ['location?']
1647
def run(self, location="."):
1649
wt = WorkingTree.open_containing(location)[0]
1650
except errors.NoWorkingTree:
1651
b = Branch.open(location)
1652
last_revision = b.last_revision()
1655
last_revision = wt.last_revision()
1657
revision_ids = b.repository.get_ancestry(last_revision)
1659
for revision_id in revision_ids:
1660
self.outf.write(revision_id + '\n')
1663
class cmd_init(Command):
1664
"""Make a directory into a versioned branch.
1666
Use this to create an empty branch, or before importing an
1669
If there is a repository in a parent directory of the location, then
1670
the history of the branch will be stored in the repository. Otherwise
1671
init creates a standalone branch which carries its own history
1672
in the .bzr directory.
1674
If there is already a branch at the location but it has no working tree,
1675
the tree can be populated with 'bzr checkout'.
1677
Recipe for importing a tree of files::
1683
bzr commit -m "imported project"
1686
_see_also = ['init-repository', 'branch', 'checkout']
1687
takes_args = ['location?']
1689
Option('create-prefix',
1690
help='Create the path leading up to the branch '
1691
'if it does not already exist.'),
1692
RegistryOption('format',
1693
help='Specify a format for this branch. '
1694
'See "help formats".',
1695
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1696
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1697
value_switches=True,
1698
title="Branch format",
1700
Option('append-revisions-only',
1701
help='Never change revnos or the existing log.'
1702
' Append revisions to it only.')
1704
def run(self, location=None, format=None, append_revisions_only=False,
1705
create_prefix=False):
1707
format = bzrdir.format_registry.make_bzrdir('default')
1708
if location is None:
1711
to_transport = transport.get_transport(location)
1713
# The path has to exist to initialize a
1714
# branch inside of it.
1715
# Just using os.mkdir, since I don't
1716
# believe that we want to create a bunch of
1717
# locations if the user supplies an extended path
1719
to_transport.ensure_base()
1720
except errors.NoSuchFile:
1721
if not create_prefix:
1722
raise errors.BzrCommandError("Parent directory of %s"
1724
"\nYou may supply --create-prefix to create all"
1725
" leading parent directories."
1727
to_transport.create_prefix()
1730
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1731
except errors.NotBranchError:
1732
# really a NotBzrDir error...
1733
create_branch = bzrdir.BzrDir.create_branch_convenience
1734
branch = create_branch(to_transport.base, format=format,
1735
possible_transports=[to_transport])
1736
a_bzrdir = branch.bzrdir
1738
from bzrlib.transport.local import LocalTransport
1739
if a_bzrdir.has_branch():
1740
if (isinstance(to_transport, LocalTransport)
1741
and not a_bzrdir.has_workingtree()):
1742
raise errors.BranchExistsWithoutWorkingTree(location)
1743
raise errors.AlreadyBranchError(location)
1744
branch = a_bzrdir.create_branch()
1745
a_bzrdir.create_workingtree()
1746
if append_revisions_only:
1748
branch.set_append_revisions_only(True)
1749
except errors.UpgradeRequired:
1750
raise errors.BzrCommandError('This branch format cannot be set'
1751
' to append-revisions-only. Try --default.')
1753
from bzrlib.info import describe_layout, describe_format
1755
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1756
except (errors.NoWorkingTree, errors.NotLocalUrl):
1758
repository = branch.repository
1759
layout = describe_layout(repository, branch, tree).lower()
1760
format = describe_format(a_bzrdir, repository, branch, tree)
1761
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1762
if repository.is_shared():
1763
#XXX: maybe this can be refactored into transport.path_or_url()
1764
url = repository.bzrdir.root_transport.external_url()
1766
url = urlutils.local_path_from_url(url)
1767
except errors.InvalidURL:
1769
self.outf.write("Using shared repository: %s\n" % url)
1772
class cmd_init_repository(Command):
1773
"""Create a shared repository for branches to share storage space.
1775
New branches created under the repository directory will store their
1776
revisions in the repository, not in the branch directory. For branches
1777
with shared history, this reduces the amount of storage needed and
1778
speeds up the creation of new branches.
1780
If the --no-trees option is given then the branches in the repository
1781
will not have working trees by default. They will still exist as
1782
directories on disk, but they will not have separate copies of the
1783
files at a certain revision. This can be useful for repositories that
1784
store branches which are interacted with through checkouts or remote
1785
branches, such as on a server.
1788
Create a shared repository holding just branches::
1790
bzr init-repo --no-trees repo
1793
Make a lightweight checkout elsewhere::
1795
bzr checkout --lightweight repo/trunk trunk-checkout
1800
_see_also = ['init', 'branch', 'checkout', 'repositories']
1801
takes_args = ["location"]
1802
takes_options = [RegistryOption('format',
1803
help='Specify a format for this repository. See'
1804
' "bzr help formats" for details.',
1805
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1806
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1807
value_switches=True, title='Repository format'),
1809
help='Branches in the repository will default to'
1810
' not having a working tree.'),
1812
aliases = ["init-repo"]
1814
def run(self, location, format=None, no_trees=False):
1816
format = bzrdir.format_registry.make_bzrdir('default')
1818
if location is None:
1821
to_transport = transport.get_transport(location)
1822
to_transport.ensure_base()
1824
newdir = format.initialize_on_transport(to_transport)
1825
repo = newdir.create_repository(shared=True)
1826
repo.set_make_working_trees(not no_trees)
1828
from bzrlib.info import show_bzrdir_info
1829
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1832
class cmd_diff(Command):
1833
"""Show differences in the working tree, between revisions or branches.
1835
If no arguments are given, all changes for the current tree are listed.
1836
If files are given, only the changes in those files are listed.
1837
Remote and multiple branches can be compared by using the --old and
1838
--new options. If not provided, the default for both is derived from
1839
the first argument, if any, or the current tree if no arguments are
1842
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1843
produces patches suitable for "patch -p1".
1847
2 - unrepresentable changes
1852
Shows the difference in the working tree versus the last commit::
1856
Difference between the working tree and revision 1::
1860
Difference between revision 3 and revision 1::
1864
Difference between revision 3 and revision 1 for branch xxx::
1868
To see the changes introduced in revision X::
1872
Note that in the case of a merge, the -c option shows the changes
1873
compared to the left hand parent. To see the changes against
1874
another parent, use::
1876
bzr diff -r<chosen_parent>..X
1878
The changes introduced by revision 2 (equivalent to -r1..2)::
1882
Show just the differences for file NEWS::
1886
Show the differences in working tree xxx for file NEWS::
1890
Show the differences from branch xxx to this working tree:
1894
Show the differences between two branches for file NEWS::
1896
bzr diff --old xxx --new yyy NEWS
1898
Same as 'bzr diff' but prefix paths with old/ and new/::
1900
bzr diff --prefix old/:new/
1902
_see_also = ['status']
1903
takes_args = ['file*']
1905
Option('diff-options', type=str,
1906
help='Pass these options to the external diff program.'),
1907
Option('prefix', type=str,
1909
help='Set prefixes added to old and new filenames, as '
1910
'two values separated by a colon. (eg "old/:new/").'),
1912
help='Branch/tree to compare from.',
1916
help='Branch/tree to compare to.',
1922
help='Use this command to compare files.',
1926
aliases = ['di', 'dif']
1927
encoding_type = 'exact'
1930
def run(self, revision=None, file_list=None, diff_options=None,
1931
prefix=None, old=None, new=None, using=None):
1932
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1934
if (prefix is None) or (prefix == '0'):
1942
old_label, new_label = prefix.split(":")
1944
raise errors.BzrCommandError(
1945
'--prefix expects two values separated by a colon'
1946
' (eg "old/:new/")')
1948
if revision and len(revision) > 2:
1949
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1950
' one or two revision specifiers')
1952
(old_tree, new_tree,
1953
old_branch, new_branch,
1954
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1955
file_list, revision, old, new, apply_view=True)
1956
return show_diff_trees(old_tree, new_tree, sys.stdout,
1957
specific_files=specific_files,
1958
external_diff_options=diff_options,
1959
old_label=old_label, new_label=new_label,
1960
extra_trees=extra_trees, using=using)
1963
class cmd_deleted(Command):
1964
"""List files deleted in the working tree.
1966
# TODO: Show files deleted since a previous revision, or
1967
# between two revisions.
1968
# TODO: Much more efficient way to do this: read in new
1969
# directories with readdir, rather than stating each one. Same
1970
# level of effort but possibly much less IO. (Or possibly not,
1971
# if the directories are very large...)
1972
_see_also = ['status', 'ls']
1973
takes_options = ['show-ids']
1976
def run(self, show_ids=False):
1977
tree = WorkingTree.open_containing(u'.')[0]
1979
self.add_cleanup(tree.unlock)
1980
old = tree.basis_tree()
1982
self.add_cleanup(old.unlock)
1983
for path, ie in old.inventory.iter_entries():
1984
if not tree.has_id(ie.file_id):
1985
self.outf.write(path)
1987
self.outf.write(' ')
1988
self.outf.write(ie.file_id)
1989
self.outf.write('\n')
1992
class cmd_modified(Command):
1993
"""List files modified in working tree.
1997
_see_also = ['status', 'ls']
2000
help='Write an ascii NUL (\\0) separator '
2001
'between files rather than a newline.')
2005
def run(self, null=False):
2006
tree = WorkingTree.open_containing(u'.')[0]
2007
td = tree.changes_from(tree.basis_tree())
2008
for path, id, kind, text_modified, meta_modified in td.modified:
2010
self.outf.write(path + '\0')
2012
self.outf.write(osutils.quotefn(path) + '\n')
2015
class cmd_added(Command):
2016
"""List files added in working tree.
2020
_see_also = ['status', 'ls']
2023
help='Write an ascii NUL (\\0) separator '
2024
'between files rather than a newline.')
2028
def run(self, null=False):
2029
wt = WorkingTree.open_containing(u'.')[0]
2031
self.add_cleanup(wt.unlock)
2032
basis = wt.basis_tree()
2034
self.add_cleanup(basis.unlock)
2035
basis_inv = basis.inventory
2038
if file_id in basis_inv:
2040
if inv.is_root(file_id) and len(basis_inv) == 0:
2042
path = inv.id2path(file_id)
2043
if not os.access(osutils.abspath(path), os.F_OK):
2046
self.outf.write(path + '\0')
2048
self.outf.write(osutils.quotefn(path) + '\n')
2051
class cmd_root(Command):
2052
"""Show the tree root directory.
2054
The root is the nearest enclosing directory with a .bzr control
2057
takes_args = ['filename?']
2059
def run(self, filename=None):
2060
"""Print the branch root."""
2061
tree = WorkingTree.open_containing(filename)[0]
2062
self.outf.write(tree.basedir + '\n')
2065
def _parse_limit(limitstring):
2067
return int(limitstring)
2069
msg = "The limit argument must be an integer."
2070
raise errors.BzrCommandError(msg)
2073
def _parse_levels(s):
2077
msg = "The levels argument must be an integer."
2078
raise errors.BzrCommandError(msg)
2081
class cmd_log(Command):
2082
"""Show historical log for a branch or subset of a branch.
2084
log is bzr's default tool for exploring the history of a branch.
2085
The branch to use is taken from the first parameter. If no parameters
2086
are given, the branch containing the working directory is logged.
2087
Here are some simple examples::
2089
bzr log log the current branch
2090
bzr log foo.py log a file in its branch
2091
bzr log http://server/branch log a branch on a server
2093
The filtering, ordering and information shown for each revision can
2094
be controlled as explained below. By default, all revisions are
2095
shown sorted (topologically) so that newer revisions appear before
2096
older ones and descendants always appear before ancestors. If displayed,
2097
merged revisions are shown indented under the revision in which they
2102
The log format controls how information about each revision is
2103
displayed. The standard log formats are called ``long``, ``short``
2104
and ``line``. The default is long. See ``bzr help log-formats``
2105
for more details on log formats.
2107
The following options can be used to control what information is
2110
-l N display a maximum of N revisions
2111
-n N display N levels of revisions (0 for all, 1 for collapsed)
2112
-v display a status summary (delta) for each revision
2113
-p display a diff (patch) for each revision
2114
--show-ids display revision-ids (and file-ids), not just revnos
2116
Note that the default number of levels to display is a function of the
2117
log format. If the -n option is not used, the standard log formats show
2118
just the top level (mainline).
2120
Status summaries are shown using status flags like A, M, etc. To see
2121
the changes explained using words like ``added`` and ``modified``
2122
instead, use the -vv option.
2126
To display revisions from oldest to newest, use the --forward option.
2127
In most cases, using this option will have little impact on the total
2128
time taken to produce a log, though --forward does not incrementally
2129
display revisions like --reverse does when it can.
2131
:Revision filtering:
2133
The -r option can be used to specify what revision or range of revisions
2134
to filter against. The various forms are shown below::
2136
-rX display revision X
2137
-rX.. display revision X and later
2138
-r..Y display up to and including revision Y
2139
-rX..Y display from X to Y inclusive
2141
See ``bzr help revisionspec`` for details on how to specify X and Y.
2142
Some common examples are given below::
2144
-r-1 show just the tip
2145
-r-10.. show the last 10 mainline revisions
2146
-rsubmit:.. show what's new on this branch
2147
-rancestor:path.. show changes since the common ancestor of this
2148
branch and the one at location path
2149
-rdate:yesterday.. show changes since yesterday
2151
When logging a range of revisions using -rX..Y, log starts at
2152
revision Y and searches back in history through the primary
2153
("left-hand") parents until it finds X. When logging just the
2154
top level (using -n1), an error is reported if X is not found
2155
along the way. If multi-level logging is used (-n0), X may be
2156
a nested merge revision and the log will be truncated accordingly.
2160
If parameters are given and the first one is not a branch, the log
2161
will be filtered to show only those revisions that changed the
2162
nominated files or directories.
2164
Filenames are interpreted within their historical context. To log a
2165
deleted file, specify a revision range so that the file existed at
2166
the end or start of the range.
2168
Historical context is also important when interpreting pathnames of
2169
renamed files/directories. Consider the following example:
2171
* revision 1: add tutorial.txt
2172
* revision 2: modify tutorial.txt
2173
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2177
* ``bzr log guide.txt`` will log the file added in revision 1
2179
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2181
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2182
the original file in revision 2.
2184
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2185
was no file called guide.txt in revision 2.
2187
Renames are always followed by log. By design, there is no need to
2188
explicitly ask for this (and no way to stop logging a file back
2189
until it was last renamed).
2193
The --message option can be used for finding revisions that match a
2194
regular expression in a commit message.
2198
GUI tools and IDEs are often better at exploring history than command
2199
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2200
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2201
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2202
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2204
You may find it useful to add the aliases below to ``bazaar.conf``::
2208
top = log -l10 --line
2211
``bzr tip`` will then show the latest revision while ``bzr top``
2212
will show the last 10 mainline revisions. To see the details of a
2213
particular revision X, ``bzr show -rX``.
2215
If you are interested in looking deeper into a particular merge X,
2216
use ``bzr log -n0 -rX``.
2218
``bzr log -v`` on a branch with lots of history is currently
2219
very slow. A fix for this issue is currently under development.
2220
With or without that fix, it is recommended that a revision range
2221
be given when using the -v option.
2223
bzr has a generic full-text matching plugin, bzr-search, that can be
2224
used to find revisions matching user names, commit messages, etc.
2225
Among other features, this plugin can find all revisions containing
2226
a list of words but not others.
2228
When exploring non-mainline history on large projects with deep
2229
history, the performance of log can be greatly improved by installing
2230
the historycache plugin. This plugin buffers historical information
2231
trading disk space for faster speed.
2233
takes_args = ['file*']
2234
_see_also = ['log-formats', 'revisionspec']
2237
help='Show from oldest to newest.'),
2239
custom_help('verbose',
2240
help='Show files changed in each revision.'),
2244
type=bzrlib.option._parse_revision_str,
2246
help='Show just the specified revision.'
2247
' See also "help revisionspec".'),
2251
help='Number of levels to display - 0 for all, 1 for flat.',
2253
type=_parse_levels),
2256
help='Show revisions whose message matches this '
2257
'regular expression.',
2261
help='Limit the output to the first N revisions.',
2266
help='Show changes made in each revision as a patch.'),
2267
Option('include-merges',
2268
help='Show merged revisions like --levels 0 does.'),
2270
encoding_type = 'replace'
2273
def run(self, file_list=None, timezone='original',
2284
include_merges=False):
2285
from bzrlib.log import (
2287
make_log_request_dict,
2288
_get_info_for_log_files,
2290
direction = (forward and 'forward') or 'reverse'
2295
raise errors.BzrCommandError(
2296
'--levels and --include-merges are mutually exclusive')
2298
if change is not None:
2300
raise errors.RangeInChangeOption()
2301
if revision is not None:
2302
raise errors.BzrCommandError(
2303
'--revision and --change are mutually exclusive')
2308
filter_by_dir = False
2310
# find the file ids to log and check for directory filtering
2311
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2312
revision, file_list)
2313
self.add_cleanup(b.unlock)
2314
for relpath, file_id, kind in file_info_list:
2316
raise errors.BzrCommandError(
2317
"Path unknown at end or start of revision range: %s" %
2319
# If the relpath is the top of the tree, we log everything
2324
file_ids.append(file_id)
2325
filter_by_dir = filter_by_dir or (
2326
kind in ['directory', 'tree-reference'])
2329
# FIXME ? log the current subdir only RBC 20060203
2330
if revision is not None \
2331
and len(revision) > 0 and revision[0].get_branch():
2332
location = revision[0].get_branch()
2335
dir, relpath = bzrdir.BzrDir.open_containing(location)
2336
b = dir.open_branch()
2338
self.add_cleanup(b.unlock)
2339
rev1, rev2 = _get_revision_range(revision, b, self.name())
2341
# Decide on the type of delta & diff filtering to use
2342
# TODO: add an --all-files option to make this configurable & consistent
2350
diff_type = 'partial'
2354
# Build the log formatter
2355
if log_format is None:
2356
log_format = log.log_formatter_registry.get_default(b)
2357
# Make a non-encoding output to include the diffs - bug 328007
2358
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2359
lf = log_format(show_ids=show_ids, to_file=self.outf,
2360
to_exact_file=unencoded_output,
2361
show_timezone=timezone,
2362
delta_format=get_verbosity_level(),
2364
show_advice=levels is None)
2366
# Choose the algorithm for doing the logging. It's annoying
2367
# having multiple code paths like this but necessary until
2368
# the underlying repository format is faster at generating
2369
# deltas or can provide everything we need from the indices.
2370
# The default algorithm - match-using-deltas - works for
2371
# multiple files and directories and is faster for small
2372
# amounts of history (200 revisions say). However, it's too
2373
# slow for logging a single file in a repository with deep
2374
# history, i.e. > 10K revisions. In the spirit of "do no
2375
# evil when adding features", we continue to use the
2376
# original algorithm - per-file-graph - for the "single
2377
# file that isn't a directory without showing a delta" case.
2378
partial_history = revision and b.repository._format.supports_chks
2379
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2380
or delta_type or partial_history)
2382
# Build the LogRequest and execute it
2383
if len(file_ids) == 0:
2385
rqst = make_log_request_dict(
2386
direction=direction, specific_fileids=file_ids,
2387
start_revision=rev1, end_revision=rev2, limit=limit,
2388
message_search=message, delta_type=delta_type,
2389
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2390
Logger(b, rqst).show(lf)
2393
def _get_revision_range(revisionspec_list, branch, command_name):
2394
"""Take the input of a revision option and turn it into a revision range.
2396
It returns RevisionInfo objects which can be used to obtain the rev_id's
2397
of the desired revisions. It does some user input validations.
2399
if revisionspec_list is None:
2402
elif len(revisionspec_list) == 1:
2403
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2404
elif len(revisionspec_list) == 2:
2405
start_spec = revisionspec_list[0]
2406
end_spec = revisionspec_list[1]
2407
if end_spec.get_branch() != start_spec.get_branch():
2408
# b is taken from revision[0].get_branch(), and
2409
# show_log will use its revision_history. Having
2410
# different branches will lead to weird behaviors.
2411
raise errors.BzrCommandError(
2412
"bzr %s doesn't accept two revisions in different"
2413
" branches." % command_name)
2414
rev1 = start_spec.in_history(branch)
2415
# Avoid loading all of history when we know a missing
2416
# end of range means the last revision ...
2417
if end_spec.spec is None:
2418
last_revno, last_revision_id = branch.last_revision_info()
2419
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2421
rev2 = end_spec.in_history(branch)
2423
raise errors.BzrCommandError(
2424
'bzr %s --revision takes one or two values.' % command_name)
2428
def _revision_range_to_revid_range(revision_range):
2431
if revision_range[0] is not None:
2432
rev_id1 = revision_range[0].rev_id
2433
if revision_range[1] is not None:
2434
rev_id2 = revision_range[1].rev_id
2435
return rev_id1, rev_id2
2437
def get_log_format(long=False, short=False, line=False, default='long'):
2438
log_format = default
2442
log_format = 'short'
2448
class cmd_touching_revisions(Command):
2449
"""Return revision-ids which affected a particular file.
2451
A more user-friendly interface is "bzr log FILE".
2455
takes_args = ["filename"]
2458
def run(self, filename):
2459
tree, relpath = WorkingTree.open_containing(filename)
2460
file_id = tree.path2id(relpath)
2463
self.add_cleanup(b.unlock)
2464
touching_revs = log.find_touching_revisions(b, file_id)
2465
for revno, revision_id, what in touching_revs:
2466
self.outf.write("%6d %s\n" % (revno, what))
2469
class cmd_ls(Command):
2470
"""List files in a tree.
2473
_see_also = ['status', 'cat']
2474
takes_args = ['path?']
2478
Option('recursive', short_name='R',
2479
help='Recurse into subdirectories.'),
2481
help='Print paths relative to the root of the branch.'),
2482
Option('unknown', help='Print unknown files.'),
2483
Option('versioned', help='Print versioned files.',
2485
Option('ignored', help='Print ignored files.'),
2487
help='Write an ascii NUL (\\0) separator '
2488
'between files rather than a newline.'),
2490
help='List entries of a particular kind: file, directory, symlink.',
2495
def run(self, revision=None, verbose=False,
2496
recursive=False, from_root=False,
2497
unknown=False, versioned=False, ignored=False,
2498
null=False, kind=None, show_ids=False, path=None):
2500
if kind and kind not in ('file', 'directory', 'symlink'):
2501
raise errors.BzrCommandError('invalid kind specified')
2503
if verbose and null:
2504
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2505
all = not (unknown or versioned or ignored)
2507
selection = {'I':ignored, '?':unknown, 'V':versioned}
2513
raise errors.BzrCommandError('cannot specify both --from-root'
2516
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2519
# Calculate the prefix to use
2523
prefix = relpath + '/'
2524
elif fs_path != '.' and not fs_path.endswith('/'):
2525
prefix = fs_path + '/'
2527
if revision is not None or tree is None:
2528
tree = _get_one_revision_tree('ls', revision, branch=branch)
2531
if isinstance(tree, WorkingTree) and tree.supports_views():
2532
view_files = tree.views.lookup_view()
2535
view_str = views.view_display_str(view_files)
2536
note("Ignoring files outside view. View is %s" % view_str)
2539
self.add_cleanup(tree.unlock)
2540
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2541
from_dir=relpath, recursive=recursive):
2542
# Apply additional masking
2543
if not all and not selection[fc]:
2545
if kind is not None and fkind != kind:
2550
fullpath = osutils.pathjoin(relpath, fp)
2553
views.check_path_in_view(tree, fullpath)
2554
except errors.FileOutsideView:
2559
fp = osutils.pathjoin(prefix, fp)
2560
kindch = entry.kind_character()
2561
outstring = fp + kindch
2562
ui.ui_factory.clear_term()
2564
outstring = '%-8s %s' % (fc, outstring)
2565
if show_ids and fid is not None:
2566
outstring = "%-50s %s" % (outstring, fid)
2567
self.outf.write(outstring + '\n')
2569
self.outf.write(fp + '\0')
2572
self.outf.write(fid)
2573
self.outf.write('\0')
2581
self.outf.write('%-50s %s\n' % (outstring, my_id))
2583
self.outf.write(outstring + '\n')
2586
class cmd_unknowns(Command):
2587
"""List unknown files.
2595
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2596
self.outf.write(osutils.quotefn(f) + '\n')
2599
class cmd_ignore(Command):
2600
"""Ignore specified files or patterns.
2602
See ``bzr help patterns`` for details on the syntax of patterns.
2604
If a .bzrignore file does not exist, the ignore command
2605
will create one and add the specified files or patterns to the newly
2606
created file. The ignore command will also automatically add the
2607
.bzrignore file to be versioned. Creating a .bzrignore file without
2608
the use of the ignore command will require an explicit add command.
2610
To remove patterns from the ignore list, edit the .bzrignore file.
2611
After adding, editing or deleting that file either indirectly by
2612
using this command or directly by using an editor, be sure to commit
2615
Patterns prefixed with '!' are exceptions to ignore patterns and take
2616
precedence over regular ignores. Such exceptions are used to specify
2617
files that should be versioned which would otherwise be ignored.
2619
Patterns prefixed with '!!' act as regular ignore patterns, but have
2620
precedence over the '!' exception patterns.
2622
Note: ignore patterns containing shell wildcards must be quoted from
2626
Ignore the top level Makefile::
2628
bzr ignore ./Makefile
2630
Ignore .class files in all directories...::
2632
bzr ignore "*.class"
2634
...but do not ignore "special.class"::
2636
bzr ignore "!special.class"
2638
Ignore .o files under the lib directory::
2640
bzr ignore "lib/**/*.o"
2642
Ignore .o files under the lib directory::
2644
bzr ignore "RE:lib/.*\.o"
2646
Ignore everything but the "debian" toplevel directory::
2648
bzr ignore "RE:(?!debian/).*"
2650
Ignore everything except the "local" toplevel directory,
2651
but always ignore "*~" autosave files, even under local/::
2654
bzr ignore "!./local"
2658
_see_also = ['status', 'ignored', 'patterns']
2659
takes_args = ['name_pattern*']
2661
Option('old-default-rules',
2662
help='Write out the ignore rules bzr < 0.9 always used.')
2665
def run(self, name_pattern_list=None, old_default_rules=None):
2666
from bzrlib import ignores
2667
if old_default_rules is not None:
2668
# dump the rules and exit
2669
for pattern in ignores.OLD_DEFAULTS:
2672
if not name_pattern_list:
2673
raise errors.BzrCommandError("ignore requires at least one "
2674
"NAME_PATTERN or --old-default-rules")
2675
name_pattern_list = [globbing.normalize_pattern(p)
2676
for p in name_pattern_list]
2677
for name_pattern in name_pattern_list:
2678
if (name_pattern[0] == '/' or
2679
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2680
raise errors.BzrCommandError(
2681
"NAME_PATTERN should not be an absolute path")
2682
tree, relpath = WorkingTree.open_containing(u'.')
2683
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2684
ignored = globbing.Globster(name_pattern_list)
2687
for entry in tree.list_files():
2691
if ignored.match(filename):
2692
matches.append(filename.encode('utf-8'))
2694
if len(matches) > 0:
2695
print "Warning: the following files are version controlled and" \
2696
" match your ignore pattern:\n%s" \
2697
"\nThese files will continue to be version controlled" \
2698
" unless you 'bzr remove' them." % ("\n".join(matches),)
2701
class cmd_ignored(Command):
2702
"""List ignored files and the patterns that matched them.
2704
List all the ignored files and the ignore pattern that caused the file to
2707
Alternatively, to list just the files::
2712
encoding_type = 'replace'
2713
_see_also = ['ignore', 'ls']
2717
tree = WorkingTree.open_containing(u'.')[0]
2719
self.add_cleanup(tree.unlock)
2720
for path, file_class, kind, file_id, entry in tree.list_files():
2721
if file_class != 'I':
2723
## XXX: Slightly inefficient since this was already calculated
2724
pat = tree.is_ignored(path)
2725
self.outf.write('%-50s %s\n' % (path, pat))
2728
class cmd_lookup_revision(Command):
2729
"""Lookup the revision-id from a revision-number
2732
bzr lookup-revision 33
2735
takes_args = ['revno']
2738
def run(self, revno):
2742
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2744
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2747
class cmd_export(Command):
2748
"""Export current or past revision to a destination directory or archive.
2750
If no revision is specified this exports the last committed revision.
2752
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2753
given, try to find the format with the extension. If no extension
2754
is found exports to a directory (equivalent to --format=dir).
2756
If root is supplied, it will be used as the root directory inside
2757
container formats (tar, zip, etc). If it is not supplied it will default
2758
to the exported filename. The root option has no effect for 'dir' format.
2760
If branch is omitted then the branch containing the current working
2761
directory will be used.
2763
Note: Export of tree with non-ASCII filenames to zip is not supported.
2765
================= =========================
2766
Supported formats Autodetected by extension
2767
================= =========================
2770
tbz2 .tar.bz2, .tbz2
2773
================= =========================
2775
takes_args = ['dest', 'branch_or_subdir?']
2778
help="Type of file to export to.",
2781
Option('filters', help='Apply content filters to export the '
2782
'convenient form.'),
2785
help="Name of the root directory inside the exported file."),
2787
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2788
root=None, filters=False):
2789
from bzrlib.export import export
2791
if branch_or_subdir is None:
2792
tree = WorkingTree.open_containing(u'.')[0]
2796
b, subdir = Branch.open_containing(branch_or_subdir)
2799
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2801
export(rev_tree, dest, format, root, subdir, filtered=filters)
2802
except errors.NoSuchExportFormat, e:
2803
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2806
class cmd_cat(Command):
2807
"""Write the contents of a file as of a given revision to standard output.
2809
If no revision is nominated, the last revision is used.
2811
Note: Take care to redirect standard output when using this command on a
2817
Option('name-from-revision', help='The path name in the old tree.'),
2818
Option('filters', help='Apply content filters to display the '
2819
'convenience form.'),
2822
takes_args = ['filename']
2823
encoding_type = 'exact'
2826
def run(self, filename, revision=None, name_from_revision=False,
2828
if revision is not None and len(revision) != 1:
2829
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2830
" one revision specifier")
2831
tree, branch, relpath = \
2832
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2834
self.add_cleanup(branch.unlock)
2835
return self._run(tree, branch, relpath, filename, revision,
2836
name_from_revision, filters)
2838
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2841
tree = b.basis_tree()
2842
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2843
rev_tree.lock_read()
2844
self.add_cleanup(rev_tree.unlock)
2846
old_file_id = rev_tree.path2id(relpath)
2848
if name_from_revision:
2849
# Try in revision if requested
2850
if old_file_id is None:
2851
raise errors.BzrCommandError(
2852
"%r is not present in revision %s" % (
2853
filename, rev_tree.get_revision_id()))
2855
content = rev_tree.get_file_text(old_file_id)
2857
cur_file_id = tree.path2id(relpath)
2859
if cur_file_id is not None:
2860
# Then try with the actual file id
2862
content = rev_tree.get_file_text(cur_file_id)
2864
except errors.NoSuchId:
2865
# The actual file id didn't exist at that time
2867
if not found and old_file_id is not None:
2868
# Finally try with the old file id
2869
content = rev_tree.get_file_text(old_file_id)
2872
# Can't be found anywhere
2873
raise errors.BzrCommandError(
2874
"%r is not present in revision %s" % (
2875
filename, rev_tree.get_revision_id()))
2877
from bzrlib.filters import (
2878
ContentFilterContext,
2879
filtered_output_bytes,
2881
filters = rev_tree._content_filter_stack(relpath)
2882
chunks = content.splitlines(True)
2883
content = filtered_output_bytes(chunks, filters,
2884
ContentFilterContext(relpath, rev_tree))
2886
self.outf.writelines(content)
2889
self.outf.write(content)
2892
class cmd_local_time_offset(Command):
2893
"""Show the offset in seconds from GMT to local time."""
2897
print osutils.local_time_offset()
2901
class cmd_commit(Command):
2902
"""Commit changes into a new revision.
2904
An explanatory message needs to be given for each commit. This is
2905
often done by using the --message option (getting the message from the
2906
command line) or by using the --file option (getting the message from
2907
a file). If neither of these options is given, an editor is opened for
2908
the user to enter the message. To see the changed files in the
2909
boilerplate text loaded into the editor, use the --show-diff option.
2911
By default, the entire tree is committed and the person doing the
2912
commit is assumed to be the author. These defaults can be overridden
2917
If selected files are specified, only changes to those files are
2918
committed. If a directory is specified then the directory and
2919
everything within it is committed.
2921
When excludes are given, they take precedence over selected files.
2922
For example, to commit only changes within foo, but not changes
2925
bzr commit foo -x foo/bar
2927
A selective commit after a merge is not yet supported.
2931
If the author of the change is not the same person as the committer,
2932
you can specify the author's name using the --author option. The
2933
name should be in the same format as a committer-id, e.g.
2934
"John Doe <jdoe@example.com>". If there is more than one author of
2935
the change you can specify the option multiple times, once for each
2940
A common mistake is to forget to add a new file or directory before
2941
running the commit command. The --strict option checks for unknown
2942
files and aborts the commit if any are found. More advanced pre-commit
2943
checks can be implemented by defining hooks. See ``bzr help hooks``
2948
If you accidentially commit the wrong changes or make a spelling
2949
mistake in the commit message say, you can use the uncommit command
2950
to undo it. See ``bzr help uncommit`` for details.
2952
Hooks can also be configured to run after a commit. This allows you
2953
to trigger updates to external systems like bug trackers. The --fixes
2954
option can be used to record the association between a revision and
2955
one or more bugs. See ``bzr help bugs`` for details.
2957
A selective commit may fail in some cases where the committed
2958
tree would be invalid. Consider::
2963
bzr commit foo -m "committing foo"
2964
bzr mv foo/bar foo/baz
2967
bzr commit foo/bar -m "committing bar but not baz"
2969
In the example above, the last commit will fail by design. This gives
2970
the user the opportunity to decide whether they want to commit the
2971
rename at the same time, separately first, or not at all. (As a general
2972
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2974
# TODO: Run hooks on tree to-be-committed, and after commit.
2976
# TODO: Strict commit that fails if there are deleted files.
2977
# (what does "deleted files" mean ??)
2979
# TODO: Give better message for -s, --summary, used by tla people
2981
# XXX: verbose currently does nothing
2983
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2984
takes_args = ['selected*']
2986
ListOption('exclude', type=str, short_name='x',
2987
help="Do not consider changes made to a given path."),
2988
Option('message', type=unicode,
2990
help="Description of the new revision."),
2993
help='Commit even if nothing has changed.'),
2994
Option('file', type=str,
2997
help='Take commit message from this file.'),
2999
help="Refuse to commit if there are unknown "
3000
"files in the working tree."),
3001
Option('commit-time', type=str,
3002
help="Manually set a commit time using commit date "
3003
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3004
ListOption('fixes', type=str,
3005
help="Mark a bug as being fixed by this revision "
3006
"(see \"bzr help bugs\")."),
3007
ListOption('author', type=unicode,
3008
help="Set the author's name, if it's different "
3009
"from the committer."),
3011
help="Perform a local commit in a bound "
3012
"branch. Local commits are not pushed to "
3013
"the master branch until a normal commit "
3017
help='When no message is supplied, show the diff along'
3018
' with the status summary in the message editor.'),
3020
aliases = ['ci', 'checkin']
3022
def _iter_bug_fix_urls(self, fixes, branch):
3023
# Configure the properties for bug fixing attributes.
3024
for fixed_bug in fixes:
3025
tokens = fixed_bug.split(':')
3026
if len(tokens) != 2:
3027
raise errors.BzrCommandError(
3028
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3029
"See \"bzr help bugs\" for more information on this "
3030
"feature.\nCommit refused." % fixed_bug)
3031
tag, bug_id = tokens
3033
yield bugtracker.get_bug_url(tag, branch, bug_id)
3034
except errors.UnknownBugTrackerAbbreviation:
3035
raise errors.BzrCommandError(
3036
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3037
except errors.MalformedBugIdentifier, e:
3038
raise errors.BzrCommandError(
3039
"%s\nCommit refused." % (str(e),))
3041
def run(self, message=None, file=None, verbose=False, selected_list=None,
3042
unchanged=False, strict=False, local=False, fixes=None,
3043
author=None, show_diff=False, exclude=None, commit_time=None):
3044
from bzrlib.errors import (
3049
from bzrlib.msgeditor import (
3050
edit_commit_message_encoded,
3051
generate_commit_message_template,
3052
make_commit_message_template_encoded
3055
commit_stamp = offset = None
3056
if commit_time is not None:
3058
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3059
except ValueError, e:
3060
raise errors.BzrCommandError(
3061
"Could not parse --commit-time: " + str(e))
3063
# TODO: Need a blackbox test for invoking the external editor; may be
3064
# slightly problematic to run this cross-platform.
3066
# TODO: do more checks that the commit will succeed before
3067
# spending the user's valuable time typing a commit message.
3071
tree, selected_list = tree_files(selected_list)
3072
if selected_list == ['']:
3073
# workaround - commit of root of tree should be exactly the same
3074
# as just default commit in that tree, and succeed even though
3075
# selected-file merge commit is not done yet
3080
bug_property = bugtracker.encode_fixes_bug_urls(
3081
self._iter_bug_fix_urls(fixes, tree.branch))
3083
properties['bugs'] = bug_property
3085
if local and not tree.branch.get_bound_location():
3086
raise errors.LocalRequiresBoundBranch()
3088
if message is not None:
3090
file_exists = osutils.lexists(message)
3091
except UnicodeError:
3092
# The commit message contains unicode characters that can't be
3093
# represented in the filesystem encoding, so that can't be a
3098
'The commit message is a file name: "%(f)s".\n'
3099
'(use --file "%(f)s" to take commit message from that file)'
3101
ui.ui_factory.show_warning(warning_msg)
3103
def get_message(commit_obj):
3104
"""Callback to get commit message"""
3105
my_message = message
3106
if my_message is not None and '\r' in my_message:
3107
my_message = my_message.replace('\r\n', '\n')
3108
my_message = my_message.replace('\r', '\n')
3109
if my_message is None and not file:
3110
t = make_commit_message_template_encoded(tree,
3111
selected_list, diff=show_diff,
3112
output_encoding=osutils.get_user_encoding())
3113
start_message = generate_commit_message_template(commit_obj)
3114
my_message = edit_commit_message_encoded(t,
3115
start_message=start_message)
3116
if my_message is None:
3117
raise errors.BzrCommandError("please specify a commit"
3118
" message with either --message or --file")
3119
elif my_message and file:
3120
raise errors.BzrCommandError(
3121
"please specify either --message or --file")
3123
my_message = codecs.open(file, 'rt',
3124
osutils.get_user_encoding()).read()
3125
if my_message == "":
3126
raise errors.BzrCommandError("empty commit message specified")
3129
# The API permits a commit with a filter of [] to mean 'select nothing'
3130
# but the command line should not do that.
3131
if not selected_list:
3132
selected_list = None
3134
tree.commit(message_callback=get_message,
3135
specific_files=selected_list,
3136
allow_pointless=unchanged, strict=strict, local=local,
3137
reporter=None, verbose=verbose, revprops=properties,
3138
authors=author, timestamp=commit_stamp,
3140
exclude=safe_relpath_files(tree, exclude))
3141
except PointlessCommit:
3142
# FIXME: This should really happen before the file is read in;
3143
# perhaps prepare the commit; get the message; then actually commit
3144
raise errors.BzrCommandError("No changes to commit."
3145
" Use --unchanged to commit anyhow.")
3146
except ConflictsInTree:
3147
raise errors.BzrCommandError('Conflicts detected in working '
3148
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3150
except StrictCommitFailed:
3151
raise errors.BzrCommandError("Commit refused because there are"
3152
" unknown files in the working tree.")
3153
except errors.BoundBranchOutOfDate, e:
3154
raise errors.BzrCommandError(str(e) + "\n"
3155
'To commit to master branch, run update and then commit.\n'
3156
'You can also pass --local to commit to continue working '
3160
class cmd_check(Command):
3161
"""Validate working tree structure, branch consistency and repository history.
3163
This command checks various invariants about branch and repository storage
3164
to detect data corruption or bzr bugs.
3166
The working tree and branch checks will only give output if a problem is
3167
detected. The output fields of the repository check are:
3170
This is just the number of revisions checked. It doesn't
3174
This is just the number of versionedfiles checked. It
3175
doesn't indicate a problem.
3177
unreferenced ancestors
3178
Texts that are ancestors of other texts, but
3179
are not properly referenced by the revision ancestry. This is a
3180
subtle problem that Bazaar can work around.
3183
This is the total number of unique file contents
3184
seen in the checked revisions. It does not indicate a problem.
3187
This is the total number of repeated texts seen
3188
in the checked revisions. Texts can be repeated when their file
3189
entries are modified, but the file contents are not. It does not
3192
If no restrictions are specified, all Bazaar data that is found at the given
3193
location will be checked.
3197
Check the tree and branch at 'foo'::
3199
bzr check --tree --branch foo
3201
Check only the repository at 'bar'::
3203
bzr check --repo bar
3205
Check everything at 'baz'::
3210
_see_also = ['reconcile']
3211
takes_args = ['path?']
3212
takes_options = ['verbose',
3213
Option('branch', help="Check the branch related to the"
3214
" current directory."),
3215
Option('repo', help="Check the repository related to the"
3216
" current directory."),
3217
Option('tree', help="Check the working tree related to"
3218
" the current directory.")]
3220
def run(self, path=None, verbose=False, branch=False, repo=False,
3222
from bzrlib.check import check_dwim
3225
if not branch and not repo and not tree:
3226
branch = repo = tree = True
3227
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3230
class cmd_upgrade(Command):
3231
"""Upgrade branch storage to current format.
3233
The check command or bzr developers may sometimes advise you to run
3234
this command. When the default format has changed you may also be warned
3235
during other operations to upgrade.
3238
_see_also = ['check']
3239
takes_args = ['url?']
3241
RegistryOption('format',
3242
help='Upgrade to a specific format. See "bzr help'
3243
' formats" for details.',
3244
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3245
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3246
value_switches=True, title='Branch format'),
3249
def run(self, url='.', format=None):
3250
from bzrlib.upgrade import upgrade
3251
upgrade(url, format)
3254
class cmd_whoami(Command):
3255
"""Show or set bzr user id.
3258
Show the email of the current user::
3262
Set the current user::
3264
bzr whoami "Frank Chu <fchu@example.com>"
3266
takes_options = [ Option('email',
3267
help='Display email address only.'),
3269
help='Set identity for the current branch instead of '
3272
takes_args = ['name?']
3273
encoding_type = 'replace'
3276
def run(self, email=False, branch=False, name=None):
3278
# use branch if we're inside one; otherwise global config
3280
c = Branch.open_containing('.')[0].get_config()
3281
except errors.NotBranchError:
3282
c = config.GlobalConfig()
3284
self.outf.write(c.user_email() + '\n')
3286
self.outf.write(c.username() + '\n')
3289
# display a warning if an email address isn't included in the given name.
3291
config.extract_email_address(name)
3292
except errors.NoEmailInUsername, e:
3293
warning('"%s" does not seem to contain an email address. '
3294
'This is allowed, but not recommended.', name)
3296
# use global config unless --branch given
3298
c = Branch.open_containing('.')[0].get_config()
3300
c = config.GlobalConfig()
3301
c.set_user_option('email', name)
3304
class cmd_nick(Command):
3305
"""Print or set the branch nickname.
3307
If unset, the tree root directory name is used as the nickname.
3308
To print the current nickname, execute with no argument.
3310
Bound branches use the nickname of its master branch unless it is set
3314
_see_also = ['info']
3315
takes_args = ['nickname?']
3316
def run(self, nickname=None):
3317
branch = Branch.open_containing(u'.')[0]
3318
if nickname is None:
3319
self.printme(branch)
3321
branch.nick = nickname
3324
def printme(self, branch):
3328
class cmd_alias(Command):
3329
"""Set/unset and display aliases.
3332
Show the current aliases::
3336
Show the alias specified for 'll'::
3340
Set an alias for 'll'::
3342
bzr alias ll="log --line -r-10..-1"
3344
To remove an alias for 'll'::
3346
bzr alias --remove ll
3349
takes_args = ['name?']
3351
Option('remove', help='Remove the alias.'),
3354
def run(self, name=None, remove=False):
3356
self.remove_alias(name)
3358
self.print_aliases()
3360
equal_pos = name.find('=')
3362
self.print_alias(name)
3364
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3366
def remove_alias(self, alias_name):
3367
if alias_name is None:
3368
raise errors.BzrCommandError(
3369
'bzr alias --remove expects an alias to remove.')
3370
# If alias is not found, print something like:
3371
# unalias: foo: not found
3372
c = config.GlobalConfig()
3373
c.unset_alias(alias_name)
3376
def print_aliases(self):
3377
"""Print out the defined aliases in a similar format to bash."""
3378
aliases = config.GlobalConfig().get_aliases()
3379
for key, value in sorted(aliases.iteritems()):
3380
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3383
def print_alias(self, alias_name):
3384
from bzrlib.commands import get_alias
3385
alias = get_alias(alias_name)
3387
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3390
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3392
def set_alias(self, alias_name, alias_command):
3393
"""Save the alias in the global config."""
3394
c = config.GlobalConfig()
3395
c.set_alias(alias_name, alias_command)
3398
class cmd_selftest(Command):
3399
"""Run internal test suite.
3401
If arguments are given, they are regular expressions that say which tests
3402
should run. Tests matching any expression are run, and other tests are
3405
Alternatively if --first is given, matching tests are run first and then
3406
all other tests are run. This is useful if you have been working in a
3407
particular area, but want to make sure nothing else was broken.
3409
If --exclude is given, tests that match that regular expression are
3410
excluded, regardless of whether they match --first or not.
3412
To help catch accidential dependencies between tests, the --randomize
3413
option is useful. In most cases, the argument used is the word 'now'.
3414
Note that the seed used for the random number generator is displayed
3415
when this option is used. The seed can be explicitly passed as the
3416
argument to this option if required. This enables reproduction of the
3417
actual ordering used if and when an order sensitive problem is encountered.
3419
If --list-only is given, the tests that would be run are listed. This is
3420
useful when combined with --first, --exclude and/or --randomize to
3421
understand their impact. The test harness reports "Listed nn tests in ..."
3422
instead of "Ran nn tests in ..." when list mode is enabled.
3424
If the global option '--no-plugins' is given, plugins are not loaded
3425
before running the selftests. This has two effects: features provided or
3426
modified by plugins will not be tested, and tests provided by plugins will
3429
Tests that need working space on disk use a common temporary directory,
3430
typically inside $TMPDIR or /tmp.
3432
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3433
into a pdb postmortem session.
3436
Run only tests relating to 'ignore'::
3440
Disable plugins and list tests as they're run::
3442
bzr --no-plugins selftest -v
3444
# NB: this is used from the class without creating an instance, which is
3445
# why it does not have a self parameter.
3446
def get_transport_type(typestring):
3447
"""Parse and return a transport specifier."""
3448
if typestring == "sftp":
3449
from bzrlib.tests import stub_sftp
3450
return stub_sftp.SFTPAbsoluteServer
3451
if typestring == "memory":
3452
from bzrlib.tests import test_server
3453
return memory.MemoryServer
3454
if typestring == "fakenfs":
3455
from bzrlib.tests import test_server
3456
return test_server.FakeNFSServer
3457
msg = "No known transport type %s. Supported types are: sftp\n" %\
3459
raise errors.BzrCommandError(msg)
3462
takes_args = ['testspecs*']
3463
takes_options = ['verbose',
3465
help='Stop when one test fails.',
3469
help='Use a different transport by default '
3470
'throughout the test suite.',
3471
type=get_transport_type),
3473
help='Run the benchmarks rather than selftests.'),
3474
Option('lsprof-timed',
3475
help='Generate lsprof output for benchmarked'
3476
' sections of code.'),
3477
Option('lsprof-tests',
3478
help='Generate lsprof output for each test.'),
3479
Option('cache-dir', type=str,
3480
help='Cache intermediate benchmark output in this '
3483
help='Run all tests, but run specified tests first.',
3487
help='List the tests instead of running them.'),
3488
RegistryOption('parallel',
3489
help="Run the test suite in parallel.",
3490
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3491
value_switches=False,
3493
Option('randomize', type=str, argname="SEED",
3494
help='Randomize the order of tests using the given'
3495
' seed or "now" for the current time.'),
3496
Option('exclude', type=str, argname="PATTERN",
3498
help='Exclude tests that match this regular'
3501
help='Output test progress via subunit.'),
3502
Option('strict', help='Fail on missing dependencies or '
3504
Option('load-list', type=str, argname='TESTLISTFILE',
3505
help='Load a test id list from a text file.'),
3506
ListOption('debugflag', type=str, short_name='E',
3507
help='Turn on a selftest debug flag.'),
3508
ListOption('starting-with', type=str, argname='TESTID',
3509
param_name='starting_with', short_name='s',
3511
'Load only the tests starting with TESTID.'),
3513
encoding_type = 'replace'
3516
Command.__init__(self)
3517
self.additional_selftest_args = {}
3519
def run(self, testspecs_list=None, verbose=False, one=False,
3520
transport=None, benchmark=None,
3521
lsprof_timed=None, cache_dir=None,
3522
first=False, list_only=False,
3523
randomize=None, exclude=None, strict=False,
3524
load_list=None, debugflag=None, starting_with=None, subunit=False,
3525
parallel=None, lsprof_tests=False):
3526
from bzrlib.tests import selftest
3527
import bzrlib.benchmarks as benchmarks
3528
from bzrlib.benchmarks import tree_creator
3530
# Make deprecation warnings visible, unless -Werror is set
3531
symbol_versioning.activate_deprecation_warnings(override=False)
3533
if cache_dir is not None:
3534
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3535
if testspecs_list is not None:
3536
pattern = '|'.join(testspecs_list)
3541
from bzrlib.tests import SubUnitBzrRunner
3543
raise errors.BzrCommandError("subunit not available. subunit "
3544
"needs to be installed to use --subunit.")
3545
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3547
self.additional_selftest_args.setdefault(
3548
'suite_decorators', []).append(parallel)
3550
test_suite_factory = benchmarks.test_suite
3551
# Unless user explicitly asks for quiet, be verbose in benchmarks
3552
verbose = not is_quiet()
3553
# TODO: should possibly lock the history file...
3554
benchfile = open(".perf_history", "at", buffering=1)
3555
self.add_cleanup(benchfile.close)
3557
test_suite_factory = None
3559
selftest_kwargs = {"verbose": verbose,
3561
"stop_on_failure": one,
3562
"transport": transport,
3563
"test_suite_factory": test_suite_factory,
3564
"lsprof_timed": lsprof_timed,
3565
"lsprof_tests": lsprof_tests,
3566
"bench_history": benchfile,
3567
"matching_tests_first": first,
3568
"list_only": list_only,
3569
"random_seed": randomize,
3570
"exclude_pattern": exclude,
3572
"load_list": load_list,
3573
"debug_flags": debugflag,
3574
"starting_with": starting_with
3576
selftest_kwargs.update(self.additional_selftest_args)
3577
result = selftest(**selftest_kwargs)
3578
return int(not result)
3581
class cmd_version(Command):
3582
"""Show version of bzr."""
3584
encoding_type = 'replace'
3586
Option("short", help="Print just the version number."),
3590
def run(self, short=False):
3591
from bzrlib.version import show_version
3593
self.outf.write(bzrlib.version_string + '\n')
3595
show_version(to_file=self.outf)
3598
class cmd_rocks(Command):
3599
"""Statement of optimism."""
3605
print "It sure does!"
3608
class cmd_find_merge_base(Command):
3609
"""Find and print a base revision for merging two branches."""
3610
# TODO: Options to specify revisions on either side, as if
3611
# merging only part of the history.
3612
takes_args = ['branch', 'other']
3616
def run(self, branch, other):
3617
from bzrlib.revision import ensure_null
3619
branch1 = Branch.open_containing(branch)[0]
3620
branch2 = Branch.open_containing(other)[0]
3622
self.add_cleanup(branch1.unlock)
3624
self.add_cleanup(branch2.unlock)
3625
last1 = ensure_null(branch1.last_revision())
3626
last2 = ensure_null(branch2.last_revision())
3628
graph = branch1.repository.get_graph(branch2.repository)
3629
base_rev_id = graph.find_unique_lca(last1, last2)
3631
print 'merge base is revision %s' % base_rev_id
3634
class cmd_merge(Command):
3635
"""Perform a three-way merge.
3637
The source of the merge can be specified either in the form of a branch,
3638
or in the form of a path to a file containing a merge directive generated
3639
with bzr send. If neither is specified, the default is the upstream branch
3640
or the branch most recently merged using --remember.
3642
When merging a branch, by default the tip will be merged. To pick a different
3643
revision, pass --revision. If you specify two values, the first will be used as
3644
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3645
available revisions, like this is commonly referred to as "cherrypicking".
3647
Revision numbers are always relative to the branch being merged.
3649
By default, bzr will try to merge in all new work from the other
3650
branch, automatically determining an appropriate base. If this
3651
fails, you may need to give an explicit base.
3653
Merge will do its best to combine the changes in two branches, but there
3654
are some kinds of problems only a human can fix. When it encounters those,
3655
it will mark a conflict. A conflict means that you need to fix something,
3656
before you should commit.
3658
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3660
If there is no default branch set, the first merge will set it. After
3661
that, you can omit the branch to use the default. To change the
3662
default, use --remember. The value will only be saved if the remote
3663
location can be accessed.
3665
The results of the merge are placed into the destination working
3666
directory, where they can be reviewed (with bzr diff), tested, and then
3667
committed to record the result of the merge.
3669
merge refuses to run if there are any uncommitted changes, unless
3670
--force is given. The --force option can also be used to create a
3671
merge revision which has more than two parents.
3673
If one would like to merge changes from the working tree of the other
3674
branch without merging any committed revisions, the --uncommitted option
3677
To select only some changes to merge, use "merge -i", which will prompt
3678
you to apply each diff hunk and file change, similar to "shelve".
3681
To merge the latest revision from bzr.dev::
3683
bzr merge ../bzr.dev
3685
To merge changes up to and including revision 82 from bzr.dev::
3687
bzr merge -r 82 ../bzr.dev
3689
To merge the changes introduced by 82, without previous changes::
3691
bzr merge -r 81..82 ../bzr.dev
3693
To apply a merge directive contained in /tmp/merge::
3695
bzr merge /tmp/merge
3697
To create a merge revision with three parents from two branches
3698
feature1a and feature1b:
3700
bzr merge ../feature1a
3701
bzr merge ../feature1b --force
3702
bzr commit -m 'revision with three parents'
3705
encoding_type = 'exact'
3706
_see_also = ['update', 'remerge', 'status-flags', 'send']
3707
takes_args = ['location?']
3712
help='Merge even if the destination tree has uncommitted changes.'),
3716
Option('show-base', help="Show base revision text in "
3718
Option('uncommitted', help='Apply uncommitted changes'
3719
' from a working copy, instead of branch changes.'),
3720
Option('pull', help='If the destination is already'
3721
' completely merged into the source, pull from the'
3722
' source rather than merging. When this happens,'
3723
' you do not need to commit the result.'),
3725
help='Branch to merge into, '
3726
'rather than the one containing the working directory.',
3730
Option('preview', help='Instead of merging, show a diff of the'
3732
Option('interactive', help='Select changes interactively.',
3736
def run(self, location=None, revision=None, force=False,
3737
merge_type=None, show_base=False, reprocess=None, remember=False,
3738
uncommitted=False, pull=False,
3743
if merge_type is None:
3744
merge_type = _mod_merge.Merge3Merger
3746
if directory is None: directory = u'.'
3747
possible_transports = []
3749
allow_pending = True
3750
verified = 'inapplicable'
3751
tree = WorkingTree.open_containing(directory)[0]
3754
basis_tree = tree.revision_tree(tree.last_revision())
3755
except errors.NoSuchRevision:
3756
basis_tree = tree.basis_tree()
3758
# die as quickly as possible if there are uncommitted changes
3760
if tree.has_changes():
3761
raise errors.UncommittedChanges(tree)
3763
view_info = _get_view_info_for_change_reporter(tree)
3764
change_reporter = delta._ChangeReporter(
3765
unversioned_filter=tree.is_ignored, view_info=view_info)
3766
pb = ui.ui_factory.nested_progress_bar()
3767
self.add_cleanup(pb.finished)
3769
self.add_cleanup(tree.unlock)
3770
if location is not None:
3772
mergeable = bundle.read_mergeable_from_url(location,
3773
possible_transports=possible_transports)
3774
except errors.NotABundle:
3778
raise errors.BzrCommandError('Cannot use --uncommitted'
3779
' with bundles or merge directives.')
3781
if revision is not None:
3782
raise errors.BzrCommandError(
3783
'Cannot use -r with merge directives or bundles')
3784
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3787
if merger is None and uncommitted:
3788
if revision is not None and len(revision) > 0:
3789
raise errors.BzrCommandError('Cannot use --uncommitted and'
3790
' --revision at the same time.')
3791
merger = self.get_merger_from_uncommitted(tree, location, None)
3792
allow_pending = False
3795
merger, allow_pending = self._get_merger_from_branch(tree,
3796
location, revision, remember, possible_transports, None)
3798
merger.merge_type = merge_type
3799
merger.reprocess = reprocess
3800
merger.show_base = show_base
3801
self.sanity_check_merger(merger)
3802
if (merger.base_rev_id == merger.other_rev_id and
3803
merger.other_rev_id is not None):
3804
note('Nothing to do.')
3807
if merger.interesting_files is not None:
3808
raise errors.BzrCommandError('Cannot pull individual files')
3809
if (merger.base_rev_id == tree.last_revision()):
3810
result = tree.pull(merger.other_branch, False,
3811
merger.other_rev_id)
3812
result.report(self.outf)
3814
if merger.this_basis is None:
3815
raise errors.BzrCommandError(
3816
"This branch has no commits."
3817
" (perhaps you would prefer 'bzr pull')")
3819
return self._do_preview(merger)
3821
return self._do_interactive(merger)
3823
return self._do_merge(merger, change_reporter, allow_pending,
3826
def _get_preview(self, merger):
3827
tree_merger = merger.make_merger()
3828
tt = tree_merger.make_preview_transform()
3829
self.add_cleanup(tt.finalize)
3830
result_tree = tt.get_preview_tree()
3833
def _do_preview(self, merger):
3834
from bzrlib.diff import show_diff_trees
3835
result_tree = self._get_preview(merger)
3836
show_diff_trees(merger.this_tree, result_tree, self.outf,
3837
old_label='', new_label='')
3839
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3840
merger.change_reporter = change_reporter
3841
conflict_count = merger.do_merge()
3843
merger.set_pending()
3844
if verified == 'failed':
3845
warning('Preview patch does not match changes')
3846
if conflict_count != 0:
3851
def _do_interactive(self, merger):
3852
"""Perform an interactive merge.
3854
This works by generating a preview tree of the merge, then using
3855
Shelver to selectively remove the differences between the working tree
3856
and the preview tree.
3858
from bzrlib import shelf_ui
3859
result_tree = self._get_preview(merger)
3860
writer = bzrlib.option.diff_writer_registry.get()
3861
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3862
reporter=shelf_ui.ApplyReporter(),
3863
diff_writer=writer(sys.stdout))
3869
def sanity_check_merger(self, merger):
3870
if (merger.show_base and
3871
not merger.merge_type is _mod_merge.Merge3Merger):
3872
raise errors.BzrCommandError("Show-base is not supported for this"
3873
" merge type. %s" % merger.merge_type)
3874
if merger.reprocess is None:
3875
if merger.show_base:
3876
merger.reprocess = False
3878
# Use reprocess if the merger supports it
3879
merger.reprocess = merger.merge_type.supports_reprocess
3880
if merger.reprocess and not merger.merge_type.supports_reprocess:
3881
raise errors.BzrCommandError("Conflict reduction is not supported"
3882
" for merge type %s." %
3884
if merger.reprocess and merger.show_base:
3885
raise errors.BzrCommandError("Cannot do conflict reduction and"
3888
def _get_merger_from_branch(self, tree, location, revision, remember,
3889
possible_transports, pb):
3890
"""Produce a merger from a location, assuming it refers to a branch."""
3891
from bzrlib.tag import _merge_tags_if_possible
3892
# find the branch locations
3893
other_loc, user_location = self._select_branch_location(tree, location,
3895
if revision is not None and len(revision) == 2:
3896
base_loc, _unused = self._select_branch_location(tree,
3897
location, revision, 0)
3899
base_loc = other_loc
3901
other_branch, other_path = Branch.open_containing(other_loc,
3902
possible_transports)
3903
if base_loc == other_loc:
3904
base_branch = other_branch
3906
base_branch, base_path = Branch.open_containing(base_loc,
3907
possible_transports)
3908
# Find the revision ids
3909
other_revision_id = None
3910
base_revision_id = None
3911
if revision is not None:
3912
if len(revision) >= 1:
3913
other_revision_id = revision[-1].as_revision_id(other_branch)
3914
if len(revision) == 2:
3915
base_revision_id = revision[0].as_revision_id(base_branch)
3916
if other_revision_id is None:
3917
other_revision_id = _mod_revision.ensure_null(
3918
other_branch.last_revision())
3919
# Remember where we merge from
3920
if ((remember or tree.branch.get_submit_branch() is None) and
3921
user_location is not None):
3922
tree.branch.set_submit_branch(other_branch.base)
3923
_merge_tags_if_possible(other_branch, tree.branch)
3924
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3925
other_revision_id, base_revision_id, other_branch, base_branch)
3926
if other_path != '':
3927
allow_pending = False
3928
merger.interesting_files = [other_path]
3930
allow_pending = True
3931
return merger, allow_pending
3933
def get_merger_from_uncommitted(self, tree, location, pb):
3934
"""Get a merger for uncommitted changes.
3936
:param tree: The tree the merger should apply to.
3937
:param location: The location containing uncommitted changes.
3938
:param pb: The progress bar to use for showing progress.
3940
location = self._select_branch_location(tree, location)[0]
3941
other_tree, other_path = WorkingTree.open_containing(location)
3942
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3943
if other_path != '':
3944
merger.interesting_files = [other_path]
3947
def _select_branch_location(self, tree, user_location, revision=None,
3949
"""Select a branch location, according to possible inputs.
3951
If provided, branches from ``revision`` are preferred. (Both
3952
``revision`` and ``index`` must be supplied.)
3954
Otherwise, the ``location`` parameter is used. If it is None, then the
3955
``submit`` or ``parent`` location is used, and a note is printed.
3957
:param tree: The working tree to select a branch for merging into
3958
:param location: The location entered by the user
3959
:param revision: The revision parameter to the command
3960
:param index: The index to use for the revision parameter. Negative
3961
indices are permitted.
3962
:return: (selected_location, user_location). The default location
3963
will be the user-entered location.
3965
if (revision is not None and index is not None
3966
and revision[index] is not None):
3967
branch = revision[index].get_branch()
3968
if branch is not None:
3969
return branch, branch
3970
if user_location is None:
3971
location = self._get_remembered(tree, 'Merging from')
3973
location = user_location
3974
return location, user_location
3976
def _get_remembered(self, tree, verb_string):
3977
"""Use tree.branch's parent if none was supplied.
3979
Report if the remembered location was used.
3981
stored_location = tree.branch.get_submit_branch()
3982
stored_location_type = "submit"
3983
if stored_location is None:
3984
stored_location = tree.branch.get_parent()
3985
stored_location_type = "parent"
3986
mutter("%s", stored_location)
3987
if stored_location is None:
3988
raise errors.BzrCommandError("No location specified or remembered")
3989
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3990
note(u"%s remembered %s location %s", verb_string,
3991
stored_location_type, display_url)
3992
return stored_location
3995
class cmd_remerge(Command):
3998
Use this if you want to try a different merge technique while resolving
3999
conflicts. Some merge techniques are better than others, and remerge
4000
lets you try different ones on different files.
4002
The options for remerge have the same meaning and defaults as the ones for
4003
merge. The difference is that remerge can (only) be run when there is a
4004
pending merge, and it lets you specify particular files.
4007
Re-do the merge of all conflicted files, and show the base text in
4008
conflict regions, in addition to the usual THIS and OTHER texts::
4010
bzr remerge --show-base
4012
Re-do the merge of "foobar", using the weave merge algorithm, with
4013
additional processing to reduce the size of conflict regions::
4015
bzr remerge --merge-type weave --reprocess foobar
4017
takes_args = ['file*']
4022
help="Show base revision text in conflicts."),
4025
def run(self, file_list=None, merge_type=None, show_base=False,
4027
if merge_type is None:
4028
merge_type = _mod_merge.Merge3Merger
4029
tree, file_list = tree_files(file_list)
4031
self.add_cleanup(tree.unlock)
4032
parents = tree.get_parent_ids()
4033
if len(parents) != 2:
4034
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4035
" merges. Not cherrypicking or"
4037
repository = tree.branch.repository
4038
interesting_ids = None
4040
conflicts = tree.conflicts()
4041
if file_list is not None:
4042
interesting_ids = set()
4043
for filename in file_list:
4044
file_id = tree.path2id(filename)
4046
raise errors.NotVersionedError(filename)
4047
interesting_ids.add(file_id)
4048
if tree.kind(file_id) != "directory":
4051
for name, ie in tree.inventory.iter_entries(file_id):
4052
interesting_ids.add(ie.file_id)
4053
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4055
# Remerge only supports resolving contents conflicts
4056
allowed_conflicts = ('text conflict', 'contents conflict')
4057
restore_files = [c.path for c in conflicts
4058
if c.typestring in allowed_conflicts]
4059
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4060
tree.set_conflicts(ConflictList(new_conflicts))
4061
if file_list is not None:
4062
restore_files = file_list
4063
for filename in restore_files:
4065
restore(tree.abspath(filename))
4066
except errors.NotConflicted:
4068
# Disable pending merges, because the file texts we are remerging
4069
# have not had those merges performed. If we use the wrong parents
4070
# list, we imply that the working tree text has seen and rejected
4071
# all the changes from the other tree, when in fact those changes
4072
# have not yet been seen.
4073
tree.set_parent_ids(parents[:1])
4075
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4076
merger.interesting_ids = interesting_ids
4077
merger.merge_type = merge_type
4078
merger.show_base = show_base
4079
merger.reprocess = reprocess
4080
conflicts = merger.do_merge()
4082
tree.set_parent_ids(parents)
4089
class cmd_revert(Command):
4090
"""Revert files to a previous revision.
4092
Giving a list of files will revert only those files. Otherwise, all files
4093
will be reverted. If the revision is not specified with '--revision', the
4094
last committed revision is used.
4096
To remove only some changes, without reverting to a prior version, use
4097
merge instead. For example, "merge . --revision -2..-3" will remove the
4098
changes introduced by -2, without affecting the changes introduced by -1.
4099
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4101
By default, any files that have been manually changed will be backed up
4102
first. (Files changed only by merge are not backed up.) Backup files have
4103
'.~#~' appended to their name, where # is a number.
4105
When you provide files, you can use their current pathname or the pathname
4106
from the target revision. So you can use revert to "undelete" a file by
4107
name. If you name a directory, all the contents of that directory will be
4110
If you have newly added files since the target revision, they will be
4111
removed. If the files to be removed have been changed, backups will be
4112
created as above. Directories containing unknown files will not be
4115
The working tree contains a list of revisions that have been merged but
4116
not yet committed. These revisions will be included as additional parents
4117
of the next commit. Normally, using revert clears that list as well as
4118
reverting the files. If any files are specified, revert leaves the list
4119
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4120
.`` in the tree root to revert all files but keep the recorded merges,
4121
and ``bzr revert --forget-merges`` to clear the pending merge list without
4122
reverting any files.
4124
Using "bzr revert --forget-merges", it is possible to apply all of the
4125
changes from a branch in a single revision. To do this, perform the merge
4126
as desired. Then doing revert with the "--forget-merges" option will keep
4127
the content of the tree as it was, but it will clear the list of pending
4128
merges. The next commit will then contain all of the changes that are
4129
present in the other branch, but without any other parent revisions.
4130
Because this technique forgets where these changes originated, it may
4131
cause additional conflicts on later merges involving the same source and
4135
_see_also = ['cat', 'export']
4138
Option('no-backup', "Do not save backups of reverted files."),
4139
Option('forget-merges',
4140
'Remove pending merge marker, without changing any files.'),
4142
takes_args = ['file*']
4144
def run(self, revision=None, no_backup=False, file_list=None,
4145
forget_merges=None):
4146
tree, file_list = tree_files(file_list)
4148
self.add_cleanup(tree.unlock)
4150
tree.set_parent_ids(tree.get_parent_ids()[:1])
4152
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4155
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4156
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4157
tree.revert(file_list, rev_tree, not no_backup, None,
4158
report_changes=True)
4161
class cmd_assert_fail(Command):
4162
"""Test reporting of assertion failures"""
4163
# intended just for use in testing
4168
raise AssertionError("always fails")
4171
class cmd_help(Command):
4172
"""Show help on a command or other topic.
4175
_see_also = ['topics']
4177
Option('long', 'Show help on all commands.'),
4179
takes_args = ['topic?']
4180
aliases = ['?', '--help', '-?', '-h']
4183
def run(self, topic=None, long=False):
4185
if topic is None and long:
4187
bzrlib.help.help(topic)
4190
class cmd_shell_complete(Command):
4191
"""Show appropriate completions for context.
4193
For a list of all available commands, say 'bzr shell-complete'.
4195
takes_args = ['context?']
4200
def run(self, context=None):
4201
import shellcomplete
4202
shellcomplete.shellcomplete(context)
4205
class cmd_missing(Command):
4206
"""Show unmerged/unpulled revisions between two branches.
4208
OTHER_BRANCH may be local or remote.
4210
To filter on a range of revisions, you can use the command -r begin..end
4211
-r revision requests a specific revision, -r ..end or -r begin.. are
4215
1 - some missing revisions
4216
0 - no missing revisions
4220
Determine the missing revisions between this and the branch at the
4221
remembered pull location::
4225
Determine the missing revisions between this and another branch::
4227
bzr missing http://server/branch
4229
Determine the missing revisions up to a specific revision on the other
4232
bzr missing -r ..-10
4234
Determine the missing revisions up to a specific revision on this
4237
bzr missing --my-revision ..-10
4240
_see_also = ['merge', 'pull']
4241
takes_args = ['other_branch?']
4243
Option('reverse', 'Reverse the order of revisions.'),
4245
'Display changes in the local branch only.'),
4246
Option('this' , 'Same as --mine-only.'),
4247
Option('theirs-only',
4248
'Display changes in the remote branch only.'),
4249
Option('other', 'Same as --theirs-only.'),
4253
custom_help('revision',
4254
help='Filter on other branch revisions (inclusive). '
4255
'See "help revisionspec" for details.'),
4256
Option('my-revision',
4257
type=_parse_revision_str,
4258
help='Filter on local branch revisions (inclusive). '
4259
'See "help revisionspec" for details.'),
4260
Option('include-merges',
4261
'Show all revisions in addition to the mainline ones.'),
4263
encoding_type = 'replace'
4266
def run(self, other_branch=None, reverse=False, mine_only=False,
4268
log_format=None, long=False, short=False, line=False,
4269
show_ids=False, verbose=False, this=False, other=False,
4270
include_merges=False, revision=None, my_revision=None):
4271
from bzrlib.missing import find_unmerged, iter_log_revisions
4280
# TODO: We should probably check that we don't have mine-only and
4281
# theirs-only set, but it gets complicated because we also have
4282
# this and other which could be used.
4289
local_branch = Branch.open_containing(u".")[0]
4290
parent = local_branch.get_parent()
4291
if other_branch is None:
4292
other_branch = parent
4293
if other_branch is None:
4294
raise errors.BzrCommandError("No peer location known"
4296
display_url = urlutils.unescape_for_display(parent,
4298
message("Using saved parent location: "
4299
+ display_url + "\n")
4301
remote_branch = Branch.open(other_branch)
4302
if remote_branch.base == local_branch.base:
4303
remote_branch = local_branch
4305
local_branch.lock_read()
4306
self.add_cleanup(local_branch.unlock)
4307
local_revid_range = _revision_range_to_revid_range(
4308
_get_revision_range(my_revision, local_branch,
4311
remote_branch.lock_read()
4312
self.add_cleanup(remote_branch.unlock)
4313
remote_revid_range = _revision_range_to_revid_range(
4314
_get_revision_range(revision,
4315
remote_branch, self.name()))
4317
local_extra, remote_extra = find_unmerged(
4318
local_branch, remote_branch, restrict,
4319
backward=not reverse,
4320
include_merges=include_merges,
4321
local_revid_range=local_revid_range,
4322
remote_revid_range=remote_revid_range)
4324
if log_format is None:
4325
registry = log.log_formatter_registry
4326
log_format = registry.get_default(local_branch)
4327
lf = log_format(to_file=self.outf,
4329
show_timezone='original')
4332
if local_extra and not theirs_only:
4333
message("You have %d extra revision(s):\n" %
4335
for revision in iter_log_revisions(local_extra,
4336
local_branch.repository,
4338
lf.log_revision(revision)
4339
printed_local = True
4342
printed_local = False
4344
if remote_extra and not mine_only:
4345
if printed_local is True:
4347
message("You are missing %d revision(s):\n" %
4349
for revision in iter_log_revisions(remote_extra,
4350
remote_branch.repository,
4352
lf.log_revision(revision)
4355
if mine_only and not local_extra:
4356
# We checked local, and found nothing extra
4357
message('This branch is up to date.\n')
4358
elif theirs_only and not remote_extra:
4359
# We checked remote, and found nothing extra
4360
message('Other branch is up to date.\n')
4361
elif not (mine_only or theirs_only or local_extra or
4363
# We checked both branches, and neither one had extra
4365
message("Branches are up to date.\n")
4367
if not status_code and parent is None and other_branch is not None:
4368
local_branch.lock_write()
4369
self.add_cleanup(local_branch.unlock)
4370
# handle race conditions - a parent might be set while we run.
4371
if local_branch.get_parent() is None:
4372
local_branch.set_parent(remote_branch.base)
4376
class cmd_pack(Command):
4377
"""Compress the data within a repository."""
4379
_see_also = ['repositories']
4380
takes_args = ['branch_or_repo?']
4382
def run(self, branch_or_repo='.'):
4383
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4385
branch = dir.open_branch()
4386
repository = branch.repository
4387
except errors.NotBranchError:
4388
repository = dir.open_repository()
4392
class cmd_plugins(Command):
4393
"""List the installed plugins.
4395
This command displays the list of installed plugins including
4396
version of plugin and a short description of each.
4398
--verbose shows the path where each plugin is located.
4400
A plugin is an external component for Bazaar that extends the
4401
revision control system, by adding or replacing code in Bazaar.
4402
Plugins can do a variety of things, including overriding commands,
4403
adding new commands, providing additional network transports and
4404
customizing log output.
4406
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4407
for further information on plugins including where to find them and how to
4408
install them. Instructions are also provided there on how to write new
4409
plugins using the Python programming language.
4411
takes_options = ['verbose']
4414
def run(self, verbose=False):
4415
import bzrlib.plugin
4416
from inspect import getdoc
4418
for name, plugin in bzrlib.plugin.plugins().items():
4419
version = plugin.__version__
4420
if version == 'unknown':
4422
name_ver = '%s %s' % (name, version)
4423
d = getdoc(plugin.module)
4425
doc = d.split('\n')[0]
4427
doc = '(no description)'
4428
result.append((name_ver, doc, plugin.path()))
4429
for name_ver, doc, path in sorted(result):
4437
class cmd_testament(Command):
4438
"""Show testament (signing-form) of a revision."""
4441
Option('long', help='Produce long-format testament.'),
4443
help='Produce a strict-format testament.')]
4444
takes_args = ['branch?']
4446
def run(self, branch=u'.', revision=None, long=False, strict=False):
4447
from bzrlib.testament import Testament, StrictTestament
4449
testament_class = StrictTestament
4451
testament_class = Testament
4453
b = Branch.open_containing(branch)[0]
4455
b = Branch.open(branch)
4457
self.add_cleanup(b.unlock)
4458
if revision is None:
4459
rev_id = b.last_revision()
4461
rev_id = revision[0].as_revision_id(b)
4462
t = testament_class.from_revision(b.repository, rev_id)
4464
sys.stdout.writelines(t.as_text_lines())
4466
sys.stdout.write(t.as_short_text())
4469
class cmd_annotate(Command):
4470
"""Show the origin of each line in a file.
4472
This prints out the given file with an annotation on the left side
4473
indicating which revision, author and date introduced the change.
4475
If the origin is the same for a run of consecutive lines, it is
4476
shown only at the top, unless the --all option is given.
4478
# TODO: annotate directories; showing when each file was last changed
4479
# TODO: if the working copy is modified, show annotations on that
4480
# with new uncommitted lines marked
4481
aliases = ['ann', 'blame', 'praise']
4482
takes_args = ['filename']
4483
takes_options = [Option('all', help='Show annotations on all lines.'),
4484
Option('long', help='Show commit date in annotations.'),
4488
encoding_type = 'exact'
4491
def run(self, filename, all=False, long=False, revision=None,
4493
from bzrlib.annotate import annotate_file, annotate_file_tree
4494
wt, branch, relpath = \
4495
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4498
self.add_cleanup(wt.unlock)
4501
self.add_cleanup(branch.unlock)
4502
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4504
self.add_cleanup(tree.unlock)
4506
file_id = wt.path2id(relpath)
4508
file_id = tree.path2id(relpath)
4510
raise errors.NotVersionedError(filename)
4511
file_version = tree.inventory[file_id].revision
4512
if wt is not None and revision is None:
4513
# If there is a tree and we're not annotating historical
4514
# versions, annotate the working tree's content.
4515
annotate_file_tree(wt, file_id, self.outf, long, all,
4518
annotate_file(branch, file_version, file_id, long, all, self.outf,
4522
class cmd_re_sign(Command):
4523
"""Create a digital signature for an existing revision."""
4524
# TODO be able to replace existing ones.
4526
hidden = True # is this right ?
4527
takes_args = ['revision_id*']
4528
takes_options = ['revision']
4530
def run(self, revision_id_list=None, revision=None):
4531
if revision_id_list is not None and revision is not None:
4532
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4533
if revision_id_list is None and revision is None:
4534
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4535
b = WorkingTree.open_containing(u'.')[0].branch
4537
self.add_cleanup(b.unlock)
4538
return self._run(b, revision_id_list, revision)
4540
def _run(self, b, revision_id_list, revision):
4541
import bzrlib.gpg as gpg
4542
gpg_strategy = gpg.GPGStrategy(b.get_config())
4543
if revision_id_list is not None:
4544
b.repository.start_write_group()
4546
for revision_id in revision_id_list:
4547
b.repository.sign_revision(revision_id, gpg_strategy)
4549
b.repository.abort_write_group()
4552
b.repository.commit_write_group()
4553
elif revision is not None:
4554
if len(revision) == 1:
4555
revno, rev_id = revision[0].in_history(b)
4556
b.repository.start_write_group()
4558
b.repository.sign_revision(rev_id, gpg_strategy)
4560
b.repository.abort_write_group()
4563
b.repository.commit_write_group()
4564
elif len(revision) == 2:
4565
# are they both on rh- if so we can walk between them
4566
# might be nice to have a range helper for arbitrary
4567
# revision paths. hmm.
4568
from_revno, from_revid = revision[0].in_history(b)
4569
to_revno, to_revid = revision[1].in_history(b)
4570
if to_revid is None:
4571
to_revno = b.revno()
4572
if from_revno is None or to_revno is None:
4573
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4574
b.repository.start_write_group()
4576
for revno in range(from_revno, to_revno + 1):
4577
b.repository.sign_revision(b.get_rev_id(revno),
4580
b.repository.abort_write_group()
4583
b.repository.commit_write_group()
4585
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4588
class cmd_bind(Command):
4589
"""Convert the current branch into a checkout of the supplied branch.
4591
Once converted into a checkout, commits must succeed on the master branch
4592
before they will be applied to the local branch.
4594
Bound branches use the nickname of its master branch unless it is set
4595
locally, in which case binding will update the local nickname to be
4599
_see_also = ['checkouts', 'unbind']
4600
takes_args = ['location?']
4603
def run(self, location=None):
4604
b, relpath = Branch.open_containing(u'.')
4605
if location is None:
4607
location = b.get_old_bound_location()
4608
except errors.UpgradeRequired:
4609
raise errors.BzrCommandError('No location supplied. '
4610
'This format does not remember old locations.')
4612
if location is None:
4613
if b.get_bound_location() is not None:
4614
raise errors.BzrCommandError('Branch is already bound')
4616
raise errors.BzrCommandError('No location supplied '
4617
'and no previous location known')
4618
b_other = Branch.open(location)
4621
except errors.DivergedBranches:
4622
raise errors.BzrCommandError('These branches have diverged.'
4623
' Try merging, and then bind again.')
4624
if b.get_config().has_explicit_nickname():
4625
b.nick = b_other.nick
4628
class cmd_unbind(Command):
4629
"""Convert the current checkout into a regular branch.
4631
After unbinding, the local branch is considered independent and subsequent
4632
commits will be local only.
4635
_see_also = ['checkouts', 'bind']
4640
b, relpath = Branch.open_containing(u'.')
4642
raise errors.BzrCommandError('Local branch is not bound')
4645
class cmd_uncommit(Command):
4646
"""Remove the last committed revision.
4648
--verbose will print out what is being removed.
4649
--dry-run will go through all the motions, but not actually
4652
If --revision is specified, uncommit revisions to leave the branch at the
4653
specified revision. For example, "bzr uncommit -r 15" will leave the
4654
branch at revision 15.
4656
Uncommit leaves the working tree ready for a new commit. The only change
4657
it may make is to restore any pending merges that were present before
4661
# TODO: jam 20060108 Add an option to allow uncommit to remove
4662
# unreferenced information in 'branch-as-repository' branches.
4663
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4664
# information in shared branches as well.
4665
_see_also = ['commit']
4666
takes_options = ['verbose', 'revision',
4667
Option('dry-run', help='Don\'t actually make changes.'),
4668
Option('force', help='Say yes to all questions.'),
4670
help="Only remove the commits from the local branch"
4671
" when in a checkout."
4674
takes_args = ['location?']
4676
encoding_type = 'replace'
4678
def run(self, location=None,
4679
dry_run=False, verbose=False,
4680
revision=None, force=False, local=False):
4681
if location is None:
4683
control, relpath = bzrdir.BzrDir.open_containing(location)
4685
tree = control.open_workingtree()
4687
except (errors.NoWorkingTree, errors.NotLocalUrl):
4689
b = control.open_branch()
4691
if tree is not None:
4693
self.add_cleanup(tree.unlock)
4696
self.add_cleanup(b.unlock)
4697
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4699
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4700
from bzrlib.log import log_formatter, show_log
4701
from bzrlib.uncommit import uncommit
4703
last_revno, last_rev_id = b.last_revision_info()
4706
if revision is None:
4708
rev_id = last_rev_id
4710
# 'bzr uncommit -r 10' actually means uncommit
4711
# so that the final tree is at revno 10.
4712
# but bzrlib.uncommit.uncommit() actually uncommits
4713
# the revisions that are supplied.
4714
# So we need to offset it by one
4715
revno = revision[0].in_history(b).revno + 1
4716
if revno <= last_revno:
4717
rev_id = b.get_rev_id(revno)
4719
if rev_id is None or _mod_revision.is_null(rev_id):
4720
ui.ui_factory.note('No revisions to uncommit.')
4723
log_collector = ui.ui_factory.make_output_stream()
4724
lf = log_formatter('short',
4725
to_file=log_collector,
4726
show_timezone='original')
4731
direction='forward',
4732
start_revision=revno,
4733
end_revision=last_revno)
4736
ui.ui_factory.note('Dry-run, pretending to remove the above revisions.')
4738
ui.ui_factory.note('The above revision(s) will be removed.')
4741
if not ui.ui_factory.get_boolean('Are you sure [y/N]? '):
4742
ui.ui_factory.note('Canceled')
4745
mutter('Uncommitting from {%s} to {%s}',
4746
last_rev_id, rev_id)
4747
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4748
revno=revno, local=local)
4749
ui.ui_factory.note('You can restore the old tip by running:\n'
4750
' bzr pull . -r revid:%s' % last_rev_id)
4753
class cmd_break_lock(Command):
4754
"""Break a dead lock on a repository, branch or working directory.
4756
CAUTION: Locks should only be broken when you are sure that the process
4757
holding the lock has been stopped.
4759
You can get information on what locks are open via the 'bzr info
4760
[location]' command.
4764
bzr break-lock bzr+ssh://example.com/bzr/foo
4766
takes_args = ['location?']
4768
def run(self, location=None, show=False):
4769
if location is None:
4771
control, relpath = bzrdir.BzrDir.open_containing(location)
4773
control.break_lock()
4774
except NotImplementedError:
4778
class cmd_wait_until_signalled(Command):
4779
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4781
This just prints a line to signal when it is ready, then blocks on stdin.
4787
sys.stdout.write("running\n")
4789
sys.stdin.readline()
4792
class cmd_serve(Command):
4793
"""Run the bzr server."""
4795
aliases = ['server']
4799
help='Serve on stdin/out for use from inetd or sshd.'),
4800
RegistryOption('protocol',
4801
help="Protocol to serve.",
4802
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4803
value_switches=True),
4805
help='Listen for connections on nominated port of the form '
4806
'[hostname:]portnumber. Passing 0 as the port number will '
4807
'result in a dynamically allocated port. The default port '
4808
'depends on the protocol.',
4811
help='Serve contents of this directory.',
4813
Option('allow-writes',
4814
help='By default the server is a readonly server. Supplying '
4815
'--allow-writes enables write access to the contents of '
4816
'the served directory and below. Note that ``bzr serve`` '
4817
'does not perform authentication, so unless some form of '
4818
'external authentication is arranged supplying this '
4819
'option leads to global uncontrolled write access to your '
4824
def get_host_and_port(self, port):
4825
"""Return the host and port to run the smart server on.
4827
If 'port' is None, None will be returned for the host and port.
4829
If 'port' has a colon in it, the string before the colon will be
4830
interpreted as the host.
4832
:param port: A string of the port to run the server on.
4833
:return: A tuple of (host, port), where 'host' is a host name or IP,
4834
and port is an integer TCP/IP port.
4837
if port is not None:
4839
host, port = port.split(':')
4843
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4845
from bzrlib.transport import get_transport, transport_server_registry
4846
if directory is None:
4847
directory = os.getcwd()
4848
if protocol is None:
4849
protocol = transport_server_registry.get()
4850
host, port = self.get_host_and_port(port)
4851
url = urlutils.local_path_to_url(directory)
4852
if not allow_writes:
4853
url = 'readonly+' + url
4854
transport = get_transport(url)
4855
protocol(transport, host, port, inet)
4858
class cmd_join(Command):
4859
"""Combine a tree into its containing tree.
4861
This command requires the target tree to be in a rich-root format.
4863
The TREE argument should be an independent tree, inside another tree, but
4864
not part of it. (Such trees can be produced by "bzr split", but also by
4865
running "bzr branch" with the target inside a tree.)
4867
The result is a combined tree, with the subtree no longer an independant
4868
part. This is marked as a merge of the subtree into the containing tree,
4869
and all history is preserved.
4872
_see_also = ['split']
4873
takes_args = ['tree']
4875
Option('reference', help='Join by reference.', hidden=True),
4878
def run(self, tree, reference=False):
4879
sub_tree = WorkingTree.open(tree)
4880
parent_dir = osutils.dirname(sub_tree.basedir)
4881
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4882
repo = containing_tree.branch.repository
4883
if not repo.supports_rich_root():
4884
raise errors.BzrCommandError(
4885
"Can't join trees because %s doesn't support rich root data.\n"
4886
"You can use bzr upgrade on the repository."
4890
containing_tree.add_reference(sub_tree)
4891
except errors.BadReferenceTarget, e:
4892
# XXX: Would be better to just raise a nicely printable
4893
# exception from the real origin. Also below. mbp 20070306
4894
raise errors.BzrCommandError("Cannot join %s. %s" %
4898
containing_tree.subsume(sub_tree)
4899
except errors.BadSubsumeSource, e:
4900
raise errors.BzrCommandError("Cannot join %s. %s" %
4904
class cmd_split(Command):
4905
"""Split a subdirectory of a tree into a separate tree.
4907
This command will produce a target tree in a format that supports
4908
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4909
converted into earlier formats like 'dirstate-tags'.
4911
The TREE argument should be a subdirectory of a working tree. That
4912
subdirectory will be converted into an independent tree, with its own
4913
branch. Commits in the top-level tree will not apply to the new subtree.
4916
_see_also = ['join']
4917
takes_args = ['tree']
4919
def run(self, tree):
4920
containing_tree, subdir = WorkingTree.open_containing(tree)
4921
sub_id = containing_tree.path2id(subdir)
4923
raise errors.NotVersionedError(subdir)
4925
containing_tree.extract(sub_id)
4926
except errors.RootNotRich:
4927
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4930
class cmd_merge_directive(Command):
4931
"""Generate a merge directive for auto-merge tools.
4933
A directive requests a merge to be performed, and also provides all the
4934
information necessary to do so. This means it must either include a
4935
revision bundle, or the location of a branch containing the desired
4938
A submit branch (the location to merge into) must be supplied the first
4939
time the command is issued. After it has been supplied once, it will
4940
be remembered as the default.
4942
A public branch is optional if a revision bundle is supplied, but required
4943
if --diff or --plain is specified. It will be remembered as the default
4944
after the first use.
4947
takes_args = ['submit_branch?', 'public_branch?']
4951
_see_also = ['send']
4954
RegistryOption.from_kwargs('patch-type',
4955
'The type of patch to include in the directive.',
4957
value_switches=True,
4959
bundle='Bazaar revision bundle (default).',
4960
diff='Normal unified diff.',
4961
plain='No patch, just directive.'),
4962
Option('sign', help='GPG-sign the directive.'), 'revision',
4963
Option('mail-to', type=str,
4964
help='Instead of printing the directive, email to this address.'),
4965
Option('message', type=str, short_name='m',
4966
help='Message to use when committing this merge.')
4969
encoding_type = 'exact'
4971
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4972
sign=False, revision=None, mail_to=None, message=None):
4973
from bzrlib.revision import ensure_null, NULL_REVISION
4974
include_patch, include_bundle = {
4975
'plain': (False, False),
4976
'diff': (True, False),
4977
'bundle': (True, True),
4979
branch = Branch.open('.')
4980
stored_submit_branch = branch.get_submit_branch()
4981
if submit_branch is None:
4982
submit_branch = stored_submit_branch
4984
if stored_submit_branch is None:
4985
branch.set_submit_branch(submit_branch)
4986
if submit_branch is None:
4987
submit_branch = branch.get_parent()
4988
if submit_branch is None:
4989
raise errors.BzrCommandError('No submit branch specified or known')
4991
stored_public_branch = branch.get_public_branch()
4992
if public_branch is None:
4993
public_branch = stored_public_branch
4994
elif stored_public_branch is None:
4995
branch.set_public_branch(public_branch)
4996
if not include_bundle and public_branch is None:
4997
raise errors.BzrCommandError('No public branch specified or'
4999
base_revision_id = None
5000
if revision is not None:
5001
if len(revision) > 2:
5002
raise errors.BzrCommandError('bzr merge-directive takes '
5003
'at most two one revision identifiers')
5004
revision_id = revision[-1].as_revision_id(branch)
5005
if len(revision) == 2:
5006
base_revision_id = revision[0].as_revision_id(branch)
5008
revision_id = branch.last_revision()
5009
revision_id = ensure_null(revision_id)
5010
if revision_id == NULL_REVISION:
5011
raise errors.BzrCommandError('No revisions to bundle.')
5012
directive = merge_directive.MergeDirective2.from_objects(
5013
branch.repository, revision_id, time.time(),
5014
osutils.local_time_offset(), submit_branch,
5015
public_branch=public_branch, include_patch=include_patch,
5016
include_bundle=include_bundle, message=message,
5017
base_revision_id=base_revision_id)
5020
self.outf.write(directive.to_signed(branch))
5022
self.outf.writelines(directive.to_lines())
5024
message = directive.to_email(mail_to, branch, sign)
5025
s = SMTPConnection(branch.get_config())
5026
s.send_email(message)
5029
class cmd_send(Command):
5030
"""Mail or create a merge-directive for submitting changes.
5032
A merge directive provides many things needed for requesting merges:
5034
* A machine-readable description of the merge to perform
5036
* An optional patch that is a preview of the changes requested
5038
* An optional bundle of revision data, so that the changes can be applied
5039
directly from the merge directive, without retrieving data from a
5042
`bzr send` creates a compact data set that, when applied using bzr
5043
merge, has the same effect as merging from the source branch.
5045
By default the merge directive is self-contained and can be applied to any
5046
branch containing submit_branch in its ancestory without needing access to
5049
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5050
revisions, but only a structured request to merge from the
5051
public_location. In that case the public_branch is needed and it must be
5052
up-to-date and accessible to the recipient. The public_branch is always
5053
included if known, so that people can check it later.
5055
The submit branch defaults to the parent of the source branch, but can be
5056
overridden. Both submit branch and public branch will be remembered in
5057
branch.conf the first time they are used for a particular branch. The
5058
source branch defaults to that containing the working directory, but can
5059
be changed using --from.
5061
In order to calculate those changes, bzr must analyse the submit branch.
5062
Therefore it is most efficient for the submit branch to be a local mirror.
5063
If a public location is known for the submit_branch, that location is used
5064
in the merge directive.
5066
The default behaviour is to send the merge directive by mail, unless -o is
5067
given, in which case it is sent to a file.
5069
Mail is sent using your preferred mail program. This should be transparent
5070
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5071
If the preferred client can't be found (or used), your editor will be used.
5073
To use a specific mail program, set the mail_client configuration option.
5074
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5075
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5076
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5077
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5080
If mail is being sent, a to address is required. This can be supplied
5081
either on the commandline, by setting the submit_to configuration
5082
option in the branch itself or the child_submit_to configuration option
5083
in the submit branch.
5085
Two formats are currently supported: "4" uses revision bundle format 4 and
5086
merge directive format 2. It is significantly faster and smaller than
5087
older formats. It is compatible with Bazaar 0.19 and later. It is the
5088
default. "0.9" uses revision bundle format 0.9 and merge directive
5089
format 1. It is compatible with Bazaar 0.12 - 0.18.
5091
The merge directives created by bzr send may be applied using bzr merge or
5092
bzr pull by specifying a file containing a merge directive as the location.
5094
bzr send makes extensive use of public locations to map local locations into
5095
URLs that can be used by other people. See `bzr help configuration` to
5096
set them, and use `bzr info` to display them.
5099
encoding_type = 'exact'
5101
_see_also = ['merge', 'pull']
5103
takes_args = ['submit_branch?', 'public_branch?']
5107
help='Do not include a bundle in the merge directive.'),
5108
Option('no-patch', help='Do not include a preview patch in the merge'
5111
help='Remember submit and public branch.'),
5113
help='Branch to generate the submission from, '
5114
'rather than the one containing the working directory.',
5117
Option('output', short_name='o',
5118
help='Write merge directive to this file; '
5119
'use - for stdout.',
5122
help='Refuse to send if there are uncommitted changes in'
5123
' the working tree, --no-strict disables the check.'),
5124
Option('mail-to', help='Mail the request to this address.',
5128
Option('body', help='Body for the email.', type=unicode),
5129
RegistryOption('format',
5130
help='Use the specified output format.',
5131
lazy_registry=('bzrlib.send', 'format_registry')),
5134
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5135
no_patch=False, revision=None, remember=False, output=None,
5136
format=None, mail_to=None, message=None, body=None,
5137
strict=None, **kwargs):
5138
from bzrlib.send import send
5139
return send(submit_branch, revision, public_branch, remember,
5140
format, no_bundle, no_patch, output,
5141
kwargs.get('from', '.'), mail_to, message, body,
5146
class cmd_bundle_revisions(cmd_send):
5147
"""Create a merge-directive for submitting changes.
5149
A merge directive provides many things needed for requesting merges:
5151
* A machine-readable description of the merge to perform
5153
* An optional patch that is a preview of the changes requested
5155
* An optional bundle of revision data, so that the changes can be applied
5156
directly from the merge directive, without retrieving data from a
5159
If --no-bundle is specified, then public_branch is needed (and must be
5160
up-to-date), so that the receiver can perform the merge using the
5161
public_branch. The public_branch is always included if known, so that
5162
people can check it later.
5164
The submit branch defaults to the parent, but can be overridden. Both
5165
submit branch and public branch will be remembered if supplied.
5167
If a public_branch is known for the submit_branch, that public submit
5168
branch is used in the merge instructions. This means that a local mirror
5169
can be used as your actual submit branch, once you have set public_branch
5172
Two formats are currently supported: "4" uses revision bundle format 4 and
5173
merge directive format 2. It is significantly faster and smaller than
5174
older formats. It is compatible with Bazaar 0.19 and later. It is the
5175
default. "0.9" uses revision bundle format 0.9 and merge directive
5176
format 1. It is compatible with Bazaar 0.12 - 0.18.
5181
help='Do not include a bundle in the merge directive.'),
5182
Option('no-patch', help='Do not include a preview patch in the merge'
5185
help='Remember submit and public branch.'),
5187
help='Branch to generate the submission from, '
5188
'rather than the one containing the working directory.',
5191
Option('output', short_name='o', help='Write directive to this file.',
5194
help='Refuse to bundle revisions if there are uncommitted'
5195
' changes in the working tree, --no-strict disables the check.'),
5197
RegistryOption('format',
5198
help='Use the specified output format.',
5199
lazy_registry=('bzrlib.send', 'format_registry')),
5201
aliases = ['bundle']
5203
_see_also = ['send', 'merge']
5207
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5208
no_patch=False, revision=None, remember=False, output=None,
5209
format=None, strict=None, **kwargs):
5212
from bzrlib.send import send
5213
return send(submit_branch, revision, public_branch, remember,
5214
format, no_bundle, no_patch, output,
5215
kwargs.get('from', '.'), None, None, None,
5216
self.outf, strict=strict)
5219
class cmd_tag(Command):
5220
"""Create, remove or modify a tag naming a revision.
5222
Tags give human-meaningful names to revisions. Commands that take a -r
5223
(--revision) option can be given -rtag:X, where X is any previously
5226
Tags are stored in the branch. Tags are copied from one branch to another
5227
along when you branch, push, pull or merge.
5229
It is an error to give a tag name that already exists unless you pass
5230
--force, in which case the tag is moved to point to the new revision.
5232
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5233
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5236
_see_also = ['commit', 'tags']
5237
takes_args = ['tag_name']
5240
help='Delete this tag rather than placing it.',
5243
help='Branch in which to place the tag.',
5248
help='Replace existing tags.',
5253
def run(self, tag_name,
5259
branch, relpath = Branch.open_containing(directory)
5261
self.add_cleanup(branch.unlock)
5263
branch.tags.delete_tag(tag_name)
5264
self.outf.write('Deleted tag %s.\n' % tag_name)
5267
if len(revision) != 1:
5268
raise errors.BzrCommandError(
5269
"Tags can only be placed on a single revision, "
5271
revision_id = revision[0].as_revision_id(branch)
5273
revision_id = branch.last_revision()
5274
if (not force) and branch.tags.has_tag(tag_name):
5275
raise errors.TagAlreadyExists(tag_name)
5276
branch.tags.set_tag(tag_name, revision_id)
5277
self.outf.write('Created tag %s.\n' % tag_name)
5280
class cmd_tags(Command):
5283
This command shows a table of tag names and the revisions they reference.
5289
help='Branch whose tags should be displayed.',
5293
RegistryOption.from_kwargs('sort',
5294
'Sort tags by different criteria.', title='Sorting',
5295
alpha='Sort tags lexicographically (default).',
5296
time='Sort tags chronologically.',
5309
branch, relpath = Branch.open_containing(directory)
5311
tags = branch.tags.get_tag_dict().items()
5316
self.add_cleanup(branch.unlock)
5318
graph = branch.repository.get_graph()
5319
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5320
revid1, revid2 = rev1.rev_id, rev2.rev_id
5321
# only show revisions between revid1 and revid2 (inclusive)
5322
tags = [(tag, revid) for tag, revid in tags if
5323
graph.is_between(revid, revid1, revid2)]
5326
elif sort == 'time':
5328
for tag, revid in tags:
5330
revobj = branch.repository.get_revision(revid)
5331
except errors.NoSuchRevision:
5332
timestamp = sys.maxint # place them at the end
5334
timestamp = revobj.timestamp
5335
timestamps[revid] = timestamp
5336
tags.sort(key=lambda x: timestamps[x[1]])
5338
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5339
for index, (tag, revid) in enumerate(tags):
5341
revno = branch.revision_id_to_dotted_revno(revid)
5342
if isinstance(revno, tuple):
5343
revno = '.'.join(map(str, revno))
5344
except errors.NoSuchRevision:
5345
# Bad tag data/merges can lead to tagged revisions
5346
# which are not in this branch. Fail gracefully ...
5348
tags[index] = (tag, revno)
5350
for tag, revspec in tags:
5351
self.outf.write('%-20s %s\n' % (tag, revspec))
5354
class cmd_reconfigure(Command):
5355
"""Reconfigure the type of a bzr directory.
5357
A target configuration must be specified.
5359
For checkouts, the bind-to location will be auto-detected if not specified.
5360
The order of preference is
5361
1. For a lightweight checkout, the current bound location.
5362
2. For branches that used to be checkouts, the previously-bound location.
5363
3. The push location.
5364
4. The parent location.
5365
If none of these is available, --bind-to must be specified.
5368
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5369
takes_args = ['location?']
5371
RegistryOption.from_kwargs(
5373
title='Target type',
5374
help='The type to reconfigure the directory to.',
5375
value_switches=True, enum_switch=False,
5376
branch='Reconfigure to be an unbound branch with no working tree.',
5377
tree='Reconfigure to be an unbound branch with a working tree.',
5378
checkout='Reconfigure to be a bound branch with a working tree.',
5379
lightweight_checkout='Reconfigure to be a lightweight'
5380
' checkout (with no local history).',
5381
standalone='Reconfigure to be a standalone branch '
5382
'(i.e. stop using shared repository).',
5383
use_shared='Reconfigure to use a shared repository.',
5384
with_trees='Reconfigure repository to create '
5385
'working trees on branches by default.',
5386
with_no_trees='Reconfigure repository to not create '
5387
'working trees on branches by default.'
5389
Option('bind-to', help='Branch to bind checkout to.', type=str),
5391
help='Perform reconfiguration even if local changes'
5393
Option('stacked-on',
5394
help='Reconfigure a branch to be stacked on another branch.',
5398
help='Reconfigure a branch to be unstacked. This '
5399
'may require copying substantial data into it.',
5403
def run(self, location=None, target_type=None, bind_to=None, force=False,
5406
directory = bzrdir.BzrDir.open(location)
5407
if stacked_on and unstacked:
5408
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5409
elif stacked_on is not None:
5410
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5412
reconfigure.ReconfigureUnstacked().apply(directory)
5413
# At the moment you can use --stacked-on and a different
5414
# reconfiguration shape at the same time; there seems no good reason
5416
if target_type is None:
5417
if stacked_on or unstacked:
5420
raise errors.BzrCommandError('No target configuration '
5422
elif target_type == 'branch':
5423
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5424
elif target_type == 'tree':
5425
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5426
elif target_type == 'checkout':
5427
reconfiguration = reconfigure.Reconfigure.to_checkout(
5429
elif target_type == 'lightweight-checkout':
5430
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5432
elif target_type == 'use-shared':
5433
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5434
elif target_type == 'standalone':
5435
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5436
elif target_type == 'with-trees':
5437
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5439
elif target_type == 'with-no-trees':
5440
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5442
reconfiguration.apply(force)
5445
class cmd_switch(Command):
5446
"""Set the branch of a checkout and update.
5448
For lightweight checkouts, this changes the branch being referenced.
5449
For heavyweight checkouts, this checks that there are no local commits
5450
versus the current bound branch, then it makes the local branch a mirror
5451
of the new location and binds to it.
5453
In both cases, the working tree is updated and uncommitted changes
5454
are merged. The user can commit or revert these as they desire.
5456
Pending merges need to be committed or reverted before using switch.
5458
The path to the branch to switch to can be specified relative to the parent
5459
directory of the current branch. For example, if you are currently in a
5460
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5463
Bound branches use the nickname of its master branch unless it is set
5464
locally, in which case switching will update the local nickname to be
5468
takes_args = ['to_location?']
5469
takes_options = [Option('force',
5470
help='Switch even if local commits will be lost.'),
5472
Option('create-branch', short_name='b',
5473
help='Create the target branch from this one before'
5474
' switching to it.'),
5477
def run(self, to_location=None, force=False, create_branch=False,
5479
from bzrlib import switch
5481
revision = _get_one_revision('switch', revision)
5482
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5483
if to_location is None:
5484
if revision is None:
5485
raise errors.BzrCommandError('You must supply either a'
5486
' revision or a location')
5489
branch = control_dir.open_branch()
5490
had_explicit_nick = branch.get_config().has_explicit_nickname()
5491
except errors.NotBranchError:
5493
had_explicit_nick = False
5496
raise errors.BzrCommandError('cannot create branch without'
5498
to_location = directory_service.directories.dereference(
5500
if '/' not in to_location and '\\' not in to_location:
5501
# This path is meant to be relative to the existing branch
5502
this_url = self._get_branch_location(control_dir)
5503
to_location = urlutils.join(this_url, '..', to_location)
5504
to_branch = branch.bzrdir.sprout(to_location,
5505
possible_transports=[branch.bzrdir.root_transport],
5506
source_branch=branch).open_branch()
5509
to_branch = Branch.open(to_location)
5510
except errors.NotBranchError:
5511
this_url = self._get_branch_location(control_dir)
5512
to_branch = Branch.open(
5513
urlutils.join(this_url, '..', to_location))
5514
if revision is not None:
5515
revision = revision.as_revision_id(to_branch)
5516
switch.switch(control_dir, to_branch, force, revision_id=revision)
5517
if had_explicit_nick:
5518
branch = control_dir.open_branch() #get the new branch!
5519
branch.nick = to_branch.nick
5520
note('Switched to branch: %s',
5521
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5523
def _get_branch_location(self, control_dir):
5524
"""Return location of branch for this control dir."""
5526
this_branch = control_dir.open_branch()
5527
# This may be a heavy checkout, where we want the master branch
5528
master_location = this_branch.get_bound_location()
5529
if master_location is not None:
5530
return master_location
5531
# If not, use a local sibling
5532
return this_branch.base
5533
except errors.NotBranchError:
5534
format = control_dir.find_branch_format()
5535
if getattr(format, 'get_reference', None) is not None:
5536
return format.get_reference(control_dir)
5538
return control_dir.root_transport.base
5541
class cmd_view(Command):
5542
"""Manage filtered views.
5544
Views provide a mask over the tree so that users can focus on
5545
a subset of a tree when doing their work. After creating a view,
5546
commands that support a list of files - status, diff, commit, etc -
5547
effectively have that list of files implicitly given each time.
5548
An explicit list of files can still be given but those files
5549
must be within the current view.
5551
In most cases, a view has a short life-span: it is created to make
5552
a selected change and is deleted once that change is committed.
5553
At other times, you may wish to create one or more named views
5554
and switch between them.
5556
To disable the current view without deleting it, you can switch to
5557
the pseudo view called ``off``. This can be useful when you need
5558
to see the whole tree for an operation or two (e.g. merge) but
5559
want to switch back to your view after that.
5562
To define the current view::
5564
bzr view file1 dir1 ...
5566
To list the current view::
5570
To delete the current view::
5574
To disable the current view without deleting it::
5576
bzr view --switch off
5578
To define a named view and switch to it::
5580
bzr view --name view-name file1 dir1 ...
5582
To list a named view::
5584
bzr view --name view-name
5586
To delete a named view::
5588
bzr view --name view-name --delete
5590
To switch to a named view::
5592
bzr view --switch view-name
5594
To list all views defined::
5598
To delete all views::
5600
bzr view --delete --all
5604
takes_args = ['file*']
5607
help='Apply list or delete action to all views.',
5610
help='Delete the view.',
5613
help='Name of the view to define, list or delete.',
5617
help='Name of the view to switch to.',
5622
def run(self, file_list,
5628
tree, file_list = tree_files(file_list, apply_view=False)
5629
current_view, view_dict = tree.views.get_view_info()
5634
raise errors.BzrCommandError(
5635
"Both --delete and a file list specified")
5637
raise errors.BzrCommandError(
5638
"Both --delete and --switch specified")
5640
tree.views.set_view_info(None, {})
5641
self.outf.write("Deleted all views.\n")
5643
raise errors.BzrCommandError("No current view to delete")
5645
tree.views.delete_view(name)
5646
self.outf.write("Deleted '%s' view.\n" % name)
5649
raise errors.BzrCommandError(
5650
"Both --switch and a file list specified")
5652
raise errors.BzrCommandError(
5653
"Both --switch and --all specified")
5654
elif switch == 'off':
5655
if current_view is None:
5656
raise errors.BzrCommandError("No current view to disable")
5657
tree.views.set_view_info(None, view_dict)
5658
self.outf.write("Disabled '%s' view.\n" % (current_view))
5660
tree.views.set_view_info(switch, view_dict)
5661
view_str = views.view_display_str(tree.views.lookup_view())
5662
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5665
self.outf.write('Views defined:\n')
5666
for view in sorted(view_dict):
5667
if view == current_view:
5671
view_str = views.view_display_str(view_dict[view])
5672
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5674
self.outf.write('No views defined.\n')
5677
# No name given and no current view set
5680
raise errors.BzrCommandError(
5681
"Cannot change the 'off' pseudo view")
5682
tree.views.set_view(name, sorted(file_list))
5683
view_str = views.view_display_str(tree.views.lookup_view())
5684
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5688
# No name given and no current view set
5689
self.outf.write('No current view.\n')
5691
view_str = views.view_display_str(tree.views.lookup_view(name))
5692
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5695
class cmd_hooks(Command):
5701
for hook_key in sorted(hooks.known_hooks.keys()):
5702
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5703
self.outf.write("%s:\n" % type(some_hooks).__name__)
5704
for hook_name, hook_point in sorted(some_hooks.items()):
5705
self.outf.write(" %s:\n" % (hook_name,))
5706
found_hooks = list(hook_point)
5708
for hook in found_hooks:
5709
self.outf.write(" %s\n" %
5710
(some_hooks.get_hook_name(hook),))
5712
self.outf.write(" <no hooks installed>\n")
5715
class cmd_shelve(Command):
5716
"""Temporarily set aside some changes from the current tree.
5718
Shelve allows you to temporarily put changes you've made "on the shelf",
5719
ie. out of the way, until a later time when you can bring them back from
5720
the shelf with the 'unshelve' command. The changes are stored alongside
5721
your working tree, and so they aren't propagated along with your branch nor
5722
will they survive its deletion.
5724
If shelve --list is specified, previously-shelved changes are listed.
5726
Shelve is intended to help separate several sets of changes that have
5727
been inappropriately mingled. If you just want to get rid of all changes
5728
and you don't need to restore them later, use revert. If you want to
5729
shelve all text changes at once, use shelve --all.
5731
If filenames are specified, only the changes to those files will be
5732
shelved. Other files will be left untouched.
5734
If a revision is specified, changes since that revision will be shelved.
5736
You can put multiple items on the shelf, and by default, 'unshelve' will
5737
restore the most recently shelved changes.
5740
takes_args = ['file*']
5744
Option('all', help='Shelve all changes.'),
5746
RegistryOption('writer', 'Method to use for writing diffs.',
5747
bzrlib.option.diff_writer_registry,
5748
value_switches=True, enum_switch=False),
5750
Option('list', help='List shelved changes.'),
5752
help='Destroy removed changes instead of shelving them.'),
5754
_see_also = ['unshelve']
5756
def run(self, revision=None, all=False, file_list=None, message=None,
5757
writer=None, list=False, destroy=False):
5759
return self.run_for_list()
5760
from bzrlib.shelf_ui import Shelver
5762
writer = bzrlib.option.diff_writer_registry.get()
5764
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5765
file_list, message, destroy=destroy)
5770
except errors.UserAbort:
5773
def run_for_list(self):
5774
tree = WorkingTree.open_containing('.')[0]
5776
self.add_cleanup(tree.unlock)
5777
manager = tree.get_shelf_manager()
5778
shelves = manager.active_shelves()
5779
if len(shelves) == 0:
5780
note('No shelved changes.')
5782
for shelf_id in reversed(shelves):
5783
message = manager.get_metadata(shelf_id).get('message')
5785
message = '<no message>'
5786
self.outf.write('%3d: %s\n' % (shelf_id, message))
5790
class cmd_unshelve(Command):
5791
"""Restore shelved changes.
5793
By default, the most recently shelved changes are restored. However if you
5794
specify a shelf by id those changes will be restored instead. This works
5795
best when the changes don't depend on each other.
5798
takes_args = ['shelf_id?']
5800
RegistryOption.from_kwargs(
5801
'action', help="The action to perform.",
5802
enum_switch=False, value_switches=True,
5803
apply="Apply changes and remove from the shelf.",
5804
dry_run="Show changes, but do not apply or remove them.",
5805
preview="Instead of unshelving the changes, show the diff that "
5806
"would result from unshelving.",
5807
delete_only="Delete changes without applying them.",
5808
keep="Apply changes but don't delete them.",
5811
_see_also = ['shelve']
5813
def run(self, shelf_id=None, action='apply'):
5814
from bzrlib.shelf_ui import Unshelver
5815
unshelver = Unshelver.from_args(shelf_id, action)
5819
unshelver.tree.unlock()
5822
class cmd_clean_tree(Command):
5823
"""Remove unwanted files from working tree.
5825
By default, only unknown files, not ignored files, are deleted. Versioned
5826
files are never deleted.
5828
Another class is 'detritus', which includes files emitted by bzr during
5829
normal operations and selftests. (The value of these files decreases with
5832
If no options are specified, unknown files are deleted. Otherwise, option
5833
flags are respected, and may be combined.
5835
To check what clean-tree will do, use --dry-run.
5837
takes_options = [Option('ignored', help='Delete all ignored files.'),
5838
Option('detritus', help='Delete conflict files, merge'
5839
' backups, and failed selftest dirs.'),
5841
help='Delete files unknown to bzr (default).'),
5842
Option('dry-run', help='Show files to delete instead of'
5844
Option('force', help='Do not prompt before deleting.')]
5845
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5847
from bzrlib.clean_tree import clean_tree
5848
if not (unknown or ignored or detritus):
5852
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5853
dry_run=dry_run, no_prompt=force)
5856
class cmd_reference(Command):
5857
"""list, view and set branch locations for nested trees.
5859
If no arguments are provided, lists the branch locations for nested trees.
5860
If one argument is provided, display the branch location for that tree.
5861
If two arguments are provided, set the branch location for that tree.
5866
takes_args = ['path?', 'location?']
5868
def run(self, path=None, location=None):
5870
if path is not None:
5872
tree, branch, relpath =(
5873
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5874
if path is not None:
5877
tree = branch.basis_tree()
5879
info = branch._get_all_reference_info().iteritems()
5880
self._display_reference_info(tree, branch, info)
5882
file_id = tree.path2id(path)
5884
raise errors.NotVersionedError(path)
5885
if location is None:
5886
info = [(file_id, branch.get_reference_info(file_id))]
5887
self._display_reference_info(tree, branch, info)
5889
branch.set_reference_info(file_id, path, location)
5891
def _display_reference_info(self, tree, branch, info):
5893
for file_id, (path, location) in info:
5895
path = tree.id2path(file_id)
5896
except errors.NoSuchId:
5898
ref_list.append((path, location))
5899
for path, location in sorted(ref_list):
5900
self.outf.write('%s %s\n' % (path, location))
5903
# these get imported and then picked up by the scan for cmd_*
5904
# TODO: Some more consistent way to split command definitions across files;
5905
# we do need to load at least some information about them to know of
5906
# aliases. ideally we would avoid loading the implementation until the
5907
# details were needed.
5908
from bzrlib.cmd_version_info import cmd_version_info
5909
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5910
from bzrlib.bundle.commands import (
5913
from bzrlib.foreign import cmd_dpush
5914
from bzrlib.sign_my_commits import cmd_sign_my_commits
added
removed
bzrlib/builtins.py
