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):
685
wt, dd = WorkingTree.open_containing(d)
686
base = os.path.dirname(dd)
687
id = wt.path2id(base)
691
self.outf.write('added %s\n' % d)
693
raise errors.NotVersionedError(path=base)
696
class cmd_relpath(Command):
697
"""Show path of a file relative to root"""
699
takes_args = ['filename']
703
def run(self, filename):
704
# TODO: jam 20050106 Can relpath return a munged path if
705
# sys.stdout encoding cannot represent it?
706
tree, relpath = WorkingTree.open_containing(filename)
707
self.outf.write(relpath)
708
self.outf.write('\n')
711
class cmd_inventory(Command):
712
"""Show inventory of the current working copy or a revision.
714
It is possible to limit the output to a particular entry
715
type using the --kind option. For example: --kind file.
717
It is also possible to restrict the list of files to a specific
718
set. For example: bzr inventory --show-ids this/file
727
help='List entries of a particular kind: file, directory, symlink.',
730
takes_args = ['file*']
733
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
734
if kind and kind not in ['file', 'directory', 'symlink']:
735
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
737
revision = _get_one_revision('inventory', revision)
738
work_tree, file_list = tree_files(file_list)
739
work_tree.lock_read()
740
self.add_cleanup(work_tree.unlock)
741
if revision is not None:
742
tree = revision.as_tree(work_tree.branch)
744
extra_trees = [work_tree]
746
self.add_cleanup(tree.unlock)
751
if file_list is not None:
752
file_ids = tree.paths2ids(file_list, trees=extra_trees,
753
require_versioned=True)
754
# find_ids_across_trees may include some paths that don't
756
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
757
for file_id in file_ids if file_id in tree)
759
entries = tree.inventory.entries()
762
for path, entry in entries:
763
if kind and kind != entry.kind:
766
self.outf.write('%-50s %s\n' % (path, entry.file_id))
768
self.outf.write(path)
769
self.outf.write('\n')
772
class cmd_mv(Command):
773
"""Move or rename a file.
776
bzr mv OLDNAME NEWNAME
778
bzr mv SOURCE... DESTINATION
780
If the last argument is a versioned directory, all the other names
781
are moved into it. Otherwise, there must be exactly two arguments
782
and the file is changed to a new name.
784
If OLDNAME does not exist on the filesystem but is versioned and
785
NEWNAME does exist on the filesystem but is not versioned, mv
786
assumes that the file has been manually moved and only updates
787
its internal inventory to reflect that change.
788
The same is valid when moving many SOURCE files to a DESTINATION.
790
Files cannot be moved between branches.
793
takes_args = ['names*']
794
takes_options = [Option("after", help="Move only the bzr identifier"
795
" of the file, because the file has already been moved."),
796
Option('auto', help='Automatically guess renames.'),
797
Option('dry-run', help='Avoid making changes when guessing renames.'),
799
aliases = ['move', 'rename']
800
encoding_type = 'replace'
802
def run(self, names_list, after=False, auto=False, dry_run=False):
804
return self.run_auto(names_list, after, dry_run)
806
raise errors.BzrCommandError('--dry-run requires --auto.')
807
if names_list is None:
809
if len(names_list) < 2:
810
raise errors.BzrCommandError("missing file argument")
811
tree, rel_names = tree_files(names_list, canonicalize=False)
812
tree.lock_tree_write()
813
self.add_cleanup(tree.unlock)
814
self._run(tree, names_list, rel_names, after)
816
def run_auto(self, names_list, after, dry_run):
817
if names_list is not None and len(names_list) > 1:
818
raise errors.BzrCommandError('Only one path may be specified to'
821
raise errors.BzrCommandError('--after cannot be specified with'
823
work_tree, file_list = tree_files(names_list, default_branch='.')
824
work_tree.lock_tree_write()
825
self.add_cleanup(work_tree.unlock)
826
rename_map.RenameMap.guess_renames(work_tree, dry_run)
828
def _run(self, tree, names_list, rel_names, after):
829
into_existing = osutils.isdir(names_list[-1])
830
if into_existing and len(names_list) == 2:
832
# a. case-insensitive filesystem and change case of dir
833
# b. move directory after the fact (if the source used to be
834
# a directory, but now doesn't exist in the working tree
835
# and the target is an existing directory, just rename it)
836
if (not tree.case_sensitive
837
and rel_names[0].lower() == rel_names[1].lower()):
838
into_existing = False
841
# 'fix' the case of a potential 'from'
842
from_id = tree.path2id(
843
tree.get_canonical_inventory_path(rel_names[0]))
844
if (not osutils.lexists(names_list[0]) and
845
from_id and inv.get_file_kind(from_id) == "directory"):
846
into_existing = False
849
# move into existing directory
850
# All entries reference existing inventory items, so fix them up
851
# for cicp file-systems.
852
rel_names = tree.get_canonical_inventory_paths(rel_names)
853
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
855
self.outf.write("%s => %s\n" % (src, dest))
857
if len(names_list) != 2:
858
raise errors.BzrCommandError('to mv multiple files the'
859
' destination must be a versioned'
862
# for cicp file-systems: the src references an existing inventory
864
src = tree.get_canonical_inventory_path(rel_names[0])
865
# Find the canonical version of the destination: In all cases, the
866
# parent of the target must be in the inventory, so we fetch the
867
# canonical version from there (we do not always *use* the
868
# canonicalized tail portion - we may be attempting to rename the
870
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
871
dest_parent = osutils.dirname(canon_dest)
872
spec_tail = osutils.basename(rel_names[1])
873
# For a CICP file-system, we need to avoid creating 2 inventory
874
# entries that differ only by case. So regardless of the case
875
# we *want* to use (ie, specified by the user or the file-system),
876
# we must always choose to use the case of any existing inventory
877
# items. The only exception to this is when we are attempting a
878
# case-only rename (ie, canonical versions of src and dest are
880
dest_id = tree.path2id(canon_dest)
881
if dest_id is None or tree.path2id(src) == dest_id:
882
# No existing item we care about, so work out what case we
883
# are actually going to use.
885
# If 'after' is specified, the tail must refer to a file on disk.
887
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
889
# pathjoin with an empty tail adds a slash, which breaks
891
dest_parent_fq = tree.basedir
893
dest_tail = osutils.canonical_relpath(
895
osutils.pathjoin(dest_parent_fq, spec_tail))
897
# not 'after', so case as specified is used
898
dest_tail = spec_tail
900
# Use the existing item so 'mv' fails with AlreadyVersioned.
901
dest_tail = os.path.basename(canon_dest)
902
dest = osutils.pathjoin(dest_parent, dest_tail)
903
mutter("attempting to move %s => %s", src, dest)
904
tree.rename_one(src, dest, after=after)
906
self.outf.write("%s => %s\n" % (src, dest))
909
class cmd_pull(Command):
910
"""Turn this branch into a mirror of another branch.
912
By default, this command only works on branches that have not diverged.
913
Branches are considered diverged if the destination branch's most recent
914
commit is one that has not been merged (directly or indirectly) into the
917
If branches have diverged, you can use 'bzr merge' to integrate the changes
918
from one into the other. Once one branch has merged, the other should
919
be able to pull it again.
921
If you want to replace your local changes and just want your branch to
922
match the remote one, use pull --overwrite. This will work even if the two
923
branches have diverged.
925
If there is no default location set, the first pull will set it. After
926
that, you can omit the location to use the default. To change the
927
default, use --remember. The value will only be saved if the remote
928
location can be accessed.
930
Note: The location can be specified either in the form of a branch,
931
or in the form of a path to a file containing a merge directive generated
935
_see_also = ['push', 'update', 'status-flags', 'send']
936
takes_options = ['remember', 'overwrite', 'revision',
937
custom_help('verbose',
938
help='Show logs of pulled revisions.'),
940
help='Branch to pull into, '
941
'rather than the one containing the working directory.',
946
help="Perform a local pull in a bound "
947
"branch. Local pulls are not applied to "
951
takes_args = ['location?']
952
encoding_type = 'replace'
954
def run(self, location=None, remember=False, overwrite=False,
955
revision=None, verbose=False,
956
directory=None, local=False):
957
# FIXME: too much stuff is in the command class
960
if directory is None:
963
tree_to = WorkingTree.open_containing(directory)[0]
964
branch_to = tree_to.branch
965
except errors.NoWorkingTree:
967
branch_to = Branch.open_containing(directory)[0]
969
if local and not branch_to.get_bound_location():
970
raise errors.LocalRequiresBoundBranch()
972
possible_transports = []
973
if location is not None:
975
mergeable = bundle.read_mergeable_from_url(location,
976
possible_transports=possible_transports)
977
except errors.NotABundle:
980
stored_loc = branch_to.get_parent()
982
if stored_loc is None:
983
raise errors.BzrCommandError("No pull location known or"
986
display_url = urlutils.unescape_for_display(stored_loc,
989
self.outf.write("Using saved parent location: %s\n" % display_url)
990
location = stored_loc
992
revision = _get_one_revision('pull', revision)
993
if mergeable is not None:
994
if revision is not None:
995
raise errors.BzrCommandError(
996
'Cannot use -r with merge directives or bundles')
997
mergeable.install_revisions(branch_to.repository)
998
base_revision_id, revision_id, verified = \
999
mergeable.get_merge_request(branch_to.repository)
1000
branch_from = branch_to
1002
branch_from = Branch.open(location,
1003
possible_transports=possible_transports)
1005
if branch_to.get_parent() is None or remember:
1006
branch_to.set_parent(branch_from.base)
1008
if branch_from is not branch_to:
1009
branch_from.lock_read()
1010
self.add_cleanup(branch_from.unlock)
1011
if revision is not None:
1012
revision_id = revision.as_revision_id(branch_from)
1014
branch_to.lock_write()
1015
self.add_cleanup(branch_to.unlock)
1016
if tree_to is not None:
1017
view_info = _get_view_info_for_change_reporter(tree_to)
1018
change_reporter = delta._ChangeReporter(
1019
unversioned_filter=tree_to.is_ignored,
1020
view_info=view_info)
1021
result = tree_to.pull(
1022
branch_from, overwrite, revision_id, change_reporter,
1023
possible_transports=possible_transports, local=local)
1025
result = branch_to.pull(
1026
branch_from, overwrite, revision_id, local=local)
1028
result.report(self.outf)
1029
if verbose and result.old_revid != result.new_revid:
1030
log.show_branch_change(
1031
branch_to, self.outf, result.old_revno,
1035
class cmd_push(Command):
1036
"""Update a mirror of this branch.
1038
The target branch will not have its working tree populated because this
1039
is both expensive, and is not supported on remote file systems.
1041
Some smart servers or protocols *may* put the working tree in place in
1044
This command only works on branches that have not diverged. Branches are
1045
considered diverged if the destination branch's most recent commit is one
1046
that has not been merged (directly or indirectly) by the source branch.
1048
If branches have diverged, you can use 'bzr push --overwrite' to replace
1049
the other branch completely, discarding its unmerged changes.
1051
If you want to ensure you have the different changes in the other branch,
1052
do a merge (see bzr help merge) from the other branch, and commit that.
1053
After that you will be able to do a push without '--overwrite'.
1055
If there is no default push location set, the first push will set it.
1056
After that, you can omit the location to use the default. To change the
1057
default, use --remember. The value will only be saved if the remote
1058
location can be accessed.
1061
_see_also = ['pull', 'update', 'working-trees']
1062
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1063
Option('create-prefix',
1064
help='Create the path leading up to the branch '
1065
'if it does not already exist.'),
1067
help='Branch to push from, '
1068
'rather than the one containing the working directory.',
1072
Option('use-existing-dir',
1073
help='By default push will fail if the target'
1074
' directory exists, but does not already'
1075
' have a control directory. This flag will'
1076
' allow push to proceed.'),
1078
help='Create a stacked branch that references the public location '
1079
'of the parent branch.'),
1080
Option('stacked-on',
1081
help='Create a stacked branch that refers to another branch '
1082
'for the commit history. Only the work not present in the '
1083
'referenced branch is included in the branch created.',
1086
help='Refuse to push if there are uncommitted changes in'
1087
' the working tree, --no-strict disables the check.'),
1089
takes_args = ['location?']
1090
encoding_type = 'replace'
1092
def run(self, location=None, remember=False, overwrite=False,
1093
create_prefix=False, verbose=False, revision=None,
1094
use_existing_dir=False, directory=None, stacked_on=None,
1095
stacked=False, strict=None):
1096
from bzrlib.push import _show_push_branch
1098
if directory is None:
1100
# Get the source branch
1102
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1104
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1105
if strict is None: strict = True # default value
1106
# Get the tip's revision_id
1107
revision = _get_one_revision('push', revision)
1108
if revision is not None:
1109
revision_id = revision.in_history(br_from).rev_id
1112
if strict and tree is not None and revision_id is None:
1113
if (tree.has_changes()):
1114
raise errors.UncommittedChanges(
1115
tree, more='Use --no-strict to force the push.')
1116
if tree.last_revision() != tree.branch.last_revision():
1117
# The tree has lost sync with its branch, there is little
1118
# chance that the user is aware of it but he can still force
1119
# the push with --no-strict
1120
raise errors.OutOfDateTree(
1121
tree, more='Use --no-strict to force the push.')
1123
# Get the stacked_on branch, if any
1124
if stacked_on is not None:
1125
stacked_on = urlutils.normalize_url(stacked_on)
1127
parent_url = br_from.get_parent()
1129
parent = Branch.open(parent_url)
1130
stacked_on = parent.get_public_branch()
1132
# I considered excluding non-http url's here, thus forcing
1133
# 'public' branches only, but that only works for some
1134
# users, so it's best to just depend on the user spotting an
1135
# error by the feedback given to them. RBC 20080227.
1136
stacked_on = parent_url
1138
raise errors.BzrCommandError(
1139
"Could not determine branch to refer to.")
1141
# Get the destination location
1142
if location is None:
1143
stored_loc = br_from.get_push_location()
1144
if stored_loc is None:
1145
raise errors.BzrCommandError(
1146
"No push location known or specified.")
1148
display_url = urlutils.unescape_for_display(stored_loc,
1150
self.outf.write("Using saved push location: %s\n" % display_url)
1151
location = stored_loc
1153
_show_push_branch(br_from, revision_id, location, self.outf,
1154
verbose=verbose, overwrite=overwrite, remember=remember,
1155
stacked_on=stacked_on, create_prefix=create_prefix,
1156
use_existing_dir=use_existing_dir)
1159
class cmd_branch(Command):
1160
"""Create a new branch that is a copy of an existing branch.
1162
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1163
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1164
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1165
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1166
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1169
To retrieve the branch as of a particular revision, supply the --revision
1170
parameter, as in "branch foo/bar -r 5".
1173
_see_also = ['checkout']
1174
takes_args = ['from_location', 'to_location?']
1175
takes_options = ['revision', Option('hardlink',
1176
help='Hard-link working tree files where possible.'),
1178
help="Create a branch without a working-tree."),
1180
help="Switch the checkout in the current directory "
1181
"to the new branch."),
1183
help='Create a stacked branch referring to the source branch. '
1184
'The new branch will depend on the availability of the source '
1185
'branch for all operations.'),
1186
Option('standalone',
1187
help='Do not use a shared repository, even if available.'),
1188
Option('use-existing-dir',
1189
help='By default branch will fail if the target'
1190
' directory exists, but does not already'
1191
' have a control directory. This flag will'
1192
' allow branch to proceed.'),
1194
help="Bind new branch to from location."),
1196
aliases = ['get', 'clone']
1198
def run(self, from_location, to_location=None, revision=None,
1199
hardlink=False, stacked=False, standalone=False, no_tree=False,
1200
use_existing_dir=False, switch=False, bind=False):
1201
from bzrlib import switch as _mod_switch
1202
from bzrlib.tag import _merge_tags_if_possible
1203
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1205
revision = _get_one_revision('branch', revision)
1207
self.add_cleanup(br_from.unlock)
1208
if revision is not None:
1209
revision_id = revision.as_revision_id(br_from)
1211
# FIXME - wt.last_revision, fallback to branch, fall back to
1212
# None or perhaps NULL_REVISION to mean copy nothing
1214
revision_id = br_from.last_revision()
1215
if to_location is None:
1216
to_location = urlutils.derive_to_location(from_location)
1217
to_transport = transport.get_transport(to_location)
1219
to_transport.mkdir('.')
1220
except errors.FileExists:
1221
if not use_existing_dir:
1222
raise errors.BzrCommandError('Target directory "%s" '
1223
'already exists.' % to_location)
1226
bzrdir.BzrDir.open_from_transport(to_transport)
1227
except errors.NotBranchError:
1230
raise errors.AlreadyBranchError(to_location)
1231
except errors.NoSuchFile:
1232
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1235
# preserve whatever source format we have.
1236
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1237
possible_transports=[to_transport],
1238
accelerator_tree=accelerator_tree,
1239
hardlink=hardlink, stacked=stacked,
1240
force_new_repo=standalone,
1241
create_tree_if_local=not no_tree,
1242
source_branch=br_from)
1243
branch = dir.open_branch()
1244
except errors.NoSuchRevision:
1245
to_transport.delete_tree('.')
1246
msg = "The branch %s has no revision %s." % (from_location,
1248
raise errors.BzrCommandError(msg)
1249
_merge_tags_if_possible(br_from, branch)
1250
# If the source branch is stacked, the new branch may
1251
# be stacked whether we asked for that explicitly or not.
1252
# We therefore need a try/except here and not just 'if stacked:'
1254
note('Created new stacked branch referring to %s.' %
1255
branch.get_stacked_on_url())
1256
except (errors.NotStacked, errors.UnstackableBranchFormat,
1257
errors.UnstackableRepositoryFormat), e:
1258
note('Branched %d revision(s).' % branch.revno())
1260
# Bind to the parent
1261
parent_branch = Branch.open(from_location)
1262
branch.bind(parent_branch)
1263
note('New branch bound to %s' % from_location)
1265
# Switch to the new branch
1266
wt, _ = WorkingTree.open_containing('.')
1267
_mod_switch.switch(wt.bzrdir, branch)
1268
note('Switched to branch: %s',
1269
urlutils.unescape_for_display(branch.base, 'utf-8'))
1272
class cmd_checkout(Command):
1273
"""Create a new checkout of an existing branch.
1275
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1276
the branch found in '.'. This is useful if you have removed the working tree
1277
or if it was never created - i.e. if you pushed the branch to its current
1278
location using SFTP.
1280
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1281
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1282
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1283
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1284
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1287
To retrieve the branch as of a particular revision, supply the --revision
1288
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1289
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1293
_see_also = ['checkouts', 'branch']
1294
takes_args = ['branch_location?', 'to_location?']
1295
takes_options = ['revision',
1296
Option('lightweight',
1297
help="Perform a lightweight checkout. Lightweight "
1298
"checkouts depend on access to the branch for "
1299
"every operation. Normal checkouts can perform "
1300
"common operations like diff and status without "
1301
"such access, and also support local commits."
1303
Option('files-from', type=str,
1304
help="Get file contents from this tree."),
1306
help='Hard-link working tree files where possible.'
1311
def run(self, branch_location=None, to_location=None, revision=None,
1312
lightweight=False, files_from=None, hardlink=False):
1313
if branch_location is None:
1314
branch_location = osutils.getcwd()
1315
to_location = branch_location
1316
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1318
revision = _get_one_revision('checkout', revision)
1319
if files_from is not None:
1320
accelerator_tree = WorkingTree.open(files_from)
1321
if revision is not None:
1322
revision_id = revision.as_revision_id(source)
1325
if to_location is None:
1326
to_location = urlutils.derive_to_location(branch_location)
1327
# if the source and to_location are the same,
1328
# and there is no working tree,
1329
# then reconstitute a branch
1330
if (osutils.abspath(to_location) ==
1331
osutils.abspath(branch_location)):
1333
source.bzrdir.open_workingtree()
1334
except errors.NoWorkingTree:
1335
source.bzrdir.create_workingtree(revision_id)
1337
source.create_checkout(to_location, revision_id, lightweight,
1338
accelerator_tree, hardlink)
1341
class cmd_renames(Command):
1342
"""Show list of renamed files.
1344
# TODO: Option to show renames between two historical versions.
1346
# TODO: Only show renames under dir, rather than in the whole branch.
1347
_see_also = ['status']
1348
takes_args = ['dir?']
1351
def run(self, dir=u'.'):
1352
tree = WorkingTree.open_containing(dir)[0]
1354
self.add_cleanup(tree.unlock)
1355
new_inv = tree.inventory
1356
old_tree = tree.basis_tree()
1357
old_tree.lock_read()
1358
self.add_cleanup(old_tree.unlock)
1359
old_inv = old_tree.inventory
1361
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1362
for f, paths, c, v, p, n, k, e in iterator:
1363
if paths[0] == paths[1]:
1367
renames.append(paths)
1369
for old_name, new_name in renames:
1370
self.outf.write("%s => %s\n" % (old_name, new_name))
1373
class cmd_update(Command):
1374
"""Update a tree to have the latest code committed to its branch.
1376
This will perform a merge into the working tree, and may generate
1377
conflicts. If you have any local changes, you will still
1378
need to commit them after the update for the update to be complete.
1380
If you want to discard your local changes, you can just do a
1381
'bzr revert' instead of 'bzr commit' after the update.
1383
If the tree's branch is bound to a master branch, it will also update
1384
the branch from the master.
1387
_see_also = ['pull', 'working-trees', 'status-flags']
1388
takes_args = ['dir?']
1389
takes_options = ['revision']
1392
def run(self, dir='.', revision=None):
1393
if revision is not None and len(revision) != 1:
1394
raise errors.BzrCommandError(
1395
"bzr update --revision takes exactly one revision")
1396
tree = WorkingTree.open_containing(dir)[0]
1397
branch = tree.branch
1398
possible_transports = []
1399
master = branch.get_master_branch(
1400
possible_transports=possible_transports)
1401
if master is not None:
1403
branch_location = master.base
1405
tree.lock_tree_write()
1406
branch_location = tree.branch.base
1407
self.add_cleanup(tree.unlock)
1408
# get rid of the final '/' and be ready for display
1409
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1411
existing_pending_merges = tree.get_parent_ids()[1:]
1415
# may need to fetch data into a heavyweight checkout
1416
# XXX: this may take some time, maybe we should display a
1418
old_tip = branch.update(possible_transports)
1419
if revision is not None:
1420
revision_id = revision[0].as_revision_id(branch)
1422
revision_id = branch.last_revision()
1423
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1424
revno = branch.revision_id_to_revno(revision_id)
1425
note("Tree is up to date at revision %d of branch %s" %
1426
(revno, branch_location))
1428
view_info = _get_view_info_for_change_reporter(tree)
1429
change_reporter = delta._ChangeReporter(
1430
unversioned_filter=tree.is_ignored,
1431
view_info=view_info)
1433
conflicts = tree.update(
1435
possible_transports=possible_transports,
1436
revision=revision_id,
1438
except errors.NoSuchRevision, e:
1439
raise errors.BzrCommandError(
1440
"branch has no revision %s\n"
1441
"bzr update --revision only works"
1442
" for a revision in the branch history"
1444
revno = tree.branch.revision_id_to_revno(
1445
_mod_revision.ensure_null(tree.last_revision()))
1446
note('Updated to revision %d of branch %s' %
1447
(revno, branch_location))
1448
if tree.get_parent_ids()[1:] != existing_pending_merges:
1449
note('Your local commits will now show as pending merges with '
1450
"'bzr status', and can be committed with 'bzr commit'.")
1457
class cmd_info(Command):
1458
"""Show information about a working tree, branch or repository.
1460
This command will show all known locations and formats associated to the
1461
tree, branch or repository.
1463
In verbose mode, statistical information is included with each report.
1464
To see extended statistic information, use a verbosity level of 2 or
1465
higher by specifying the verbose option multiple times, e.g. -vv.
1467
Branches and working trees will also report any missing revisions.
1471
Display information on the format and related locations:
1475
Display the above together with extended format information and
1476
basic statistics (like the number of files in the working tree and
1477
number of revisions in the branch and repository):
1481
Display the above together with number of committers to the branch:
1485
_see_also = ['revno', 'working-trees', 'repositories']
1486
takes_args = ['location?']
1487
takes_options = ['verbose']
1488
encoding_type = 'replace'
1491
def run(self, location=None, verbose=False):
1493
noise_level = get_verbosity_level()
1496
from bzrlib.info import show_bzrdir_info
1497
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1498
verbose=noise_level, outfile=self.outf)
1501
class cmd_remove(Command):
1502
"""Remove files or directories.
1504
This makes bzr stop tracking changes to the specified files. bzr will delete
1505
them if they can easily be recovered using revert. If no options or
1506
parameters are given bzr will scan for files that are being tracked by bzr
1507
but missing in your tree and stop tracking them for you.
1509
takes_args = ['file*']
1510
takes_options = ['verbose',
1511
Option('new', help='Only remove files that have never been committed.'),
1512
RegistryOption.from_kwargs('file-deletion-strategy',
1513
'The file deletion mode to be used.',
1514
title='Deletion Strategy', value_switches=True, enum_switch=False,
1515
safe='Only delete files if they can be'
1516
' safely recovered (default).',
1517
keep='Delete from bzr but leave the working copy.',
1518
force='Delete all the specified files, even if they can not be '
1519
'recovered and even if they are non-empty directories.')]
1520
aliases = ['rm', 'del']
1521
encoding_type = 'replace'
1523
def run(self, file_list, verbose=False, new=False,
1524
file_deletion_strategy='safe'):
1525
tree, file_list = tree_files(file_list)
1527
if file_list is not None:
1528
file_list = [f for f in file_list]
1531
self.add_cleanup(tree.unlock)
1532
# Heuristics should probably all move into tree.remove_smart or
1535
added = tree.changes_from(tree.basis_tree(),
1536
specific_files=file_list).added
1537
file_list = sorted([f[0] for f in added], reverse=True)
1538
if len(file_list) == 0:
1539
raise errors.BzrCommandError('No matching files.')
1540
elif file_list is None:
1541
# missing files show up in iter_changes(basis) as
1542
# versioned-with-no-kind.
1544
for change in tree.iter_changes(tree.basis_tree()):
1545
# Find paths in the working tree that have no kind:
1546
if change[1][1] is not None and change[6][1] is None:
1547
missing.append(change[1][1])
1548
file_list = sorted(missing, reverse=True)
1549
file_deletion_strategy = 'keep'
1550
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1551
keep_files=file_deletion_strategy=='keep',
1552
force=file_deletion_strategy=='force')
1555
class cmd_file_id(Command):
1556
"""Print file_id of a particular file or directory.
1558
The file_id is assigned when the file is first added and remains the
1559
same through all revisions where the file exists, even when it is
1564
_see_also = ['inventory', 'ls']
1565
takes_args = ['filename']
1568
def run(self, filename):
1569
tree, relpath = WorkingTree.open_containing(filename)
1570
i = tree.path2id(relpath)
1572
raise errors.NotVersionedError(filename)
1574
self.outf.write(i + '\n')
1577
class cmd_file_path(Command):
1578
"""Print path of file_ids to a file or directory.
1580
This prints one line for each directory down to the target,
1581
starting at the branch root.
1585
takes_args = ['filename']
1588
def run(self, filename):
1589
tree, relpath = WorkingTree.open_containing(filename)
1590
fid = tree.path2id(relpath)
1592
raise errors.NotVersionedError(filename)
1593
segments = osutils.splitpath(relpath)
1594
for pos in range(1, len(segments) + 1):
1595
path = osutils.joinpath(segments[:pos])
1596
self.outf.write("%s\n" % tree.path2id(path))
1599
class cmd_reconcile(Command):
1600
"""Reconcile bzr metadata in a branch.
1602
This can correct data mismatches that may have been caused by
1603
previous ghost operations or bzr upgrades. You should only
1604
need to run this command if 'bzr check' or a bzr developer
1605
advises you to run it.
1607
If a second branch is provided, cross-branch reconciliation is
1608
also attempted, which will check that data like the tree root
1609
id which was not present in very early bzr versions is represented
1610
correctly in both branches.
1612
At the same time it is run it may recompress data resulting in
1613
a potential saving in disk space or performance gain.
1615
The branch *MUST* be on a listable system such as local disk or sftp.
1618
_see_also = ['check']
1619
takes_args = ['branch?']
1621
def run(self, branch="."):
1622
from bzrlib.reconcile import reconcile
1623
dir = bzrdir.BzrDir.open(branch)
1627
class cmd_revision_history(Command):
1628
"""Display the list of revision ids on a branch."""
1631
takes_args = ['location?']
1636
def run(self, location="."):
1637
branch = Branch.open_containing(location)[0]
1638
for revid in branch.revision_history():
1639
self.outf.write(revid)
1640
self.outf.write('\n')
1643
class cmd_ancestry(Command):
1644
"""List all revisions merged into this branch."""
1646
_see_also = ['log', 'revision-history']
1647
takes_args = ['location?']
1652
def run(self, location="."):
1654
wt = WorkingTree.open_containing(location)[0]
1655
except errors.NoWorkingTree:
1656
b = Branch.open(location)
1657
last_revision = b.last_revision()
1660
last_revision = wt.last_revision()
1662
revision_ids = b.repository.get_ancestry(last_revision)
1664
for revision_id in revision_ids:
1665
self.outf.write(revision_id + '\n')
1668
class cmd_init(Command):
1669
"""Make a directory into a versioned branch.
1671
Use this to create an empty branch, or before importing an
1674
If there is a repository in a parent directory of the location, then
1675
the history of the branch will be stored in the repository. Otherwise
1676
init creates a standalone branch which carries its own history
1677
in the .bzr directory.
1679
If there is already a branch at the location but it has no working tree,
1680
the tree can be populated with 'bzr checkout'.
1682
Recipe for importing a tree of files::
1688
bzr commit -m "imported project"
1691
_see_also = ['init-repository', 'branch', 'checkout']
1692
takes_args = ['location?']
1694
Option('create-prefix',
1695
help='Create the path leading up to the branch '
1696
'if it does not already exist.'),
1697
RegistryOption('format',
1698
help='Specify a format for this branch. '
1699
'See "help formats".',
1700
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1701
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1702
value_switches=True,
1703
title="Branch format",
1705
Option('append-revisions-only',
1706
help='Never change revnos or the existing log.'
1707
' Append revisions to it only.')
1709
def run(self, location=None, format=None, append_revisions_only=False,
1710
create_prefix=False):
1712
format = bzrdir.format_registry.make_bzrdir('default')
1713
if location is None:
1716
to_transport = transport.get_transport(location)
1718
# The path has to exist to initialize a
1719
# branch inside of it.
1720
# Just using os.mkdir, since I don't
1721
# believe that we want to create a bunch of
1722
# locations if the user supplies an extended path
1724
to_transport.ensure_base()
1725
except errors.NoSuchFile:
1726
if not create_prefix:
1727
raise errors.BzrCommandError("Parent directory of %s"
1729
"\nYou may supply --create-prefix to create all"
1730
" leading parent directories."
1732
to_transport.create_prefix()
1735
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1736
except errors.NotBranchError:
1737
# really a NotBzrDir error...
1738
create_branch = bzrdir.BzrDir.create_branch_convenience
1739
branch = create_branch(to_transport.base, format=format,
1740
possible_transports=[to_transport])
1741
a_bzrdir = branch.bzrdir
1743
from bzrlib.transport.local import LocalTransport
1744
if a_bzrdir.has_branch():
1745
if (isinstance(to_transport, LocalTransport)
1746
and not a_bzrdir.has_workingtree()):
1747
raise errors.BranchExistsWithoutWorkingTree(location)
1748
raise errors.AlreadyBranchError(location)
1749
branch = a_bzrdir.create_branch()
1750
a_bzrdir.create_workingtree()
1751
if append_revisions_only:
1753
branch.set_append_revisions_only(True)
1754
except errors.UpgradeRequired:
1755
raise errors.BzrCommandError('This branch format cannot be set'
1756
' to append-revisions-only. Try --default.')
1758
from bzrlib.info import describe_layout, describe_format
1760
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1761
except (errors.NoWorkingTree, errors.NotLocalUrl):
1763
repository = branch.repository
1764
layout = describe_layout(repository, branch, tree).lower()
1765
format = describe_format(a_bzrdir, repository, branch, tree)
1766
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1767
if repository.is_shared():
1768
#XXX: maybe this can be refactored into transport.path_or_url()
1769
url = repository.bzrdir.root_transport.external_url()
1771
url = urlutils.local_path_from_url(url)
1772
except errors.InvalidURL:
1774
self.outf.write("Using shared repository: %s\n" % url)
1777
class cmd_init_repository(Command):
1778
"""Create a shared repository for branches to share storage space.
1780
New branches created under the repository directory will store their
1781
revisions in the repository, not in the branch directory. For branches
1782
with shared history, this reduces the amount of storage needed and
1783
speeds up the creation of new branches.
1785
If the --no-trees option is given then the branches in the repository
1786
will not have working trees by default. They will still exist as
1787
directories on disk, but they will not have separate copies of the
1788
files at a certain revision. This can be useful for repositories that
1789
store branches which are interacted with through checkouts or remote
1790
branches, such as on a server.
1793
Create a shared repository holding just branches::
1795
bzr init-repo --no-trees repo
1798
Make a lightweight checkout elsewhere::
1800
bzr checkout --lightweight repo/trunk trunk-checkout
1805
_see_also = ['init', 'branch', 'checkout', 'repositories']
1806
takes_args = ["location"]
1807
takes_options = [RegistryOption('format',
1808
help='Specify a format for this repository. See'
1809
' "bzr help formats" for details.',
1810
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1811
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1812
value_switches=True, title='Repository format'),
1814
help='Branches in the repository will default to'
1815
' not having a working tree.'),
1817
aliases = ["init-repo"]
1819
def run(self, location, format=None, no_trees=False):
1821
format = bzrdir.format_registry.make_bzrdir('default')
1823
if location is None:
1826
to_transport = transport.get_transport(location)
1827
to_transport.ensure_base()
1829
newdir = format.initialize_on_transport(to_transport)
1830
repo = newdir.create_repository(shared=True)
1831
repo.set_make_working_trees(not no_trees)
1833
from bzrlib.info import show_bzrdir_info
1834
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1837
class cmd_diff(Command):
1838
"""Show differences in the working tree, between revisions or branches.
1840
If no arguments are given, all changes for the current tree are listed.
1841
If files are given, only the changes in those files are listed.
1842
Remote and multiple branches can be compared by using the --old and
1843
--new options. If not provided, the default for both is derived from
1844
the first argument, if any, or the current tree if no arguments are
1847
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1848
produces patches suitable for "patch -p1".
1852
2 - unrepresentable changes
1857
Shows the difference in the working tree versus the last commit::
1861
Difference between the working tree and revision 1::
1865
Difference between revision 3 and revision 1::
1869
Difference between revision 3 and revision 1 for branch xxx::
1873
To see the changes introduced in revision X::
1877
Note that in the case of a merge, the -c option shows the changes
1878
compared to the left hand parent. To see the changes against
1879
another parent, use::
1881
bzr diff -r<chosen_parent>..X
1883
The changes introduced by revision 2 (equivalent to -r1..2)::
1887
Show just the differences for file NEWS::
1891
Show the differences in working tree xxx for file NEWS::
1895
Show the differences from branch xxx to this working tree:
1899
Show the differences between two branches for file NEWS::
1901
bzr diff --old xxx --new yyy NEWS
1903
Same as 'bzr diff' but prefix paths with old/ and new/::
1905
bzr diff --prefix old/:new/
1907
_see_also = ['status']
1908
takes_args = ['file*']
1910
Option('diff-options', type=str,
1911
help='Pass these options to the external diff program.'),
1912
Option('prefix', type=str,
1914
help='Set prefixes added to old and new filenames, as '
1915
'two values separated by a colon. (eg "old/:new/").'),
1917
help='Branch/tree to compare from.',
1921
help='Branch/tree to compare to.',
1927
help='Use this command to compare files.',
1931
aliases = ['di', 'dif']
1932
encoding_type = 'exact'
1935
def run(self, revision=None, file_list=None, diff_options=None,
1936
prefix=None, old=None, new=None, using=None):
1937
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1939
if (prefix is None) or (prefix == '0'):
1947
old_label, new_label = prefix.split(":")
1949
raise errors.BzrCommandError(
1950
'--prefix expects two values separated by a colon'
1951
' (eg "old/:new/")')
1953
if revision and len(revision) > 2:
1954
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1955
' one or two revision specifiers')
1957
(old_tree, new_tree,
1958
old_branch, new_branch,
1959
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1960
file_list, revision, old, new, apply_view=True)
1961
return show_diff_trees(old_tree, new_tree, sys.stdout,
1962
specific_files=specific_files,
1963
external_diff_options=diff_options,
1964
old_label=old_label, new_label=new_label,
1965
extra_trees=extra_trees, using=using)
1968
class cmd_deleted(Command):
1969
"""List files deleted in the working tree.
1971
# TODO: Show files deleted since a previous revision, or
1972
# between two revisions.
1973
# TODO: Much more efficient way to do this: read in new
1974
# directories with readdir, rather than stating each one. Same
1975
# level of effort but possibly much less IO. (Or possibly not,
1976
# if the directories are very large...)
1977
_see_also = ['status', 'ls']
1978
takes_options = ['show-ids']
1981
def run(self, show_ids=False):
1982
tree = WorkingTree.open_containing(u'.')[0]
1984
self.add_cleanup(tree.unlock)
1985
old = tree.basis_tree()
1987
self.add_cleanup(old.unlock)
1988
for path, ie in old.inventory.iter_entries():
1989
if not tree.has_id(ie.file_id):
1990
self.outf.write(path)
1992
self.outf.write(' ')
1993
self.outf.write(ie.file_id)
1994
self.outf.write('\n')
1997
class cmd_modified(Command):
1998
"""List files modified in working tree.
2002
_see_also = ['status', 'ls']
2005
help='Write an ascii NUL (\\0) separator '
2006
'between files rather than a newline.')
2010
def run(self, null=False):
2011
tree = WorkingTree.open_containing(u'.')[0]
2012
td = tree.changes_from(tree.basis_tree())
2013
for path, id, kind, text_modified, meta_modified in td.modified:
2015
self.outf.write(path + '\0')
2017
self.outf.write(osutils.quotefn(path) + '\n')
2020
class cmd_added(Command):
2021
"""List files added in working tree.
2025
_see_also = ['status', 'ls']
2028
help='Write an ascii NUL (\\0) separator '
2029
'between files rather than a newline.')
2033
def run(self, null=False):
2034
wt = WorkingTree.open_containing(u'.')[0]
2036
self.add_cleanup(wt.unlock)
2037
basis = wt.basis_tree()
2039
self.add_cleanup(basis.unlock)
2040
basis_inv = basis.inventory
2043
if file_id in basis_inv:
2045
if inv.is_root(file_id) and len(basis_inv) == 0:
2047
path = inv.id2path(file_id)
2048
if not os.access(osutils.abspath(path), os.F_OK):
2051
self.outf.write(path + '\0')
2053
self.outf.write(osutils.quotefn(path) + '\n')
2056
class cmd_root(Command):
2057
"""Show the tree root directory.
2059
The root is the nearest enclosing directory with a .bzr control
2062
takes_args = ['filename?']
2064
def run(self, filename=None):
2065
"""Print the branch root."""
2066
tree = WorkingTree.open_containing(filename)[0]
2067
self.outf.write(tree.basedir + '\n')
2070
def _parse_limit(limitstring):
2072
return int(limitstring)
2074
msg = "The limit argument must be an integer."
2075
raise errors.BzrCommandError(msg)
2078
def _parse_levels(s):
2082
msg = "The levels argument must be an integer."
2083
raise errors.BzrCommandError(msg)
2086
class cmd_log(Command):
2087
"""Show historical log for a branch or subset of a branch.
2089
log is bzr's default tool for exploring the history of a branch.
2090
The branch to use is taken from the first parameter. If no parameters
2091
are given, the branch containing the working directory is logged.
2092
Here are some simple examples::
2094
bzr log log the current branch
2095
bzr log foo.py log a file in its branch
2096
bzr log http://server/branch log a branch on a server
2098
The filtering, ordering and information shown for each revision can
2099
be controlled as explained below. By default, all revisions are
2100
shown sorted (topologically) so that newer revisions appear before
2101
older ones and descendants always appear before ancestors. If displayed,
2102
merged revisions are shown indented under the revision in which they
2107
The log format controls how information about each revision is
2108
displayed. The standard log formats are called ``long``, ``short``
2109
and ``line``. The default is long. See ``bzr help log-formats``
2110
for more details on log formats.
2112
The following options can be used to control what information is
2115
-l N display a maximum of N revisions
2116
-n N display N levels of revisions (0 for all, 1 for collapsed)
2117
-v display a status summary (delta) for each revision
2118
-p display a diff (patch) for each revision
2119
--show-ids display revision-ids (and file-ids), not just revnos
2121
Note that the default number of levels to display is a function of the
2122
log format. If the -n option is not used, the standard log formats show
2123
just the top level (mainline).
2125
Status summaries are shown using status flags like A, M, etc. To see
2126
the changes explained using words like ``added`` and ``modified``
2127
instead, use the -vv option.
2131
To display revisions from oldest to newest, use the --forward option.
2132
In most cases, using this option will have little impact on the total
2133
time taken to produce a log, though --forward does not incrementally
2134
display revisions like --reverse does when it can.
2136
:Revision filtering:
2138
The -r option can be used to specify what revision or range of revisions
2139
to filter against. The various forms are shown below::
2141
-rX display revision X
2142
-rX.. display revision X and later
2143
-r..Y display up to and including revision Y
2144
-rX..Y display from X to Y inclusive
2146
See ``bzr help revisionspec`` for details on how to specify X and Y.
2147
Some common examples are given below::
2149
-r-1 show just the tip
2150
-r-10.. show the last 10 mainline revisions
2151
-rsubmit:.. show what's new on this branch
2152
-rancestor:path.. show changes since the common ancestor of this
2153
branch and the one at location path
2154
-rdate:yesterday.. show changes since yesterday
2156
When logging a range of revisions using -rX..Y, log starts at
2157
revision Y and searches back in history through the primary
2158
("left-hand") parents until it finds X. When logging just the
2159
top level (using -n1), an error is reported if X is not found
2160
along the way. If multi-level logging is used (-n0), X may be
2161
a nested merge revision and the log will be truncated accordingly.
2165
If parameters are given and the first one is not a branch, the log
2166
will be filtered to show only those revisions that changed the
2167
nominated files or directories.
2169
Filenames are interpreted within their historical context. To log a
2170
deleted file, specify a revision range so that the file existed at
2171
the end or start of the range.
2173
Historical context is also important when interpreting pathnames of
2174
renamed files/directories. Consider the following example:
2176
* revision 1: add tutorial.txt
2177
* revision 2: modify tutorial.txt
2178
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2182
* ``bzr log guide.txt`` will log the file added in revision 1
2184
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2186
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2187
the original file in revision 2.
2189
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2190
was no file called guide.txt in revision 2.
2192
Renames are always followed by log. By design, there is no need to
2193
explicitly ask for this (and no way to stop logging a file back
2194
until it was last renamed).
2198
The --message option can be used for finding revisions that match a
2199
regular expression in a commit message.
2203
GUI tools and IDEs are often better at exploring history than command
2204
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2205
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2206
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2207
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2209
You may find it useful to add the aliases below to ``bazaar.conf``::
2213
top = log -l10 --line
2216
``bzr tip`` will then show the latest revision while ``bzr top``
2217
will show the last 10 mainline revisions. To see the details of a
2218
particular revision X, ``bzr show -rX``.
2220
If you are interested in looking deeper into a particular merge X,
2221
use ``bzr log -n0 -rX``.
2223
``bzr log -v`` on a branch with lots of history is currently
2224
very slow. A fix for this issue is currently under development.
2225
With or without that fix, it is recommended that a revision range
2226
be given when using the -v option.
2228
bzr has a generic full-text matching plugin, bzr-search, that can be
2229
used to find revisions matching user names, commit messages, etc.
2230
Among other features, this plugin can find all revisions containing
2231
a list of words but not others.
2233
When exploring non-mainline history on large projects with deep
2234
history, the performance of log can be greatly improved by installing
2235
the historycache plugin. This plugin buffers historical information
2236
trading disk space for faster speed.
2238
takes_args = ['file*']
2239
_see_also = ['log-formats', 'revisionspec']
2242
help='Show from oldest to newest.'),
2244
custom_help('verbose',
2245
help='Show files changed in each revision.'),
2249
type=bzrlib.option._parse_revision_str,
2251
help='Show just the specified revision.'
2252
' See also "help revisionspec".'),
2256
help='Number of levels to display - 0 for all, 1 for flat.',
2258
type=_parse_levels),
2261
help='Show revisions whose message matches this '
2262
'regular expression.',
2266
help='Limit the output to the first N revisions.',
2271
help='Show changes made in each revision as a patch.'),
2272
Option('include-merges',
2273
help='Show merged revisions like --levels 0 does.'),
2275
encoding_type = 'replace'
2278
def run(self, file_list=None, timezone='original',
2289
include_merges=False):
2290
from bzrlib.log import (
2292
make_log_request_dict,
2293
_get_info_for_log_files,
2295
direction = (forward and 'forward') or 'reverse'
2300
raise errors.BzrCommandError(
2301
'--levels and --include-merges are mutually exclusive')
2303
if change is not None:
2305
raise errors.RangeInChangeOption()
2306
if revision is not None:
2307
raise errors.BzrCommandError(
2308
'--revision and --change are mutually exclusive')
2313
filter_by_dir = False
2315
# find the file ids to log and check for directory filtering
2316
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2317
revision, file_list)
2318
self.add_cleanup(b.unlock)
2319
for relpath, file_id, kind in file_info_list:
2321
raise errors.BzrCommandError(
2322
"Path unknown at end or start of revision range: %s" %
2324
# If the relpath is the top of the tree, we log everything
2329
file_ids.append(file_id)
2330
filter_by_dir = filter_by_dir or (
2331
kind in ['directory', 'tree-reference'])
2334
# FIXME ? log the current subdir only RBC 20060203
2335
if revision is not None \
2336
and len(revision) > 0 and revision[0].get_branch():
2337
location = revision[0].get_branch()
2340
dir, relpath = bzrdir.BzrDir.open_containing(location)
2341
b = dir.open_branch()
2343
self.add_cleanup(b.unlock)
2344
rev1, rev2 = _get_revision_range(revision, b, self.name())
2346
# Decide on the type of delta & diff filtering to use
2347
# TODO: add an --all-files option to make this configurable & consistent
2355
diff_type = 'partial'
2359
# Build the log formatter
2360
if log_format is None:
2361
log_format = log.log_formatter_registry.get_default(b)
2362
# Make a non-encoding output to include the diffs - bug 328007
2363
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2364
lf = log_format(show_ids=show_ids, to_file=self.outf,
2365
to_exact_file=unencoded_output,
2366
show_timezone=timezone,
2367
delta_format=get_verbosity_level(),
2369
show_advice=levels is None)
2371
# Choose the algorithm for doing the logging. It's annoying
2372
# having multiple code paths like this but necessary until
2373
# the underlying repository format is faster at generating
2374
# deltas or can provide everything we need from the indices.
2375
# The default algorithm - match-using-deltas - works for
2376
# multiple files and directories and is faster for small
2377
# amounts of history (200 revisions say). However, it's too
2378
# slow for logging a single file in a repository with deep
2379
# history, i.e. > 10K revisions. In the spirit of "do no
2380
# evil when adding features", we continue to use the
2381
# original algorithm - per-file-graph - for the "single
2382
# file that isn't a directory without showing a delta" case.
2383
partial_history = revision and b.repository._format.supports_chks
2384
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2385
or delta_type or partial_history)
2387
# Build the LogRequest and execute it
2388
if len(file_ids) == 0:
2390
rqst = make_log_request_dict(
2391
direction=direction, specific_fileids=file_ids,
2392
start_revision=rev1, end_revision=rev2, limit=limit,
2393
message_search=message, delta_type=delta_type,
2394
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2395
Logger(b, rqst).show(lf)
2398
def _get_revision_range(revisionspec_list, branch, command_name):
2399
"""Take the input of a revision option and turn it into a revision range.
2401
It returns RevisionInfo objects which can be used to obtain the rev_id's
2402
of the desired revisions. It does some user input validations.
2404
if revisionspec_list is None:
2407
elif len(revisionspec_list) == 1:
2408
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2409
elif len(revisionspec_list) == 2:
2410
start_spec = revisionspec_list[0]
2411
end_spec = revisionspec_list[1]
2412
if end_spec.get_branch() != start_spec.get_branch():
2413
# b is taken from revision[0].get_branch(), and
2414
# show_log will use its revision_history. Having
2415
# different branches will lead to weird behaviors.
2416
raise errors.BzrCommandError(
2417
"bzr %s doesn't accept two revisions in different"
2418
" branches." % command_name)
2419
rev1 = start_spec.in_history(branch)
2420
# Avoid loading all of history when we know a missing
2421
# end of range means the last revision ...
2422
if end_spec.spec is None:
2423
last_revno, last_revision_id = branch.last_revision_info()
2424
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2426
rev2 = end_spec.in_history(branch)
2428
raise errors.BzrCommandError(
2429
'bzr %s --revision takes one or two values.' % command_name)
2433
def _revision_range_to_revid_range(revision_range):
2436
if revision_range[0] is not None:
2437
rev_id1 = revision_range[0].rev_id
2438
if revision_range[1] is not None:
2439
rev_id2 = revision_range[1].rev_id
2440
return rev_id1, rev_id2
2442
def get_log_format(long=False, short=False, line=False, default='long'):
2443
log_format = default
2447
log_format = 'short'
2453
class cmd_touching_revisions(Command):
2454
"""Return revision-ids which affected a particular file.
2456
A more user-friendly interface is "bzr log FILE".
2460
takes_args = ["filename"]
2463
def run(self, filename):
2464
tree, relpath = WorkingTree.open_containing(filename)
2465
file_id = tree.path2id(relpath)
2468
self.add_cleanup(b.unlock)
2469
touching_revs = log.find_touching_revisions(b, file_id)
2470
for revno, revision_id, what in touching_revs:
2471
self.outf.write("%6d %s\n" % (revno, what))
2474
class cmd_ls(Command):
2475
"""List files in a tree.
2478
_see_also = ['status', 'cat']
2479
takes_args = ['path?']
2483
Option('recursive', short_name='R',
2484
help='Recurse into subdirectories.'),
2486
help='Print paths relative to the root of the branch.'),
2487
Option('unknown', help='Print unknown files.'),
2488
Option('versioned', help='Print versioned files.',
2490
Option('ignored', help='Print ignored files.'),
2492
help='Write an ascii NUL (\\0) separator '
2493
'between files rather than a newline.'),
2495
help='List entries of a particular kind: file, directory, symlink.',
2500
def run(self, revision=None, verbose=False,
2501
recursive=False, from_root=False,
2502
unknown=False, versioned=False, ignored=False,
2503
null=False, kind=None, show_ids=False, path=None):
2505
if kind and kind not in ('file', 'directory', 'symlink'):
2506
raise errors.BzrCommandError('invalid kind specified')
2508
if verbose and null:
2509
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2510
all = not (unknown or versioned or ignored)
2512
selection = {'I':ignored, '?':unknown, 'V':versioned}
2518
raise errors.BzrCommandError('cannot specify both --from-root'
2521
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2524
# Calculate the prefix to use
2528
prefix = relpath + '/'
2529
elif fs_path != '.' and not fs_path.endswith('/'):
2530
prefix = fs_path + '/'
2532
if revision is not None or tree is None:
2533
tree = _get_one_revision_tree('ls', revision, branch=branch)
2536
if isinstance(tree, WorkingTree) and tree.supports_views():
2537
view_files = tree.views.lookup_view()
2540
view_str = views.view_display_str(view_files)
2541
note("Ignoring files outside view. View is %s" % view_str)
2544
self.add_cleanup(tree.unlock)
2545
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2546
from_dir=relpath, recursive=recursive):
2547
# Apply additional masking
2548
if not all and not selection[fc]:
2550
if kind is not None and fkind != kind:
2555
fullpath = osutils.pathjoin(relpath, fp)
2558
views.check_path_in_view(tree, fullpath)
2559
except errors.FileOutsideView:
2564
fp = osutils.pathjoin(prefix, fp)
2565
kindch = entry.kind_character()
2566
outstring = fp + kindch
2567
ui.ui_factory.clear_term()
2569
outstring = '%-8s %s' % (fc, outstring)
2570
if show_ids and fid is not None:
2571
outstring = "%-50s %s" % (outstring, fid)
2572
self.outf.write(outstring + '\n')
2574
self.outf.write(fp + '\0')
2577
self.outf.write(fid)
2578
self.outf.write('\0')
2586
self.outf.write('%-50s %s\n' % (outstring, my_id))
2588
self.outf.write(outstring + '\n')
2591
class cmd_unknowns(Command):
2592
"""List unknown files.
2600
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2601
self.outf.write(osutils.quotefn(f) + '\n')
2604
class cmd_ignore(Command):
2605
"""Ignore specified files or patterns.
2607
See ``bzr help patterns`` for details on the syntax of patterns.
2609
If a .bzrignore file does not exist, the ignore command
2610
will create one and add the specified files or patterns to the newly
2611
created file. The ignore command will also automatically add the
2612
.bzrignore file to be versioned. Creating a .bzrignore file without
2613
the use of the ignore command will require an explicit add command.
2615
To remove patterns from the ignore list, edit the .bzrignore file.
2616
After adding, editing or deleting that file either indirectly by
2617
using this command or directly by using an editor, be sure to commit
2620
Patterns prefixed with '!' are exceptions to ignore patterns and take
2621
precedence over regular ignores. Such exceptions are used to specify
2622
files that should be versioned which would otherwise be ignored.
2624
Patterns prefixed with '!!' act as regular ignore patterns, but have
2625
precedence over the '!' exception patterns.
2627
Note: ignore patterns containing shell wildcards must be quoted from
2631
Ignore the top level Makefile::
2633
bzr ignore ./Makefile
2635
Ignore .class files in all directories...::
2637
bzr ignore "*.class"
2639
...but do not ignore "special.class"::
2641
bzr ignore "!special.class"
2643
Ignore .o files under the lib directory::
2645
bzr ignore "lib/**/*.o"
2647
Ignore .o files under the lib directory::
2649
bzr ignore "RE:lib/.*\.o"
2651
Ignore everything but the "debian" toplevel directory::
2653
bzr ignore "RE:(?!debian/).*"
2655
Ignore everything except the "local" toplevel directory,
2656
but always ignore "*~" autosave files, even under local/::
2659
bzr ignore "!./local"
2663
_see_also = ['status', 'ignored', 'patterns']
2664
takes_args = ['name_pattern*']
2666
Option('old-default-rules',
2667
help='Write out the ignore rules bzr < 0.9 always used.')
2670
def run(self, name_pattern_list=None, old_default_rules=None):
2671
from bzrlib import ignores
2672
if old_default_rules is not None:
2673
# dump the rules and exit
2674
for pattern in ignores.OLD_DEFAULTS:
2677
if not name_pattern_list:
2678
raise errors.BzrCommandError("ignore requires at least one "
2679
"NAME_PATTERN or --old-default-rules")
2680
name_pattern_list = [globbing.normalize_pattern(p)
2681
for p in name_pattern_list]
2682
for name_pattern in name_pattern_list:
2683
if (name_pattern[0] == '/' or
2684
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2685
raise errors.BzrCommandError(
2686
"NAME_PATTERN should not be an absolute path")
2687
tree, relpath = WorkingTree.open_containing(u'.')
2688
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2689
ignored = globbing.Globster(name_pattern_list)
2692
for entry in tree.list_files():
2696
if ignored.match(filename):
2697
matches.append(filename.encode('utf-8'))
2699
if len(matches) > 0:
2700
print "Warning: the following files are version controlled and" \
2701
" match your ignore pattern:\n%s" \
2702
"\nThese files will continue to be version controlled" \
2703
" unless you 'bzr remove' them." % ("\n".join(matches),)
2706
class cmd_ignored(Command):
2707
"""List ignored files and the patterns that matched them.
2709
List all the ignored files and the ignore pattern that caused the file to
2712
Alternatively, to list just the files::
2717
encoding_type = 'replace'
2718
_see_also = ['ignore', 'ls']
2722
tree = WorkingTree.open_containing(u'.')[0]
2724
self.add_cleanup(tree.unlock)
2725
for path, file_class, kind, file_id, entry in tree.list_files():
2726
if file_class != 'I':
2728
## XXX: Slightly inefficient since this was already calculated
2729
pat = tree.is_ignored(path)
2730
self.outf.write('%-50s %s\n' % (path, pat))
2733
class cmd_lookup_revision(Command):
2734
"""Lookup the revision-id from a revision-number
2737
bzr lookup-revision 33
2740
takes_args = ['revno']
2743
def run(self, revno):
2747
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2749
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2752
class cmd_export(Command):
2753
"""Export current or past revision to a destination directory or archive.
2755
If no revision is specified this exports the last committed revision.
2757
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2758
given, try to find the format with the extension. If no extension
2759
is found exports to a directory (equivalent to --format=dir).
2761
If root is supplied, it will be used as the root directory inside
2762
container formats (tar, zip, etc). If it is not supplied it will default
2763
to the exported filename. The root option has no effect for 'dir' format.
2765
If branch is omitted then the branch containing the current working
2766
directory will be used.
2768
Note: Export of tree with non-ASCII filenames to zip is not supported.
2770
================= =========================
2771
Supported formats Autodetected by extension
2772
================= =========================
2775
tbz2 .tar.bz2, .tbz2
2778
================= =========================
2780
takes_args = ['dest', 'branch_or_subdir?']
2783
help="Type of file to export to.",
2786
Option('filters', help='Apply content filters to export the '
2787
'convenient form.'),
2790
help="Name of the root directory inside the exported file."),
2792
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2793
root=None, filters=False):
2794
from bzrlib.export import export
2796
if branch_or_subdir is None:
2797
tree = WorkingTree.open_containing(u'.')[0]
2801
b, subdir = Branch.open_containing(branch_or_subdir)
2804
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2806
export(rev_tree, dest, format, root, subdir, filtered=filters)
2807
except errors.NoSuchExportFormat, e:
2808
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2811
class cmd_cat(Command):
2812
"""Write the contents of a file as of a given revision to standard output.
2814
If no revision is nominated, the last revision is used.
2816
Note: Take care to redirect standard output when using this command on a
2822
Option('name-from-revision', help='The path name in the old tree.'),
2823
Option('filters', help='Apply content filters to display the '
2824
'convenience form.'),
2827
takes_args = ['filename']
2828
encoding_type = 'exact'
2831
def run(self, filename, revision=None, name_from_revision=False,
2833
if revision is not None and len(revision) != 1:
2834
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2835
" one revision specifier")
2836
tree, branch, relpath = \
2837
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2839
self.add_cleanup(branch.unlock)
2840
return self._run(tree, branch, relpath, filename, revision,
2841
name_from_revision, filters)
2843
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2846
tree = b.basis_tree()
2847
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2848
rev_tree.lock_read()
2849
self.add_cleanup(rev_tree.unlock)
2851
old_file_id = rev_tree.path2id(relpath)
2853
if name_from_revision:
2854
# Try in revision if requested
2855
if old_file_id is None:
2856
raise errors.BzrCommandError(
2857
"%r is not present in revision %s" % (
2858
filename, rev_tree.get_revision_id()))
2860
content = rev_tree.get_file_text(old_file_id)
2862
cur_file_id = tree.path2id(relpath)
2864
if cur_file_id is not None:
2865
# Then try with the actual file id
2867
content = rev_tree.get_file_text(cur_file_id)
2869
except errors.NoSuchId:
2870
# The actual file id didn't exist at that time
2872
if not found and old_file_id is not None:
2873
# Finally try with the old file id
2874
content = rev_tree.get_file_text(old_file_id)
2877
# Can't be found anywhere
2878
raise errors.BzrCommandError(
2879
"%r is not present in revision %s" % (
2880
filename, rev_tree.get_revision_id()))
2882
from bzrlib.filters import (
2883
ContentFilterContext,
2884
filtered_output_bytes,
2886
filters = rev_tree._content_filter_stack(relpath)
2887
chunks = content.splitlines(True)
2888
content = filtered_output_bytes(chunks, filters,
2889
ContentFilterContext(relpath, rev_tree))
2891
self.outf.writelines(content)
2894
self.outf.write(content)
2897
class cmd_local_time_offset(Command):
2898
"""Show the offset in seconds from GMT to local time."""
2902
print osutils.local_time_offset()
2906
class cmd_commit(Command):
2907
"""Commit changes into a new revision.
2909
An explanatory message needs to be given for each commit. This is
2910
often done by using the --message option (getting the message from the
2911
command line) or by using the --file option (getting the message from
2912
a file). If neither of these options is given, an editor is opened for
2913
the user to enter the message. To see the changed files in the
2914
boilerplate text loaded into the editor, use the --show-diff option.
2916
By default, the entire tree is committed and the person doing the
2917
commit is assumed to be the author. These defaults can be overridden
2922
If selected files are specified, only changes to those files are
2923
committed. If a directory is specified then the directory and
2924
everything within it is committed.
2926
When excludes are given, they take precedence over selected files.
2927
For example, to commit only changes within foo, but not changes
2930
bzr commit foo -x foo/bar
2932
A selective commit after a merge is not yet supported.
2936
If the author of the change is not the same person as the committer,
2937
you can specify the author's name using the --author option. The
2938
name should be in the same format as a committer-id, e.g.
2939
"John Doe <jdoe@example.com>". If there is more than one author of
2940
the change you can specify the option multiple times, once for each
2945
A common mistake is to forget to add a new file or directory before
2946
running the commit command. The --strict option checks for unknown
2947
files and aborts the commit if any are found. More advanced pre-commit
2948
checks can be implemented by defining hooks. See ``bzr help hooks``
2953
If you accidentially commit the wrong changes or make a spelling
2954
mistake in the commit message say, you can use the uncommit command
2955
to undo it. See ``bzr help uncommit`` for details.
2957
Hooks can also be configured to run after a commit. This allows you
2958
to trigger updates to external systems like bug trackers. The --fixes
2959
option can be used to record the association between a revision and
2960
one or more bugs. See ``bzr help bugs`` for details.
2962
A selective commit may fail in some cases where the committed
2963
tree would be invalid. Consider::
2968
bzr commit foo -m "committing foo"
2969
bzr mv foo/bar foo/baz
2972
bzr commit foo/bar -m "committing bar but not baz"
2974
In the example above, the last commit will fail by design. This gives
2975
the user the opportunity to decide whether they want to commit the
2976
rename at the same time, separately first, or not at all. (As a general
2977
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2979
# TODO: Run hooks on tree to-be-committed, and after commit.
2981
# TODO: Strict commit that fails if there are deleted files.
2982
# (what does "deleted files" mean ??)
2984
# TODO: Give better message for -s, --summary, used by tla people
2986
# XXX: verbose currently does nothing
2988
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2989
takes_args = ['selected*']
2991
ListOption('exclude', type=str, short_name='x',
2992
help="Do not consider changes made to a given path."),
2993
Option('message', type=unicode,
2995
help="Description of the new revision."),
2998
help='Commit even if nothing has changed.'),
2999
Option('file', type=str,
3002
help='Take commit message from this file.'),
3004
help="Refuse to commit if there are unknown "
3005
"files in the working tree."),
3006
Option('commit-time', type=str,
3007
help="Manually set a commit time using commit date "
3008
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3009
ListOption('fixes', type=str,
3010
help="Mark a bug as being fixed by this revision "
3011
"(see \"bzr help bugs\")."),
3012
ListOption('author', type=unicode,
3013
help="Set the author's name, if it's different "
3014
"from the committer."),
3016
help="Perform a local commit in a bound "
3017
"branch. Local commits are not pushed to "
3018
"the master branch until a normal commit "
3022
help='When no message is supplied, show the diff along'
3023
' with the status summary in the message editor.'),
3025
aliases = ['ci', 'checkin']
3027
def _iter_bug_fix_urls(self, fixes, branch):
3028
# Configure the properties for bug fixing attributes.
3029
for fixed_bug in fixes:
3030
tokens = fixed_bug.split(':')
3031
if len(tokens) != 2:
3032
raise errors.BzrCommandError(
3033
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3034
"See \"bzr help bugs\" for more information on this "
3035
"feature.\nCommit refused." % fixed_bug)
3036
tag, bug_id = tokens
3038
yield bugtracker.get_bug_url(tag, branch, bug_id)
3039
except errors.UnknownBugTrackerAbbreviation:
3040
raise errors.BzrCommandError(
3041
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3042
except errors.MalformedBugIdentifier, e:
3043
raise errors.BzrCommandError(
3044
"%s\nCommit refused." % (str(e),))
3046
def run(self, message=None, file=None, verbose=False, selected_list=None,
3047
unchanged=False, strict=False, local=False, fixes=None,
3048
author=None, show_diff=False, exclude=None, commit_time=None):
3049
from bzrlib.errors import (
3054
from bzrlib.msgeditor import (
3055
edit_commit_message_encoded,
3056
generate_commit_message_template,
3057
make_commit_message_template_encoded
3060
commit_stamp = offset = None
3061
if commit_time is not None:
3063
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3064
except ValueError, e:
3065
raise errors.BzrCommandError(
3066
"Could not parse --commit-time: " + str(e))
3068
# TODO: Need a blackbox test for invoking the external editor; may be
3069
# slightly problematic to run this cross-platform.
3071
# TODO: do more checks that the commit will succeed before
3072
# spending the user's valuable time typing a commit message.
3076
tree, selected_list = tree_files(selected_list)
3077
if selected_list == ['']:
3078
# workaround - commit of root of tree should be exactly the same
3079
# as just default commit in that tree, and succeed even though
3080
# selected-file merge commit is not done yet
3085
bug_property = bugtracker.encode_fixes_bug_urls(
3086
self._iter_bug_fix_urls(fixes, tree.branch))
3088
properties['bugs'] = bug_property
3090
if local and not tree.branch.get_bound_location():
3091
raise errors.LocalRequiresBoundBranch()
3093
if message is not None:
3095
file_exists = osutils.lexists(message)
3096
except UnicodeError:
3097
# The commit message contains unicode characters that can't be
3098
# represented in the filesystem encoding, so that can't be a
3103
'The commit message is a file name: "%(f)s".\n'
3104
'(use --file "%(f)s" to take commit message from that file)'
3106
ui.ui_factory.show_warning(warning_msg)
3108
def get_message(commit_obj):
3109
"""Callback to get commit message"""
3110
my_message = message
3111
if my_message is not None and '\r' in my_message:
3112
my_message = my_message.replace('\r\n', '\n')
3113
my_message = my_message.replace('\r', '\n')
3114
if my_message is None and not file:
3115
t = make_commit_message_template_encoded(tree,
3116
selected_list, diff=show_diff,
3117
output_encoding=osutils.get_user_encoding())
3118
start_message = generate_commit_message_template(commit_obj)
3119
my_message = edit_commit_message_encoded(t,
3120
start_message=start_message)
3121
if my_message is None:
3122
raise errors.BzrCommandError("please specify a commit"
3123
" message with either --message or --file")
3124
elif my_message and file:
3125
raise errors.BzrCommandError(
3126
"please specify either --message or --file")
3128
my_message = codecs.open(file, 'rt',
3129
osutils.get_user_encoding()).read()
3130
if my_message == "":
3131
raise errors.BzrCommandError("empty commit message specified")
3134
# The API permits a commit with a filter of [] to mean 'select nothing'
3135
# but the command line should not do that.
3136
if not selected_list:
3137
selected_list = None
3139
tree.commit(message_callback=get_message,
3140
specific_files=selected_list,
3141
allow_pointless=unchanged, strict=strict, local=local,
3142
reporter=None, verbose=verbose, revprops=properties,
3143
authors=author, timestamp=commit_stamp,
3145
exclude=safe_relpath_files(tree, exclude))
3146
except PointlessCommit:
3147
# FIXME: This should really happen before the file is read in;
3148
# perhaps prepare the commit; get the message; then actually commit
3149
raise errors.BzrCommandError("No changes to commit."
3150
" Use --unchanged to commit anyhow.")
3151
except ConflictsInTree:
3152
raise errors.BzrCommandError('Conflicts detected in working '
3153
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3155
except StrictCommitFailed:
3156
raise errors.BzrCommandError("Commit refused because there are"
3157
" unknown files in the working tree.")
3158
except errors.BoundBranchOutOfDate, e:
3159
raise errors.BzrCommandError(str(e) + "\n"
3160
'To commit to master branch, run update and then commit.\n'
3161
'You can also pass --local to commit to continue working '
3165
class cmd_check(Command):
3166
"""Validate working tree structure, branch consistency and repository history.
3168
This command checks various invariants about branch and repository storage
3169
to detect data corruption or bzr bugs.
3171
The working tree and branch checks will only give output if a problem is
3172
detected. The output fields of the repository check are:
3175
This is just the number of revisions checked. It doesn't
3179
This is just the number of versionedfiles checked. It
3180
doesn't indicate a problem.
3182
unreferenced ancestors
3183
Texts that are ancestors of other texts, but
3184
are not properly referenced by the revision ancestry. This is a
3185
subtle problem that Bazaar can work around.
3188
This is the total number of unique file contents
3189
seen in the checked revisions. It does not indicate a problem.
3192
This is the total number of repeated texts seen
3193
in the checked revisions. Texts can be repeated when their file
3194
entries are modified, but the file contents are not. It does not
3197
If no restrictions are specified, all Bazaar data that is found at the given
3198
location will be checked.
3202
Check the tree and branch at 'foo'::
3204
bzr check --tree --branch foo
3206
Check only the repository at 'bar'::
3208
bzr check --repo bar
3210
Check everything at 'baz'::
3215
_see_also = ['reconcile']
3216
takes_args = ['path?']
3217
takes_options = ['verbose',
3218
Option('branch', help="Check the branch related to the"
3219
" current directory."),
3220
Option('repo', help="Check the repository related to the"
3221
" current directory."),
3222
Option('tree', help="Check the working tree related to"
3223
" the current directory.")]
3225
def run(self, path=None, verbose=False, branch=False, repo=False,
3227
from bzrlib.check import check_dwim
3230
if not branch and not repo and not tree:
3231
branch = repo = tree = True
3232
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3235
class cmd_upgrade(Command):
3236
"""Upgrade branch storage to current format.
3238
The check command or bzr developers may sometimes advise you to run
3239
this command. When the default format has changed you may also be warned
3240
during other operations to upgrade.
3243
_see_also = ['check']
3244
takes_args = ['url?']
3246
RegistryOption('format',
3247
help='Upgrade to a specific format. See "bzr help'
3248
' formats" for details.',
3249
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3250
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3251
value_switches=True, title='Branch format'),
3254
def run(self, url='.', format=None):
3255
from bzrlib.upgrade import upgrade
3256
upgrade(url, format)
3259
class cmd_whoami(Command):
3260
"""Show or set bzr user id.
3263
Show the email of the current user::
3267
Set the current user::
3269
bzr whoami "Frank Chu <fchu@example.com>"
3271
takes_options = [ Option('email',
3272
help='Display email address only.'),
3274
help='Set identity for the current branch instead of '
3277
takes_args = ['name?']
3278
encoding_type = 'replace'
3281
def run(self, email=False, branch=False, name=None):
3283
# use branch if we're inside one; otherwise global config
3285
c = Branch.open_containing('.')[0].get_config()
3286
except errors.NotBranchError:
3287
c = config.GlobalConfig()
3289
self.outf.write(c.user_email() + '\n')
3291
self.outf.write(c.username() + '\n')
3294
# display a warning if an email address isn't included in the given name.
3296
config.extract_email_address(name)
3297
except errors.NoEmailInUsername, e:
3298
warning('"%s" does not seem to contain an email address. '
3299
'This is allowed, but not recommended.', name)
3301
# use global config unless --branch given
3303
c = Branch.open_containing('.')[0].get_config()
3305
c = config.GlobalConfig()
3306
c.set_user_option('email', name)
3309
class cmd_nick(Command):
3310
"""Print or set the branch nickname.
3312
If unset, the tree root directory name is used as the nickname.
3313
To print the current nickname, execute with no argument.
3315
Bound branches use the nickname of its master branch unless it is set
3319
_see_also = ['info']
3320
takes_args = ['nickname?']
3321
def run(self, nickname=None):
3322
branch = Branch.open_containing(u'.')[0]
3323
if nickname is None:
3324
self.printme(branch)
3326
branch.nick = nickname
3329
def printme(self, branch):
3333
class cmd_alias(Command):
3334
"""Set/unset and display aliases.
3337
Show the current aliases::
3341
Show the alias specified for 'll'::
3345
Set an alias for 'll'::
3347
bzr alias ll="log --line -r-10..-1"
3349
To remove an alias for 'll'::
3351
bzr alias --remove ll
3354
takes_args = ['name?']
3356
Option('remove', help='Remove the alias.'),
3359
def run(self, name=None, remove=False):
3361
self.remove_alias(name)
3363
self.print_aliases()
3365
equal_pos = name.find('=')
3367
self.print_alias(name)
3369
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3371
def remove_alias(self, alias_name):
3372
if alias_name is None:
3373
raise errors.BzrCommandError(
3374
'bzr alias --remove expects an alias to remove.')
3375
# If alias is not found, print something like:
3376
# unalias: foo: not found
3377
c = config.GlobalConfig()
3378
c.unset_alias(alias_name)
3381
def print_aliases(self):
3382
"""Print out the defined aliases in a similar format to bash."""
3383
aliases = config.GlobalConfig().get_aliases()
3384
for key, value in sorted(aliases.iteritems()):
3385
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3388
def print_alias(self, alias_name):
3389
from bzrlib.commands import get_alias
3390
alias = get_alias(alias_name)
3392
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3395
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3397
def set_alias(self, alias_name, alias_command):
3398
"""Save the alias in the global config."""
3399
c = config.GlobalConfig()
3400
c.set_alias(alias_name, alias_command)
3403
class cmd_selftest(Command):
3404
"""Run internal test suite.
3406
If arguments are given, they are regular expressions that say which tests
3407
should run. Tests matching any expression are run, and other tests are
3410
Alternatively if --first is given, matching tests are run first and then
3411
all other tests are run. This is useful if you have been working in a
3412
particular area, but want to make sure nothing else was broken.
3414
If --exclude is given, tests that match that regular expression are
3415
excluded, regardless of whether they match --first or not.
3417
To help catch accidential dependencies between tests, the --randomize
3418
option is useful. In most cases, the argument used is the word 'now'.
3419
Note that the seed used for the random number generator is displayed
3420
when this option is used. The seed can be explicitly passed as the
3421
argument to this option if required. This enables reproduction of the
3422
actual ordering used if and when an order sensitive problem is encountered.
3424
If --list-only is given, the tests that would be run are listed. This is
3425
useful when combined with --first, --exclude and/or --randomize to
3426
understand their impact. The test harness reports "Listed nn tests in ..."
3427
instead of "Ran nn tests in ..." when list mode is enabled.
3429
If the global option '--no-plugins' is given, plugins are not loaded
3430
before running the selftests. This has two effects: features provided or
3431
modified by plugins will not be tested, and tests provided by plugins will
3434
Tests that need working space on disk use a common temporary directory,
3435
typically inside $TMPDIR or /tmp.
3437
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3438
into a pdb postmortem session.
3441
Run only tests relating to 'ignore'::
3445
Disable plugins and list tests as they're run::
3447
bzr --no-plugins selftest -v
3449
# NB: this is used from the class without creating an instance, which is
3450
# why it does not have a self parameter.
3451
def get_transport_type(typestring):
3452
"""Parse and return a transport specifier."""
3453
if typestring == "sftp":
3454
from bzrlib.tests import stub_sftp
3455
return stub_sftp.SFTPAbsoluteServer
3456
if typestring == "memory":
3457
from bzrlib.tests import test_server
3458
return memory.MemoryServer
3459
if typestring == "fakenfs":
3460
from bzrlib.tests import test_server
3461
return test_server.FakeNFSServer
3462
msg = "No known transport type %s. Supported types are: sftp\n" %\
3464
raise errors.BzrCommandError(msg)
3467
takes_args = ['testspecs*']
3468
takes_options = ['verbose',
3470
help='Stop when one test fails.',
3474
help='Use a different transport by default '
3475
'throughout the test suite.',
3476
type=get_transport_type),
3478
help='Run the benchmarks rather than selftests.'),
3479
Option('lsprof-timed',
3480
help='Generate lsprof output for benchmarked'
3481
' sections of code.'),
3482
Option('lsprof-tests',
3483
help='Generate lsprof output for each test.'),
3484
Option('cache-dir', type=str,
3485
help='Cache intermediate benchmark output in this '
3488
help='Run all tests, but run specified tests first.',
3492
help='List the tests instead of running them.'),
3493
RegistryOption('parallel',
3494
help="Run the test suite in parallel.",
3495
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3496
value_switches=False,
3498
Option('randomize', type=str, argname="SEED",
3499
help='Randomize the order of tests using the given'
3500
' seed or "now" for the current time.'),
3501
Option('exclude', type=str, argname="PATTERN",
3503
help='Exclude tests that match this regular'
3506
help='Output test progress via subunit.'),
3507
Option('strict', help='Fail on missing dependencies or '
3509
Option('load-list', type=str, argname='TESTLISTFILE',
3510
help='Load a test id list from a text file.'),
3511
ListOption('debugflag', type=str, short_name='E',
3512
help='Turn on a selftest debug flag.'),
3513
ListOption('starting-with', type=str, argname='TESTID',
3514
param_name='starting_with', short_name='s',
3516
'Load only the tests starting with TESTID.'),
3518
encoding_type = 'replace'
3521
Command.__init__(self)
3522
self.additional_selftest_args = {}
3524
def run(self, testspecs_list=None, verbose=False, one=False,
3525
transport=None, benchmark=None,
3526
lsprof_timed=None, cache_dir=None,
3527
first=False, list_only=False,
3528
randomize=None, exclude=None, strict=False,
3529
load_list=None, debugflag=None, starting_with=None, subunit=False,
3530
parallel=None, lsprof_tests=False):
3531
from bzrlib.tests import selftest
3532
import bzrlib.benchmarks as benchmarks
3533
from bzrlib.benchmarks import tree_creator
3535
# Make deprecation warnings visible, unless -Werror is set
3536
symbol_versioning.activate_deprecation_warnings(override=False)
3538
if cache_dir is not None:
3539
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3540
if testspecs_list is not None:
3541
pattern = '|'.join(testspecs_list)
3546
from bzrlib.tests import SubUnitBzrRunner
3548
raise errors.BzrCommandError("subunit not available. subunit "
3549
"needs to be installed to use --subunit.")
3550
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3552
self.additional_selftest_args.setdefault(
3553
'suite_decorators', []).append(parallel)
3555
test_suite_factory = benchmarks.test_suite
3556
# Unless user explicitly asks for quiet, be verbose in benchmarks
3557
verbose = not is_quiet()
3558
# TODO: should possibly lock the history file...
3559
benchfile = open(".perf_history", "at", buffering=1)
3560
self.add_cleanup(benchfile.close)
3562
test_suite_factory = None
3564
selftest_kwargs = {"verbose": verbose,
3566
"stop_on_failure": one,
3567
"transport": transport,
3568
"test_suite_factory": test_suite_factory,
3569
"lsprof_timed": lsprof_timed,
3570
"lsprof_tests": lsprof_tests,
3571
"bench_history": benchfile,
3572
"matching_tests_first": first,
3573
"list_only": list_only,
3574
"random_seed": randomize,
3575
"exclude_pattern": exclude,
3577
"load_list": load_list,
3578
"debug_flags": debugflag,
3579
"starting_with": starting_with
3581
selftest_kwargs.update(self.additional_selftest_args)
3582
result = selftest(**selftest_kwargs)
3583
return int(not result)
3586
class cmd_version(Command):
3587
"""Show version of bzr."""
3589
encoding_type = 'replace'
3591
Option("short", help="Print just the version number."),
3595
def run(self, short=False):
3596
from bzrlib.version import show_version
3598
self.outf.write(bzrlib.version_string + '\n')
3600
show_version(to_file=self.outf)
3603
class cmd_rocks(Command):
3604
"""Statement of optimism."""
3610
print "It sure does!"
3613
class cmd_find_merge_base(Command):
3614
"""Find and print a base revision for merging two branches."""
3615
# TODO: Options to specify revisions on either side, as if
3616
# merging only part of the history.
3617
takes_args = ['branch', 'other']
3621
def run(self, branch, other):
3622
from bzrlib.revision import ensure_null
3624
branch1 = Branch.open_containing(branch)[0]
3625
branch2 = Branch.open_containing(other)[0]
3627
self.add_cleanup(branch1.unlock)
3629
self.add_cleanup(branch2.unlock)
3630
last1 = ensure_null(branch1.last_revision())
3631
last2 = ensure_null(branch2.last_revision())
3633
graph = branch1.repository.get_graph(branch2.repository)
3634
base_rev_id = graph.find_unique_lca(last1, last2)
3636
print 'merge base is revision %s' % base_rev_id
3639
class cmd_merge(Command):
3640
"""Perform a three-way merge.
3642
The source of the merge can be specified either in the form of a branch,
3643
or in the form of a path to a file containing a merge directive generated
3644
with bzr send. If neither is specified, the default is the upstream branch
3645
or the branch most recently merged using --remember.
3647
When merging a branch, by default the tip will be merged. To pick a different
3648
revision, pass --revision. If you specify two values, the first will be used as
3649
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3650
available revisions, like this is commonly referred to as "cherrypicking".
3652
Revision numbers are always relative to the branch being merged.
3654
By default, bzr will try to merge in all new work from the other
3655
branch, automatically determining an appropriate base. If this
3656
fails, you may need to give an explicit base.
3658
Merge will do its best to combine the changes in two branches, but there
3659
are some kinds of problems only a human can fix. When it encounters those,
3660
it will mark a conflict. A conflict means that you need to fix something,
3661
before you should commit.
3663
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3665
If there is no default branch set, the first merge will set it. After
3666
that, you can omit the branch to use the default. To change the
3667
default, use --remember. The value will only be saved if the remote
3668
location can be accessed.
3670
The results of the merge are placed into the destination working
3671
directory, where they can be reviewed (with bzr diff), tested, and then
3672
committed to record the result of the merge.
3674
merge refuses to run if there are any uncommitted changes, unless
3675
--force is given. The --force option can also be used to create a
3676
merge revision which has more than two parents.
3678
If one would like to merge changes from the working tree of the other
3679
branch without merging any committed revisions, the --uncommitted option
3682
To select only some changes to merge, use "merge -i", which will prompt
3683
you to apply each diff hunk and file change, similar to "shelve".
3686
To merge the latest revision from bzr.dev::
3688
bzr merge ../bzr.dev
3690
To merge changes up to and including revision 82 from bzr.dev::
3692
bzr merge -r 82 ../bzr.dev
3694
To merge the changes introduced by 82, without previous changes::
3696
bzr merge -r 81..82 ../bzr.dev
3698
To apply a merge directive contained in /tmp/merge::
3700
bzr merge /tmp/merge
3702
To create a merge revision with three parents from two branches
3703
feature1a and feature1b:
3705
bzr merge ../feature1a
3706
bzr merge ../feature1b --force
3707
bzr commit -m 'revision with three parents'
3710
encoding_type = 'exact'
3711
_see_also = ['update', 'remerge', 'status-flags', 'send']
3712
takes_args = ['location?']
3717
help='Merge even if the destination tree has uncommitted changes.'),
3721
Option('show-base', help="Show base revision text in "
3723
Option('uncommitted', help='Apply uncommitted changes'
3724
' from a working copy, instead of branch changes.'),
3725
Option('pull', help='If the destination is already'
3726
' completely merged into the source, pull from the'
3727
' source rather than merging. When this happens,'
3728
' you do not need to commit the result.'),
3730
help='Branch to merge into, '
3731
'rather than the one containing the working directory.',
3735
Option('preview', help='Instead of merging, show a diff of the'
3737
Option('interactive', help='Select changes interactively.',
3741
def run(self, location=None, revision=None, force=False,
3742
merge_type=None, show_base=False, reprocess=None, remember=False,
3743
uncommitted=False, pull=False,
3748
if merge_type is None:
3749
merge_type = _mod_merge.Merge3Merger
3751
if directory is None: directory = u'.'
3752
possible_transports = []
3754
allow_pending = True
3755
verified = 'inapplicable'
3756
tree = WorkingTree.open_containing(directory)[0]
3759
basis_tree = tree.revision_tree(tree.last_revision())
3760
except errors.NoSuchRevision:
3761
basis_tree = tree.basis_tree()
3763
# die as quickly as possible if there are uncommitted changes
3765
if tree.has_changes():
3766
raise errors.UncommittedChanges(tree)
3768
view_info = _get_view_info_for_change_reporter(tree)
3769
change_reporter = delta._ChangeReporter(
3770
unversioned_filter=tree.is_ignored, view_info=view_info)
3771
pb = ui.ui_factory.nested_progress_bar()
3772
self.add_cleanup(pb.finished)
3774
self.add_cleanup(tree.unlock)
3775
if location is not None:
3777
mergeable = bundle.read_mergeable_from_url(location,
3778
possible_transports=possible_transports)
3779
except errors.NotABundle:
3783
raise errors.BzrCommandError('Cannot use --uncommitted'
3784
' with bundles or merge directives.')
3786
if revision is not None:
3787
raise errors.BzrCommandError(
3788
'Cannot use -r with merge directives or bundles')
3789
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3792
if merger is None and uncommitted:
3793
if revision is not None and len(revision) > 0:
3794
raise errors.BzrCommandError('Cannot use --uncommitted and'
3795
' --revision at the same time.')
3796
merger = self.get_merger_from_uncommitted(tree, location, None)
3797
allow_pending = False
3800
merger, allow_pending = self._get_merger_from_branch(tree,
3801
location, revision, remember, possible_transports, None)
3803
merger.merge_type = merge_type
3804
merger.reprocess = reprocess
3805
merger.show_base = show_base
3806
self.sanity_check_merger(merger)
3807
if (merger.base_rev_id == merger.other_rev_id and
3808
merger.other_rev_id is not None):
3809
note('Nothing to do.')
3812
if merger.interesting_files is not None:
3813
raise errors.BzrCommandError('Cannot pull individual files')
3814
if (merger.base_rev_id == tree.last_revision()):
3815
result = tree.pull(merger.other_branch, False,
3816
merger.other_rev_id)
3817
result.report(self.outf)
3819
if merger.this_basis is None:
3820
raise errors.BzrCommandError(
3821
"This branch has no commits."
3822
" (perhaps you would prefer 'bzr pull')")
3824
return self._do_preview(merger)
3826
return self._do_interactive(merger)
3828
return self._do_merge(merger, change_reporter, allow_pending,
3831
def _get_preview(self, merger):
3832
tree_merger = merger.make_merger()
3833
tt = tree_merger.make_preview_transform()
3834
self.add_cleanup(tt.finalize)
3835
result_tree = tt.get_preview_tree()
3838
def _do_preview(self, merger):
3839
from bzrlib.diff import show_diff_trees
3840
result_tree = self._get_preview(merger)
3841
show_diff_trees(merger.this_tree, result_tree, self.outf,
3842
old_label='', new_label='')
3844
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3845
merger.change_reporter = change_reporter
3846
conflict_count = merger.do_merge()
3848
merger.set_pending()
3849
if verified == 'failed':
3850
warning('Preview patch does not match changes')
3851
if conflict_count != 0:
3856
def _do_interactive(self, merger):
3857
"""Perform an interactive merge.
3859
This works by generating a preview tree of the merge, then using
3860
Shelver to selectively remove the differences between the working tree
3861
and the preview tree.
3863
from bzrlib import shelf_ui
3864
result_tree = self._get_preview(merger)
3865
writer = bzrlib.option.diff_writer_registry.get()
3866
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3867
reporter=shelf_ui.ApplyReporter(),
3868
diff_writer=writer(sys.stdout))
3874
def sanity_check_merger(self, merger):
3875
if (merger.show_base and
3876
not merger.merge_type is _mod_merge.Merge3Merger):
3877
raise errors.BzrCommandError("Show-base is not supported for this"
3878
" merge type. %s" % merger.merge_type)
3879
if merger.reprocess is None:
3880
if merger.show_base:
3881
merger.reprocess = False
3883
# Use reprocess if the merger supports it
3884
merger.reprocess = merger.merge_type.supports_reprocess
3885
if merger.reprocess and not merger.merge_type.supports_reprocess:
3886
raise errors.BzrCommandError("Conflict reduction is not supported"
3887
" for merge type %s." %
3889
if merger.reprocess and merger.show_base:
3890
raise errors.BzrCommandError("Cannot do conflict reduction and"
3893
def _get_merger_from_branch(self, tree, location, revision, remember,
3894
possible_transports, pb):
3895
"""Produce a merger from a location, assuming it refers to a branch."""
3896
from bzrlib.tag import _merge_tags_if_possible
3897
# find the branch locations
3898
other_loc, user_location = self._select_branch_location(tree, location,
3900
if revision is not None and len(revision) == 2:
3901
base_loc, _unused = self._select_branch_location(tree,
3902
location, revision, 0)
3904
base_loc = other_loc
3906
other_branch, other_path = Branch.open_containing(other_loc,
3907
possible_transports)
3908
if base_loc == other_loc:
3909
base_branch = other_branch
3911
base_branch, base_path = Branch.open_containing(base_loc,
3912
possible_transports)
3913
# Find the revision ids
3914
other_revision_id = None
3915
base_revision_id = None
3916
if revision is not None:
3917
if len(revision) >= 1:
3918
other_revision_id = revision[-1].as_revision_id(other_branch)
3919
if len(revision) == 2:
3920
base_revision_id = revision[0].as_revision_id(base_branch)
3921
if other_revision_id is None:
3922
other_revision_id = _mod_revision.ensure_null(
3923
other_branch.last_revision())
3924
# Remember where we merge from
3925
if ((remember or tree.branch.get_submit_branch() is None) and
3926
user_location is not None):
3927
tree.branch.set_submit_branch(other_branch.base)
3928
_merge_tags_if_possible(other_branch, tree.branch)
3929
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3930
other_revision_id, base_revision_id, other_branch, base_branch)
3931
if other_path != '':
3932
allow_pending = False
3933
merger.interesting_files = [other_path]
3935
allow_pending = True
3936
return merger, allow_pending
3938
def get_merger_from_uncommitted(self, tree, location, pb):
3939
"""Get a merger for uncommitted changes.
3941
:param tree: The tree the merger should apply to.
3942
:param location: The location containing uncommitted changes.
3943
:param pb: The progress bar to use for showing progress.
3945
location = self._select_branch_location(tree, location)[0]
3946
other_tree, other_path = WorkingTree.open_containing(location)
3947
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3948
if other_path != '':
3949
merger.interesting_files = [other_path]
3952
def _select_branch_location(self, tree, user_location, revision=None,
3954
"""Select a branch location, according to possible inputs.
3956
If provided, branches from ``revision`` are preferred. (Both
3957
``revision`` and ``index`` must be supplied.)
3959
Otherwise, the ``location`` parameter is used. If it is None, then the
3960
``submit`` or ``parent`` location is used, and a note is printed.
3962
:param tree: The working tree to select a branch for merging into
3963
:param location: The location entered by the user
3964
:param revision: The revision parameter to the command
3965
:param index: The index to use for the revision parameter. Negative
3966
indices are permitted.
3967
:return: (selected_location, user_location). The default location
3968
will be the user-entered location.
3970
if (revision is not None and index is not None
3971
and revision[index] is not None):
3972
branch = revision[index].get_branch()
3973
if branch is not None:
3974
return branch, branch
3975
if user_location is None:
3976
location = self._get_remembered(tree, 'Merging from')
3978
location = user_location
3979
return location, user_location
3981
def _get_remembered(self, tree, verb_string):
3982
"""Use tree.branch's parent if none was supplied.
3984
Report if the remembered location was used.
3986
stored_location = tree.branch.get_submit_branch()
3987
stored_location_type = "submit"
3988
if stored_location is None:
3989
stored_location = tree.branch.get_parent()
3990
stored_location_type = "parent"
3991
mutter("%s", stored_location)
3992
if stored_location is None:
3993
raise errors.BzrCommandError("No location specified or remembered")
3994
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3995
note(u"%s remembered %s location %s", verb_string,
3996
stored_location_type, display_url)
3997
return stored_location
4000
class cmd_remerge(Command):
4003
Use this if you want to try a different merge technique while resolving
4004
conflicts. Some merge techniques are better than others, and remerge
4005
lets you try different ones on different files.
4007
The options for remerge have the same meaning and defaults as the ones for
4008
merge. The difference is that remerge can (only) be run when there is a
4009
pending merge, and it lets you specify particular files.
4012
Re-do the merge of all conflicted files, and show the base text in
4013
conflict regions, in addition to the usual THIS and OTHER texts::
4015
bzr remerge --show-base
4017
Re-do the merge of "foobar", using the weave merge algorithm, with
4018
additional processing to reduce the size of conflict regions::
4020
bzr remerge --merge-type weave --reprocess foobar
4022
takes_args = ['file*']
4027
help="Show base revision text in conflicts."),
4030
def run(self, file_list=None, merge_type=None, show_base=False,
4032
if merge_type is None:
4033
merge_type = _mod_merge.Merge3Merger
4034
tree, file_list = tree_files(file_list)
4036
self.add_cleanup(tree.unlock)
4037
parents = tree.get_parent_ids()
4038
if len(parents) != 2:
4039
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4040
" merges. Not cherrypicking or"
4042
repository = tree.branch.repository
4043
interesting_ids = None
4045
conflicts = tree.conflicts()
4046
if file_list is not None:
4047
interesting_ids = set()
4048
for filename in file_list:
4049
file_id = tree.path2id(filename)
4051
raise errors.NotVersionedError(filename)
4052
interesting_ids.add(file_id)
4053
if tree.kind(file_id) != "directory":
4056
for name, ie in tree.inventory.iter_entries(file_id):
4057
interesting_ids.add(ie.file_id)
4058
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4060
# Remerge only supports resolving contents conflicts
4061
allowed_conflicts = ('text conflict', 'contents conflict')
4062
restore_files = [c.path for c in conflicts
4063
if c.typestring in allowed_conflicts]
4064
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4065
tree.set_conflicts(ConflictList(new_conflicts))
4066
if file_list is not None:
4067
restore_files = file_list
4068
for filename in restore_files:
4070
restore(tree.abspath(filename))
4071
except errors.NotConflicted:
4073
# Disable pending merges, because the file texts we are remerging
4074
# have not had those merges performed. If we use the wrong parents
4075
# list, we imply that the working tree text has seen and rejected
4076
# all the changes from the other tree, when in fact those changes
4077
# have not yet been seen.
4078
tree.set_parent_ids(parents[:1])
4080
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4081
merger.interesting_ids = interesting_ids
4082
merger.merge_type = merge_type
4083
merger.show_base = show_base
4084
merger.reprocess = reprocess
4085
conflicts = merger.do_merge()
4087
tree.set_parent_ids(parents)
4094
class cmd_revert(Command):
4095
"""Revert files to a previous revision.
4097
Giving a list of files will revert only those files. Otherwise, all files
4098
will be reverted. If the revision is not specified with '--revision', the
4099
last committed revision is used.
4101
To remove only some changes, without reverting to a prior version, use
4102
merge instead. For example, "merge . --revision -2..-3" will remove the
4103
changes introduced by -2, without affecting the changes introduced by -1.
4104
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4106
By default, any files that have been manually changed will be backed up
4107
first. (Files changed only by merge are not backed up.) Backup files have
4108
'.~#~' appended to their name, where # is a number.
4110
When you provide files, you can use their current pathname or the pathname
4111
from the target revision. So you can use revert to "undelete" a file by
4112
name. If you name a directory, all the contents of that directory will be
4115
If you have newly added files since the target revision, they will be
4116
removed. If the files to be removed have been changed, backups will be
4117
created as above. Directories containing unknown files will not be
4120
The working tree contains a list of revisions that have been merged but
4121
not yet committed. These revisions will be included as additional parents
4122
of the next commit. Normally, using revert clears that list as well as
4123
reverting the files. If any files are specified, revert leaves the list
4124
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4125
.`` in the tree root to revert all files but keep the recorded merges,
4126
and ``bzr revert --forget-merges`` to clear the pending merge list without
4127
reverting any files.
4129
Using "bzr revert --forget-merges", it is possible to apply all of the
4130
changes from a branch in a single revision. To do this, perform the merge
4131
as desired. Then doing revert with the "--forget-merges" option will keep
4132
the content of the tree as it was, but it will clear the list of pending
4133
merges. The next commit will then contain all of the changes that are
4134
present in the other branch, but without any other parent revisions.
4135
Because this technique forgets where these changes originated, it may
4136
cause additional conflicts on later merges involving the same source and
4140
_see_also = ['cat', 'export']
4143
Option('no-backup', "Do not save backups of reverted files."),
4144
Option('forget-merges',
4145
'Remove pending merge marker, without changing any files.'),
4147
takes_args = ['file*']
4149
def run(self, revision=None, no_backup=False, file_list=None,
4150
forget_merges=None):
4151
tree, file_list = tree_files(file_list)
4153
self.add_cleanup(tree.unlock)
4155
tree.set_parent_ids(tree.get_parent_ids()[:1])
4157
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4160
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4161
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4162
tree.revert(file_list, rev_tree, not no_backup, None,
4163
report_changes=True)
4166
class cmd_assert_fail(Command):
4167
"""Test reporting of assertion failures"""
4168
# intended just for use in testing
4173
raise AssertionError("always fails")
4176
class cmd_help(Command):
4177
"""Show help on a command or other topic.
4180
_see_also = ['topics']
4182
Option('long', 'Show help on all commands.'),
4184
takes_args = ['topic?']
4185
aliases = ['?', '--help', '-?', '-h']
4188
def run(self, topic=None, long=False):
4190
if topic is None and long:
4192
bzrlib.help.help(topic)
4195
class cmd_shell_complete(Command):
4196
"""Show appropriate completions for context.
4198
For a list of all available commands, say 'bzr shell-complete'.
4200
takes_args = ['context?']
4205
def run(self, context=None):
4206
import shellcomplete
4207
shellcomplete.shellcomplete(context)
4210
class cmd_missing(Command):
4211
"""Show unmerged/unpulled revisions between two branches.
4213
OTHER_BRANCH may be local or remote.
4215
To filter on a range of revisions, you can use the command -r begin..end
4216
-r revision requests a specific revision, -r ..end or -r begin.. are
4220
1 - some missing revisions
4221
0 - no missing revisions
4225
Determine the missing revisions between this and the branch at the
4226
remembered pull location::
4230
Determine the missing revisions between this and another branch::
4232
bzr missing http://server/branch
4234
Determine the missing revisions up to a specific revision on the other
4237
bzr missing -r ..-10
4239
Determine the missing revisions up to a specific revision on this
4242
bzr missing --my-revision ..-10
4245
_see_also = ['merge', 'pull']
4246
takes_args = ['other_branch?']
4248
Option('reverse', 'Reverse the order of revisions.'),
4250
'Display changes in the local branch only.'),
4251
Option('this' , 'Same as --mine-only.'),
4252
Option('theirs-only',
4253
'Display changes in the remote branch only.'),
4254
Option('other', 'Same as --theirs-only.'),
4258
custom_help('revision',
4259
help='Filter on other branch revisions (inclusive). '
4260
'See "help revisionspec" for details.'),
4261
Option('my-revision',
4262
type=_parse_revision_str,
4263
help='Filter on local branch revisions (inclusive). '
4264
'See "help revisionspec" for details.'),
4265
Option('include-merges',
4266
'Show all revisions in addition to the mainline ones.'),
4268
encoding_type = 'replace'
4271
def run(self, other_branch=None, reverse=False, mine_only=False,
4273
log_format=None, long=False, short=False, line=False,
4274
show_ids=False, verbose=False, this=False, other=False,
4275
include_merges=False, revision=None, my_revision=None):
4276
from bzrlib.missing import find_unmerged, iter_log_revisions
4285
# TODO: We should probably check that we don't have mine-only and
4286
# theirs-only set, but it gets complicated because we also have
4287
# this and other which could be used.
4294
local_branch = Branch.open_containing(u".")[0]
4295
parent = local_branch.get_parent()
4296
if other_branch is None:
4297
other_branch = parent
4298
if other_branch is None:
4299
raise errors.BzrCommandError("No peer location known"
4301
display_url = urlutils.unescape_for_display(parent,
4303
message("Using saved parent location: "
4304
+ display_url + "\n")
4306
remote_branch = Branch.open(other_branch)
4307
if remote_branch.base == local_branch.base:
4308
remote_branch = local_branch
4310
local_branch.lock_read()
4311
self.add_cleanup(local_branch.unlock)
4312
local_revid_range = _revision_range_to_revid_range(
4313
_get_revision_range(my_revision, local_branch,
4316
remote_branch.lock_read()
4317
self.add_cleanup(remote_branch.unlock)
4318
remote_revid_range = _revision_range_to_revid_range(
4319
_get_revision_range(revision,
4320
remote_branch, self.name()))
4322
local_extra, remote_extra = find_unmerged(
4323
local_branch, remote_branch, restrict,
4324
backward=not reverse,
4325
include_merges=include_merges,
4326
local_revid_range=local_revid_range,
4327
remote_revid_range=remote_revid_range)
4329
if log_format is None:
4330
registry = log.log_formatter_registry
4331
log_format = registry.get_default(local_branch)
4332
lf = log_format(to_file=self.outf,
4334
show_timezone='original')
4337
if local_extra and not theirs_only:
4338
message("You have %d extra revision(s):\n" %
4340
for revision in iter_log_revisions(local_extra,
4341
local_branch.repository,
4343
lf.log_revision(revision)
4344
printed_local = True
4347
printed_local = False
4349
if remote_extra and not mine_only:
4350
if printed_local is True:
4352
message("You are missing %d revision(s):\n" %
4354
for revision in iter_log_revisions(remote_extra,
4355
remote_branch.repository,
4357
lf.log_revision(revision)
4360
if mine_only and not local_extra:
4361
# We checked local, and found nothing extra
4362
message('This branch is up to date.\n')
4363
elif theirs_only and not remote_extra:
4364
# We checked remote, and found nothing extra
4365
message('Other branch is up to date.\n')
4366
elif not (mine_only or theirs_only or local_extra or
4368
# We checked both branches, and neither one had extra
4370
message("Branches are up to date.\n")
4372
if not status_code and parent is None and other_branch is not None:
4373
local_branch.lock_write()
4374
self.add_cleanup(local_branch.unlock)
4375
# handle race conditions - a parent might be set while we run.
4376
if local_branch.get_parent() is None:
4377
local_branch.set_parent(remote_branch.base)
4381
class cmd_pack(Command):
4382
"""Compress the data within a repository."""
4384
_see_also = ['repositories']
4385
takes_args = ['branch_or_repo?']
4387
def run(self, branch_or_repo='.'):
4388
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4390
branch = dir.open_branch()
4391
repository = branch.repository
4392
except errors.NotBranchError:
4393
repository = dir.open_repository()
4397
class cmd_plugins(Command):
4398
"""List the installed plugins.
4400
This command displays the list of installed plugins including
4401
version of plugin and a short description of each.
4403
--verbose shows the path where each plugin is located.
4405
A plugin is an external component for Bazaar that extends the
4406
revision control system, by adding or replacing code in Bazaar.
4407
Plugins can do a variety of things, including overriding commands,
4408
adding new commands, providing additional network transports and
4409
customizing log output.
4411
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4412
for further information on plugins including where to find them and how to
4413
install them. Instructions are also provided there on how to write new
4414
plugins using the Python programming language.
4416
takes_options = ['verbose']
4419
def run(self, verbose=False):
4420
import bzrlib.plugin
4421
from inspect import getdoc
4423
for name, plugin in bzrlib.plugin.plugins().items():
4424
version = plugin.__version__
4425
if version == 'unknown':
4427
name_ver = '%s %s' % (name, version)
4428
d = getdoc(plugin.module)
4430
doc = d.split('\n')[0]
4432
doc = '(no description)'
4433
result.append((name_ver, doc, plugin.path()))
4434
for name_ver, doc, path in sorted(result):
4442
class cmd_testament(Command):
4443
"""Show testament (signing-form) of a revision."""
4446
Option('long', help='Produce long-format testament.'),
4448
help='Produce a strict-format testament.')]
4449
takes_args = ['branch?']
4451
def run(self, branch=u'.', revision=None, long=False, strict=False):
4452
from bzrlib.testament import Testament, StrictTestament
4454
testament_class = StrictTestament
4456
testament_class = Testament
4458
b = Branch.open_containing(branch)[0]
4460
b = Branch.open(branch)
4462
self.add_cleanup(b.unlock)
4463
if revision is None:
4464
rev_id = b.last_revision()
4466
rev_id = revision[0].as_revision_id(b)
4467
t = testament_class.from_revision(b.repository, rev_id)
4469
sys.stdout.writelines(t.as_text_lines())
4471
sys.stdout.write(t.as_short_text())
4474
class cmd_annotate(Command):
4475
"""Show the origin of each line in a file.
4477
This prints out the given file with an annotation on the left side
4478
indicating which revision, author and date introduced the change.
4480
If the origin is the same for a run of consecutive lines, it is
4481
shown only at the top, unless the --all option is given.
4483
# TODO: annotate directories; showing when each file was last changed
4484
# TODO: if the working copy is modified, show annotations on that
4485
# with new uncommitted lines marked
4486
aliases = ['ann', 'blame', 'praise']
4487
takes_args = ['filename']
4488
takes_options = [Option('all', help='Show annotations on all lines.'),
4489
Option('long', help='Show commit date in annotations.'),
4493
encoding_type = 'exact'
4496
def run(self, filename, all=False, long=False, revision=None,
4498
from bzrlib.annotate import annotate_file, annotate_file_tree
4499
wt, branch, relpath = \
4500
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4503
self.add_cleanup(wt.unlock)
4506
self.add_cleanup(branch.unlock)
4507
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4509
self.add_cleanup(tree.unlock)
4511
file_id = wt.path2id(relpath)
4513
file_id = tree.path2id(relpath)
4515
raise errors.NotVersionedError(filename)
4516
file_version = tree.inventory[file_id].revision
4517
if wt is not None and revision is None:
4518
# If there is a tree and we're not annotating historical
4519
# versions, annotate the working tree's content.
4520
annotate_file_tree(wt, file_id, self.outf, long, all,
4523
annotate_file(branch, file_version, file_id, long, all, self.outf,
4527
class cmd_re_sign(Command):
4528
"""Create a digital signature for an existing revision."""
4529
# TODO be able to replace existing ones.
4531
hidden = True # is this right ?
4532
takes_args = ['revision_id*']
4533
takes_options = ['revision']
4535
def run(self, revision_id_list=None, revision=None):
4536
if revision_id_list is not None and revision is not None:
4537
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4538
if revision_id_list is None and revision is None:
4539
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4540
b = WorkingTree.open_containing(u'.')[0].branch
4542
self.add_cleanup(b.unlock)
4543
return self._run(b, revision_id_list, revision)
4545
def _run(self, b, revision_id_list, revision):
4546
import bzrlib.gpg as gpg
4547
gpg_strategy = gpg.GPGStrategy(b.get_config())
4548
if revision_id_list is not None:
4549
b.repository.start_write_group()
4551
for revision_id in revision_id_list:
4552
b.repository.sign_revision(revision_id, gpg_strategy)
4554
b.repository.abort_write_group()
4557
b.repository.commit_write_group()
4558
elif revision is not None:
4559
if len(revision) == 1:
4560
revno, rev_id = revision[0].in_history(b)
4561
b.repository.start_write_group()
4563
b.repository.sign_revision(rev_id, gpg_strategy)
4565
b.repository.abort_write_group()
4568
b.repository.commit_write_group()
4569
elif len(revision) == 2:
4570
# are they both on rh- if so we can walk between them
4571
# might be nice to have a range helper for arbitrary
4572
# revision paths. hmm.
4573
from_revno, from_revid = revision[0].in_history(b)
4574
to_revno, to_revid = revision[1].in_history(b)
4575
if to_revid is None:
4576
to_revno = b.revno()
4577
if from_revno is None or to_revno is None:
4578
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4579
b.repository.start_write_group()
4581
for revno in range(from_revno, to_revno + 1):
4582
b.repository.sign_revision(b.get_rev_id(revno),
4585
b.repository.abort_write_group()
4588
b.repository.commit_write_group()
4590
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4593
class cmd_bind(Command):
4594
"""Convert the current branch into a checkout of the supplied branch.
4596
Once converted into a checkout, commits must succeed on the master branch
4597
before they will be applied to the local branch.
4599
Bound branches use the nickname of its master branch unless it is set
4600
locally, in which case binding will update the local nickname to be
4604
_see_also = ['checkouts', 'unbind']
4605
takes_args = ['location?']
4608
def run(self, location=None):
4609
b, relpath = Branch.open_containing(u'.')
4610
if location is None:
4612
location = b.get_old_bound_location()
4613
except errors.UpgradeRequired:
4614
raise errors.BzrCommandError('No location supplied. '
4615
'This format does not remember old locations.')
4617
if location is None:
4618
if b.get_bound_location() is not None:
4619
raise errors.BzrCommandError('Branch is already bound')
4621
raise errors.BzrCommandError('No location supplied '
4622
'and no previous location known')
4623
b_other = Branch.open(location)
4626
except errors.DivergedBranches:
4627
raise errors.BzrCommandError('These branches have diverged.'
4628
' Try merging, and then bind again.')
4629
if b.get_config().has_explicit_nickname():
4630
b.nick = b_other.nick
4633
class cmd_unbind(Command):
4634
"""Convert the current checkout into a regular branch.
4636
After unbinding, the local branch is considered independent and subsequent
4637
commits will be local only.
4640
_see_also = ['checkouts', 'bind']
4645
b, relpath = Branch.open_containing(u'.')
4647
raise errors.BzrCommandError('Local branch is not bound')
4650
class cmd_uncommit(Command):
4651
"""Remove the last committed revision.
4653
--verbose will print out what is being removed.
4654
--dry-run will go through all the motions, but not actually
4657
If --revision is specified, uncommit revisions to leave the branch at the
4658
specified revision. For example, "bzr uncommit -r 15" will leave the
4659
branch at revision 15.
4661
Uncommit leaves the working tree ready for a new commit. The only change
4662
it may make is to restore any pending merges that were present before
4666
# TODO: jam 20060108 Add an option to allow uncommit to remove
4667
# unreferenced information in 'branch-as-repository' branches.
4668
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4669
# information in shared branches as well.
4670
_see_also = ['commit']
4671
takes_options = ['verbose', 'revision',
4672
Option('dry-run', help='Don\'t actually make changes.'),
4673
Option('force', help='Say yes to all questions.'),
4675
help="Only remove the commits from the local branch"
4676
" when in a checkout."
4679
takes_args = ['location?']
4681
encoding_type = 'replace'
4683
def run(self, location=None,
4684
dry_run=False, verbose=False,
4685
revision=None, force=False, local=False):
4686
if location is None:
4688
control, relpath = bzrdir.BzrDir.open_containing(location)
4690
tree = control.open_workingtree()
4692
except (errors.NoWorkingTree, errors.NotLocalUrl):
4694
b = control.open_branch()
4696
if tree is not None:
4698
self.add_cleanup(tree.unlock)
4701
self.add_cleanup(b.unlock)
4702
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4704
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4705
from bzrlib.log import log_formatter, show_log
4706
from bzrlib.uncommit import uncommit
4708
last_revno, last_rev_id = b.last_revision_info()
4711
if revision is None:
4713
rev_id = last_rev_id
4715
# 'bzr uncommit -r 10' actually means uncommit
4716
# so that the final tree is at revno 10.
4717
# but bzrlib.uncommit.uncommit() actually uncommits
4718
# the revisions that are supplied.
4719
# So we need to offset it by one
4720
revno = revision[0].in_history(b).revno + 1
4721
if revno <= last_revno:
4722
rev_id = b.get_rev_id(revno)
4724
if rev_id is None or _mod_revision.is_null(rev_id):
4725
ui.ui_factory.note('No revisions to uncommit.')
4728
log_collector = ui.ui_factory.make_output_stream()
4729
lf = log_formatter('short',
4730
to_file=log_collector,
4731
show_timezone='original')
4736
direction='forward',
4737
start_revision=revno,
4738
end_revision=last_revno)
4741
ui.ui_factory.note('Dry-run, pretending to remove the above revisions.')
4743
ui.ui_factory.note('The above revision(s) will be removed.')
4746
if not ui.ui_factory.get_boolean('Are you sure [y/N]? '):
4747
ui.ui_factory.note('Canceled')
4750
mutter('Uncommitting from {%s} to {%s}',
4751
last_rev_id, rev_id)
4752
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4753
revno=revno, local=local)
4754
ui.ui_factory.note('You can restore the old tip by running:\n'
4755
' bzr pull . -r revid:%s' % last_rev_id)
4758
class cmd_break_lock(Command):
4759
"""Break a dead lock on a repository, branch or working directory.
4761
CAUTION: Locks should only be broken when you are sure that the process
4762
holding the lock has been stopped.
4764
You can get information on what locks are open via the 'bzr info
4765
[location]' command.
4769
bzr break-lock bzr+ssh://example.com/bzr/foo
4771
takes_args = ['location?']
4773
def run(self, location=None, show=False):
4774
if location is None:
4776
control, relpath = bzrdir.BzrDir.open_containing(location)
4778
control.break_lock()
4779
except NotImplementedError:
4783
class cmd_wait_until_signalled(Command):
4784
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4786
This just prints a line to signal when it is ready, then blocks on stdin.
4792
sys.stdout.write("running\n")
4794
sys.stdin.readline()
4797
class cmd_serve(Command):
4798
"""Run the bzr server."""
4800
aliases = ['server']
4804
help='Serve on stdin/out for use from inetd or sshd.'),
4805
RegistryOption('protocol',
4806
help="Protocol to serve.",
4807
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4808
value_switches=True),
4810
help='Listen for connections on nominated port of the form '
4811
'[hostname:]portnumber. Passing 0 as the port number will '
4812
'result in a dynamically allocated port. The default port '
4813
'depends on the protocol.',
4816
help='Serve contents of this directory.',
4818
Option('allow-writes',
4819
help='By default the server is a readonly server. Supplying '
4820
'--allow-writes enables write access to the contents of '
4821
'the served directory and below. Note that ``bzr serve`` '
4822
'does not perform authentication, so unless some form of '
4823
'external authentication is arranged supplying this '
4824
'option leads to global uncontrolled write access to your '
4829
def get_host_and_port(self, port):
4830
"""Return the host and port to run the smart server on.
4832
If 'port' is None, None will be returned for the host and port.
4834
If 'port' has a colon in it, the string before the colon will be
4835
interpreted as the host.
4837
:param port: A string of the port to run the server on.
4838
:return: A tuple of (host, port), where 'host' is a host name or IP,
4839
and port is an integer TCP/IP port.
4842
if port is not None:
4844
host, port = port.split(':')
4848
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4850
from bzrlib.transport import get_transport, transport_server_registry
4851
if directory is None:
4852
directory = os.getcwd()
4853
if protocol is None:
4854
protocol = transport_server_registry.get()
4855
host, port = self.get_host_and_port(port)
4856
url = urlutils.local_path_to_url(directory)
4857
if not allow_writes:
4858
url = 'readonly+' + url
4859
transport = get_transport(url)
4860
protocol(transport, host, port, inet)
4863
class cmd_join(Command):
4864
"""Combine a tree into its containing tree.
4866
This command requires the target tree to be in a rich-root format.
4868
The TREE argument should be an independent tree, inside another tree, but
4869
not part of it. (Such trees can be produced by "bzr split", but also by
4870
running "bzr branch" with the target inside a tree.)
4872
The result is a combined tree, with the subtree no longer an independant
4873
part. This is marked as a merge of the subtree into the containing tree,
4874
and all history is preserved.
4877
_see_also = ['split']
4878
takes_args = ['tree']
4880
Option('reference', help='Join by reference.', hidden=True),
4883
def run(self, tree, reference=False):
4884
sub_tree = WorkingTree.open(tree)
4885
parent_dir = osutils.dirname(sub_tree.basedir)
4886
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4887
repo = containing_tree.branch.repository
4888
if not repo.supports_rich_root():
4889
raise errors.BzrCommandError(
4890
"Can't join trees because %s doesn't support rich root data.\n"
4891
"You can use bzr upgrade on the repository."
4895
containing_tree.add_reference(sub_tree)
4896
except errors.BadReferenceTarget, e:
4897
# XXX: Would be better to just raise a nicely printable
4898
# exception from the real origin. Also below. mbp 20070306
4899
raise errors.BzrCommandError("Cannot join %s. %s" %
4903
containing_tree.subsume(sub_tree)
4904
except errors.BadSubsumeSource, e:
4905
raise errors.BzrCommandError("Cannot join %s. %s" %
4909
class cmd_split(Command):
4910
"""Split a subdirectory of a tree into a separate tree.
4912
This command will produce a target tree in a format that supports
4913
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4914
converted into earlier formats like 'dirstate-tags'.
4916
The TREE argument should be a subdirectory of a working tree. That
4917
subdirectory will be converted into an independent tree, with its own
4918
branch. Commits in the top-level tree will not apply to the new subtree.
4921
_see_also = ['join']
4922
takes_args = ['tree']
4924
def run(self, tree):
4925
containing_tree, subdir = WorkingTree.open_containing(tree)
4926
sub_id = containing_tree.path2id(subdir)
4928
raise errors.NotVersionedError(subdir)
4930
containing_tree.extract(sub_id)
4931
except errors.RootNotRich:
4932
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4935
class cmd_merge_directive(Command):
4936
"""Generate a merge directive for auto-merge tools.
4938
A directive requests a merge to be performed, and also provides all the
4939
information necessary to do so. This means it must either include a
4940
revision bundle, or the location of a branch containing the desired
4943
A submit branch (the location to merge into) must be supplied the first
4944
time the command is issued. After it has been supplied once, it will
4945
be remembered as the default.
4947
A public branch is optional if a revision bundle is supplied, but required
4948
if --diff or --plain is specified. It will be remembered as the default
4949
after the first use.
4952
takes_args = ['submit_branch?', 'public_branch?']
4956
_see_also = ['send']
4959
RegistryOption.from_kwargs('patch-type',
4960
'The type of patch to include in the directive.',
4962
value_switches=True,
4964
bundle='Bazaar revision bundle (default).',
4965
diff='Normal unified diff.',
4966
plain='No patch, just directive.'),
4967
Option('sign', help='GPG-sign the directive.'), 'revision',
4968
Option('mail-to', type=str,
4969
help='Instead of printing the directive, email to this address.'),
4970
Option('message', type=str, short_name='m',
4971
help='Message to use when committing this merge.')
4974
encoding_type = 'exact'
4976
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4977
sign=False, revision=None, mail_to=None, message=None):
4978
from bzrlib.revision import ensure_null, NULL_REVISION
4979
include_patch, include_bundle = {
4980
'plain': (False, False),
4981
'diff': (True, False),
4982
'bundle': (True, True),
4984
branch = Branch.open('.')
4985
stored_submit_branch = branch.get_submit_branch()
4986
if submit_branch is None:
4987
submit_branch = stored_submit_branch
4989
if stored_submit_branch is None:
4990
branch.set_submit_branch(submit_branch)
4991
if submit_branch is None:
4992
submit_branch = branch.get_parent()
4993
if submit_branch is None:
4994
raise errors.BzrCommandError('No submit branch specified or known')
4996
stored_public_branch = branch.get_public_branch()
4997
if public_branch is None:
4998
public_branch = stored_public_branch
4999
elif stored_public_branch is None:
5000
branch.set_public_branch(public_branch)
5001
if not include_bundle and public_branch is None:
5002
raise errors.BzrCommandError('No public branch specified or'
5004
base_revision_id = None
5005
if revision is not None:
5006
if len(revision) > 2:
5007
raise errors.BzrCommandError('bzr merge-directive takes '
5008
'at most two one revision identifiers')
5009
revision_id = revision[-1].as_revision_id(branch)
5010
if len(revision) == 2:
5011
base_revision_id = revision[0].as_revision_id(branch)
5013
revision_id = branch.last_revision()
5014
revision_id = ensure_null(revision_id)
5015
if revision_id == NULL_REVISION:
5016
raise errors.BzrCommandError('No revisions to bundle.')
5017
directive = merge_directive.MergeDirective2.from_objects(
5018
branch.repository, revision_id, time.time(),
5019
osutils.local_time_offset(), submit_branch,
5020
public_branch=public_branch, include_patch=include_patch,
5021
include_bundle=include_bundle, message=message,
5022
base_revision_id=base_revision_id)
5025
self.outf.write(directive.to_signed(branch))
5027
self.outf.writelines(directive.to_lines())
5029
message = directive.to_email(mail_to, branch, sign)
5030
s = SMTPConnection(branch.get_config())
5031
s.send_email(message)
5034
class cmd_send(Command):
5035
"""Mail or create a merge-directive for submitting changes.
5037
A merge directive provides many things needed for requesting merges:
5039
* A machine-readable description of the merge to perform
5041
* An optional patch that is a preview of the changes requested
5043
* An optional bundle of revision data, so that the changes can be applied
5044
directly from the merge directive, without retrieving data from a
5047
`bzr send` creates a compact data set that, when applied using bzr
5048
merge, has the same effect as merging from the source branch.
5050
By default the merge directive is self-contained and can be applied to any
5051
branch containing submit_branch in its ancestory without needing access to
5054
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5055
revisions, but only a structured request to merge from the
5056
public_location. In that case the public_branch is needed and it must be
5057
up-to-date and accessible to the recipient. The public_branch is always
5058
included if known, so that people can check it later.
5060
The submit branch defaults to the parent of the source branch, but can be
5061
overridden. Both submit branch and public branch will be remembered in
5062
branch.conf the first time they are used for a particular branch. The
5063
source branch defaults to that containing the working directory, but can
5064
be changed using --from.
5066
In order to calculate those changes, bzr must analyse the submit branch.
5067
Therefore it is most efficient for the submit branch to be a local mirror.
5068
If a public location is known for the submit_branch, that location is used
5069
in the merge directive.
5071
The default behaviour is to send the merge directive by mail, unless -o is
5072
given, in which case it is sent to a file.
5074
Mail is sent using your preferred mail program. This should be transparent
5075
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5076
If the preferred client can't be found (or used), your editor will be used.
5078
To use a specific mail program, set the mail_client configuration option.
5079
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5080
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5081
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5082
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5085
If mail is being sent, a to address is required. This can be supplied
5086
either on the commandline, by setting the submit_to configuration
5087
option in the branch itself or the child_submit_to configuration option
5088
in the submit branch.
5090
Two formats are currently supported: "4" uses revision bundle format 4 and
5091
merge directive format 2. It is significantly faster and smaller than
5092
older formats. It is compatible with Bazaar 0.19 and later. It is the
5093
default. "0.9" uses revision bundle format 0.9 and merge directive
5094
format 1. It is compatible with Bazaar 0.12 - 0.18.
5096
The merge directives created by bzr send may be applied using bzr merge or
5097
bzr pull by specifying a file containing a merge directive as the location.
5099
bzr send makes extensive use of public locations to map local locations into
5100
URLs that can be used by other people. See `bzr help configuration` to
5101
set them, and use `bzr info` to display them.
5104
encoding_type = 'exact'
5106
_see_also = ['merge', 'pull']
5108
takes_args = ['submit_branch?', 'public_branch?']
5112
help='Do not include a bundle in the merge directive.'),
5113
Option('no-patch', help='Do not include a preview patch in the merge'
5116
help='Remember submit and public branch.'),
5118
help='Branch to generate the submission from, '
5119
'rather than the one containing the working directory.',
5122
Option('output', short_name='o',
5123
help='Write merge directive to this file; '
5124
'use - for stdout.',
5127
help='Refuse to send if there are uncommitted changes in'
5128
' the working tree, --no-strict disables the check.'),
5129
Option('mail-to', help='Mail the request to this address.',
5133
Option('body', help='Body for the email.', type=unicode),
5134
RegistryOption('format',
5135
help='Use the specified output format.',
5136
lazy_registry=('bzrlib.send', 'format_registry')),
5139
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5140
no_patch=False, revision=None, remember=False, output=None,
5141
format=None, mail_to=None, message=None, body=None,
5142
strict=None, **kwargs):
5143
from bzrlib.send import send
5144
return send(submit_branch, revision, public_branch, remember,
5145
format, no_bundle, no_patch, output,
5146
kwargs.get('from', '.'), mail_to, message, body,
5151
class cmd_bundle_revisions(cmd_send):
5152
"""Create a merge-directive for submitting changes.
5154
A merge directive provides many things needed for requesting merges:
5156
* A machine-readable description of the merge to perform
5158
* An optional patch that is a preview of the changes requested
5160
* An optional bundle of revision data, so that the changes can be applied
5161
directly from the merge directive, without retrieving data from a
5164
If --no-bundle is specified, then public_branch is needed (and must be
5165
up-to-date), so that the receiver can perform the merge using the
5166
public_branch. The public_branch is always included if known, so that
5167
people can check it later.
5169
The submit branch defaults to the parent, but can be overridden. Both
5170
submit branch and public branch will be remembered if supplied.
5172
If a public_branch is known for the submit_branch, that public submit
5173
branch is used in the merge instructions. This means that a local mirror
5174
can be used as your actual submit branch, once you have set public_branch
5177
Two formats are currently supported: "4" uses revision bundle format 4 and
5178
merge directive format 2. It is significantly faster and smaller than
5179
older formats. It is compatible with Bazaar 0.19 and later. It is the
5180
default. "0.9" uses revision bundle format 0.9 and merge directive
5181
format 1. It is compatible with Bazaar 0.12 - 0.18.
5186
help='Do not include a bundle in the merge directive.'),
5187
Option('no-patch', help='Do not include a preview patch in the merge'
5190
help='Remember submit and public branch.'),
5192
help='Branch to generate the submission from, '
5193
'rather than the one containing the working directory.',
5196
Option('output', short_name='o', help='Write directive to this file.',
5199
help='Refuse to bundle revisions if there are uncommitted'
5200
' changes in the working tree, --no-strict disables the check.'),
5202
RegistryOption('format',
5203
help='Use the specified output format.',
5204
lazy_registry=('bzrlib.send', 'format_registry')),
5206
aliases = ['bundle']
5208
_see_also = ['send', 'merge']
5212
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5213
no_patch=False, revision=None, remember=False, output=None,
5214
format=None, strict=None, **kwargs):
5217
from bzrlib.send import send
5218
return send(submit_branch, revision, public_branch, remember,
5219
format, no_bundle, no_patch, output,
5220
kwargs.get('from', '.'), None, None, None,
5221
self.outf, strict=strict)
5224
class cmd_tag(Command):
5225
"""Create, remove or modify a tag naming a revision.
5227
Tags give human-meaningful names to revisions. Commands that take a -r
5228
(--revision) option can be given -rtag:X, where X is any previously
5231
Tags are stored in the branch. Tags are copied from one branch to another
5232
along when you branch, push, pull or merge.
5234
It is an error to give a tag name that already exists unless you pass
5235
--force, in which case the tag is moved to point to the new revision.
5237
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5238
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5241
_see_also = ['commit', 'tags']
5242
takes_args = ['tag_name']
5245
help='Delete this tag rather than placing it.',
5248
help='Branch in which to place the tag.',
5253
help='Replace existing tags.',
5258
def run(self, tag_name,
5264
branch, relpath = Branch.open_containing(directory)
5266
self.add_cleanup(branch.unlock)
5268
branch.tags.delete_tag(tag_name)
5269
self.outf.write('Deleted tag %s.\n' % tag_name)
5272
if len(revision) != 1:
5273
raise errors.BzrCommandError(
5274
"Tags can only be placed on a single revision, "
5276
revision_id = revision[0].as_revision_id(branch)
5278
revision_id = branch.last_revision()
5279
if (not force) and branch.tags.has_tag(tag_name):
5280
raise errors.TagAlreadyExists(tag_name)
5281
branch.tags.set_tag(tag_name, revision_id)
5282
self.outf.write('Created tag %s.\n' % tag_name)
5285
class cmd_tags(Command):
5288
This command shows a table of tag names and the revisions they reference.
5294
help='Branch whose tags should be displayed.',
5298
RegistryOption.from_kwargs('sort',
5299
'Sort tags by different criteria.', title='Sorting',
5300
alpha='Sort tags lexicographically (default).',
5301
time='Sort tags chronologically.',
5314
branch, relpath = Branch.open_containing(directory)
5316
tags = branch.tags.get_tag_dict().items()
5321
self.add_cleanup(branch.unlock)
5323
graph = branch.repository.get_graph()
5324
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5325
revid1, revid2 = rev1.rev_id, rev2.rev_id
5326
# only show revisions between revid1 and revid2 (inclusive)
5327
tags = [(tag, revid) for tag, revid in tags if
5328
graph.is_between(revid, revid1, revid2)]
5331
elif sort == 'time':
5333
for tag, revid in tags:
5335
revobj = branch.repository.get_revision(revid)
5336
except errors.NoSuchRevision:
5337
timestamp = sys.maxint # place them at the end
5339
timestamp = revobj.timestamp
5340
timestamps[revid] = timestamp
5341
tags.sort(key=lambda x: timestamps[x[1]])
5343
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5344
for index, (tag, revid) in enumerate(tags):
5346
revno = branch.revision_id_to_dotted_revno(revid)
5347
if isinstance(revno, tuple):
5348
revno = '.'.join(map(str, revno))
5349
except errors.NoSuchRevision:
5350
# Bad tag data/merges can lead to tagged revisions
5351
# which are not in this branch. Fail gracefully ...
5353
tags[index] = (tag, revno)
5355
for tag, revspec in tags:
5356
self.outf.write('%-20s %s\n' % (tag, revspec))
5359
class cmd_reconfigure(Command):
5360
"""Reconfigure the type of a bzr directory.
5362
A target configuration must be specified.
5364
For checkouts, the bind-to location will be auto-detected if not specified.
5365
The order of preference is
5366
1. For a lightweight checkout, the current bound location.
5367
2. For branches that used to be checkouts, the previously-bound location.
5368
3. The push location.
5369
4. The parent location.
5370
If none of these is available, --bind-to must be specified.
5373
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5374
takes_args = ['location?']
5376
RegistryOption.from_kwargs(
5378
title='Target type',
5379
help='The type to reconfigure the directory to.',
5380
value_switches=True, enum_switch=False,
5381
branch='Reconfigure to be an unbound branch with no working tree.',
5382
tree='Reconfigure to be an unbound branch with a working tree.',
5383
checkout='Reconfigure to be a bound branch with a working tree.',
5384
lightweight_checkout='Reconfigure to be a lightweight'
5385
' checkout (with no local history).',
5386
standalone='Reconfigure to be a standalone branch '
5387
'(i.e. stop using shared repository).',
5388
use_shared='Reconfigure to use a shared repository.',
5389
with_trees='Reconfigure repository to create '
5390
'working trees on branches by default.',
5391
with_no_trees='Reconfigure repository to not create '
5392
'working trees on branches by default.'
5394
Option('bind-to', help='Branch to bind checkout to.', type=str),
5396
help='Perform reconfiguration even if local changes'
5398
Option('stacked-on',
5399
help='Reconfigure a branch to be stacked on another branch.',
5403
help='Reconfigure a branch to be unstacked. This '
5404
'may require copying substantial data into it.',
5408
def run(self, location=None, target_type=None, bind_to=None, force=False,
5411
directory = bzrdir.BzrDir.open(location)
5412
if stacked_on and unstacked:
5413
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5414
elif stacked_on is not None:
5415
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5417
reconfigure.ReconfigureUnstacked().apply(directory)
5418
# At the moment you can use --stacked-on and a different
5419
# reconfiguration shape at the same time; there seems no good reason
5421
if target_type is None:
5422
if stacked_on or unstacked:
5425
raise errors.BzrCommandError('No target configuration '
5427
elif target_type == 'branch':
5428
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5429
elif target_type == 'tree':
5430
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5431
elif target_type == 'checkout':
5432
reconfiguration = reconfigure.Reconfigure.to_checkout(
5434
elif target_type == 'lightweight-checkout':
5435
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5437
elif target_type == 'use-shared':
5438
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5439
elif target_type == 'standalone':
5440
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5441
elif target_type == 'with-trees':
5442
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5444
elif target_type == 'with-no-trees':
5445
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5447
reconfiguration.apply(force)
5450
class cmd_switch(Command):
5451
"""Set the branch of a checkout and update.
5453
For lightweight checkouts, this changes the branch being referenced.
5454
For heavyweight checkouts, this checks that there are no local commits
5455
versus the current bound branch, then it makes the local branch a mirror
5456
of the new location and binds to it.
5458
In both cases, the working tree is updated and uncommitted changes
5459
are merged. The user can commit or revert these as they desire.
5461
Pending merges need to be committed or reverted before using switch.
5463
The path to the branch to switch to can be specified relative to the parent
5464
directory of the current branch. For example, if you are currently in a
5465
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5468
Bound branches use the nickname of its master branch unless it is set
5469
locally, in which case switching will update the local nickname to be
5473
takes_args = ['to_location?']
5474
takes_options = [Option('force',
5475
help='Switch even if local commits will be lost.'),
5477
Option('create-branch', short_name='b',
5478
help='Create the target branch from this one before'
5479
' switching to it.'),
5482
def run(self, to_location=None, force=False, create_branch=False,
5484
from bzrlib import switch
5486
revision = _get_one_revision('switch', revision)
5487
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5488
if to_location is None:
5489
if revision is None:
5490
raise errors.BzrCommandError('You must supply either a'
5491
' revision or a location')
5494
branch = control_dir.open_branch()
5495
had_explicit_nick = branch.get_config().has_explicit_nickname()
5496
except errors.NotBranchError:
5498
had_explicit_nick = False
5501
raise errors.BzrCommandError('cannot create branch without'
5503
to_location = directory_service.directories.dereference(
5505
if '/' not in to_location and '\\' not in to_location:
5506
# This path is meant to be relative to the existing branch
5507
this_url = self._get_branch_location(control_dir)
5508
to_location = urlutils.join(this_url, '..', to_location)
5509
to_branch = branch.bzrdir.sprout(to_location,
5510
possible_transports=[branch.bzrdir.root_transport],
5511
source_branch=branch).open_branch()
5514
to_branch = Branch.open(to_location)
5515
except errors.NotBranchError:
5516
this_url = self._get_branch_location(control_dir)
5517
to_branch = Branch.open(
5518
urlutils.join(this_url, '..', to_location))
5519
if revision is not None:
5520
revision = revision.as_revision_id(to_branch)
5521
switch.switch(control_dir, to_branch, force, revision_id=revision)
5522
if had_explicit_nick:
5523
branch = control_dir.open_branch() #get the new branch!
5524
branch.nick = to_branch.nick
5525
note('Switched to branch: %s',
5526
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5528
def _get_branch_location(self, control_dir):
5529
"""Return location of branch for this control dir."""
5531
this_branch = control_dir.open_branch()
5532
# This may be a heavy checkout, where we want the master branch
5533
master_location = this_branch.get_bound_location()
5534
if master_location is not None:
5535
return master_location
5536
# If not, use a local sibling
5537
return this_branch.base
5538
except errors.NotBranchError:
5539
format = control_dir.find_branch_format()
5540
if getattr(format, 'get_reference', None) is not None:
5541
return format.get_reference(control_dir)
5543
return control_dir.root_transport.base
5546
class cmd_view(Command):
5547
"""Manage filtered views.
5549
Views provide a mask over the tree so that users can focus on
5550
a subset of a tree when doing their work. After creating a view,
5551
commands that support a list of files - status, diff, commit, etc -
5552
effectively have that list of files implicitly given each time.
5553
An explicit list of files can still be given but those files
5554
must be within the current view.
5556
In most cases, a view has a short life-span: it is created to make
5557
a selected change and is deleted once that change is committed.
5558
At other times, you may wish to create one or more named views
5559
and switch between them.
5561
To disable the current view without deleting it, you can switch to
5562
the pseudo view called ``off``. This can be useful when you need
5563
to see the whole tree for an operation or two (e.g. merge) but
5564
want to switch back to your view after that.
5567
To define the current view::
5569
bzr view file1 dir1 ...
5571
To list the current view::
5575
To delete the current view::
5579
To disable the current view without deleting it::
5581
bzr view --switch off
5583
To define a named view and switch to it::
5585
bzr view --name view-name file1 dir1 ...
5587
To list a named view::
5589
bzr view --name view-name
5591
To delete a named view::
5593
bzr view --name view-name --delete
5595
To switch to a named view::
5597
bzr view --switch view-name
5599
To list all views defined::
5603
To delete all views::
5605
bzr view --delete --all
5609
takes_args = ['file*']
5612
help='Apply list or delete action to all views.',
5615
help='Delete the view.',
5618
help='Name of the view to define, list or delete.',
5622
help='Name of the view to switch to.',
5627
def run(self, file_list,
5633
tree, file_list = tree_files(file_list, apply_view=False)
5634
current_view, view_dict = tree.views.get_view_info()
5639
raise errors.BzrCommandError(
5640
"Both --delete and a file list specified")
5642
raise errors.BzrCommandError(
5643
"Both --delete and --switch specified")
5645
tree.views.set_view_info(None, {})
5646
self.outf.write("Deleted all views.\n")
5648
raise errors.BzrCommandError("No current view to delete")
5650
tree.views.delete_view(name)
5651
self.outf.write("Deleted '%s' view.\n" % name)
5654
raise errors.BzrCommandError(
5655
"Both --switch and a file list specified")
5657
raise errors.BzrCommandError(
5658
"Both --switch and --all specified")
5659
elif switch == 'off':
5660
if current_view is None:
5661
raise errors.BzrCommandError("No current view to disable")
5662
tree.views.set_view_info(None, view_dict)
5663
self.outf.write("Disabled '%s' view.\n" % (current_view))
5665
tree.views.set_view_info(switch, view_dict)
5666
view_str = views.view_display_str(tree.views.lookup_view())
5667
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5670
self.outf.write('Views defined:\n')
5671
for view in sorted(view_dict):
5672
if view == current_view:
5676
view_str = views.view_display_str(view_dict[view])
5677
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5679
self.outf.write('No views defined.\n')
5682
# No name given and no current view set
5685
raise errors.BzrCommandError(
5686
"Cannot change the 'off' pseudo view")
5687
tree.views.set_view(name, sorted(file_list))
5688
view_str = views.view_display_str(tree.views.lookup_view())
5689
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5693
# No name given and no current view set
5694
self.outf.write('No current view.\n')
5696
view_str = views.view_display_str(tree.views.lookup_view(name))
5697
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5700
class cmd_hooks(Command):
5706
for hook_key in sorted(hooks.known_hooks.keys()):
5707
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5708
self.outf.write("%s:\n" % type(some_hooks).__name__)
5709
for hook_name, hook_point in sorted(some_hooks.items()):
5710
self.outf.write(" %s:\n" % (hook_name,))
5711
found_hooks = list(hook_point)
5713
for hook in found_hooks:
5714
self.outf.write(" %s\n" %
5715
(some_hooks.get_hook_name(hook),))
5717
self.outf.write(" <no hooks installed>\n")
5720
class cmd_shelve(Command):
5721
"""Temporarily set aside some changes from the current tree.
5723
Shelve allows you to temporarily put changes you've made "on the shelf",
5724
ie. out of the way, until a later time when you can bring them back from
5725
the shelf with the 'unshelve' command. The changes are stored alongside
5726
your working tree, and so they aren't propagated along with your branch nor
5727
will they survive its deletion.
5729
If shelve --list is specified, previously-shelved changes are listed.
5731
Shelve is intended to help separate several sets of changes that have
5732
been inappropriately mingled. If you just want to get rid of all changes
5733
and you don't need to restore them later, use revert. If you want to
5734
shelve all text changes at once, use shelve --all.
5736
If filenames are specified, only the changes to those files will be
5737
shelved. Other files will be left untouched.
5739
If a revision is specified, changes since that revision will be shelved.
5741
You can put multiple items on the shelf, and by default, 'unshelve' will
5742
restore the most recently shelved changes.
5745
takes_args = ['file*']
5749
Option('all', help='Shelve all changes.'),
5751
RegistryOption('writer', 'Method to use for writing diffs.',
5752
bzrlib.option.diff_writer_registry,
5753
value_switches=True, enum_switch=False),
5755
Option('list', help='List shelved changes.'),
5757
help='Destroy removed changes instead of shelving them.'),
5759
_see_also = ['unshelve']
5761
def run(self, revision=None, all=False, file_list=None, message=None,
5762
writer=None, list=False, destroy=False):
5764
return self.run_for_list()
5765
from bzrlib.shelf_ui import Shelver
5767
writer = bzrlib.option.diff_writer_registry.get()
5769
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5770
file_list, message, destroy=destroy)
5775
except errors.UserAbort:
5778
def run_for_list(self):
5779
tree = WorkingTree.open_containing('.')[0]
5781
self.add_cleanup(tree.unlock)
5782
manager = tree.get_shelf_manager()
5783
shelves = manager.active_shelves()
5784
if len(shelves) == 0:
5785
note('No shelved changes.')
5787
for shelf_id in reversed(shelves):
5788
message = manager.get_metadata(shelf_id).get('message')
5790
message = '<no message>'
5791
self.outf.write('%3d: %s\n' % (shelf_id, message))
5795
class cmd_unshelve(Command):
5796
"""Restore shelved changes.
5798
By default, the most recently shelved changes are restored. However if you
5799
specify a shelf by id those changes will be restored instead. This works
5800
best when the changes don't depend on each other.
5803
takes_args = ['shelf_id?']
5805
RegistryOption.from_kwargs(
5806
'action', help="The action to perform.",
5807
enum_switch=False, value_switches=True,
5808
apply="Apply changes and remove from the shelf.",
5809
dry_run="Show changes, but do not apply or remove them.",
5810
preview="Instead of unshelving the changes, show the diff that "
5811
"would result from unshelving.",
5812
delete_only="Delete changes without applying them.",
5813
keep="Apply changes but don't delete them.",
5816
_see_also = ['shelve']
5818
def run(self, shelf_id=None, action='apply'):
5819
from bzrlib.shelf_ui import Unshelver
5820
unshelver = Unshelver.from_args(shelf_id, action)
5824
unshelver.tree.unlock()
5827
class cmd_clean_tree(Command):
5828
"""Remove unwanted files from working tree.
5830
By default, only unknown files, not ignored files, are deleted. Versioned
5831
files are never deleted.
5833
Another class is 'detritus', which includes files emitted by bzr during
5834
normal operations and selftests. (The value of these files decreases with
5837
If no options are specified, unknown files are deleted. Otherwise, option
5838
flags are respected, and may be combined.
5840
To check what clean-tree will do, use --dry-run.
5842
takes_options = [Option('ignored', help='Delete all ignored files.'),
5843
Option('detritus', help='Delete conflict files, merge'
5844
' backups, and failed selftest dirs.'),
5846
help='Delete files unknown to bzr (default).'),
5847
Option('dry-run', help='Show files to delete instead of'
5849
Option('force', help='Do not prompt before deleting.')]
5850
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5852
from bzrlib.clean_tree import clean_tree
5853
if not (unknown or ignored or detritus):
5857
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5858
dry_run=dry_run, no_prompt=force)
5861
class cmd_reference(Command):
5862
"""list, view and set branch locations for nested trees.
5864
If no arguments are provided, lists the branch locations for nested trees.
5865
If one argument is provided, display the branch location for that tree.
5866
If two arguments are provided, set the branch location for that tree.
5871
takes_args = ['path?', 'location?']
5873
def run(self, path=None, location=None):
5875
if path is not None:
5877
tree, branch, relpath =(
5878
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5879
if path is not None:
5882
tree = branch.basis_tree()
5884
info = branch._get_all_reference_info().iteritems()
5885
self._display_reference_info(tree, branch, info)
5887
file_id = tree.path2id(path)
5889
raise errors.NotVersionedError(path)
5890
if location is None:
5891
info = [(file_id, branch.get_reference_info(file_id))]
5892
self._display_reference_info(tree, branch, info)
5894
branch.set_reference_info(file_id, path, location)
5896
def _display_reference_info(self, tree, branch, info):
5898
for file_id, (path, location) in info:
5900
path = tree.id2path(file_id)
5901
except errors.NoSuchId:
5903
ref_list.append((path, location))
5904
for path, location in sorted(ref_list):
5905
self.outf.write('%s %s\n' % (path, location))
5908
# these get imported and then picked up by the scan for cmd_*
5909
# TODO: Some more consistent way to split command definitions across files;
5910
# we do need to load at least some information about them to know of
5911
# aliases. ideally we would avoid loading the implementation until the
5912
# details were needed.
5913
from bzrlib.cmd_version_info import cmd_version_info
5914
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5915
from bzrlib.bundle.commands import (
5918
from bzrlib.foreign import cmd_dpush
5919
from bzrlib.sign_my_commits import cmd_sign_my_commits
added
removed
bzrlib/builtins.py
