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
343
def print_revision(self, revisions, revid):
344
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
345
record = stream.next()
346
if record.storage_kind == 'absent':
347
raise errors.NoSuchRevision(revisions, revid)
348
revtext = record.get_bytes_as('fulltext')
349
self.outf.write(revtext.decode('utf-8'))
352
def run(self, revision_id=None, revision=None):
353
if revision_id is not None and revision is not None:
354
raise errors.BzrCommandError('You can only supply one of'
355
' revision_id or --revision')
356
if revision_id is None and revision is None:
357
raise errors.BzrCommandError('You must supply either'
358
' --revision or a revision_id')
359
b = WorkingTree.open_containing(u'.')[0].branch
361
revisions = b.repository.revisions
362
if revisions is None:
363
raise errors.BzrCommandError('Repository %r does not support '
364
'access to raw revision texts')
366
b.repository.lock_read()
368
# TODO: jam 20060112 should cat-revision always output utf-8?
369
if revision_id is not None:
370
revision_id = osutils.safe_revision_id(revision_id, warn=False)
372
self.print_revision(revisions, revision_id)
373
except errors.NoSuchRevision:
374
msg = "The repository %s contains no revision %s." % (
375
b.repository.base, revision_id)
376
raise errors.BzrCommandError(msg)
377
elif revision is not None:
380
raise errors.BzrCommandError(
381
'You cannot specify a NULL revision.')
382
rev_id = rev.as_revision_id(b)
383
self.print_revision(revisions, rev_id)
385
b.repository.unlock()
388
class cmd_dump_btree(Command):
389
"""Dump the contents of a btree index file to stdout.
391
PATH is a btree index file, it can be any URL. This includes things like
392
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
394
By default, the tuples stored in the index file will be displayed. With
395
--raw, we will uncompress the pages, but otherwise display the raw bytes
399
# TODO: Do we want to dump the internal nodes as well?
400
# TODO: It would be nice to be able to dump the un-parsed information,
401
# rather than only going through iter_all_entries. However, this is
402
# good enough for a start
404
encoding_type = 'exact'
405
takes_args = ['path']
406
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
407
' rather than the parsed tuples.'),
410
def run(self, path, raw=False):
411
dirname, basename = osutils.split(path)
412
t = transport.get_transport(dirname)
414
self._dump_raw_bytes(t, basename)
416
self._dump_entries(t, basename)
418
def _get_index_and_bytes(self, trans, basename):
419
"""Create a BTreeGraphIndex and raw bytes."""
420
bt = btree_index.BTreeGraphIndex(trans, basename, None)
421
bytes = trans.get_bytes(basename)
422
bt._file = cStringIO.StringIO(bytes)
423
bt._size = len(bytes)
426
def _dump_raw_bytes(self, trans, basename):
429
# We need to parse at least the root node.
430
# This is because the first page of every row starts with an
431
# uncompressed header.
432
bt, bytes = self._get_index_and_bytes(trans, basename)
433
for page_idx, page_start in enumerate(xrange(0, len(bytes),
434
btree_index._PAGE_SIZE)):
435
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
436
page_bytes = bytes[page_start:page_end]
438
self.outf.write('Root node:\n')
439
header_end, data = bt._parse_header_from_bytes(page_bytes)
440
self.outf.write(page_bytes[:header_end])
442
self.outf.write('\nPage %d\n' % (page_idx,))
443
decomp_bytes = zlib.decompress(page_bytes)
444
self.outf.write(decomp_bytes)
445
self.outf.write('\n')
447
def _dump_entries(self, trans, basename):
449
st = trans.stat(basename)
450
except errors.TransportNotPossible:
451
# We can't stat, so we'll fake it because we have to do the 'get()'
453
bt, _ = self._get_index_and_bytes(trans, basename)
455
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
456
for node in bt.iter_all_entries():
457
# Node is made up of:
458
# (index, key, value, [references])
459
refs_as_tuples = static_tuple.as_tuples(node[3])
460
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
461
self.outf.write('%s\n' % (as_tuple,))
464
class cmd_remove_tree(Command):
465
"""Remove the working tree from a given branch/checkout.
467
Since a lightweight checkout is little more than a working tree
468
this will refuse to run against one.
470
To re-create the working tree, use "bzr checkout".
472
_see_also = ['checkout', 'working-trees']
473
takes_args = ['location*']
476
help='Remove the working tree even if it has '
477
'uncommitted changes.'),
480
def run(self, location_list, force=False):
481
if not location_list:
484
for location in location_list:
485
d = bzrdir.BzrDir.open(location)
488
working = d.open_workingtree()
489
except errors.NoWorkingTree:
490
raise errors.BzrCommandError("No working tree to remove")
491
except errors.NotLocalUrl:
492
raise errors.BzrCommandError("You cannot remove the working tree"
495
if (working.has_changes()):
496
raise errors.UncommittedChanges(working)
498
working_path = working.bzrdir.root_transport.base
499
branch_path = working.branch.bzrdir.root_transport.base
500
if working_path != branch_path:
501
raise errors.BzrCommandError("You cannot remove the working tree"
502
" from a lightweight checkout")
504
d.destroy_workingtree()
507
class cmd_revno(Command):
508
"""Show current revision number.
510
This is equal to the number of revisions on this branch.
514
takes_args = ['location?']
516
Option('tree', help='Show revno of working tree'),
520
def run(self, tree=False, location=u'.'):
523
wt = WorkingTree.open_containing(location)[0]
525
except (errors.NoWorkingTree, errors.NotLocalUrl):
526
raise errors.NoWorkingTree(location)
527
self.add_cleanup(wt.unlock)
528
revid = wt.last_revision()
530
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
531
except errors.NoSuchRevision:
533
revno = ".".join(str(n) for n in revno_t)
535
b = Branch.open_containing(location)[0]
537
self.add_cleanup(b.unlock)
540
self.outf.write(str(revno) + '\n')
543
class cmd_revision_info(Command):
544
"""Show revision number and revision id for a given revision identifier.
547
takes_args = ['revision_info*']
551
help='Branch to examine, '
552
'rather than the one containing the working directory.',
556
Option('tree', help='Show revno of working tree'),
560
def run(self, revision=None, directory=u'.', tree=False,
561
revision_info_list=[]):
564
wt = WorkingTree.open_containing(directory)[0]
567
self.add_cleanup(wt.unlock)
568
except (errors.NoWorkingTree, errors.NotLocalUrl):
570
b = Branch.open_containing(directory)[0]
572
self.add_cleanup(b.unlock)
574
if revision is not None:
575
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
576
if revision_info_list is not None:
577
for rev_str in revision_info_list:
578
rev_spec = RevisionSpec.from_string(rev_str)
579
revision_ids.append(rev_spec.as_revision_id(b))
580
# No arguments supplied, default to the last revision
581
if len(revision_ids) == 0:
584
raise errors.NoWorkingTree(directory)
585
revision_ids.append(wt.last_revision())
587
revision_ids.append(b.last_revision())
591
for revision_id in revision_ids:
593
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
594
revno = '.'.join(str(i) for i in dotted_revno)
595
except errors.NoSuchRevision:
597
maxlen = max(maxlen, len(revno))
598
revinfos.append([revno, revision_id])
602
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
605
class cmd_add(Command):
606
"""Add specified files or directories.
608
In non-recursive mode, all the named items are added, regardless
609
of whether they were previously ignored. A warning is given if
610
any of the named files are already versioned.
612
In recursive mode (the default), files are treated the same way
613
but the behaviour for directories is different. Directories that
614
are already versioned do not give a warning. All directories,
615
whether already versioned or not, are searched for files or
616
subdirectories that are neither versioned or ignored, and these
617
are added. This search proceeds recursively into versioned
618
directories. If no names are given '.' is assumed.
620
Therefore simply saying 'bzr add' will version all files that
621
are currently unknown.
623
Adding a file whose parent directory is not versioned will
624
implicitly add the parent, and so on up to the root. This means
625
you should never need to explicitly add a directory, they'll just
626
get added when you add a file in the directory.
628
--dry-run will show which files would be added, but not actually
631
--file-ids-from will try to use the file ids from the supplied path.
632
It looks up ids trying to find a matching parent directory with the
633
same filename, and then by pure path. This option is rarely needed
634
but can be useful when adding the same logical file into two
635
branches that will be merged later (without showing the two different
636
adds as a conflict). It is also useful when merging another project
637
into a subdirectory of this one.
639
Any files matching patterns in the ignore list will not be added
640
unless they are explicitly mentioned.
642
takes_args = ['file*']
645
help="Don't recursively add the contents of directories."),
647
help="Show what would be done, but don't actually do anything."),
649
Option('file-ids-from',
651
help='Lookup file ids from this tree.'),
653
encoding_type = 'replace'
654
_see_also = ['remove', 'ignore']
656
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
661
if file_ids_from is not None:
663
base_tree, base_path = WorkingTree.open_containing(
665
except errors.NoWorkingTree:
666
base_branch, base_path = Branch.open_containing(
668
base_tree = base_branch.basis_tree()
670
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
671
to_file=self.outf, should_print=(not is_quiet()))
673
action = bzrlib.add.AddAction(to_file=self.outf,
674
should_print=(not is_quiet()))
677
base_tree.lock_read()
678
self.add_cleanup(base_tree.unlock)
679
tree, file_list = tree_files_for_add(file_list)
680
added, ignored = tree.smart_add(file_list, not
681
no_recurse, action=action, save=not dry_run)
685
for glob in sorted(ignored.keys()):
686
for path in ignored[glob]:
687
self.outf.write("ignored %s matching \"%s\"\n"
691
class cmd_mkdir(Command):
692
"""Create a new versioned directory.
694
This is equivalent to creating the directory and then adding it.
697
takes_args = ['dir+']
698
encoding_type = 'replace'
700
def run(self, dir_list):
702
wt, dd = WorkingTree.open_containing(d)
703
base = os.path.dirname(dd)
704
id = wt.path2id(base)
708
self.outf.write('added %s\n' % d)
710
raise errors.NotVersionedError(path=base)
713
class cmd_relpath(Command):
714
"""Show path of a file relative to root"""
716
takes_args = ['filename']
720
def run(self, filename):
721
# TODO: jam 20050106 Can relpath return a munged path if
722
# sys.stdout encoding cannot represent it?
723
tree, relpath = WorkingTree.open_containing(filename)
724
self.outf.write(relpath)
725
self.outf.write('\n')
728
class cmd_inventory(Command):
729
"""Show inventory of the current working copy or a revision.
731
It is possible to limit the output to a particular entry
732
type using the --kind option. For example: --kind file.
734
It is also possible to restrict the list of files to a specific
735
set. For example: bzr inventory --show-ids this/file
744
help='List entries of a particular kind: file, directory, symlink.',
747
takes_args = ['file*']
750
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
751
if kind and kind not in ['file', 'directory', 'symlink']:
752
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
754
revision = _get_one_revision('inventory', revision)
755
work_tree, file_list = tree_files(file_list)
756
work_tree.lock_read()
757
self.add_cleanup(work_tree.unlock)
758
if revision is not None:
759
tree = revision.as_tree(work_tree.branch)
761
extra_trees = [work_tree]
763
self.add_cleanup(tree.unlock)
768
if file_list is not None:
769
file_ids = tree.paths2ids(file_list, trees=extra_trees,
770
require_versioned=True)
771
# find_ids_across_trees may include some paths that don't
773
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
774
for file_id in file_ids if file_id in tree)
776
entries = tree.inventory.entries()
779
for path, entry in entries:
780
if kind and kind != entry.kind:
783
self.outf.write('%-50s %s\n' % (path, entry.file_id))
785
self.outf.write(path)
786
self.outf.write('\n')
789
class cmd_mv(Command):
790
"""Move or rename a file.
793
bzr mv OLDNAME NEWNAME
795
bzr mv SOURCE... DESTINATION
797
If the last argument is a versioned directory, all the other names
798
are moved into it. Otherwise, there must be exactly two arguments
799
and the file is changed to a new name.
801
If OLDNAME does not exist on the filesystem but is versioned and
802
NEWNAME does exist on the filesystem but is not versioned, mv
803
assumes that the file has been manually moved and only updates
804
its internal inventory to reflect that change.
805
The same is valid when moving many SOURCE files to a DESTINATION.
807
Files cannot be moved between branches.
810
takes_args = ['names*']
811
takes_options = [Option("after", help="Move only the bzr identifier"
812
" of the file, because the file has already been moved."),
813
Option('auto', help='Automatically guess renames.'),
814
Option('dry-run', help='Avoid making changes when guessing renames.'),
816
aliases = ['move', 'rename']
817
encoding_type = 'replace'
819
def run(self, names_list, after=False, auto=False, dry_run=False):
821
return self.run_auto(names_list, after, dry_run)
823
raise errors.BzrCommandError('--dry-run requires --auto.')
824
if names_list is None:
826
if len(names_list) < 2:
827
raise errors.BzrCommandError("missing file argument")
828
tree, rel_names = tree_files(names_list, canonicalize=False)
829
tree.lock_tree_write()
830
self.add_cleanup(tree.unlock)
831
self._run(tree, names_list, rel_names, after)
833
def run_auto(self, names_list, after, dry_run):
834
if names_list is not None and len(names_list) > 1:
835
raise errors.BzrCommandError('Only one path may be specified to'
838
raise errors.BzrCommandError('--after cannot be specified with'
840
work_tree, file_list = tree_files(names_list, default_branch='.')
841
work_tree.lock_tree_write()
842
self.add_cleanup(work_tree.unlock)
843
rename_map.RenameMap.guess_renames(work_tree, dry_run)
845
def _run(self, tree, names_list, rel_names, after):
846
into_existing = osutils.isdir(names_list[-1])
847
if into_existing and len(names_list) == 2:
849
# a. case-insensitive filesystem and change case of dir
850
# b. move directory after the fact (if the source used to be
851
# a directory, but now doesn't exist in the working tree
852
# and the target is an existing directory, just rename it)
853
if (not tree.case_sensitive
854
and rel_names[0].lower() == rel_names[1].lower()):
855
into_existing = False
858
# 'fix' the case of a potential 'from'
859
from_id = tree.path2id(
860
tree.get_canonical_inventory_path(rel_names[0]))
861
if (not osutils.lexists(names_list[0]) and
862
from_id and inv.get_file_kind(from_id) == "directory"):
863
into_existing = False
866
# move into existing directory
867
# All entries reference existing inventory items, so fix them up
868
# for cicp file-systems.
869
rel_names = tree.get_canonical_inventory_paths(rel_names)
870
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
872
self.outf.write("%s => %s\n" % (src, dest))
874
if len(names_list) != 2:
875
raise errors.BzrCommandError('to mv multiple files the'
876
' destination must be a versioned'
879
# for cicp file-systems: the src references an existing inventory
881
src = tree.get_canonical_inventory_path(rel_names[0])
882
# Find the canonical version of the destination: In all cases, the
883
# parent of the target must be in the inventory, so we fetch the
884
# canonical version from there (we do not always *use* the
885
# canonicalized tail portion - we may be attempting to rename the
887
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
888
dest_parent = osutils.dirname(canon_dest)
889
spec_tail = osutils.basename(rel_names[1])
890
# For a CICP file-system, we need to avoid creating 2 inventory
891
# entries that differ only by case. So regardless of the case
892
# we *want* to use (ie, specified by the user or the file-system),
893
# we must always choose to use the case of any existing inventory
894
# items. The only exception to this is when we are attempting a
895
# case-only rename (ie, canonical versions of src and dest are
897
dest_id = tree.path2id(canon_dest)
898
if dest_id is None or tree.path2id(src) == dest_id:
899
# No existing item we care about, so work out what case we
900
# are actually going to use.
902
# If 'after' is specified, the tail must refer to a file on disk.
904
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
906
# pathjoin with an empty tail adds a slash, which breaks
908
dest_parent_fq = tree.basedir
910
dest_tail = osutils.canonical_relpath(
912
osutils.pathjoin(dest_parent_fq, spec_tail))
914
# not 'after', so case as specified is used
915
dest_tail = spec_tail
917
# Use the existing item so 'mv' fails with AlreadyVersioned.
918
dest_tail = os.path.basename(canon_dest)
919
dest = osutils.pathjoin(dest_parent, dest_tail)
920
mutter("attempting to move %s => %s", src, dest)
921
tree.rename_one(src, dest, after=after)
923
self.outf.write("%s => %s\n" % (src, dest))
926
class cmd_pull(Command):
927
"""Turn this branch into a mirror of another branch.
929
By default, this command only works on branches that have not diverged.
930
Branches are considered diverged if the destination branch's most recent
931
commit is one that has not been merged (directly or indirectly) into the
934
If branches have diverged, you can use 'bzr merge' to integrate the changes
935
from one into the other. Once one branch has merged, the other should
936
be able to pull it again.
938
If you want to replace your local changes and just want your branch to
939
match the remote one, use pull --overwrite. This will work even if the two
940
branches have diverged.
942
If there is no default location set, the first pull will set it. After
943
that, you can omit the location to use the default. To change the
944
default, use --remember. The value will only be saved if the remote
945
location can be accessed.
947
Note: The location can be specified either in the form of a branch,
948
or in the form of a path to a file containing a merge directive generated
952
_see_also = ['push', 'update', 'status-flags', 'send']
953
takes_options = ['remember', 'overwrite', 'revision',
954
custom_help('verbose',
955
help='Show logs of pulled revisions.'),
957
help='Branch to pull into, '
958
'rather than the one containing the working directory.',
963
help="Perform a local pull in a bound "
964
"branch. Local pulls are not applied to "
968
takes_args = ['location?']
969
encoding_type = 'replace'
971
def run(self, location=None, remember=False, overwrite=False,
972
revision=None, verbose=False,
973
directory=None, local=False):
974
# FIXME: too much stuff is in the command class
977
if directory is None:
980
tree_to = WorkingTree.open_containing(directory)[0]
981
branch_to = tree_to.branch
982
except errors.NoWorkingTree:
984
branch_to = Branch.open_containing(directory)[0]
986
if local and not branch_to.get_bound_location():
987
raise errors.LocalRequiresBoundBranch()
989
possible_transports = []
990
if location is not None:
992
mergeable = bundle.read_mergeable_from_url(location,
993
possible_transports=possible_transports)
994
except errors.NotABundle:
997
stored_loc = branch_to.get_parent()
999
if stored_loc is None:
1000
raise errors.BzrCommandError("No pull location known or"
1003
display_url = urlutils.unescape_for_display(stored_loc,
1006
self.outf.write("Using saved parent location: %s\n" % display_url)
1007
location = stored_loc
1009
revision = _get_one_revision('pull', revision)
1010
if mergeable is not None:
1011
if revision is not None:
1012
raise errors.BzrCommandError(
1013
'Cannot use -r with merge directives or bundles')
1014
mergeable.install_revisions(branch_to.repository)
1015
base_revision_id, revision_id, verified = \
1016
mergeable.get_merge_request(branch_to.repository)
1017
branch_from = branch_to
1019
branch_from = Branch.open(location,
1020
possible_transports=possible_transports)
1022
if branch_to.get_parent() is None or remember:
1023
branch_to.set_parent(branch_from.base)
1025
if branch_from is not branch_to:
1026
branch_from.lock_read()
1027
self.add_cleanup(branch_from.unlock)
1028
if revision is not None:
1029
revision_id = revision.as_revision_id(branch_from)
1031
branch_to.lock_write()
1032
self.add_cleanup(branch_to.unlock)
1033
if tree_to is not None:
1034
view_info = _get_view_info_for_change_reporter(tree_to)
1035
change_reporter = delta._ChangeReporter(
1036
unversioned_filter=tree_to.is_ignored,
1037
view_info=view_info)
1038
result = tree_to.pull(
1039
branch_from, overwrite, revision_id, change_reporter,
1040
possible_transports=possible_transports, local=local)
1042
result = branch_to.pull(
1043
branch_from, overwrite, revision_id, local=local)
1045
result.report(self.outf)
1046
if verbose and result.old_revid != result.new_revid:
1047
log.show_branch_change(
1048
branch_to, self.outf, result.old_revno,
1052
class cmd_push(Command):
1053
"""Update a mirror of this branch.
1055
The target branch will not have its working tree populated because this
1056
is both expensive, and is not supported on remote file systems.
1058
Some smart servers or protocols *may* put the working tree in place in
1061
This command only works on branches that have not diverged. Branches are
1062
considered diverged if the destination branch's most recent commit is one
1063
that has not been merged (directly or indirectly) by the source branch.
1065
If branches have diverged, you can use 'bzr push --overwrite' to replace
1066
the other branch completely, discarding its unmerged changes.
1068
If you want to ensure you have the different changes in the other branch,
1069
do a merge (see bzr help merge) from the other branch, and commit that.
1070
After that you will be able to do a push without '--overwrite'.
1072
If there is no default push location set, the first push will set it.
1073
After that, you can omit the location to use the default. To change the
1074
default, use --remember. The value will only be saved if the remote
1075
location can be accessed.
1078
_see_also = ['pull', 'update', 'working-trees']
1079
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1080
Option('create-prefix',
1081
help='Create the path leading up to the branch '
1082
'if it does not already exist.'),
1084
help='Branch to push from, '
1085
'rather than the one containing the working directory.',
1089
Option('use-existing-dir',
1090
help='By default push will fail if the target'
1091
' directory exists, but does not already'
1092
' have a control directory. This flag will'
1093
' allow push to proceed.'),
1095
help='Create a stacked branch that references the public location '
1096
'of the parent branch.'),
1097
Option('stacked-on',
1098
help='Create a stacked branch that refers to another branch '
1099
'for the commit history. Only the work not present in the '
1100
'referenced branch is included in the branch created.',
1103
help='Refuse to push if there are uncommitted changes in'
1104
' the working tree, --no-strict disables the check.'),
1106
takes_args = ['location?']
1107
encoding_type = 'replace'
1109
def run(self, location=None, remember=False, overwrite=False,
1110
create_prefix=False, verbose=False, revision=None,
1111
use_existing_dir=False, directory=None, stacked_on=None,
1112
stacked=False, strict=None):
1113
from bzrlib.push import _show_push_branch
1115
if directory is None:
1117
# Get the source branch
1119
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1121
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1122
if strict is None: strict = True # default value
1123
# Get the tip's revision_id
1124
revision = _get_one_revision('push', revision)
1125
if revision is not None:
1126
revision_id = revision.in_history(br_from).rev_id
1129
if strict and tree is not None and revision_id is None:
1130
if (tree.has_changes()):
1131
raise errors.UncommittedChanges(
1132
tree, more='Use --no-strict to force the push.')
1133
if tree.last_revision() != tree.branch.last_revision():
1134
# The tree has lost sync with its branch, there is little
1135
# chance that the user is aware of it but he can still force
1136
# the push with --no-strict
1137
raise errors.OutOfDateTree(
1138
tree, more='Use --no-strict to force the push.')
1140
# Get the stacked_on branch, if any
1141
if stacked_on is not None:
1142
stacked_on = urlutils.normalize_url(stacked_on)
1144
parent_url = br_from.get_parent()
1146
parent = Branch.open(parent_url)
1147
stacked_on = parent.get_public_branch()
1149
# I considered excluding non-http url's here, thus forcing
1150
# 'public' branches only, but that only works for some
1151
# users, so it's best to just depend on the user spotting an
1152
# error by the feedback given to them. RBC 20080227.
1153
stacked_on = parent_url
1155
raise errors.BzrCommandError(
1156
"Could not determine branch to refer to.")
1158
# Get the destination location
1159
if location is None:
1160
stored_loc = br_from.get_push_location()
1161
if stored_loc is None:
1162
raise errors.BzrCommandError(
1163
"No push location known or specified.")
1165
display_url = urlutils.unescape_for_display(stored_loc,
1167
self.outf.write("Using saved push location: %s\n" % display_url)
1168
location = stored_loc
1170
_show_push_branch(br_from, revision_id, location, self.outf,
1171
verbose=verbose, overwrite=overwrite, remember=remember,
1172
stacked_on=stacked_on, create_prefix=create_prefix,
1173
use_existing_dir=use_existing_dir)
1176
class cmd_branch(Command):
1177
"""Create a new branch that is a copy of an existing branch.
1179
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1180
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1181
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1182
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1183
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1186
To retrieve the branch as of a particular revision, supply the --revision
1187
parameter, as in "branch foo/bar -r 5".
1190
_see_also = ['checkout']
1191
takes_args = ['from_location', 'to_location?']
1192
takes_options = ['revision', Option('hardlink',
1193
help='Hard-link working tree files where possible.'),
1195
help="Create a branch without a working-tree."),
1197
help="Switch the checkout in the current directory "
1198
"to the new branch."),
1200
help='Create a stacked branch referring to the source branch. '
1201
'The new branch will depend on the availability of the source '
1202
'branch for all operations.'),
1203
Option('standalone',
1204
help='Do not use a shared repository, even if available.'),
1205
Option('use-existing-dir',
1206
help='By default branch will fail if the target'
1207
' directory exists, but does not already'
1208
' have a control directory. This flag will'
1209
' allow branch to proceed.'),
1211
help="Bind new branch to from location."),
1213
aliases = ['get', 'clone']
1215
def run(self, from_location, to_location=None, revision=None,
1216
hardlink=False, stacked=False, standalone=False, no_tree=False,
1217
use_existing_dir=False, switch=False, bind=False):
1218
from bzrlib import switch as _mod_switch
1219
from bzrlib.tag import _merge_tags_if_possible
1220
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1222
revision = _get_one_revision('branch', revision)
1224
self.add_cleanup(br_from.unlock)
1225
if revision is not None:
1226
revision_id = revision.as_revision_id(br_from)
1228
# FIXME - wt.last_revision, fallback to branch, fall back to
1229
# None or perhaps NULL_REVISION to mean copy nothing
1231
revision_id = br_from.last_revision()
1232
if to_location is None:
1233
to_location = urlutils.derive_to_location(from_location)
1234
to_transport = transport.get_transport(to_location)
1236
to_transport.mkdir('.')
1237
except errors.FileExists:
1238
if not use_existing_dir:
1239
raise errors.BzrCommandError('Target directory "%s" '
1240
'already exists.' % to_location)
1243
bzrdir.BzrDir.open_from_transport(to_transport)
1244
except errors.NotBranchError:
1247
raise errors.AlreadyBranchError(to_location)
1248
except errors.NoSuchFile:
1249
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1252
# preserve whatever source format we have.
1253
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1254
possible_transports=[to_transport],
1255
accelerator_tree=accelerator_tree,
1256
hardlink=hardlink, stacked=stacked,
1257
force_new_repo=standalone,
1258
create_tree_if_local=not no_tree,
1259
source_branch=br_from)
1260
branch = dir.open_branch()
1261
except errors.NoSuchRevision:
1262
to_transport.delete_tree('.')
1263
msg = "The branch %s has no revision %s." % (from_location,
1265
raise errors.BzrCommandError(msg)
1266
_merge_tags_if_possible(br_from, branch)
1267
# If the source branch is stacked, the new branch may
1268
# be stacked whether we asked for that explicitly or not.
1269
# We therefore need a try/except here and not just 'if stacked:'
1271
note('Created new stacked branch referring to %s.' %
1272
branch.get_stacked_on_url())
1273
except (errors.NotStacked, errors.UnstackableBranchFormat,
1274
errors.UnstackableRepositoryFormat), e:
1275
note('Branched %d revision(s).' % branch.revno())
1277
# Bind to the parent
1278
parent_branch = Branch.open(from_location)
1279
branch.bind(parent_branch)
1280
note('New branch bound to %s' % from_location)
1282
# Switch to the new branch
1283
wt, _ = WorkingTree.open_containing('.')
1284
_mod_switch.switch(wt.bzrdir, branch)
1285
note('Switched to branch: %s',
1286
urlutils.unescape_for_display(branch.base, 'utf-8'))
1289
class cmd_checkout(Command):
1290
"""Create a new checkout of an existing branch.
1292
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1293
the branch found in '.'. This is useful if you have removed the working tree
1294
or if it was never created - i.e. if you pushed the branch to its current
1295
location using SFTP.
1297
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1298
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1299
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1300
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1301
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1304
To retrieve the branch as of a particular revision, supply the --revision
1305
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1306
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1310
_see_also = ['checkouts', 'branch']
1311
takes_args = ['branch_location?', 'to_location?']
1312
takes_options = ['revision',
1313
Option('lightweight',
1314
help="Perform a lightweight checkout. Lightweight "
1315
"checkouts depend on access to the branch for "
1316
"every operation. Normal checkouts can perform "
1317
"common operations like diff and status without "
1318
"such access, and also support local commits."
1320
Option('files-from', type=str,
1321
help="Get file contents from this tree."),
1323
help='Hard-link working tree files where possible.'
1328
def run(self, branch_location=None, to_location=None, revision=None,
1329
lightweight=False, files_from=None, hardlink=False):
1330
if branch_location is None:
1331
branch_location = osutils.getcwd()
1332
to_location = branch_location
1333
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1335
revision = _get_one_revision('checkout', revision)
1336
if files_from is not None:
1337
accelerator_tree = WorkingTree.open(files_from)
1338
if revision is not None:
1339
revision_id = revision.as_revision_id(source)
1342
if to_location is None:
1343
to_location = urlutils.derive_to_location(branch_location)
1344
# if the source and to_location are the same,
1345
# and there is no working tree,
1346
# then reconstitute a branch
1347
if (osutils.abspath(to_location) ==
1348
osutils.abspath(branch_location)):
1350
source.bzrdir.open_workingtree()
1351
except errors.NoWorkingTree:
1352
source.bzrdir.create_workingtree(revision_id)
1354
source.create_checkout(to_location, revision_id, lightweight,
1355
accelerator_tree, hardlink)
1358
class cmd_renames(Command):
1359
"""Show list of renamed files.
1361
# TODO: Option to show renames between two historical versions.
1363
# TODO: Only show renames under dir, rather than in the whole branch.
1364
_see_also = ['status']
1365
takes_args = ['dir?']
1368
def run(self, dir=u'.'):
1369
tree = WorkingTree.open_containing(dir)[0]
1371
self.add_cleanup(tree.unlock)
1372
new_inv = tree.inventory
1373
old_tree = tree.basis_tree()
1374
old_tree.lock_read()
1375
self.add_cleanup(old_tree.unlock)
1376
old_inv = old_tree.inventory
1378
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1379
for f, paths, c, v, p, n, k, e in iterator:
1380
if paths[0] == paths[1]:
1384
renames.append(paths)
1386
for old_name, new_name in renames:
1387
self.outf.write("%s => %s\n" % (old_name, new_name))
1390
class cmd_update(Command):
1391
"""Update a tree to have the latest code committed to its branch.
1393
This will perform a merge into the working tree, and may generate
1394
conflicts. If you have any local changes, you will still
1395
need to commit them after the update for the update to be complete.
1397
If you want to discard your local changes, you can just do a
1398
'bzr revert' instead of 'bzr commit' after the update.
1400
If the tree's branch is bound to a master branch, it will also update
1401
the branch from the master.
1404
_see_also = ['pull', 'working-trees', 'status-flags']
1405
takes_args = ['dir?']
1406
takes_options = ['revision']
1409
def run(self, dir='.', revision=None):
1410
if revision is not None and len(revision) != 1:
1411
raise errors.BzrCommandError(
1412
"bzr update --revision takes exactly one revision")
1413
tree = WorkingTree.open_containing(dir)[0]
1414
branch = tree.branch
1415
possible_transports = []
1416
master = branch.get_master_branch(
1417
possible_transports=possible_transports)
1418
if master is not None:
1420
branch_location = master.base
1422
tree.lock_tree_write()
1423
branch_location = tree.branch.base
1424
self.add_cleanup(tree.unlock)
1425
# get rid of the final '/' and be ready for display
1426
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1428
existing_pending_merges = tree.get_parent_ids()[1:]
1432
# may need to fetch data into a heavyweight checkout
1433
# XXX: this may take some time, maybe we should display a
1435
old_tip = branch.update(possible_transports)
1436
if revision is not None:
1437
revision_id = revision[0].as_revision_id(branch)
1439
revision_id = branch.last_revision()
1440
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
revno = branch.revision_id_to_revno(revision_id)
1442
note("Tree is up to date at revision %d of branch %s" %
1443
(revno, branch_location))
1445
view_info = _get_view_info_for_change_reporter(tree)
1446
change_reporter = delta._ChangeReporter(
1447
unversioned_filter=tree.is_ignored,
1448
view_info=view_info)
1450
conflicts = tree.update(
1452
possible_transports=possible_transports,
1453
revision=revision_id,
1455
except errors.NoSuchRevision, e:
1456
raise errors.BzrCommandError(
1457
"branch has no revision %s\n"
1458
"bzr update --revision only works"
1459
" for a revision in the branch history"
1461
revno = tree.branch.revision_id_to_revno(
1462
_mod_revision.ensure_null(tree.last_revision()))
1463
note('Updated to revision %d of branch %s' %
1464
(revno, branch_location))
1465
if tree.get_parent_ids()[1:] != existing_pending_merges:
1466
note('Your local commits will now show as pending merges with '
1467
"'bzr status', and can be committed with 'bzr commit'.")
1474
class cmd_info(Command):
1475
"""Show information about a working tree, branch or repository.
1477
This command will show all known locations and formats associated to the
1478
tree, branch or repository.
1480
In verbose mode, statistical information is included with each report.
1481
To see extended statistic information, use a verbosity level of 2 or
1482
higher by specifying the verbose option multiple times, e.g. -vv.
1484
Branches and working trees will also report any missing revisions.
1488
Display information on the format and related locations:
1492
Display the above together with extended format information and
1493
basic statistics (like the number of files in the working tree and
1494
number of revisions in the branch and repository):
1498
Display the above together with number of committers to the branch:
1502
_see_also = ['revno', 'working-trees', 'repositories']
1503
takes_args = ['location?']
1504
takes_options = ['verbose']
1505
encoding_type = 'replace'
1508
def run(self, location=None, verbose=False):
1510
noise_level = get_verbosity_level()
1513
from bzrlib.info import show_bzrdir_info
1514
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1515
verbose=noise_level, outfile=self.outf)
1518
class cmd_remove(Command):
1519
"""Remove files or directories.
1521
This makes bzr stop tracking changes to the specified files. bzr will delete
1522
them if they can easily be recovered using revert. If no options or
1523
parameters are given bzr will scan for files that are being tracked by bzr
1524
but missing in your tree and stop tracking them for you.
1526
takes_args = ['file*']
1527
takes_options = ['verbose',
1528
Option('new', help='Only remove files that have never been committed.'),
1529
RegistryOption.from_kwargs('file-deletion-strategy',
1530
'The file deletion mode to be used.',
1531
title='Deletion Strategy', value_switches=True, enum_switch=False,
1532
safe='Only delete files if they can be'
1533
' safely recovered (default).',
1534
keep='Delete from bzr but leave the working copy.',
1535
force='Delete all the specified files, even if they can not be '
1536
'recovered and even if they are non-empty directories.')]
1537
aliases = ['rm', 'del']
1538
encoding_type = 'replace'
1540
def run(self, file_list, verbose=False, new=False,
1541
file_deletion_strategy='safe'):
1542
tree, file_list = tree_files(file_list)
1544
if file_list is not None:
1545
file_list = [f for f in file_list]
1548
self.add_cleanup(tree.unlock)
1549
# Heuristics should probably all move into tree.remove_smart or
1552
added = tree.changes_from(tree.basis_tree(),
1553
specific_files=file_list).added
1554
file_list = sorted([f[0] for f in added], reverse=True)
1555
if len(file_list) == 0:
1556
raise errors.BzrCommandError('No matching files.')
1557
elif file_list is None:
1558
# missing files show up in iter_changes(basis) as
1559
# versioned-with-no-kind.
1561
for change in tree.iter_changes(tree.basis_tree()):
1562
# Find paths in the working tree that have no kind:
1563
if change[1][1] is not None and change[6][1] is None:
1564
missing.append(change[1][1])
1565
file_list = sorted(missing, reverse=True)
1566
file_deletion_strategy = 'keep'
1567
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1568
keep_files=file_deletion_strategy=='keep',
1569
force=file_deletion_strategy=='force')
1572
class cmd_file_id(Command):
1573
"""Print file_id of a particular file or directory.
1575
The file_id is assigned when the file is first added and remains the
1576
same through all revisions where the file exists, even when it is
1581
_see_also = ['inventory', 'ls']
1582
takes_args = ['filename']
1585
def run(self, filename):
1586
tree, relpath = WorkingTree.open_containing(filename)
1587
i = tree.path2id(relpath)
1589
raise errors.NotVersionedError(filename)
1591
self.outf.write(i + '\n')
1594
class cmd_file_path(Command):
1595
"""Print path of file_ids to a file or directory.
1597
This prints one line for each directory down to the target,
1598
starting at the branch root.
1602
takes_args = ['filename']
1605
def run(self, filename):
1606
tree, relpath = WorkingTree.open_containing(filename)
1607
fid = tree.path2id(relpath)
1609
raise errors.NotVersionedError(filename)
1610
segments = osutils.splitpath(relpath)
1611
for pos in range(1, len(segments) + 1):
1612
path = osutils.joinpath(segments[:pos])
1613
self.outf.write("%s\n" % tree.path2id(path))
1616
class cmd_reconcile(Command):
1617
"""Reconcile bzr metadata in a branch.
1619
This can correct data mismatches that may have been caused by
1620
previous ghost operations or bzr upgrades. You should only
1621
need to run this command if 'bzr check' or a bzr developer
1622
advises you to run it.
1624
If a second branch is provided, cross-branch reconciliation is
1625
also attempted, which will check that data like the tree root
1626
id which was not present in very early bzr versions is represented
1627
correctly in both branches.
1629
At the same time it is run it may recompress data resulting in
1630
a potential saving in disk space or performance gain.
1632
The branch *MUST* be on a listable system such as local disk or sftp.
1635
_see_also = ['check']
1636
takes_args = ['branch?']
1638
def run(self, branch="."):
1639
from bzrlib.reconcile import reconcile
1640
dir = bzrdir.BzrDir.open(branch)
1644
class cmd_revision_history(Command):
1645
"""Display the list of revision ids on a branch."""
1648
takes_args = ['location?']
1653
def run(self, location="."):
1654
branch = Branch.open_containing(location)[0]
1655
for revid in branch.revision_history():
1656
self.outf.write(revid)
1657
self.outf.write('\n')
1660
class cmd_ancestry(Command):
1661
"""List all revisions merged into this branch."""
1663
_see_also = ['log', 'revision-history']
1664
takes_args = ['location?']
1669
def run(self, location="."):
1671
wt = WorkingTree.open_containing(location)[0]
1672
except errors.NoWorkingTree:
1673
b = Branch.open(location)
1674
last_revision = b.last_revision()
1677
last_revision = wt.last_revision()
1679
revision_ids = b.repository.get_ancestry(last_revision)
1681
for revision_id in revision_ids:
1682
self.outf.write(revision_id + '\n')
1685
class cmd_init(Command):
1686
"""Make a directory into a versioned branch.
1688
Use this to create an empty branch, or before importing an
1691
If there is a repository in a parent directory of the location, then
1692
the history of the branch will be stored in the repository. Otherwise
1693
init creates a standalone branch which carries its own history
1694
in the .bzr directory.
1696
If there is already a branch at the location but it has no working tree,
1697
the tree can be populated with 'bzr checkout'.
1699
Recipe for importing a tree of files::
1705
bzr commit -m "imported project"
1708
_see_also = ['init-repository', 'branch', 'checkout']
1709
takes_args = ['location?']
1711
Option('create-prefix',
1712
help='Create the path leading up to the branch '
1713
'if it does not already exist.'),
1714
RegistryOption('format',
1715
help='Specify a format for this branch. '
1716
'See "help formats".',
1717
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1718
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1719
value_switches=True,
1720
title="Branch format",
1722
Option('append-revisions-only',
1723
help='Never change revnos or the existing log.'
1724
' Append revisions to it only.')
1726
def run(self, location=None, format=None, append_revisions_only=False,
1727
create_prefix=False):
1729
format = bzrdir.format_registry.make_bzrdir('default')
1730
if location is None:
1733
to_transport = transport.get_transport(location)
1735
# The path has to exist to initialize a
1736
# branch inside of it.
1737
# Just using os.mkdir, since I don't
1738
# believe that we want to create a bunch of
1739
# locations if the user supplies an extended path
1741
to_transport.ensure_base()
1742
except errors.NoSuchFile:
1743
if not create_prefix:
1744
raise errors.BzrCommandError("Parent directory of %s"
1746
"\nYou may supply --create-prefix to create all"
1747
" leading parent directories."
1749
to_transport.create_prefix()
1752
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1753
except errors.NotBranchError:
1754
# really a NotBzrDir error...
1755
create_branch = bzrdir.BzrDir.create_branch_convenience
1756
branch = create_branch(to_transport.base, format=format,
1757
possible_transports=[to_transport])
1758
a_bzrdir = branch.bzrdir
1760
from bzrlib.transport.local import LocalTransport
1761
if a_bzrdir.has_branch():
1762
if (isinstance(to_transport, LocalTransport)
1763
and not a_bzrdir.has_workingtree()):
1764
raise errors.BranchExistsWithoutWorkingTree(location)
1765
raise errors.AlreadyBranchError(location)
1766
branch = a_bzrdir.create_branch()
1767
a_bzrdir.create_workingtree()
1768
if append_revisions_only:
1770
branch.set_append_revisions_only(True)
1771
except errors.UpgradeRequired:
1772
raise errors.BzrCommandError('This branch format cannot be set'
1773
' to append-revisions-only. Try --default.')
1775
from bzrlib.info import describe_layout, describe_format
1777
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1778
except (errors.NoWorkingTree, errors.NotLocalUrl):
1780
repository = branch.repository
1781
layout = describe_layout(repository, branch, tree).lower()
1782
format = describe_format(a_bzrdir, repository, branch, tree)
1783
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1784
if repository.is_shared():
1785
#XXX: maybe this can be refactored into transport.path_or_url()
1786
url = repository.bzrdir.root_transport.external_url()
1788
url = urlutils.local_path_from_url(url)
1789
except errors.InvalidURL:
1791
self.outf.write("Using shared repository: %s\n" % url)
1794
class cmd_init_repository(Command):
1795
"""Create a shared repository for branches to share storage space.
1797
New branches created under the repository directory will store their
1798
revisions in the repository, not in the branch directory. For branches
1799
with shared history, this reduces the amount of storage needed and
1800
speeds up the creation of new branches.
1802
If the --no-trees option is given then the branches in the repository
1803
will not have working trees by default. They will still exist as
1804
directories on disk, but they will not have separate copies of the
1805
files at a certain revision. This can be useful for repositories that
1806
store branches which are interacted with through checkouts or remote
1807
branches, such as on a server.
1810
Create a shared repository holding just branches::
1812
bzr init-repo --no-trees repo
1815
Make a lightweight checkout elsewhere::
1817
bzr checkout --lightweight repo/trunk trunk-checkout
1822
_see_also = ['init', 'branch', 'checkout', 'repositories']
1823
takes_args = ["location"]
1824
takes_options = [RegistryOption('format',
1825
help='Specify a format for this repository. See'
1826
' "bzr help formats" for details.',
1827
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1828
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1829
value_switches=True, title='Repository format'),
1831
help='Branches in the repository will default to'
1832
' not having a working tree.'),
1834
aliases = ["init-repo"]
1836
def run(self, location, format=None, no_trees=False):
1838
format = bzrdir.format_registry.make_bzrdir('default')
1840
if location is None:
1843
to_transport = transport.get_transport(location)
1844
to_transport.ensure_base()
1846
newdir = format.initialize_on_transport(to_transport)
1847
repo = newdir.create_repository(shared=True)
1848
repo.set_make_working_trees(not no_trees)
1850
from bzrlib.info import show_bzrdir_info
1851
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1854
class cmd_diff(Command):
1855
"""Show differences in the working tree, between revisions or branches.
1857
If no arguments are given, all changes for the current tree are listed.
1858
If files are given, only the changes in those files are listed.
1859
Remote and multiple branches can be compared by using the --old and
1860
--new options. If not provided, the default for both is derived from
1861
the first argument, if any, or the current tree if no arguments are
1864
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1865
produces patches suitable for "patch -p1".
1869
2 - unrepresentable changes
1874
Shows the difference in the working tree versus the last commit::
1878
Difference between the working tree and revision 1::
1882
Difference between revision 3 and revision 1::
1886
Difference between revision 3 and revision 1 for branch xxx::
1890
To see the changes introduced in revision X::
1894
Note that in the case of a merge, the -c option shows the changes
1895
compared to the left hand parent. To see the changes against
1896
another parent, use::
1898
bzr diff -r<chosen_parent>..X
1900
The changes introduced by revision 2 (equivalent to -r1..2)::
1904
Show just the differences for file NEWS::
1908
Show the differences in working tree xxx for file NEWS::
1912
Show the differences from branch xxx to this working tree:
1916
Show the differences between two branches for file NEWS::
1918
bzr diff --old xxx --new yyy NEWS
1920
Same as 'bzr diff' but prefix paths with old/ and new/::
1922
bzr diff --prefix old/:new/
1924
_see_also = ['status']
1925
takes_args = ['file*']
1927
Option('diff-options', type=str,
1928
help='Pass these options to the external diff program.'),
1929
Option('prefix', type=str,
1931
help='Set prefixes added to old and new filenames, as '
1932
'two values separated by a colon. (eg "old/:new/").'),
1934
help='Branch/tree to compare from.',
1938
help='Branch/tree to compare to.',
1944
help='Use this command to compare files.',
1948
aliases = ['di', 'dif']
1949
encoding_type = 'exact'
1952
def run(self, revision=None, file_list=None, diff_options=None,
1953
prefix=None, old=None, new=None, using=None):
1954
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1956
if (prefix is None) or (prefix == '0'):
1964
old_label, new_label = prefix.split(":")
1966
raise errors.BzrCommandError(
1967
'--prefix expects two values separated by a colon'
1968
' (eg "old/:new/")')
1970
if revision and len(revision) > 2:
1971
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1972
' one or two revision specifiers')
1974
(old_tree, new_tree,
1975
old_branch, new_branch,
1976
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1977
file_list, revision, old, new, apply_view=True)
1978
return show_diff_trees(old_tree, new_tree, sys.stdout,
1979
specific_files=specific_files,
1980
external_diff_options=diff_options,
1981
old_label=old_label, new_label=new_label,
1982
extra_trees=extra_trees, using=using)
1985
class cmd_deleted(Command):
1986
"""List files deleted in the working tree.
1988
# TODO: Show files deleted since a previous revision, or
1989
# between two revisions.
1990
# TODO: Much more efficient way to do this: read in new
1991
# directories with readdir, rather than stating each one. Same
1992
# level of effort but possibly much less IO. (Or possibly not,
1993
# if the directories are very large...)
1994
_see_also = ['status', 'ls']
1995
takes_options = ['show-ids']
1998
def run(self, show_ids=False):
1999
tree = WorkingTree.open_containing(u'.')[0]
2001
self.add_cleanup(tree.unlock)
2002
old = tree.basis_tree()
2004
self.add_cleanup(old.unlock)
2005
for path, ie in old.inventory.iter_entries():
2006
if not tree.has_id(ie.file_id):
2007
self.outf.write(path)
2009
self.outf.write(' ')
2010
self.outf.write(ie.file_id)
2011
self.outf.write('\n')
2014
class cmd_modified(Command):
2015
"""List files modified in working tree.
2019
_see_also = ['status', 'ls']
2022
help='Write an ascii NUL (\\0) separator '
2023
'between files rather than a newline.')
2027
def run(self, null=False):
2028
tree = WorkingTree.open_containing(u'.')[0]
2029
td = tree.changes_from(tree.basis_tree())
2030
for path, id, kind, text_modified, meta_modified in td.modified:
2032
self.outf.write(path + '\0')
2034
self.outf.write(osutils.quotefn(path) + '\n')
2037
class cmd_added(Command):
2038
"""List files added in working tree.
2042
_see_also = ['status', 'ls']
2045
help='Write an ascii NUL (\\0) separator '
2046
'between files rather than a newline.')
2050
def run(self, null=False):
2051
wt = WorkingTree.open_containing(u'.')[0]
2053
self.add_cleanup(wt.unlock)
2054
basis = wt.basis_tree()
2056
self.add_cleanup(basis.unlock)
2057
basis_inv = basis.inventory
2060
if file_id in basis_inv:
2062
if inv.is_root(file_id) and len(basis_inv) == 0:
2064
path = inv.id2path(file_id)
2065
if not os.access(osutils.abspath(path), os.F_OK):
2068
self.outf.write(path + '\0')
2070
self.outf.write(osutils.quotefn(path) + '\n')
2073
class cmd_root(Command):
2074
"""Show the tree root directory.
2076
The root is the nearest enclosing directory with a .bzr control
2079
takes_args = ['filename?']
2081
def run(self, filename=None):
2082
"""Print the branch root."""
2083
tree = WorkingTree.open_containing(filename)[0]
2084
self.outf.write(tree.basedir + '\n')
2087
def _parse_limit(limitstring):
2089
return int(limitstring)
2091
msg = "The limit argument must be an integer."
2092
raise errors.BzrCommandError(msg)
2095
def _parse_levels(s):
2099
msg = "The levels argument must be an integer."
2100
raise errors.BzrCommandError(msg)
2103
class cmd_log(Command):
2104
"""Show historical log for a branch or subset of a branch.
2106
log is bzr's default tool for exploring the history of a branch.
2107
The branch to use is taken from the first parameter. If no parameters
2108
are given, the branch containing the working directory is logged.
2109
Here are some simple examples::
2111
bzr log log the current branch
2112
bzr log foo.py log a file in its branch
2113
bzr log http://server/branch log a branch on a server
2115
The filtering, ordering and information shown for each revision can
2116
be controlled as explained below. By default, all revisions are
2117
shown sorted (topologically) so that newer revisions appear before
2118
older ones and descendants always appear before ancestors. If displayed,
2119
merged revisions are shown indented under the revision in which they
2124
The log format controls how information about each revision is
2125
displayed. The standard log formats are called ``long``, ``short``
2126
and ``line``. The default is long. See ``bzr help log-formats``
2127
for more details on log formats.
2129
The following options can be used to control what information is
2132
-l N display a maximum of N revisions
2133
-n N display N levels of revisions (0 for all, 1 for collapsed)
2134
-v display a status summary (delta) for each revision
2135
-p display a diff (patch) for each revision
2136
--show-ids display revision-ids (and file-ids), not just revnos
2138
Note that the default number of levels to display is a function of the
2139
log format. If the -n option is not used, the standard log formats show
2140
just the top level (mainline).
2142
Status summaries are shown using status flags like A, M, etc. To see
2143
the changes explained using words like ``added`` and ``modified``
2144
instead, use the -vv option.
2148
To display revisions from oldest to newest, use the --forward option.
2149
In most cases, using this option will have little impact on the total
2150
time taken to produce a log, though --forward does not incrementally
2151
display revisions like --reverse does when it can.
2153
:Revision filtering:
2155
The -r option can be used to specify what revision or range of revisions
2156
to filter against. The various forms are shown below::
2158
-rX display revision X
2159
-rX.. display revision X and later
2160
-r..Y display up to and including revision Y
2161
-rX..Y display from X to Y inclusive
2163
See ``bzr help revisionspec`` for details on how to specify X and Y.
2164
Some common examples are given below::
2166
-r-1 show just the tip
2167
-r-10.. show the last 10 mainline revisions
2168
-rsubmit:.. show what's new on this branch
2169
-rancestor:path.. show changes since the common ancestor of this
2170
branch and the one at location path
2171
-rdate:yesterday.. show changes since yesterday
2173
When logging a range of revisions using -rX..Y, log starts at
2174
revision Y and searches back in history through the primary
2175
("left-hand") parents until it finds X. When logging just the
2176
top level (using -n1), an error is reported if X is not found
2177
along the way. If multi-level logging is used (-n0), X may be
2178
a nested merge revision and the log will be truncated accordingly.
2182
If parameters are given and the first one is not a branch, the log
2183
will be filtered to show only those revisions that changed the
2184
nominated files or directories.
2186
Filenames are interpreted within their historical context. To log a
2187
deleted file, specify a revision range so that the file existed at
2188
the end or start of the range.
2190
Historical context is also important when interpreting pathnames of
2191
renamed files/directories. Consider the following example:
2193
* revision 1: add tutorial.txt
2194
* revision 2: modify tutorial.txt
2195
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2199
* ``bzr log guide.txt`` will log the file added in revision 1
2201
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2203
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2204
the original file in revision 2.
2206
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2207
was no file called guide.txt in revision 2.
2209
Renames are always followed by log. By design, there is no need to
2210
explicitly ask for this (and no way to stop logging a file back
2211
until it was last renamed).
2215
The --message option can be used for finding revisions that match a
2216
regular expression in a commit message.
2220
GUI tools and IDEs are often better at exploring history than command
2221
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2222
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2223
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2224
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2226
You may find it useful to add the aliases below to ``bazaar.conf``::
2230
top = log -l10 --line
2233
``bzr tip`` will then show the latest revision while ``bzr top``
2234
will show the last 10 mainline revisions. To see the details of a
2235
particular revision X, ``bzr show -rX``.
2237
If you are interested in looking deeper into a particular merge X,
2238
use ``bzr log -n0 -rX``.
2240
``bzr log -v`` on a branch with lots of history is currently
2241
very slow. A fix for this issue is currently under development.
2242
With or without that fix, it is recommended that a revision range
2243
be given when using the -v option.
2245
bzr has a generic full-text matching plugin, bzr-search, that can be
2246
used to find revisions matching user names, commit messages, etc.
2247
Among other features, this plugin can find all revisions containing
2248
a list of words but not others.
2250
When exploring non-mainline history on large projects with deep
2251
history, the performance of log can be greatly improved by installing
2252
the historycache plugin. This plugin buffers historical information
2253
trading disk space for faster speed.
2255
takes_args = ['file*']
2256
_see_also = ['log-formats', 'revisionspec']
2259
help='Show from oldest to newest.'),
2261
custom_help('verbose',
2262
help='Show files changed in each revision.'),
2266
type=bzrlib.option._parse_revision_str,
2268
help='Show just the specified revision.'
2269
' See also "help revisionspec".'),
2273
help='Number of levels to display - 0 for all, 1 for flat.',
2275
type=_parse_levels),
2278
help='Show revisions whose message matches this '
2279
'regular expression.',
2283
help='Limit the output to the first N revisions.',
2288
help='Show changes made in each revision as a patch.'),
2289
Option('include-merges',
2290
help='Show merged revisions like --levels 0 does.'),
2292
encoding_type = 'replace'
2295
def run(self, file_list=None, timezone='original',
2306
include_merges=False):
2307
from bzrlib.log import (
2309
make_log_request_dict,
2310
_get_info_for_log_files,
2312
direction = (forward and 'forward') or 'reverse'
2317
raise errors.BzrCommandError(
2318
'--levels and --include-merges are mutually exclusive')
2320
if change is not None:
2322
raise errors.RangeInChangeOption()
2323
if revision is not None:
2324
raise errors.BzrCommandError(
2325
'--revision and --change are mutually exclusive')
2330
filter_by_dir = False
2332
# find the file ids to log and check for directory filtering
2333
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2334
revision, file_list)
2335
self.add_cleanup(b.unlock)
2336
for relpath, file_id, kind in file_info_list:
2338
raise errors.BzrCommandError(
2339
"Path unknown at end or start of revision range: %s" %
2341
# If the relpath is the top of the tree, we log everything
2346
file_ids.append(file_id)
2347
filter_by_dir = filter_by_dir or (
2348
kind in ['directory', 'tree-reference'])
2351
# FIXME ? log the current subdir only RBC 20060203
2352
if revision is not None \
2353
and len(revision) > 0 and revision[0].get_branch():
2354
location = revision[0].get_branch()
2357
dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
b = dir.open_branch()
2360
self.add_cleanup(b.unlock)
2361
rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
# Decide on the type of delta & diff filtering to use
2364
# TODO: add an --all-files option to make this configurable & consistent
2372
diff_type = 'partial'
2376
# Build the log formatter
2377
if log_format is None:
2378
log_format = log.log_formatter_registry.get_default(b)
2379
# Make a non-encoding output to include the diffs - bug 328007
2380
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2381
lf = log_format(show_ids=show_ids, to_file=self.outf,
2382
to_exact_file=unencoded_output,
2383
show_timezone=timezone,
2384
delta_format=get_verbosity_level(),
2386
show_advice=levels is None)
2388
# Choose the algorithm for doing the logging. It's annoying
2389
# having multiple code paths like this but necessary until
2390
# the underlying repository format is faster at generating
2391
# deltas or can provide everything we need from the indices.
2392
# The default algorithm - match-using-deltas - works for
2393
# multiple files and directories and is faster for small
2394
# amounts of history (200 revisions say). However, it's too
2395
# slow for logging a single file in a repository with deep
2396
# history, i.e. > 10K revisions. In the spirit of "do no
2397
# evil when adding features", we continue to use the
2398
# original algorithm - per-file-graph - for the "single
2399
# file that isn't a directory without showing a delta" case.
2400
partial_history = revision and b.repository._format.supports_chks
2401
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2402
or delta_type or partial_history)
2404
# Build the LogRequest and execute it
2405
if len(file_ids) == 0:
2407
rqst = make_log_request_dict(
2408
direction=direction, specific_fileids=file_ids,
2409
start_revision=rev1, end_revision=rev2, limit=limit,
2410
message_search=message, delta_type=delta_type,
2411
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2412
Logger(b, rqst).show(lf)
2415
def _get_revision_range(revisionspec_list, branch, command_name):
2416
"""Take the input of a revision option and turn it into a revision range.
2418
It returns RevisionInfo objects which can be used to obtain the rev_id's
2419
of the desired revisions. It does some user input validations.
2421
if revisionspec_list is None:
2424
elif len(revisionspec_list) == 1:
2425
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2426
elif len(revisionspec_list) == 2:
2427
start_spec = revisionspec_list[0]
2428
end_spec = revisionspec_list[1]
2429
if end_spec.get_branch() != start_spec.get_branch():
2430
# b is taken from revision[0].get_branch(), and
2431
# show_log will use its revision_history. Having
2432
# different branches will lead to weird behaviors.
2433
raise errors.BzrCommandError(
2434
"bzr %s doesn't accept two revisions in different"
2435
" branches." % command_name)
2436
rev1 = start_spec.in_history(branch)
2437
# Avoid loading all of history when we know a missing
2438
# end of range means the last revision ...
2439
if end_spec.spec is None:
2440
last_revno, last_revision_id = branch.last_revision_info()
2441
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2443
rev2 = end_spec.in_history(branch)
2445
raise errors.BzrCommandError(
2446
'bzr %s --revision takes one or two values.' % command_name)
2450
def _revision_range_to_revid_range(revision_range):
2453
if revision_range[0] is not None:
2454
rev_id1 = revision_range[0].rev_id
2455
if revision_range[1] is not None:
2456
rev_id2 = revision_range[1].rev_id
2457
return rev_id1, rev_id2
2459
def get_log_format(long=False, short=False, line=False, default='long'):
2460
log_format = default
2464
log_format = 'short'
2470
class cmd_touching_revisions(Command):
2471
"""Return revision-ids which affected a particular file.
2473
A more user-friendly interface is "bzr log FILE".
2477
takes_args = ["filename"]
2480
def run(self, filename):
2481
tree, relpath = WorkingTree.open_containing(filename)
2482
file_id = tree.path2id(relpath)
2485
self.add_cleanup(b.unlock)
2486
touching_revs = log.find_touching_revisions(b, file_id)
2487
for revno, revision_id, what in touching_revs:
2488
self.outf.write("%6d %s\n" % (revno, what))
2491
class cmd_ls(Command):
2492
"""List files in a tree.
2495
_see_also = ['status', 'cat']
2496
takes_args = ['path?']
2500
Option('recursive', short_name='R',
2501
help='Recurse into subdirectories.'),
2503
help='Print paths relative to the root of the branch.'),
2504
Option('unknown', help='Print unknown files.'),
2505
Option('versioned', help='Print versioned files.',
2507
Option('ignored', help='Print ignored files.'),
2509
help='Write an ascii NUL (\\0) separator '
2510
'between files rather than a newline.'),
2512
help='List entries of a particular kind: file, directory, symlink.',
2517
def run(self, revision=None, verbose=False,
2518
recursive=False, from_root=False,
2519
unknown=False, versioned=False, ignored=False,
2520
null=False, kind=None, show_ids=False, path=None):
2522
if kind and kind not in ('file', 'directory', 'symlink'):
2523
raise errors.BzrCommandError('invalid kind specified')
2525
if verbose and null:
2526
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2527
all = not (unknown or versioned or ignored)
2529
selection = {'I':ignored, '?':unknown, 'V':versioned}
2535
raise errors.BzrCommandError('cannot specify both --from-root'
2538
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2541
# Calculate the prefix to use
2545
prefix = relpath + '/'
2546
elif fs_path != '.' and not fs_path.endswith('/'):
2547
prefix = fs_path + '/'
2549
if revision is not None or tree is None:
2550
tree = _get_one_revision_tree('ls', revision, branch=branch)
2553
if isinstance(tree, WorkingTree) and tree.supports_views():
2554
view_files = tree.views.lookup_view()
2557
view_str = views.view_display_str(view_files)
2558
note("Ignoring files outside view. View is %s" % view_str)
2561
self.add_cleanup(tree.unlock)
2562
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2563
from_dir=relpath, recursive=recursive):
2564
# Apply additional masking
2565
if not all and not selection[fc]:
2567
if kind is not None and fkind != kind:
2572
fullpath = osutils.pathjoin(relpath, fp)
2575
views.check_path_in_view(tree, fullpath)
2576
except errors.FileOutsideView:
2581
fp = osutils.pathjoin(prefix, fp)
2582
kindch = entry.kind_character()
2583
outstring = fp + kindch
2584
ui.ui_factory.clear_term()
2586
outstring = '%-8s %s' % (fc, outstring)
2587
if show_ids and fid is not None:
2588
outstring = "%-50s %s" % (outstring, fid)
2589
self.outf.write(outstring + '\n')
2591
self.outf.write(fp + '\0')
2594
self.outf.write(fid)
2595
self.outf.write('\0')
2603
self.outf.write('%-50s %s\n' % (outstring, my_id))
2605
self.outf.write(outstring + '\n')
2608
class cmd_unknowns(Command):
2609
"""List unknown files.
2617
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2618
self.outf.write(osutils.quotefn(f) + '\n')
2621
class cmd_ignore(Command):
2622
"""Ignore specified files or patterns.
2624
See ``bzr help patterns`` for details on the syntax of patterns.
2626
If a .bzrignore file does not exist, the ignore command
2627
will create one and add the specified files or patterns to the newly
2628
created file. The ignore command will also automatically add the
2629
.bzrignore file to be versioned. Creating a .bzrignore file without
2630
the use of the ignore command will require an explicit add command.
2632
To remove patterns from the ignore list, edit the .bzrignore file.
2633
After adding, editing or deleting that file either indirectly by
2634
using this command or directly by using an editor, be sure to commit
2637
Patterns prefixed with '!' are exceptions to ignore patterns and take
2638
precedence over regular ignores. Such exceptions are used to specify
2639
files that should be versioned which would otherwise be ignored.
2641
Patterns prefixed with '!!' act as regular ignore patterns, but have
2642
precedence over the '!' exception patterns.
2644
Note: ignore patterns containing shell wildcards must be quoted from
2648
Ignore the top level Makefile::
2650
bzr ignore ./Makefile
2652
Ignore .class files in all directories...::
2654
bzr ignore "*.class"
2656
...but do not ignore "special.class"::
2658
bzr ignore "!special.class"
2660
Ignore .o files under the lib directory::
2662
bzr ignore "lib/**/*.o"
2664
Ignore .o files under the lib directory::
2666
bzr ignore "RE:lib/.*\.o"
2668
Ignore everything but the "debian" toplevel directory::
2670
bzr ignore "RE:(?!debian/).*"
2672
Ignore everything except the "local" toplevel directory,
2673
but always ignore "*~" autosave files, even under local/::
2676
bzr ignore "!./local"
2680
_see_also = ['status', 'ignored', 'patterns']
2681
takes_args = ['name_pattern*']
2683
Option('old-default-rules',
2684
help='Write out the ignore rules bzr < 0.9 always used.')
2687
def run(self, name_pattern_list=None, old_default_rules=None):
2688
from bzrlib import ignores
2689
if old_default_rules is not None:
2690
# dump the rules and exit
2691
for pattern in ignores.OLD_DEFAULTS:
2692
self.outf.write("%s\n" % pattern)
2694
if not name_pattern_list:
2695
raise errors.BzrCommandError("ignore requires at least one "
2696
"NAME_PATTERN or --old-default-rules")
2697
name_pattern_list = [globbing.normalize_pattern(p)
2698
for p in name_pattern_list]
2699
for name_pattern in name_pattern_list:
2700
if (name_pattern[0] == '/' or
2701
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2702
raise errors.BzrCommandError(
2703
"NAME_PATTERN should not be an absolute path")
2704
tree, relpath = WorkingTree.open_containing(u'.')
2705
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2706
ignored = globbing.Globster(name_pattern_list)
2709
for entry in tree.list_files():
2713
if ignored.match(filename):
2714
matches.append(filename)
2716
if len(matches) > 0:
2717
self.outf.write("Warning: the following files are version controlled and"
2718
" match your ignore pattern:\n%s"
2719
"\nThese files will continue to be version controlled"
2720
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2723
class cmd_ignored(Command):
2724
"""List ignored files and the patterns that matched them.
2726
List all the ignored files and the ignore pattern that caused the file to
2729
Alternatively, to list just the files::
2734
encoding_type = 'replace'
2735
_see_also = ['ignore', 'ls']
2739
tree = WorkingTree.open_containing(u'.')[0]
2741
self.add_cleanup(tree.unlock)
2742
for path, file_class, kind, file_id, entry in tree.list_files():
2743
if file_class != 'I':
2745
## XXX: Slightly inefficient since this was already calculated
2746
pat = tree.is_ignored(path)
2747
self.outf.write('%-50s %s\n' % (path, pat))
2750
class cmd_lookup_revision(Command):
2751
"""Lookup the revision-id from a revision-number
2754
bzr lookup-revision 33
2757
takes_args = ['revno']
2760
def run(self, revno):
2764
raise errors.BzrCommandError("not a valid revision-number: %r"
2766
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2767
self.outf.write("%s\n" % revid)
2770
class cmd_export(Command):
2771
"""Export current or past revision to a destination directory or archive.
2773
If no revision is specified this exports the last committed revision.
2775
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2776
given, try to find the format with the extension. If no extension
2777
is found exports to a directory (equivalent to --format=dir).
2779
If root is supplied, it will be used as the root directory inside
2780
container formats (tar, zip, etc). If it is not supplied it will default
2781
to the exported filename. The root option has no effect for 'dir' format.
2783
If branch is omitted then the branch containing the current working
2784
directory will be used.
2786
Note: Export of tree with non-ASCII filenames to zip is not supported.
2788
================= =========================
2789
Supported formats Autodetected by extension
2790
================= =========================
2793
tbz2 .tar.bz2, .tbz2
2796
================= =========================
2798
takes_args = ['dest', 'branch_or_subdir?']
2801
help="Type of file to export to.",
2804
Option('filters', help='Apply content filters to export the '
2805
'convenient form.'),
2808
help="Name of the root directory inside the exported file."),
2810
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2811
root=None, filters=False):
2812
from bzrlib.export import export
2814
if branch_or_subdir is None:
2815
tree = WorkingTree.open_containing(u'.')[0]
2819
b, subdir = Branch.open_containing(branch_or_subdir)
2822
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2824
export(rev_tree, dest, format, root, subdir, filtered=filters)
2825
except errors.NoSuchExportFormat, e:
2826
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2829
class cmd_cat(Command):
2830
"""Write the contents of a file as of a given revision to standard output.
2832
If no revision is nominated, the last revision is used.
2834
Note: Take care to redirect standard output when using this command on a
2840
Option('name-from-revision', help='The path name in the old tree.'),
2841
Option('filters', help='Apply content filters to display the '
2842
'convenience form.'),
2845
takes_args = ['filename']
2846
encoding_type = 'exact'
2849
def run(self, filename, revision=None, name_from_revision=False,
2851
if revision is not None and len(revision) != 1:
2852
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2853
" one revision specifier")
2854
tree, branch, relpath = \
2855
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2857
self.add_cleanup(branch.unlock)
2858
return self._run(tree, branch, relpath, filename, revision,
2859
name_from_revision, filters)
2861
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2864
tree = b.basis_tree()
2865
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2866
rev_tree.lock_read()
2867
self.add_cleanup(rev_tree.unlock)
2869
old_file_id = rev_tree.path2id(relpath)
2871
if name_from_revision:
2872
# Try in revision if requested
2873
if old_file_id is None:
2874
raise errors.BzrCommandError(
2875
"%r is not present in revision %s" % (
2876
filename, rev_tree.get_revision_id()))
2878
content = rev_tree.get_file_text(old_file_id)
2880
cur_file_id = tree.path2id(relpath)
2882
if cur_file_id is not None:
2883
# Then try with the actual file id
2885
content = rev_tree.get_file_text(cur_file_id)
2887
except errors.NoSuchId:
2888
# The actual file id didn't exist at that time
2890
if not found and old_file_id is not None:
2891
# Finally try with the old file id
2892
content = rev_tree.get_file_text(old_file_id)
2895
# Can't be found anywhere
2896
raise errors.BzrCommandError(
2897
"%r is not present in revision %s" % (
2898
filename, rev_tree.get_revision_id()))
2900
from bzrlib.filters import (
2901
ContentFilterContext,
2902
filtered_output_bytes,
2904
filters = rev_tree._content_filter_stack(relpath)
2905
chunks = content.splitlines(True)
2906
content = filtered_output_bytes(chunks, filters,
2907
ContentFilterContext(relpath, rev_tree))
2909
self.outf.writelines(content)
2912
self.outf.write(content)
2915
class cmd_local_time_offset(Command):
2916
"""Show the offset in seconds from GMT to local time."""
2920
self.outf.write("%s\n" % osutils.local_time_offset())
2924
class cmd_commit(Command):
2925
"""Commit changes into a new revision.
2927
An explanatory message needs to be given for each commit. This is
2928
often done by using the --message option (getting the message from the
2929
command line) or by using the --file option (getting the message from
2930
a file). If neither of these options is given, an editor is opened for
2931
the user to enter the message. To see the changed files in the
2932
boilerplate text loaded into the editor, use the --show-diff option.
2934
By default, the entire tree is committed and the person doing the
2935
commit is assumed to be the author. These defaults can be overridden
2940
If selected files are specified, only changes to those files are
2941
committed. If a directory is specified then the directory and
2942
everything within it is committed.
2944
When excludes are given, they take precedence over selected files.
2945
For example, to commit only changes within foo, but not changes
2948
bzr commit foo -x foo/bar
2950
A selective commit after a merge is not yet supported.
2954
If the author of the change is not the same person as the committer,
2955
you can specify the author's name using the --author option. The
2956
name should be in the same format as a committer-id, e.g.
2957
"John Doe <jdoe@example.com>". If there is more than one author of
2958
the change you can specify the option multiple times, once for each
2963
A common mistake is to forget to add a new file or directory before
2964
running the commit command. The --strict option checks for unknown
2965
files and aborts the commit if any are found. More advanced pre-commit
2966
checks can be implemented by defining hooks. See ``bzr help hooks``
2971
If you accidentially commit the wrong changes or make a spelling
2972
mistake in the commit message say, you can use the uncommit command
2973
to undo it. See ``bzr help uncommit`` for details.
2975
Hooks can also be configured to run after a commit. This allows you
2976
to trigger updates to external systems like bug trackers. The --fixes
2977
option can be used to record the association between a revision and
2978
one or more bugs. See ``bzr help bugs`` for details.
2980
A selective commit may fail in some cases where the committed
2981
tree would be invalid. Consider::
2986
bzr commit foo -m "committing foo"
2987
bzr mv foo/bar foo/baz
2990
bzr commit foo/bar -m "committing bar but not baz"
2992
In the example above, the last commit will fail by design. This gives
2993
the user the opportunity to decide whether they want to commit the
2994
rename at the same time, separately first, or not at all. (As a general
2995
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2997
# TODO: Run hooks on tree to-be-committed, and after commit.
2999
# TODO: Strict commit that fails if there are deleted files.
3000
# (what does "deleted files" mean ??)
3002
# TODO: Give better message for -s, --summary, used by tla people
3004
# XXX: verbose currently does nothing
3006
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3007
takes_args = ['selected*']
3009
ListOption('exclude', type=str, short_name='x',
3010
help="Do not consider changes made to a given path."),
3011
Option('message', type=unicode,
3013
help="Description of the new revision."),
3016
help='Commit even if nothing has changed.'),
3017
Option('file', type=str,
3020
help='Take commit message from this file.'),
3022
help="Refuse to commit if there are unknown "
3023
"files in the working tree."),
3024
Option('commit-time', type=str,
3025
help="Manually set a commit time using commit date "
3026
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3027
ListOption('fixes', type=str,
3028
help="Mark a bug as being fixed by this revision "
3029
"(see \"bzr help bugs\")."),
3030
ListOption('author', type=unicode,
3031
help="Set the author's name, if it's different "
3032
"from the committer."),
3034
help="Perform a local commit in a bound "
3035
"branch. Local commits are not pushed to "
3036
"the master branch until a normal commit "
3040
help='When no message is supplied, show the diff along'
3041
' with the status summary in the message editor.'),
3043
aliases = ['ci', 'checkin']
3045
def _iter_bug_fix_urls(self, fixes, branch):
3046
# Configure the properties for bug fixing attributes.
3047
for fixed_bug in fixes:
3048
tokens = fixed_bug.split(':')
3049
if len(tokens) != 2:
3050
raise errors.BzrCommandError(
3051
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3052
"See \"bzr help bugs\" for more information on this "
3053
"feature.\nCommit refused." % fixed_bug)
3054
tag, bug_id = tokens
3056
yield bugtracker.get_bug_url(tag, branch, bug_id)
3057
except errors.UnknownBugTrackerAbbreviation:
3058
raise errors.BzrCommandError(
3059
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3060
except errors.MalformedBugIdentifier, e:
3061
raise errors.BzrCommandError(
3062
"%s\nCommit refused." % (str(e),))
3064
def run(self, message=None, file=None, verbose=False, selected_list=None,
3065
unchanged=False, strict=False, local=False, fixes=None,
3066
author=None, show_diff=False, exclude=None, commit_time=None):
3067
from bzrlib.errors import (
3072
from bzrlib.msgeditor import (
3073
edit_commit_message_encoded,
3074
generate_commit_message_template,
3075
make_commit_message_template_encoded
3078
commit_stamp = offset = None
3079
if commit_time is not None:
3081
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3082
except ValueError, e:
3083
raise errors.BzrCommandError(
3084
"Could not parse --commit-time: " + str(e))
3086
# TODO: Need a blackbox test for invoking the external editor; may be
3087
# slightly problematic to run this cross-platform.
3089
# TODO: do more checks that the commit will succeed before
3090
# spending the user's valuable time typing a commit message.
3094
tree, selected_list = tree_files(selected_list)
3095
if selected_list == ['']:
3096
# workaround - commit of root of tree should be exactly the same
3097
# as just default commit in that tree, and succeed even though
3098
# selected-file merge commit is not done yet
3103
bug_property = bugtracker.encode_fixes_bug_urls(
3104
self._iter_bug_fix_urls(fixes, tree.branch))
3106
properties['bugs'] = bug_property
3108
if local and not tree.branch.get_bound_location():
3109
raise errors.LocalRequiresBoundBranch()
3111
if message is not None:
3113
file_exists = osutils.lexists(message)
3114
except UnicodeError:
3115
# The commit message contains unicode characters that can't be
3116
# represented in the filesystem encoding, so that can't be a
3121
'The commit message is a file name: "%(f)s".\n'
3122
'(use --file "%(f)s" to take commit message from that file)'
3124
ui.ui_factory.show_warning(warning_msg)
3126
def get_message(commit_obj):
3127
"""Callback to get commit message"""
3128
my_message = message
3129
if my_message is not None and '\r' in my_message:
3130
my_message = my_message.replace('\r\n', '\n')
3131
my_message = my_message.replace('\r', '\n')
3132
if my_message is None and not file:
3133
t = make_commit_message_template_encoded(tree,
3134
selected_list, diff=show_diff,
3135
output_encoding=osutils.get_user_encoding())
3136
start_message = generate_commit_message_template(commit_obj)
3137
my_message = edit_commit_message_encoded(t,
3138
start_message=start_message)
3139
if my_message is None:
3140
raise errors.BzrCommandError("please specify a commit"
3141
" message with either --message or --file")
3142
elif my_message and file:
3143
raise errors.BzrCommandError(
3144
"please specify either --message or --file")
3146
my_message = codecs.open(file, 'rt',
3147
osutils.get_user_encoding()).read()
3148
if my_message == "":
3149
raise errors.BzrCommandError("empty commit message specified")
3152
# The API permits a commit with a filter of [] to mean 'select nothing'
3153
# but the command line should not do that.
3154
if not selected_list:
3155
selected_list = None
3157
tree.commit(message_callback=get_message,
3158
specific_files=selected_list,
3159
allow_pointless=unchanged, strict=strict, local=local,
3160
reporter=None, verbose=verbose, revprops=properties,
3161
authors=author, timestamp=commit_stamp,
3163
exclude=safe_relpath_files(tree, exclude))
3164
except PointlessCommit:
3165
# FIXME: This should really happen before the file is read in;
3166
# perhaps prepare the commit; get the message; then actually commit
3167
raise errors.BzrCommandError("No changes to commit."
3168
" Use --unchanged to commit anyhow.")
3169
except ConflictsInTree:
3170
raise errors.BzrCommandError('Conflicts detected in working '
3171
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3173
except StrictCommitFailed:
3174
raise errors.BzrCommandError("Commit refused because there are"
3175
" unknown files in the working tree.")
3176
except errors.BoundBranchOutOfDate, e:
3177
raise errors.BzrCommandError(str(e) + "\n"
3178
'To commit to master branch, run update and then commit.\n'
3179
'You can also pass --local to commit to continue working '
3183
class cmd_check(Command):
3184
"""Validate working tree structure, branch consistency and repository history.
3186
This command checks various invariants about branch and repository storage
3187
to detect data corruption or bzr bugs.
3189
The working tree and branch checks will only give output if a problem is
3190
detected. The output fields of the repository check are:
3193
This is just the number of revisions checked. It doesn't
3197
This is just the number of versionedfiles checked. It
3198
doesn't indicate a problem.
3200
unreferenced ancestors
3201
Texts that are ancestors of other texts, but
3202
are not properly referenced by the revision ancestry. This is a
3203
subtle problem that Bazaar can work around.
3206
This is the total number of unique file contents
3207
seen in the checked revisions. It does not indicate a problem.
3210
This is the total number of repeated texts seen
3211
in the checked revisions. Texts can be repeated when their file
3212
entries are modified, but the file contents are not. It does not
3215
If no restrictions are specified, all Bazaar data that is found at the given
3216
location will be checked.
3220
Check the tree and branch at 'foo'::
3222
bzr check --tree --branch foo
3224
Check only the repository at 'bar'::
3226
bzr check --repo bar
3228
Check everything at 'baz'::
3233
_see_also = ['reconcile']
3234
takes_args = ['path?']
3235
takes_options = ['verbose',
3236
Option('branch', help="Check the branch related to the"
3237
" current directory."),
3238
Option('repo', help="Check the repository related to the"
3239
" current directory."),
3240
Option('tree', help="Check the working tree related to"
3241
" the current directory.")]
3243
def run(self, path=None, verbose=False, branch=False, repo=False,
3245
from bzrlib.check import check_dwim
3248
if not branch and not repo and not tree:
3249
branch = repo = tree = True
3250
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3253
class cmd_upgrade(Command):
3254
"""Upgrade branch storage to current format.
3256
The check command or bzr developers may sometimes advise you to run
3257
this command. When the default format has changed you may also be warned
3258
during other operations to upgrade.
3261
_see_also = ['check']
3262
takes_args = ['url?']
3264
RegistryOption('format',
3265
help='Upgrade to a specific format. See "bzr help'
3266
' formats" for details.',
3267
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3268
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3269
value_switches=True, title='Branch format'),
3272
def run(self, url='.', format=None):
3273
from bzrlib.upgrade import upgrade
3274
upgrade(url, format)
3277
class cmd_whoami(Command):
3278
"""Show or set bzr user id.
3281
Show the email of the current user::
3285
Set the current user::
3287
bzr whoami "Frank Chu <fchu@example.com>"
3289
takes_options = [ Option('email',
3290
help='Display email address only.'),
3292
help='Set identity for the current branch instead of '
3295
takes_args = ['name?']
3296
encoding_type = 'replace'
3299
def run(self, email=False, branch=False, name=None):
3301
# use branch if we're inside one; otherwise global config
3303
c = Branch.open_containing('.')[0].get_config()
3304
except errors.NotBranchError:
3305
c = config.GlobalConfig()
3307
self.outf.write(c.user_email() + '\n')
3309
self.outf.write(c.username() + '\n')
3312
# display a warning if an email address isn't included in the given name.
3314
config.extract_email_address(name)
3315
except errors.NoEmailInUsername, e:
3316
warning('"%s" does not seem to contain an email address. '
3317
'This is allowed, but not recommended.', name)
3319
# use global config unless --branch given
3321
c = Branch.open_containing('.')[0].get_config()
3323
c = config.GlobalConfig()
3324
c.set_user_option('email', name)
3327
class cmd_nick(Command):
3328
"""Print or set the branch nickname.
3330
If unset, the tree root directory name is used as the nickname.
3331
To print the current nickname, execute with no argument.
3333
Bound branches use the nickname of its master branch unless it is set
3337
_see_also = ['info']
3338
takes_args = ['nickname?']
3339
def run(self, nickname=None):
3340
branch = Branch.open_containing(u'.')[0]
3341
if nickname is None:
3342
self.printme(branch)
3344
branch.nick = nickname
3347
def printme(self, branch):
3348
self.outf.write('%s\n' % branch.nick)
3351
class cmd_alias(Command):
3352
"""Set/unset and display aliases.
3355
Show the current aliases::
3359
Show the alias specified for 'll'::
3363
Set an alias for 'll'::
3365
bzr alias ll="log --line -r-10..-1"
3367
To remove an alias for 'll'::
3369
bzr alias --remove ll
3372
takes_args = ['name?']
3374
Option('remove', help='Remove the alias.'),
3377
def run(self, name=None, remove=False):
3379
self.remove_alias(name)
3381
self.print_aliases()
3383
equal_pos = name.find('=')
3385
self.print_alias(name)
3387
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3389
def remove_alias(self, alias_name):
3390
if alias_name is None:
3391
raise errors.BzrCommandError(
3392
'bzr alias --remove expects an alias to remove.')
3393
# If alias is not found, print something like:
3394
# unalias: foo: not found
3395
c = config.GlobalConfig()
3396
c.unset_alias(alias_name)
3399
def print_aliases(self):
3400
"""Print out the defined aliases in a similar format to bash."""
3401
aliases = config.GlobalConfig().get_aliases()
3402
for key, value in sorted(aliases.iteritems()):
3403
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3406
def print_alias(self, alias_name):
3407
from bzrlib.commands import get_alias
3408
alias = get_alias(alias_name)
3410
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3413
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3415
def set_alias(self, alias_name, alias_command):
3416
"""Save the alias in the global config."""
3417
c = config.GlobalConfig()
3418
c.set_alias(alias_name, alias_command)
3421
class cmd_selftest(Command):
3422
"""Run internal test suite.
3424
If arguments are given, they are regular expressions that say which tests
3425
should run. Tests matching any expression are run, and other tests are
3428
Alternatively if --first is given, matching tests are run first and then
3429
all other tests are run. This is useful if you have been working in a
3430
particular area, but want to make sure nothing else was broken.
3432
If --exclude is given, tests that match that regular expression are
3433
excluded, regardless of whether they match --first or not.
3435
To help catch accidential dependencies between tests, the --randomize
3436
option is useful. In most cases, the argument used is the word 'now'.
3437
Note that the seed used for the random number generator is displayed
3438
when this option is used. The seed can be explicitly passed as the
3439
argument to this option if required. This enables reproduction of the
3440
actual ordering used if and when an order sensitive problem is encountered.
3442
If --list-only is given, the tests that would be run are listed. This is
3443
useful when combined with --first, --exclude and/or --randomize to
3444
understand their impact. The test harness reports "Listed nn tests in ..."
3445
instead of "Ran nn tests in ..." when list mode is enabled.
3447
If the global option '--no-plugins' is given, plugins are not loaded
3448
before running the selftests. This has two effects: features provided or
3449
modified by plugins will not be tested, and tests provided by plugins will
3452
Tests that need working space on disk use a common temporary directory,
3453
typically inside $TMPDIR or /tmp.
3455
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3456
into a pdb postmortem session.
3459
Run only tests relating to 'ignore'::
3463
Disable plugins and list tests as they're run::
3465
bzr --no-plugins selftest -v
3467
# NB: this is used from the class without creating an instance, which is
3468
# why it does not have a self parameter.
3469
def get_transport_type(typestring):
3470
"""Parse and return a transport specifier."""
3471
if typestring == "sftp":
3472
from bzrlib.tests import stub_sftp
3473
return stub_sftp.SFTPAbsoluteServer
3474
if typestring == "memory":
3475
from bzrlib.tests import test_server
3476
return memory.MemoryServer
3477
if typestring == "fakenfs":
3478
from bzrlib.tests import test_server
3479
return test_server.FakeNFSServer
3480
msg = "No known transport type %s. Supported types are: sftp\n" %\
3482
raise errors.BzrCommandError(msg)
3485
takes_args = ['testspecs*']
3486
takes_options = ['verbose',
3488
help='Stop when one test fails.',
3492
help='Use a different transport by default '
3493
'throughout the test suite.',
3494
type=get_transport_type),
3496
help='Run the benchmarks rather than selftests.'),
3497
Option('lsprof-timed',
3498
help='Generate lsprof output for benchmarked'
3499
' sections of code.'),
3500
Option('lsprof-tests',
3501
help='Generate lsprof output for each test.'),
3502
Option('cache-dir', type=str,
3503
help='Cache intermediate benchmark output in this '
3506
help='Run all tests, but run specified tests first.',
3510
help='List the tests instead of running them.'),
3511
RegistryOption('parallel',
3512
help="Run the test suite in parallel.",
3513
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3514
value_switches=False,
3516
Option('randomize', type=str, argname="SEED",
3517
help='Randomize the order of tests using the given'
3518
' seed or "now" for the current time.'),
3519
Option('exclude', type=str, argname="PATTERN",
3521
help='Exclude tests that match this regular'
3524
help='Output test progress via subunit.'),
3525
Option('strict', help='Fail on missing dependencies or '
3527
Option('load-list', type=str, argname='TESTLISTFILE',
3528
help='Load a test id list from a text file.'),
3529
ListOption('debugflag', type=str, short_name='E',
3530
help='Turn on a selftest debug flag.'),
3531
ListOption('starting-with', type=str, argname='TESTID',
3532
param_name='starting_with', short_name='s',
3534
'Load only the tests starting with TESTID.'),
3536
encoding_type = 'replace'
3539
Command.__init__(self)
3540
self.additional_selftest_args = {}
3542
def run(self, testspecs_list=None, verbose=False, one=False,
3543
transport=None, benchmark=None,
3544
lsprof_timed=None, cache_dir=None,
3545
first=False, list_only=False,
3546
randomize=None, exclude=None, strict=False,
3547
load_list=None, debugflag=None, starting_with=None, subunit=False,
3548
parallel=None, lsprof_tests=False):
3549
from bzrlib.tests import selftest
3550
import bzrlib.benchmarks as benchmarks
3551
from bzrlib.benchmarks import tree_creator
3553
# Make deprecation warnings visible, unless -Werror is set
3554
symbol_versioning.activate_deprecation_warnings(override=False)
3556
if cache_dir is not None:
3557
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3558
if testspecs_list is not None:
3559
pattern = '|'.join(testspecs_list)
3564
from bzrlib.tests import SubUnitBzrRunner
3566
raise errors.BzrCommandError("subunit not available. subunit "
3567
"needs to be installed to use --subunit.")
3568
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3570
self.additional_selftest_args.setdefault(
3571
'suite_decorators', []).append(parallel)
3573
test_suite_factory = benchmarks.test_suite
3574
# Unless user explicitly asks for quiet, be verbose in benchmarks
3575
verbose = not is_quiet()
3576
# TODO: should possibly lock the history file...
3577
benchfile = open(".perf_history", "at", buffering=1)
3578
self.add_cleanup(benchfile.close)
3580
test_suite_factory = None
3582
selftest_kwargs = {"verbose": verbose,
3584
"stop_on_failure": one,
3585
"transport": transport,
3586
"test_suite_factory": test_suite_factory,
3587
"lsprof_timed": lsprof_timed,
3588
"lsprof_tests": lsprof_tests,
3589
"bench_history": benchfile,
3590
"matching_tests_first": first,
3591
"list_only": list_only,
3592
"random_seed": randomize,
3593
"exclude_pattern": exclude,
3595
"load_list": load_list,
3596
"debug_flags": debugflag,
3597
"starting_with": starting_with
3599
selftest_kwargs.update(self.additional_selftest_args)
3600
result = selftest(**selftest_kwargs)
3601
return int(not result)
3604
class cmd_version(Command):
3605
"""Show version of bzr."""
3607
encoding_type = 'replace'
3609
Option("short", help="Print just the version number."),
3613
def run(self, short=False):
3614
from bzrlib.version import show_version
3616
self.outf.write(bzrlib.version_string + '\n')
3618
show_version(to_file=self.outf)
3621
class cmd_rocks(Command):
3622
"""Statement of optimism."""
3628
self.outf.write("It sure does!\n")
3631
class cmd_find_merge_base(Command):
3632
"""Find and print a base revision for merging two branches."""
3633
# TODO: Options to specify revisions on either side, as if
3634
# merging only part of the history.
3635
takes_args = ['branch', 'other']
3639
def run(self, branch, other):
3640
from bzrlib.revision import ensure_null
3642
branch1 = Branch.open_containing(branch)[0]
3643
branch2 = Branch.open_containing(other)[0]
3645
self.add_cleanup(branch1.unlock)
3647
self.add_cleanup(branch2.unlock)
3648
last1 = ensure_null(branch1.last_revision())
3649
last2 = ensure_null(branch2.last_revision())
3651
graph = branch1.repository.get_graph(branch2.repository)
3652
base_rev_id = graph.find_unique_lca(last1, last2)
3654
self.outf.write('merge base is revision %s\n' % base_rev_id)
3657
class cmd_merge(Command):
3658
"""Perform a three-way merge.
3660
The source of the merge can be specified either in the form of a branch,
3661
or in the form of a path to a file containing a merge directive generated
3662
with bzr send. If neither is specified, the default is the upstream branch
3663
or the branch most recently merged using --remember.
3665
When merging a branch, by default the tip will be merged. To pick a different
3666
revision, pass --revision. If you specify two values, the first will be used as
3667
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3668
available revisions, like this is commonly referred to as "cherrypicking".
3670
Revision numbers are always relative to the branch being merged.
3672
By default, bzr will try to merge in all new work from the other
3673
branch, automatically determining an appropriate base. If this
3674
fails, you may need to give an explicit base.
3676
Merge will do its best to combine the changes in two branches, but there
3677
are some kinds of problems only a human can fix. When it encounters those,
3678
it will mark a conflict. A conflict means that you need to fix something,
3679
before you should commit.
3681
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3683
If there is no default branch set, the first merge will set it. After
3684
that, you can omit the branch to use the default. To change the
3685
default, use --remember. The value will only be saved if the remote
3686
location can be accessed.
3688
The results of the merge are placed into the destination working
3689
directory, where they can be reviewed (with bzr diff), tested, and then
3690
committed to record the result of the merge.
3692
merge refuses to run if there are any uncommitted changes, unless
3693
--force is given. The --force option can also be used to create a
3694
merge revision which has more than two parents.
3696
If one would like to merge changes from the working tree of the other
3697
branch without merging any committed revisions, the --uncommitted option
3700
To select only some changes to merge, use "merge -i", which will prompt
3701
you to apply each diff hunk and file change, similar to "shelve".
3704
To merge the latest revision from bzr.dev::
3706
bzr merge ../bzr.dev
3708
To merge changes up to and including revision 82 from bzr.dev::
3710
bzr merge -r 82 ../bzr.dev
3712
To merge the changes introduced by 82, without previous changes::
3714
bzr merge -r 81..82 ../bzr.dev
3716
To apply a merge directive contained in /tmp/merge::
3718
bzr merge /tmp/merge
3720
To create a merge revision with three parents from two branches
3721
feature1a and feature1b:
3723
bzr merge ../feature1a
3724
bzr merge ../feature1b --force
3725
bzr commit -m 'revision with three parents'
3728
encoding_type = 'exact'
3729
_see_also = ['update', 'remerge', 'status-flags', 'send']
3730
takes_args = ['location?']
3735
help='Merge even if the destination tree has uncommitted changes.'),
3739
Option('show-base', help="Show base revision text in "
3741
Option('uncommitted', help='Apply uncommitted changes'
3742
' from a working copy, instead of branch changes.'),
3743
Option('pull', help='If the destination is already'
3744
' completely merged into the source, pull from the'
3745
' source rather than merging. When this happens,'
3746
' you do not need to commit the result.'),
3748
help='Branch to merge into, '
3749
'rather than the one containing the working directory.',
3753
Option('preview', help='Instead of merging, show a diff of the'
3755
Option('interactive', help='Select changes interactively.',
3759
def run(self, location=None, revision=None, force=False,
3760
merge_type=None, show_base=False, reprocess=None, remember=False,
3761
uncommitted=False, pull=False,
3766
if merge_type is None:
3767
merge_type = _mod_merge.Merge3Merger
3769
if directory is None: directory = u'.'
3770
possible_transports = []
3772
allow_pending = True
3773
verified = 'inapplicable'
3774
tree = WorkingTree.open_containing(directory)[0]
3777
basis_tree = tree.revision_tree(tree.last_revision())
3778
except errors.NoSuchRevision:
3779
basis_tree = tree.basis_tree()
3781
# die as quickly as possible if there are uncommitted changes
3783
if tree.has_changes():
3784
raise errors.UncommittedChanges(tree)
3786
view_info = _get_view_info_for_change_reporter(tree)
3787
change_reporter = delta._ChangeReporter(
3788
unversioned_filter=tree.is_ignored, view_info=view_info)
3789
pb = ui.ui_factory.nested_progress_bar()
3790
self.add_cleanup(pb.finished)
3792
self.add_cleanup(tree.unlock)
3793
if location is not None:
3795
mergeable = bundle.read_mergeable_from_url(location,
3796
possible_transports=possible_transports)
3797
except errors.NotABundle:
3801
raise errors.BzrCommandError('Cannot use --uncommitted'
3802
' with bundles or merge directives.')
3804
if revision is not None:
3805
raise errors.BzrCommandError(
3806
'Cannot use -r with merge directives or bundles')
3807
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3810
if merger is None and uncommitted:
3811
if revision is not None and len(revision) > 0:
3812
raise errors.BzrCommandError('Cannot use --uncommitted and'
3813
' --revision at the same time.')
3814
merger = self.get_merger_from_uncommitted(tree, location, None)
3815
allow_pending = False
3818
merger, allow_pending = self._get_merger_from_branch(tree,
3819
location, revision, remember, possible_transports, None)
3821
merger.merge_type = merge_type
3822
merger.reprocess = reprocess
3823
merger.show_base = show_base
3824
self.sanity_check_merger(merger)
3825
if (merger.base_rev_id == merger.other_rev_id and
3826
merger.other_rev_id is not None):
3827
note('Nothing to do.')
3830
if merger.interesting_files is not None:
3831
raise errors.BzrCommandError('Cannot pull individual files')
3832
if (merger.base_rev_id == tree.last_revision()):
3833
result = tree.pull(merger.other_branch, False,
3834
merger.other_rev_id)
3835
result.report(self.outf)
3837
if merger.this_basis is None:
3838
raise errors.BzrCommandError(
3839
"This branch has no commits."
3840
" (perhaps you would prefer 'bzr pull')")
3842
return self._do_preview(merger)
3844
return self._do_interactive(merger)
3846
return self._do_merge(merger, change_reporter, allow_pending,
3849
def _get_preview(self, merger):
3850
tree_merger = merger.make_merger()
3851
tt = tree_merger.make_preview_transform()
3852
self.add_cleanup(tt.finalize)
3853
result_tree = tt.get_preview_tree()
3856
def _do_preview(self, merger):
3857
from bzrlib.diff import show_diff_trees
3858
result_tree = self._get_preview(merger)
3859
show_diff_trees(merger.this_tree, result_tree, self.outf,
3860
old_label='', new_label='')
3862
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3863
merger.change_reporter = change_reporter
3864
conflict_count = merger.do_merge()
3866
merger.set_pending()
3867
if verified == 'failed':
3868
warning('Preview patch does not match changes')
3869
if conflict_count != 0:
3874
def _do_interactive(self, merger):
3875
"""Perform an interactive merge.
3877
This works by generating a preview tree of the merge, then using
3878
Shelver to selectively remove the differences between the working tree
3879
and the preview tree.
3881
from bzrlib import shelf_ui
3882
result_tree = self._get_preview(merger)
3883
writer = bzrlib.option.diff_writer_registry.get()
3884
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3885
reporter=shelf_ui.ApplyReporter(),
3886
diff_writer=writer(sys.stdout))
3892
def sanity_check_merger(self, merger):
3893
if (merger.show_base and
3894
not merger.merge_type is _mod_merge.Merge3Merger):
3895
raise errors.BzrCommandError("Show-base is not supported for this"
3896
" merge type. %s" % merger.merge_type)
3897
if merger.reprocess is None:
3898
if merger.show_base:
3899
merger.reprocess = False
3901
# Use reprocess if the merger supports it
3902
merger.reprocess = merger.merge_type.supports_reprocess
3903
if merger.reprocess and not merger.merge_type.supports_reprocess:
3904
raise errors.BzrCommandError("Conflict reduction is not supported"
3905
" for merge type %s." %
3907
if merger.reprocess and merger.show_base:
3908
raise errors.BzrCommandError("Cannot do conflict reduction and"
3911
def _get_merger_from_branch(self, tree, location, revision, remember,
3912
possible_transports, pb):
3913
"""Produce a merger from a location, assuming it refers to a branch."""
3914
from bzrlib.tag import _merge_tags_if_possible
3915
# find the branch locations
3916
other_loc, user_location = self._select_branch_location(tree, location,
3918
if revision is not None and len(revision) == 2:
3919
base_loc, _unused = self._select_branch_location(tree,
3920
location, revision, 0)
3922
base_loc = other_loc
3924
other_branch, other_path = Branch.open_containing(other_loc,
3925
possible_transports)
3926
if base_loc == other_loc:
3927
base_branch = other_branch
3929
base_branch, base_path = Branch.open_containing(base_loc,
3930
possible_transports)
3931
# Find the revision ids
3932
other_revision_id = None
3933
base_revision_id = None
3934
if revision is not None:
3935
if len(revision) >= 1:
3936
other_revision_id = revision[-1].as_revision_id(other_branch)
3937
if len(revision) == 2:
3938
base_revision_id = revision[0].as_revision_id(base_branch)
3939
if other_revision_id is None:
3940
other_revision_id = _mod_revision.ensure_null(
3941
other_branch.last_revision())
3942
# Remember where we merge from
3943
if ((remember or tree.branch.get_submit_branch() is None) and
3944
user_location is not None):
3945
tree.branch.set_submit_branch(other_branch.base)
3946
_merge_tags_if_possible(other_branch, tree.branch)
3947
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3948
other_revision_id, base_revision_id, other_branch, base_branch)
3949
if other_path != '':
3950
allow_pending = False
3951
merger.interesting_files = [other_path]
3953
allow_pending = True
3954
return merger, allow_pending
3956
def get_merger_from_uncommitted(self, tree, location, pb):
3957
"""Get a merger for uncommitted changes.
3959
:param tree: The tree the merger should apply to.
3960
:param location: The location containing uncommitted changes.
3961
:param pb: The progress bar to use for showing progress.
3963
location = self._select_branch_location(tree, location)[0]
3964
other_tree, other_path = WorkingTree.open_containing(location)
3965
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3966
if other_path != '':
3967
merger.interesting_files = [other_path]
3970
def _select_branch_location(self, tree, user_location, revision=None,
3972
"""Select a branch location, according to possible inputs.
3974
If provided, branches from ``revision`` are preferred. (Both
3975
``revision`` and ``index`` must be supplied.)
3977
Otherwise, the ``location`` parameter is used. If it is None, then the
3978
``submit`` or ``parent`` location is used, and a note is printed.
3980
:param tree: The working tree to select a branch for merging into
3981
:param location: The location entered by the user
3982
:param revision: The revision parameter to the command
3983
:param index: The index to use for the revision parameter. Negative
3984
indices are permitted.
3985
:return: (selected_location, user_location). The default location
3986
will be the user-entered location.
3988
if (revision is not None and index is not None
3989
and revision[index] is not None):
3990
branch = revision[index].get_branch()
3991
if branch is not None:
3992
return branch, branch
3993
if user_location is None:
3994
location = self._get_remembered(tree, 'Merging from')
3996
location = user_location
3997
return location, user_location
3999
def _get_remembered(self, tree, verb_string):
4000
"""Use tree.branch's parent if none was supplied.
4002
Report if the remembered location was used.
4004
stored_location = tree.branch.get_submit_branch()
4005
stored_location_type = "submit"
4006
if stored_location is None:
4007
stored_location = tree.branch.get_parent()
4008
stored_location_type = "parent"
4009
mutter("%s", stored_location)
4010
if stored_location is None:
4011
raise errors.BzrCommandError("No location specified or remembered")
4012
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4013
note(u"%s remembered %s location %s", verb_string,
4014
stored_location_type, display_url)
4015
return stored_location
4018
class cmd_remerge(Command):
4021
Use this if you want to try a different merge technique while resolving
4022
conflicts. Some merge techniques are better than others, and remerge
4023
lets you try different ones on different files.
4025
The options for remerge have the same meaning and defaults as the ones for
4026
merge. The difference is that remerge can (only) be run when there is a
4027
pending merge, and it lets you specify particular files.
4030
Re-do the merge of all conflicted files, and show the base text in
4031
conflict regions, in addition to the usual THIS and OTHER texts::
4033
bzr remerge --show-base
4035
Re-do the merge of "foobar", using the weave merge algorithm, with
4036
additional processing to reduce the size of conflict regions::
4038
bzr remerge --merge-type weave --reprocess foobar
4040
takes_args = ['file*']
4045
help="Show base revision text in conflicts."),
4048
def run(self, file_list=None, merge_type=None, show_base=False,
4050
if merge_type is None:
4051
merge_type = _mod_merge.Merge3Merger
4052
tree, file_list = tree_files(file_list)
4054
self.add_cleanup(tree.unlock)
4055
parents = tree.get_parent_ids()
4056
if len(parents) != 2:
4057
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4058
" merges. Not cherrypicking or"
4060
repository = tree.branch.repository
4061
interesting_ids = None
4063
conflicts = tree.conflicts()
4064
if file_list is not None:
4065
interesting_ids = set()
4066
for filename in file_list:
4067
file_id = tree.path2id(filename)
4069
raise errors.NotVersionedError(filename)
4070
interesting_ids.add(file_id)
4071
if tree.kind(file_id) != "directory":
4074
for name, ie in tree.inventory.iter_entries(file_id):
4075
interesting_ids.add(ie.file_id)
4076
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4078
# Remerge only supports resolving contents conflicts
4079
allowed_conflicts = ('text conflict', 'contents conflict')
4080
restore_files = [c.path for c in conflicts
4081
if c.typestring in allowed_conflicts]
4082
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4083
tree.set_conflicts(ConflictList(new_conflicts))
4084
if file_list is not None:
4085
restore_files = file_list
4086
for filename in restore_files:
4088
restore(tree.abspath(filename))
4089
except errors.NotConflicted:
4091
# Disable pending merges, because the file texts we are remerging
4092
# have not had those merges performed. If we use the wrong parents
4093
# list, we imply that the working tree text has seen and rejected
4094
# all the changes from the other tree, when in fact those changes
4095
# have not yet been seen.
4096
tree.set_parent_ids(parents[:1])
4098
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4099
merger.interesting_ids = interesting_ids
4100
merger.merge_type = merge_type
4101
merger.show_base = show_base
4102
merger.reprocess = reprocess
4103
conflicts = merger.do_merge()
4105
tree.set_parent_ids(parents)
4112
class cmd_revert(Command):
4113
"""Revert files to a previous revision.
4115
Giving a list of files will revert only those files. Otherwise, all files
4116
will be reverted. If the revision is not specified with '--revision', the
4117
last committed revision is used.
4119
To remove only some changes, without reverting to a prior version, use
4120
merge instead. For example, "merge . --revision -2..-3" will remove the
4121
changes introduced by -2, without affecting the changes introduced by -1.
4122
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4124
By default, any files that have been manually changed will be backed up
4125
first. (Files changed only by merge are not backed up.) Backup files have
4126
'.~#~' appended to their name, where # is a number.
4128
When you provide files, you can use their current pathname or the pathname
4129
from the target revision. So you can use revert to "undelete" a file by
4130
name. If you name a directory, all the contents of that directory will be
4133
If you have newly added files since the target revision, they will be
4134
removed. If the files to be removed have been changed, backups will be
4135
created as above. Directories containing unknown files will not be
4138
The working tree contains a list of revisions that have been merged but
4139
not yet committed. These revisions will be included as additional parents
4140
of the next commit. Normally, using revert clears that list as well as
4141
reverting the files. If any files are specified, revert leaves the list
4142
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4143
.`` in the tree root to revert all files but keep the recorded merges,
4144
and ``bzr revert --forget-merges`` to clear the pending merge list without
4145
reverting any files.
4147
Using "bzr revert --forget-merges", it is possible to apply all of the
4148
changes from a branch in a single revision. To do this, perform the merge
4149
as desired. Then doing revert with the "--forget-merges" option will keep
4150
the content of the tree as it was, but it will clear the list of pending
4151
merges. The next commit will then contain all of the changes that are
4152
present in the other branch, but without any other parent revisions.
4153
Because this technique forgets where these changes originated, it may
4154
cause additional conflicts on later merges involving the same source and
4158
_see_also = ['cat', 'export']
4161
Option('no-backup', "Do not save backups of reverted files."),
4162
Option('forget-merges',
4163
'Remove pending merge marker, without changing any files.'),
4165
takes_args = ['file*']
4167
def run(self, revision=None, no_backup=False, file_list=None,
4168
forget_merges=None):
4169
tree, file_list = tree_files(file_list)
4171
self.add_cleanup(tree.unlock)
4173
tree.set_parent_ids(tree.get_parent_ids()[:1])
4175
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4178
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4179
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4180
tree.revert(file_list, rev_tree, not no_backup, None,
4181
report_changes=True)
4184
class cmd_assert_fail(Command):
4185
"""Test reporting of assertion failures"""
4186
# intended just for use in testing
4191
raise AssertionError("always fails")
4194
class cmd_help(Command):
4195
"""Show help on a command or other topic.
4198
_see_also = ['topics']
4200
Option('long', 'Show help on all commands.'),
4202
takes_args = ['topic?']
4203
aliases = ['?', '--help', '-?', '-h']
4206
def run(self, topic=None, long=False):
4208
if topic is None and long:
4210
bzrlib.help.help(topic)
4213
class cmd_shell_complete(Command):
4214
"""Show appropriate completions for context.
4216
For a list of all available commands, say 'bzr shell-complete'.
4218
takes_args = ['context?']
4223
def run(self, context=None):
4224
import shellcomplete
4225
shellcomplete.shellcomplete(context)
4228
class cmd_missing(Command):
4229
"""Show unmerged/unpulled revisions between two branches.
4231
OTHER_BRANCH may be local or remote.
4233
To filter on a range of revisions, you can use the command -r begin..end
4234
-r revision requests a specific revision, -r ..end or -r begin.. are
4238
1 - some missing revisions
4239
0 - no missing revisions
4243
Determine the missing revisions between this and the branch at the
4244
remembered pull location::
4248
Determine the missing revisions between this and another branch::
4250
bzr missing http://server/branch
4252
Determine the missing revisions up to a specific revision on the other
4255
bzr missing -r ..-10
4257
Determine the missing revisions up to a specific revision on this
4260
bzr missing --my-revision ..-10
4263
_see_also = ['merge', 'pull']
4264
takes_args = ['other_branch?']
4266
Option('reverse', 'Reverse the order of revisions.'),
4268
'Display changes in the local branch only.'),
4269
Option('this' , 'Same as --mine-only.'),
4270
Option('theirs-only',
4271
'Display changes in the remote branch only.'),
4272
Option('other', 'Same as --theirs-only.'),
4276
custom_help('revision',
4277
help='Filter on other branch revisions (inclusive). '
4278
'See "help revisionspec" for details.'),
4279
Option('my-revision',
4280
type=_parse_revision_str,
4281
help='Filter on local branch revisions (inclusive). '
4282
'See "help revisionspec" for details.'),
4283
Option('include-merges',
4284
'Show all revisions in addition to the mainline ones.'),
4286
encoding_type = 'replace'
4289
def run(self, other_branch=None, reverse=False, mine_only=False,
4291
log_format=None, long=False, short=False, line=False,
4292
show_ids=False, verbose=False, this=False, other=False,
4293
include_merges=False, revision=None, my_revision=None):
4294
from bzrlib.missing import find_unmerged, iter_log_revisions
4303
# TODO: We should probably check that we don't have mine-only and
4304
# theirs-only set, but it gets complicated because we also have
4305
# this and other which could be used.
4312
local_branch = Branch.open_containing(u".")[0]
4313
parent = local_branch.get_parent()
4314
if other_branch is None:
4315
other_branch = parent
4316
if other_branch is None:
4317
raise errors.BzrCommandError("No peer location known"
4319
display_url = urlutils.unescape_for_display(parent,
4321
message("Using saved parent location: "
4322
+ display_url + "\n")
4324
remote_branch = Branch.open(other_branch)
4325
if remote_branch.base == local_branch.base:
4326
remote_branch = local_branch
4328
local_branch.lock_read()
4329
self.add_cleanup(local_branch.unlock)
4330
local_revid_range = _revision_range_to_revid_range(
4331
_get_revision_range(my_revision, local_branch,
4334
remote_branch.lock_read()
4335
self.add_cleanup(remote_branch.unlock)
4336
remote_revid_range = _revision_range_to_revid_range(
4337
_get_revision_range(revision,
4338
remote_branch, self.name()))
4340
local_extra, remote_extra = find_unmerged(
4341
local_branch, remote_branch, restrict,
4342
backward=not reverse,
4343
include_merges=include_merges,
4344
local_revid_range=local_revid_range,
4345
remote_revid_range=remote_revid_range)
4347
if log_format is None:
4348
registry = log.log_formatter_registry
4349
log_format = registry.get_default(local_branch)
4350
lf = log_format(to_file=self.outf,
4352
show_timezone='original')
4355
if local_extra and not theirs_only:
4356
message("You have %d extra revision(s):\n" %
4358
for revision in iter_log_revisions(local_extra,
4359
local_branch.repository,
4361
lf.log_revision(revision)
4362
printed_local = True
4365
printed_local = False
4367
if remote_extra and not mine_only:
4368
if printed_local is True:
4370
message("You are missing %d revision(s):\n" %
4372
for revision in iter_log_revisions(remote_extra,
4373
remote_branch.repository,
4375
lf.log_revision(revision)
4378
if mine_only and not local_extra:
4379
# We checked local, and found nothing extra
4380
message('This branch is up to date.\n')
4381
elif theirs_only and not remote_extra:
4382
# We checked remote, and found nothing extra
4383
message('Other branch is up to date.\n')
4384
elif not (mine_only or theirs_only or local_extra or
4386
# We checked both branches, and neither one had extra
4388
message("Branches are up to date.\n")
4390
if not status_code and parent is None and other_branch is not None:
4391
local_branch.lock_write()
4392
self.add_cleanup(local_branch.unlock)
4393
# handle race conditions - a parent might be set while we run.
4394
if local_branch.get_parent() is None:
4395
local_branch.set_parent(remote_branch.base)
4399
class cmd_pack(Command):
4400
"""Compress the data within a repository."""
4402
_see_also = ['repositories']
4403
takes_args = ['branch_or_repo?']
4405
def run(self, branch_or_repo='.'):
4406
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4408
branch = dir.open_branch()
4409
repository = branch.repository
4410
except errors.NotBranchError:
4411
repository = dir.open_repository()
4415
class cmd_plugins(Command):
4416
"""List the installed plugins.
4418
This command displays the list of installed plugins including
4419
version of plugin and a short description of each.
4421
--verbose shows the path where each plugin is located.
4423
A plugin is an external component for Bazaar that extends the
4424
revision control system, by adding or replacing code in Bazaar.
4425
Plugins can do a variety of things, including overriding commands,
4426
adding new commands, providing additional network transports and
4427
customizing log output.
4429
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4430
for further information on plugins including where to find them and how to
4431
install them. Instructions are also provided there on how to write new
4432
plugins using the Python programming language.
4434
takes_options = ['verbose']
4437
def run(self, verbose=False):
4438
import bzrlib.plugin
4439
from inspect import getdoc
4441
for name, plugin in bzrlib.plugin.plugins().items():
4442
version = plugin.__version__
4443
if version == 'unknown':
4445
name_ver = '%s %s' % (name, version)
4446
d = getdoc(plugin.module)
4448
doc = d.split('\n')[0]
4450
doc = '(no description)'
4451
result.append((name_ver, doc, plugin.path()))
4452
for name_ver, doc, path in sorted(result):
4453
self.outf.write("%s\n" % name_ver)
4454
self.outf.write(" %s\n" % doc)
4456
self.outf.write(" %s\n" % path)
4457
self.outf.write("\n")
4460
class cmd_testament(Command):
4461
"""Show testament (signing-form) of a revision."""
4464
Option('long', help='Produce long-format testament.'),
4466
help='Produce a strict-format testament.')]
4467
takes_args = ['branch?']
4469
def run(self, branch=u'.', revision=None, long=False, strict=False):
4470
from bzrlib.testament import Testament, StrictTestament
4472
testament_class = StrictTestament
4474
testament_class = Testament
4476
b = Branch.open_containing(branch)[0]
4478
b = Branch.open(branch)
4480
self.add_cleanup(b.unlock)
4481
if revision is None:
4482
rev_id = b.last_revision()
4484
rev_id = revision[0].as_revision_id(b)
4485
t = testament_class.from_revision(b.repository, rev_id)
4487
sys.stdout.writelines(t.as_text_lines())
4489
sys.stdout.write(t.as_short_text())
4492
class cmd_annotate(Command):
4493
"""Show the origin of each line in a file.
4495
This prints out the given file with an annotation on the left side
4496
indicating which revision, author and date introduced the change.
4498
If the origin is the same for a run of consecutive lines, it is
4499
shown only at the top, unless the --all option is given.
4501
# TODO: annotate directories; showing when each file was last changed
4502
# TODO: if the working copy is modified, show annotations on that
4503
# with new uncommitted lines marked
4504
aliases = ['ann', 'blame', 'praise']
4505
takes_args = ['filename']
4506
takes_options = [Option('all', help='Show annotations on all lines.'),
4507
Option('long', help='Show commit date in annotations.'),
4511
encoding_type = 'exact'
4514
def run(self, filename, all=False, long=False, revision=None,
4516
from bzrlib.annotate import annotate_file, annotate_file_tree
4517
wt, branch, relpath = \
4518
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4521
self.add_cleanup(wt.unlock)
4524
self.add_cleanup(branch.unlock)
4525
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4527
self.add_cleanup(tree.unlock)
4529
file_id = wt.path2id(relpath)
4531
file_id = tree.path2id(relpath)
4533
raise errors.NotVersionedError(filename)
4534
file_version = tree.inventory[file_id].revision
4535
if wt is not None and revision is None:
4536
# If there is a tree and we're not annotating historical
4537
# versions, annotate the working tree's content.
4538
annotate_file_tree(wt, file_id, self.outf, long, all,
4541
annotate_file(branch, file_version, file_id, long, all, self.outf,
4545
class cmd_re_sign(Command):
4546
"""Create a digital signature for an existing revision."""
4547
# TODO be able to replace existing ones.
4549
hidden = True # is this right ?
4550
takes_args = ['revision_id*']
4551
takes_options = ['revision']
4553
def run(self, revision_id_list=None, revision=None):
4554
if revision_id_list is not None and revision is not None:
4555
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4556
if revision_id_list is None and revision is None:
4557
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4558
b = WorkingTree.open_containing(u'.')[0].branch
4560
self.add_cleanup(b.unlock)
4561
return self._run(b, revision_id_list, revision)
4563
def _run(self, b, revision_id_list, revision):
4564
import bzrlib.gpg as gpg
4565
gpg_strategy = gpg.GPGStrategy(b.get_config())
4566
if revision_id_list is not None:
4567
b.repository.start_write_group()
4569
for revision_id in revision_id_list:
4570
b.repository.sign_revision(revision_id, gpg_strategy)
4572
b.repository.abort_write_group()
4575
b.repository.commit_write_group()
4576
elif revision is not None:
4577
if len(revision) == 1:
4578
revno, rev_id = revision[0].in_history(b)
4579
b.repository.start_write_group()
4581
b.repository.sign_revision(rev_id, gpg_strategy)
4583
b.repository.abort_write_group()
4586
b.repository.commit_write_group()
4587
elif len(revision) == 2:
4588
# are they both on rh- if so we can walk between them
4589
# might be nice to have a range helper for arbitrary
4590
# revision paths. hmm.
4591
from_revno, from_revid = revision[0].in_history(b)
4592
to_revno, to_revid = revision[1].in_history(b)
4593
if to_revid is None:
4594
to_revno = b.revno()
4595
if from_revno is None or to_revno is None:
4596
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4597
b.repository.start_write_group()
4599
for revno in range(from_revno, to_revno + 1):
4600
b.repository.sign_revision(b.get_rev_id(revno),
4603
b.repository.abort_write_group()
4606
b.repository.commit_write_group()
4608
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4611
class cmd_bind(Command):
4612
"""Convert the current branch into a checkout of the supplied branch.
4614
Once converted into a checkout, commits must succeed on the master branch
4615
before they will be applied to the local branch.
4617
Bound branches use the nickname of its master branch unless it is set
4618
locally, in which case binding will update the local nickname to be
4622
_see_also = ['checkouts', 'unbind']
4623
takes_args = ['location?']
4626
def run(self, location=None):
4627
b, relpath = Branch.open_containing(u'.')
4628
if location is None:
4630
location = b.get_old_bound_location()
4631
except errors.UpgradeRequired:
4632
raise errors.BzrCommandError('No location supplied. '
4633
'This format does not remember old locations.')
4635
if location is None:
4636
if b.get_bound_location() is not None:
4637
raise errors.BzrCommandError('Branch is already bound')
4639
raise errors.BzrCommandError('No location supplied '
4640
'and no previous location known')
4641
b_other = Branch.open(location)
4644
except errors.DivergedBranches:
4645
raise errors.BzrCommandError('These branches have diverged.'
4646
' Try merging, and then bind again.')
4647
if b.get_config().has_explicit_nickname():
4648
b.nick = b_other.nick
4651
class cmd_unbind(Command):
4652
"""Convert the current checkout into a regular branch.
4654
After unbinding, the local branch is considered independent and subsequent
4655
commits will be local only.
4658
_see_also = ['checkouts', 'bind']
4663
b, relpath = Branch.open_containing(u'.')
4665
raise errors.BzrCommandError('Local branch is not bound')
4668
class cmd_uncommit(Command):
4669
"""Remove the last committed revision.
4671
--verbose will print out what is being removed.
4672
--dry-run will go through all the motions, but not actually
4675
If --revision is specified, uncommit revisions to leave the branch at the
4676
specified revision. For example, "bzr uncommit -r 15" will leave the
4677
branch at revision 15.
4679
Uncommit leaves the working tree ready for a new commit. The only change
4680
it may make is to restore any pending merges that were present before
4684
# TODO: jam 20060108 Add an option to allow uncommit to remove
4685
# unreferenced information in 'branch-as-repository' branches.
4686
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4687
# information in shared branches as well.
4688
_see_also = ['commit']
4689
takes_options = ['verbose', 'revision',
4690
Option('dry-run', help='Don\'t actually make changes.'),
4691
Option('force', help='Say yes to all questions.'),
4693
help="Only remove the commits from the local branch"
4694
" when in a checkout."
4697
takes_args = ['location?']
4699
encoding_type = 'replace'
4701
def run(self, location=None,
4702
dry_run=False, verbose=False,
4703
revision=None, force=False, local=False):
4704
if location is None:
4706
control, relpath = bzrdir.BzrDir.open_containing(location)
4708
tree = control.open_workingtree()
4710
except (errors.NoWorkingTree, errors.NotLocalUrl):
4712
b = control.open_branch()
4714
if tree is not None:
4716
self.add_cleanup(tree.unlock)
4719
self.add_cleanup(b.unlock)
4720
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4722
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4723
from bzrlib.log import log_formatter, show_log
4724
from bzrlib.uncommit import uncommit
4726
last_revno, last_rev_id = b.last_revision_info()
4729
if revision is None:
4731
rev_id = last_rev_id
4733
# 'bzr uncommit -r 10' actually means uncommit
4734
# so that the final tree is at revno 10.
4735
# but bzrlib.uncommit.uncommit() actually uncommits
4736
# the revisions that are supplied.
4737
# So we need to offset it by one
4738
revno = revision[0].in_history(b).revno + 1
4739
if revno <= last_revno:
4740
rev_id = b.get_rev_id(revno)
4742
if rev_id is None or _mod_revision.is_null(rev_id):
4743
self.outf.write('No revisions to uncommit.\n')
4746
lf = log_formatter('short',
4748
show_timezone='original')
4753
direction='forward',
4754
start_revision=revno,
4755
end_revision=last_revno)
4758
self.outf.write('Dry-run, pretending to remove'
4759
' the above revisions.\n')
4761
self.outf.write('The above revision(s) will be removed.\n')
4764
if not ui.ui_factory.get_boolean('Are you sure'):
4765
self.outf.write('Canceled')
4768
mutter('Uncommitting from {%s} to {%s}',
4769
last_rev_id, rev_id)
4770
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4771
revno=revno, local=local)
4772
self.outf.write('You can restore the old tip by running:\n'
4773
' bzr pull . -r revid:%s\n' % last_rev_id)
4776
class cmd_break_lock(Command):
4777
"""Break a dead lock on a repository, branch or working directory.
4779
CAUTION: Locks should only be broken when you are sure that the process
4780
holding the lock has been stopped.
4782
You can get information on what locks are open via the 'bzr info
4783
[location]' command.
4787
bzr break-lock bzr+ssh://example.com/bzr/foo
4789
takes_args = ['location?']
4791
def run(self, location=None, show=False):
4792
if location is None:
4794
control, relpath = bzrdir.BzrDir.open_containing(location)
4796
control.break_lock()
4797
except NotImplementedError:
4801
class cmd_wait_until_signalled(Command):
4802
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4804
This just prints a line to signal when it is ready, then blocks on stdin.
4810
sys.stdout.write("running\n")
4812
sys.stdin.readline()
4815
class cmd_serve(Command):
4816
"""Run the bzr server."""
4818
aliases = ['server']
4822
help='Serve on stdin/out for use from inetd or sshd.'),
4823
RegistryOption('protocol',
4824
help="Protocol to serve.",
4825
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4826
value_switches=True),
4828
help='Listen for connections on nominated port of the form '
4829
'[hostname:]portnumber. Passing 0 as the port number will '
4830
'result in a dynamically allocated port. The default port '
4831
'depends on the protocol.',
4834
help='Serve contents of this directory.',
4836
Option('allow-writes',
4837
help='By default the server is a readonly server. Supplying '
4838
'--allow-writes enables write access to the contents of '
4839
'the served directory and below. Note that ``bzr serve`` '
4840
'does not perform authentication, so unless some form of '
4841
'external authentication is arranged supplying this '
4842
'option leads to global uncontrolled write access to your '
4847
def get_host_and_port(self, port):
4848
"""Return the host and port to run the smart server on.
4850
If 'port' is None, None will be returned for the host and port.
4852
If 'port' has a colon in it, the string before the colon will be
4853
interpreted as the host.
4855
:param port: A string of the port to run the server on.
4856
:return: A tuple of (host, port), where 'host' is a host name or IP,
4857
and port is an integer TCP/IP port.
4860
if port is not None:
4862
host, port = port.split(':')
4866
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4868
from bzrlib.transport import get_transport, transport_server_registry
4869
if directory is None:
4870
directory = os.getcwd()
4871
if protocol is None:
4872
protocol = transport_server_registry.get()
4873
host, port = self.get_host_and_port(port)
4874
url = urlutils.local_path_to_url(directory)
4875
if not allow_writes:
4876
url = 'readonly+' + url
4877
transport = get_transport(url)
4878
protocol(transport, host, port, inet)
4881
class cmd_join(Command):
4882
"""Combine a tree into its containing tree.
4884
This command requires the target tree to be in a rich-root format.
4886
The TREE argument should be an independent tree, inside another tree, but
4887
not part of it. (Such trees can be produced by "bzr split", but also by
4888
running "bzr branch" with the target inside a tree.)
4890
The result is a combined tree, with the subtree no longer an independant
4891
part. This is marked as a merge of the subtree into the containing tree,
4892
and all history is preserved.
4895
_see_also = ['split']
4896
takes_args = ['tree']
4898
Option('reference', help='Join by reference.', hidden=True),
4901
def run(self, tree, reference=False):
4902
sub_tree = WorkingTree.open(tree)
4903
parent_dir = osutils.dirname(sub_tree.basedir)
4904
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4905
repo = containing_tree.branch.repository
4906
if not repo.supports_rich_root():
4907
raise errors.BzrCommandError(
4908
"Can't join trees because %s doesn't support rich root data.\n"
4909
"You can use bzr upgrade on the repository."
4913
containing_tree.add_reference(sub_tree)
4914
except errors.BadReferenceTarget, e:
4915
# XXX: Would be better to just raise a nicely printable
4916
# exception from the real origin. Also below. mbp 20070306
4917
raise errors.BzrCommandError("Cannot join %s. %s" %
4921
containing_tree.subsume(sub_tree)
4922
except errors.BadSubsumeSource, e:
4923
raise errors.BzrCommandError("Cannot join %s. %s" %
4927
class cmd_split(Command):
4928
"""Split a subdirectory of a tree into a separate tree.
4930
This command will produce a target tree in a format that supports
4931
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4932
converted into earlier formats like 'dirstate-tags'.
4934
The TREE argument should be a subdirectory of a working tree. That
4935
subdirectory will be converted into an independent tree, with its own
4936
branch. Commits in the top-level tree will not apply to the new subtree.
4939
_see_also = ['join']
4940
takes_args = ['tree']
4942
def run(self, tree):
4943
containing_tree, subdir = WorkingTree.open_containing(tree)
4944
sub_id = containing_tree.path2id(subdir)
4946
raise errors.NotVersionedError(subdir)
4948
containing_tree.extract(sub_id)
4949
except errors.RootNotRich:
4950
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4953
class cmd_merge_directive(Command):
4954
"""Generate a merge directive for auto-merge tools.
4956
A directive requests a merge to be performed, and also provides all the
4957
information necessary to do so. This means it must either include a
4958
revision bundle, or the location of a branch containing the desired
4961
A submit branch (the location to merge into) must be supplied the first
4962
time the command is issued. After it has been supplied once, it will
4963
be remembered as the default.
4965
A public branch is optional if a revision bundle is supplied, but required
4966
if --diff or --plain is specified. It will be remembered as the default
4967
after the first use.
4970
takes_args = ['submit_branch?', 'public_branch?']
4974
_see_also = ['send']
4977
RegistryOption.from_kwargs('patch-type',
4978
'The type of patch to include in the directive.',
4980
value_switches=True,
4982
bundle='Bazaar revision bundle (default).',
4983
diff='Normal unified diff.',
4984
plain='No patch, just directive.'),
4985
Option('sign', help='GPG-sign the directive.'), 'revision',
4986
Option('mail-to', type=str,
4987
help='Instead of printing the directive, email to this address.'),
4988
Option('message', type=str, short_name='m',
4989
help='Message to use when committing this merge.')
4992
encoding_type = 'exact'
4994
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4995
sign=False, revision=None, mail_to=None, message=None):
4996
from bzrlib.revision import ensure_null, NULL_REVISION
4997
include_patch, include_bundle = {
4998
'plain': (False, False),
4999
'diff': (True, False),
5000
'bundle': (True, True),
5002
branch = Branch.open('.')
5003
stored_submit_branch = branch.get_submit_branch()
5004
if submit_branch is None:
5005
submit_branch = stored_submit_branch
5007
if stored_submit_branch is None:
5008
branch.set_submit_branch(submit_branch)
5009
if submit_branch is None:
5010
submit_branch = branch.get_parent()
5011
if submit_branch is None:
5012
raise errors.BzrCommandError('No submit branch specified or known')
5014
stored_public_branch = branch.get_public_branch()
5015
if public_branch is None:
5016
public_branch = stored_public_branch
5017
elif stored_public_branch is None:
5018
branch.set_public_branch(public_branch)
5019
if not include_bundle and public_branch is None:
5020
raise errors.BzrCommandError('No public branch specified or'
5022
base_revision_id = None
5023
if revision is not None:
5024
if len(revision) > 2:
5025
raise errors.BzrCommandError('bzr merge-directive takes '
5026
'at most two one revision identifiers')
5027
revision_id = revision[-1].as_revision_id(branch)
5028
if len(revision) == 2:
5029
base_revision_id = revision[0].as_revision_id(branch)
5031
revision_id = branch.last_revision()
5032
revision_id = ensure_null(revision_id)
5033
if revision_id == NULL_REVISION:
5034
raise errors.BzrCommandError('No revisions to bundle.')
5035
directive = merge_directive.MergeDirective2.from_objects(
5036
branch.repository, revision_id, time.time(),
5037
osutils.local_time_offset(), submit_branch,
5038
public_branch=public_branch, include_patch=include_patch,
5039
include_bundle=include_bundle, message=message,
5040
base_revision_id=base_revision_id)
5043
self.outf.write(directive.to_signed(branch))
5045
self.outf.writelines(directive.to_lines())
5047
message = directive.to_email(mail_to, branch, sign)
5048
s = SMTPConnection(branch.get_config())
5049
s.send_email(message)
5052
class cmd_send(Command):
5053
"""Mail or create a merge-directive for submitting changes.
5055
A merge directive provides many things needed for requesting merges:
5057
* A machine-readable description of the merge to perform
5059
* An optional patch that is a preview of the changes requested
5061
* An optional bundle of revision data, so that the changes can be applied
5062
directly from the merge directive, without retrieving data from a
5065
`bzr send` creates a compact data set that, when applied using bzr
5066
merge, has the same effect as merging from the source branch.
5068
By default the merge directive is self-contained and can be applied to any
5069
branch containing submit_branch in its ancestory without needing access to
5072
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5073
revisions, but only a structured request to merge from the
5074
public_location. In that case the public_branch is needed and it must be
5075
up-to-date and accessible to the recipient. The public_branch is always
5076
included if known, so that people can check it later.
5078
The submit branch defaults to the parent of the source branch, but can be
5079
overridden. Both submit branch and public branch will be remembered in
5080
branch.conf the first time they are used for a particular branch. The
5081
source branch defaults to that containing the working directory, but can
5082
be changed using --from.
5084
In order to calculate those changes, bzr must analyse the submit branch.
5085
Therefore it is most efficient for the submit branch to be a local mirror.
5086
If a public location is known for the submit_branch, that location is used
5087
in the merge directive.
5089
The default behaviour is to send the merge directive by mail, unless -o is
5090
given, in which case it is sent to a file.
5092
Mail is sent using your preferred mail program. This should be transparent
5093
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5094
If the preferred client can't be found (or used), your editor will be used.
5096
To use a specific mail program, set the mail_client configuration option.
5097
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5098
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5099
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5100
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5103
If mail is being sent, a to address is required. This can be supplied
5104
either on the commandline, by setting the submit_to configuration
5105
option in the branch itself or the child_submit_to configuration option
5106
in the submit branch.
5108
Two formats are currently supported: "4" uses revision bundle format 4 and
5109
merge directive format 2. It is significantly faster and smaller than
5110
older formats. It is compatible with Bazaar 0.19 and later. It is the
5111
default. "0.9" uses revision bundle format 0.9 and merge directive
5112
format 1. It is compatible with Bazaar 0.12 - 0.18.
5114
The merge directives created by bzr send may be applied using bzr merge or
5115
bzr pull by specifying a file containing a merge directive as the location.
5117
bzr send makes extensive use of public locations to map local locations into
5118
URLs that can be used by other people. See `bzr help configuration` to
5119
set them, and use `bzr info` to display them.
5122
encoding_type = 'exact'
5124
_see_also = ['merge', 'pull']
5126
takes_args = ['submit_branch?', 'public_branch?']
5130
help='Do not include a bundle in the merge directive.'),
5131
Option('no-patch', help='Do not include a preview patch in the merge'
5134
help='Remember submit and public branch.'),
5136
help='Branch to generate the submission from, '
5137
'rather than the one containing the working directory.',
5140
Option('output', short_name='o',
5141
help='Write merge directive to this file; '
5142
'use - for stdout.',
5145
help='Refuse to send if there are uncommitted changes in'
5146
' the working tree, --no-strict disables the check.'),
5147
Option('mail-to', help='Mail the request to this address.',
5151
Option('body', help='Body for the email.', type=unicode),
5152
RegistryOption('format',
5153
help='Use the specified output format.',
5154
lazy_registry=('bzrlib.send', 'format_registry')),
5157
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5158
no_patch=False, revision=None, remember=False, output=None,
5159
format=None, mail_to=None, message=None, body=None,
5160
strict=None, **kwargs):
5161
from bzrlib.send import send
5162
return send(submit_branch, revision, public_branch, remember,
5163
format, no_bundle, no_patch, output,
5164
kwargs.get('from', '.'), mail_to, message, body,
5169
class cmd_bundle_revisions(cmd_send):
5170
"""Create a merge-directive for submitting changes.
5172
A merge directive provides many things needed for requesting merges:
5174
* A machine-readable description of the merge to perform
5176
* An optional patch that is a preview of the changes requested
5178
* An optional bundle of revision data, so that the changes can be applied
5179
directly from the merge directive, without retrieving data from a
5182
If --no-bundle is specified, then public_branch is needed (and must be
5183
up-to-date), so that the receiver can perform the merge using the
5184
public_branch. The public_branch is always included if known, so that
5185
people can check it later.
5187
The submit branch defaults to the parent, but can be overridden. Both
5188
submit branch and public branch will be remembered if supplied.
5190
If a public_branch is known for the submit_branch, that public submit
5191
branch is used in the merge instructions. This means that a local mirror
5192
can be used as your actual submit branch, once you have set public_branch
5195
Two formats are currently supported: "4" uses revision bundle format 4 and
5196
merge directive format 2. It is significantly faster and smaller than
5197
older formats. It is compatible with Bazaar 0.19 and later. It is the
5198
default. "0.9" uses revision bundle format 0.9 and merge directive
5199
format 1. It is compatible with Bazaar 0.12 - 0.18.
5204
help='Do not include a bundle in the merge directive.'),
5205
Option('no-patch', help='Do not include a preview patch in the merge'
5208
help='Remember submit and public branch.'),
5210
help='Branch to generate the submission from, '
5211
'rather than the one containing the working directory.',
5214
Option('output', short_name='o', help='Write directive to this file.',
5217
help='Refuse to bundle revisions if there are uncommitted'
5218
' changes in the working tree, --no-strict disables the check.'),
5220
RegistryOption('format',
5221
help='Use the specified output format.',
5222
lazy_registry=('bzrlib.send', 'format_registry')),
5224
aliases = ['bundle']
5226
_see_also = ['send', 'merge']
5230
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5231
no_patch=False, revision=None, remember=False, output=None,
5232
format=None, strict=None, **kwargs):
5235
from bzrlib.send import send
5236
return send(submit_branch, revision, public_branch, remember,
5237
format, no_bundle, no_patch, output,
5238
kwargs.get('from', '.'), None, None, None,
5239
self.outf, strict=strict)
5242
class cmd_tag(Command):
5243
"""Create, remove or modify a tag naming a revision.
5245
Tags give human-meaningful names to revisions. Commands that take a -r
5246
(--revision) option can be given -rtag:X, where X is any previously
5249
Tags are stored in the branch. Tags are copied from one branch to another
5250
along when you branch, push, pull or merge.
5252
It is an error to give a tag name that already exists unless you pass
5253
--force, in which case the tag is moved to point to the new revision.
5255
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5256
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5259
_see_also = ['commit', 'tags']
5260
takes_args = ['tag_name']
5263
help='Delete this tag rather than placing it.',
5266
help='Branch in which to place the tag.',
5271
help='Replace existing tags.',
5276
def run(self, tag_name,
5282
branch, relpath = Branch.open_containing(directory)
5284
self.add_cleanup(branch.unlock)
5286
branch.tags.delete_tag(tag_name)
5287
self.outf.write('Deleted tag %s.\n' % tag_name)
5290
if len(revision) != 1:
5291
raise errors.BzrCommandError(
5292
"Tags can only be placed on a single revision, "
5294
revision_id = revision[0].as_revision_id(branch)
5296
revision_id = branch.last_revision()
5297
if (not force) and branch.tags.has_tag(tag_name):
5298
raise errors.TagAlreadyExists(tag_name)
5299
branch.tags.set_tag(tag_name, revision_id)
5300
self.outf.write('Created tag %s.\n' % tag_name)
5303
class cmd_tags(Command):
5306
This command shows a table of tag names and the revisions they reference.
5312
help='Branch whose tags should be displayed.',
5316
RegistryOption.from_kwargs('sort',
5317
'Sort tags by different criteria.', title='Sorting',
5318
alpha='Sort tags lexicographically (default).',
5319
time='Sort tags chronologically.',
5332
branch, relpath = Branch.open_containing(directory)
5334
tags = branch.tags.get_tag_dict().items()
5339
self.add_cleanup(branch.unlock)
5341
graph = branch.repository.get_graph()
5342
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5343
revid1, revid2 = rev1.rev_id, rev2.rev_id
5344
# only show revisions between revid1 and revid2 (inclusive)
5345
tags = [(tag, revid) for tag, revid in tags if
5346
graph.is_between(revid, revid1, revid2)]
5349
elif sort == 'time':
5351
for tag, revid in tags:
5353
revobj = branch.repository.get_revision(revid)
5354
except errors.NoSuchRevision:
5355
timestamp = sys.maxint # place them at the end
5357
timestamp = revobj.timestamp
5358
timestamps[revid] = timestamp
5359
tags.sort(key=lambda x: timestamps[x[1]])
5361
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5362
for index, (tag, revid) in enumerate(tags):
5364
revno = branch.revision_id_to_dotted_revno(revid)
5365
if isinstance(revno, tuple):
5366
revno = '.'.join(map(str, revno))
5367
except errors.NoSuchRevision:
5368
# Bad tag data/merges can lead to tagged revisions
5369
# which are not in this branch. Fail gracefully ...
5371
tags[index] = (tag, revno)
5373
for tag, revspec in tags:
5374
self.outf.write('%-20s %s\n' % (tag, revspec))
5377
class cmd_reconfigure(Command):
5378
"""Reconfigure the type of a bzr directory.
5380
A target configuration must be specified.
5382
For checkouts, the bind-to location will be auto-detected if not specified.
5383
The order of preference is
5384
1. For a lightweight checkout, the current bound location.
5385
2. For branches that used to be checkouts, the previously-bound location.
5386
3. The push location.
5387
4. The parent location.
5388
If none of these is available, --bind-to must be specified.
5391
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5392
takes_args = ['location?']
5394
RegistryOption.from_kwargs(
5396
title='Target type',
5397
help='The type to reconfigure the directory to.',
5398
value_switches=True, enum_switch=False,
5399
branch='Reconfigure to be an unbound branch with no working tree.',
5400
tree='Reconfigure to be an unbound branch with a working tree.',
5401
checkout='Reconfigure to be a bound branch with a working tree.',
5402
lightweight_checkout='Reconfigure to be a lightweight'
5403
' checkout (with no local history).',
5404
standalone='Reconfigure to be a standalone branch '
5405
'(i.e. stop using shared repository).',
5406
use_shared='Reconfigure to use a shared repository.',
5407
with_trees='Reconfigure repository to create '
5408
'working trees on branches by default.',
5409
with_no_trees='Reconfigure repository to not create '
5410
'working trees on branches by default.'
5412
Option('bind-to', help='Branch to bind checkout to.', type=str),
5414
help='Perform reconfiguration even if local changes'
5416
Option('stacked-on',
5417
help='Reconfigure a branch to be stacked on another branch.',
5421
help='Reconfigure a branch to be unstacked. This '
5422
'may require copying substantial data into it.',
5426
def run(self, location=None, target_type=None, bind_to=None, force=False,
5429
directory = bzrdir.BzrDir.open(location)
5430
if stacked_on and unstacked:
5431
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5432
elif stacked_on is not None:
5433
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5435
reconfigure.ReconfigureUnstacked().apply(directory)
5436
# At the moment you can use --stacked-on and a different
5437
# reconfiguration shape at the same time; there seems no good reason
5439
if target_type is None:
5440
if stacked_on or unstacked:
5443
raise errors.BzrCommandError('No target configuration '
5445
elif target_type == 'branch':
5446
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5447
elif target_type == 'tree':
5448
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5449
elif target_type == 'checkout':
5450
reconfiguration = reconfigure.Reconfigure.to_checkout(
5452
elif target_type == 'lightweight-checkout':
5453
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5455
elif target_type == 'use-shared':
5456
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5457
elif target_type == 'standalone':
5458
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5459
elif target_type == 'with-trees':
5460
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5462
elif target_type == 'with-no-trees':
5463
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5465
reconfiguration.apply(force)
5468
class cmd_switch(Command):
5469
"""Set the branch of a checkout and update.
5471
For lightweight checkouts, this changes the branch being referenced.
5472
For heavyweight checkouts, this checks that there are no local commits
5473
versus the current bound branch, then it makes the local branch a mirror
5474
of the new location and binds to it.
5476
In both cases, the working tree is updated and uncommitted changes
5477
are merged. The user can commit or revert these as they desire.
5479
Pending merges need to be committed or reverted before using switch.
5481
The path to the branch to switch to can be specified relative to the parent
5482
directory of the current branch. For example, if you are currently in a
5483
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5486
Bound branches use the nickname of its master branch unless it is set
5487
locally, in which case switching will update the local nickname to be
5491
takes_args = ['to_location?']
5492
takes_options = [Option('force',
5493
help='Switch even if local commits will be lost.'),
5495
Option('create-branch', short_name='b',
5496
help='Create the target branch from this one before'
5497
' switching to it.'),
5500
def run(self, to_location=None, force=False, create_branch=False,
5502
from bzrlib import switch
5504
revision = _get_one_revision('switch', revision)
5505
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5506
if to_location is None:
5507
if revision is None:
5508
raise errors.BzrCommandError('You must supply either a'
5509
' revision or a location')
5512
branch = control_dir.open_branch()
5513
had_explicit_nick = branch.get_config().has_explicit_nickname()
5514
except errors.NotBranchError:
5516
had_explicit_nick = False
5519
raise errors.BzrCommandError('cannot create branch without'
5521
to_location = directory_service.directories.dereference(
5523
if '/' not in to_location and '\\' not in to_location:
5524
# This path is meant to be relative to the existing branch
5525
this_url = self._get_branch_location(control_dir)
5526
to_location = urlutils.join(this_url, '..', to_location)
5527
to_branch = branch.bzrdir.sprout(to_location,
5528
possible_transports=[branch.bzrdir.root_transport],
5529
source_branch=branch).open_branch()
5532
to_branch = Branch.open(to_location)
5533
except errors.NotBranchError:
5534
this_url = self._get_branch_location(control_dir)
5535
to_branch = Branch.open(
5536
urlutils.join(this_url, '..', to_location))
5537
if revision is not None:
5538
revision = revision.as_revision_id(to_branch)
5539
switch.switch(control_dir, to_branch, force, revision_id=revision)
5540
if had_explicit_nick:
5541
branch = control_dir.open_branch() #get the new branch!
5542
branch.nick = to_branch.nick
5543
note('Switched to branch: %s',
5544
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5546
def _get_branch_location(self, control_dir):
5547
"""Return location of branch for this control dir."""
5549
this_branch = control_dir.open_branch()
5550
# This may be a heavy checkout, where we want the master branch
5551
master_location = this_branch.get_bound_location()
5552
if master_location is not None:
5553
return master_location
5554
# If not, use a local sibling
5555
return this_branch.base
5556
except errors.NotBranchError:
5557
format = control_dir.find_branch_format()
5558
if getattr(format, 'get_reference', None) is not None:
5559
return format.get_reference(control_dir)
5561
return control_dir.root_transport.base
5564
class cmd_view(Command):
5565
"""Manage filtered views.
5567
Views provide a mask over the tree so that users can focus on
5568
a subset of a tree when doing their work. After creating a view,
5569
commands that support a list of files - status, diff, commit, etc -
5570
effectively have that list of files implicitly given each time.
5571
An explicit list of files can still be given but those files
5572
must be within the current view.
5574
In most cases, a view has a short life-span: it is created to make
5575
a selected change and is deleted once that change is committed.
5576
At other times, you may wish to create one or more named views
5577
and switch between them.
5579
To disable the current view without deleting it, you can switch to
5580
the pseudo view called ``off``. This can be useful when you need
5581
to see the whole tree for an operation or two (e.g. merge) but
5582
want to switch back to your view after that.
5585
To define the current view::
5587
bzr view file1 dir1 ...
5589
To list the current view::
5593
To delete the current view::
5597
To disable the current view without deleting it::
5599
bzr view --switch off
5601
To define a named view and switch to it::
5603
bzr view --name view-name file1 dir1 ...
5605
To list a named view::
5607
bzr view --name view-name
5609
To delete a named view::
5611
bzr view --name view-name --delete
5613
To switch to a named view::
5615
bzr view --switch view-name
5617
To list all views defined::
5621
To delete all views::
5623
bzr view --delete --all
5627
takes_args = ['file*']
5630
help='Apply list or delete action to all views.',
5633
help='Delete the view.',
5636
help='Name of the view to define, list or delete.',
5640
help='Name of the view to switch to.',
5645
def run(self, file_list,
5651
tree, file_list = tree_files(file_list, apply_view=False)
5652
current_view, view_dict = tree.views.get_view_info()
5657
raise errors.BzrCommandError(
5658
"Both --delete and a file list specified")
5660
raise errors.BzrCommandError(
5661
"Both --delete and --switch specified")
5663
tree.views.set_view_info(None, {})
5664
self.outf.write("Deleted all views.\n")
5666
raise errors.BzrCommandError("No current view to delete")
5668
tree.views.delete_view(name)
5669
self.outf.write("Deleted '%s' view.\n" % name)
5672
raise errors.BzrCommandError(
5673
"Both --switch and a file list specified")
5675
raise errors.BzrCommandError(
5676
"Both --switch and --all specified")
5677
elif switch == 'off':
5678
if current_view is None:
5679
raise errors.BzrCommandError("No current view to disable")
5680
tree.views.set_view_info(None, view_dict)
5681
self.outf.write("Disabled '%s' view.\n" % (current_view))
5683
tree.views.set_view_info(switch, view_dict)
5684
view_str = views.view_display_str(tree.views.lookup_view())
5685
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5688
self.outf.write('Views defined:\n')
5689
for view in sorted(view_dict):
5690
if view == current_view:
5694
view_str = views.view_display_str(view_dict[view])
5695
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5697
self.outf.write('No views defined.\n')
5700
# No name given and no current view set
5703
raise errors.BzrCommandError(
5704
"Cannot change the 'off' pseudo view")
5705
tree.views.set_view(name, sorted(file_list))
5706
view_str = views.view_display_str(tree.views.lookup_view())
5707
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5711
# No name given and no current view set
5712
self.outf.write('No current view.\n')
5714
view_str = views.view_display_str(tree.views.lookup_view(name))
5715
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5718
class cmd_hooks(Command):
5724
for hook_key in sorted(hooks.known_hooks.keys()):
5725
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5726
self.outf.write("%s:\n" % type(some_hooks).__name__)
5727
for hook_name, hook_point in sorted(some_hooks.items()):
5728
self.outf.write(" %s:\n" % (hook_name,))
5729
found_hooks = list(hook_point)
5731
for hook in found_hooks:
5732
self.outf.write(" %s\n" %
5733
(some_hooks.get_hook_name(hook),))
5735
self.outf.write(" <no hooks installed>\n")
5738
class cmd_shelve(Command):
5739
"""Temporarily set aside some changes from the current tree.
5741
Shelve allows you to temporarily put changes you've made "on the shelf",
5742
ie. out of the way, until a later time when you can bring them back from
5743
the shelf with the 'unshelve' command. The changes are stored alongside
5744
your working tree, and so they aren't propagated along with your branch nor
5745
will they survive its deletion.
5747
If shelve --list is specified, previously-shelved changes are listed.
5749
Shelve is intended to help separate several sets of changes that have
5750
been inappropriately mingled. If you just want to get rid of all changes
5751
and you don't need to restore them later, use revert. If you want to
5752
shelve all text changes at once, use shelve --all.
5754
If filenames are specified, only the changes to those files will be
5755
shelved. Other files will be left untouched.
5757
If a revision is specified, changes since that revision will be shelved.
5759
You can put multiple items on the shelf, and by default, 'unshelve' will
5760
restore the most recently shelved changes.
5763
takes_args = ['file*']
5767
Option('all', help='Shelve all changes.'),
5769
RegistryOption('writer', 'Method to use for writing diffs.',
5770
bzrlib.option.diff_writer_registry,
5771
value_switches=True, enum_switch=False),
5773
Option('list', help='List shelved changes.'),
5775
help='Destroy removed changes instead of shelving them.'),
5777
_see_also = ['unshelve']
5779
def run(self, revision=None, all=False, file_list=None, message=None,
5780
writer=None, list=False, destroy=False):
5782
return self.run_for_list()
5783
from bzrlib.shelf_ui import Shelver
5785
writer = bzrlib.option.diff_writer_registry.get()
5787
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5788
file_list, message, destroy=destroy)
5793
except errors.UserAbort:
5796
def run_for_list(self):
5797
tree = WorkingTree.open_containing('.')[0]
5799
self.add_cleanup(tree.unlock)
5800
manager = tree.get_shelf_manager()
5801
shelves = manager.active_shelves()
5802
if len(shelves) == 0:
5803
note('No shelved changes.')
5805
for shelf_id in reversed(shelves):
5806
message = manager.get_metadata(shelf_id).get('message')
5808
message = '<no message>'
5809
self.outf.write('%3d: %s\n' % (shelf_id, message))
5813
class cmd_unshelve(Command):
5814
"""Restore shelved changes.
5816
By default, the most recently shelved changes are restored. However if you
5817
specify a shelf by id those changes will be restored instead. This works
5818
best when the changes don't depend on each other.
5821
takes_args = ['shelf_id?']
5823
RegistryOption.from_kwargs(
5824
'action', help="The action to perform.",
5825
enum_switch=False, value_switches=True,
5826
apply="Apply changes and remove from the shelf.",
5827
dry_run="Show changes, but do not apply or remove them.",
5828
preview="Instead of unshelving the changes, show the diff that "
5829
"would result from unshelving.",
5830
delete_only="Delete changes without applying them.",
5831
keep="Apply changes but don't delete them.",
5834
_see_also = ['shelve']
5836
def run(self, shelf_id=None, action='apply'):
5837
from bzrlib.shelf_ui import Unshelver
5838
unshelver = Unshelver.from_args(shelf_id, action)
5842
unshelver.tree.unlock()
5845
class cmd_clean_tree(Command):
5846
"""Remove unwanted files from working tree.
5848
By default, only unknown files, not ignored files, are deleted. Versioned
5849
files are never deleted.
5851
Another class is 'detritus', which includes files emitted by bzr during
5852
normal operations and selftests. (The value of these files decreases with
5855
If no options are specified, unknown files are deleted. Otherwise, option
5856
flags are respected, and may be combined.
5858
To check what clean-tree will do, use --dry-run.
5860
takes_options = [Option('ignored', help='Delete all ignored files.'),
5861
Option('detritus', help='Delete conflict files, merge'
5862
' backups, and failed selftest dirs.'),
5864
help='Delete files unknown to bzr (default).'),
5865
Option('dry-run', help='Show files to delete instead of'
5867
Option('force', help='Do not prompt before deleting.')]
5868
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5870
from bzrlib.clean_tree import clean_tree
5871
if not (unknown or ignored or detritus):
5875
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5876
dry_run=dry_run, no_prompt=force)
5879
class cmd_reference(Command):
5880
"""list, view and set branch locations for nested trees.
5882
If no arguments are provided, lists the branch locations for nested trees.
5883
If one argument is provided, display the branch location for that tree.
5884
If two arguments are provided, set the branch location for that tree.
5889
takes_args = ['path?', 'location?']
5891
def run(self, path=None, location=None):
5893
if path is not None:
5895
tree, branch, relpath =(
5896
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5897
if path is not None:
5900
tree = branch.basis_tree()
5902
info = branch._get_all_reference_info().iteritems()
5903
self._display_reference_info(tree, branch, info)
5905
file_id = tree.path2id(path)
5907
raise errors.NotVersionedError(path)
5908
if location is None:
5909
info = [(file_id, branch.get_reference_info(file_id))]
5910
self._display_reference_info(tree, branch, info)
5912
branch.set_reference_info(file_id, path, location)
5914
def _display_reference_info(self, tree, branch, info):
5916
for file_id, (path, location) in info:
5918
path = tree.id2path(file_id)
5919
except errors.NoSuchId:
5921
ref_list.append((path, location))
5922
for path, location in sorted(ref_list):
5923
self.outf.write('%s %s\n' % (path, location))
5926
# these get imported and then picked up by the scan for cmd_*
5927
# TODO: Some more consistent way to split command definitions across files;
5928
# we do need to load at least some information about them to know of
5929
# aliases. ideally we would avoid loading the implementation until the
5930
# details were needed.
5931
from bzrlib.cmd_version_info import cmd_version_info
5932
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5933
from bzrlib.bundle.commands import (
5936
from bzrlib.foreign import cmd_dpush
5937
from bzrlib.sign_my_commits import cmd_sign_my_commits
added
removed
bzrlib/builtins.py
