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 (
65
builtin_command_registry,
68
from bzrlib.option import (
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
81
return internal_tree_files(file_list, default_branch, canonicalize,
83
except errors.FileInWrongBranch, e:
84
raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
(e.path, file_list[0]))
88
def tree_files_for_add(file_list):
90
Return a tree and list of absolute paths from a file list.
92
Similar to tree_files, but add handles files a bit differently, so it a
93
custom implementation. In particular, MutableTreeTree.smart_add expects
94
absolute paths, which it immediately converts to relative paths.
96
# FIXME Would be nice to just return the relative paths like
97
# internal_tree_files does, but there are a large number of unit tests
98
# that assume the current interface to mutabletree.smart_add
100
tree, relpath = WorkingTree.open_containing(file_list[0])
101
if tree.supports_views():
102
view_files = tree.views.lookup_view()
104
for filename in file_list:
105
if not osutils.is_inside_any(view_files, filename):
106
raise errors.FileOutsideView(filename, view_files)
107
file_list = file_list[:]
108
file_list[0] = tree.abspath(relpath)
110
tree = WorkingTree.open_containing(u'.')[0]
111
if tree.supports_views():
112
view_files = tree.views.lookup_view()
114
file_list = view_files
115
view_str = views.view_display_str(view_files)
116
note("Ignoring files outside view. View is %s" % view_str)
117
return tree, file_list
120
def _get_one_revision(command_name, revisions):
121
if revisions is None:
123
if len(revisions) != 1:
124
raise errors.BzrCommandError(
125
'bzr %s --revision takes exactly one revision identifier' % (
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
"""Get a revision tree. Not suitable for commands that change the tree.
133
Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
and doing a commit/uncommit/pull will at best fail due to changing the
137
If tree is passed in, it should be already locked, for lifetime management
138
of the trees internal cached state.
142
if revisions is None:
144
rev_tree = tree.basis_tree()
146
rev_tree = branch.basis_tree()
148
revision = _get_one_revision(command_name, revisions)
149
rev_tree = revision.as_tree(branch)
153
# XXX: Bad function name; should possibly also be a class method of
154
# WorkingTree rather than a function.
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
157
"""Convert command-line paths to a WorkingTree and relative paths.
159
This is typically used for command-line processors that take one or
160
more filenames, and infer the workingtree that contains them.
162
The filenames given are not required to exist.
164
:param file_list: Filenames to convert.
166
:param default_branch: Fallback tree path to use if file_list is empty or
169
:param apply_view: if True and a view is set, apply it or check that
170
specified files are within it
172
:return: workingtree, [relative_paths]
174
if file_list is None or len(file_list) == 0:
175
tree = WorkingTree.open_containing(default_branch)[0]
176
if tree.supports_views() and apply_view:
177
view_files = tree.views.lookup_view()
179
file_list = view_files
180
view_str = views.view_display_str(view_files)
181
note("Ignoring files outside view. View is %s" % view_str)
182
return tree, file_list
183
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
return tree, safe_relpath_files(tree, file_list, canonicalize,
185
apply_view=apply_view)
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
"""Convert file_list into a list of relpaths in tree.
191
:param tree: A tree to operate on.
192
:param file_list: A list of user provided paths or None.
193
:param apply_view: if True and a view is set, apply it or check that
194
specified files are within it
195
:return: A list of relative paths.
196
:raises errors.PathNotChild: When a provided path is in a different tree
199
if file_list is None:
201
if tree.supports_views() and apply_view:
202
view_files = tree.views.lookup_view()
206
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
# doesn't - fix that up here before we enter the loop.
209
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
212
for filename in file_list:
214
relpath = fixer(osutils.dereference_path(filename))
215
if view_files and not osutils.is_inside_any(view_files, relpath):
216
raise errors.FileOutsideView(filename, view_files)
217
new_list.append(relpath)
218
except errors.PathNotChild:
219
raise errors.FileInWrongBranch(tree.branch, filename)
223
def _get_view_info_for_change_reporter(tree):
224
"""Get the view information from a tree for change reporting."""
227
current_view = tree.views.get_view_info()[0]
228
if current_view is not None:
229
view_info = (current_view, tree.views.lookup_view())
230
except errors.ViewsNotSupported:
235
# TODO: Make sure no commands unconditionally use the working directory as a
236
# branch. If a filename argument is used, the first of them should be used to
237
# specify the branch. (Perhaps this can be factored out into some kind of
238
# Argument class, representing a file in a branch, where the first occurrence
241
class cmd_status(Command):
242
"""Display status summary.
244
This reports on versioned and unknown files, reporting them
245
grouped by state. Possible states are:
248
Versioned in the working copy but not in the previous revision.
251
Versioned in the previous revision but removed or deleted
255
Path of this file changed from the previous revision;
256
the text may also have changed. This includes files whose
257
parent directory was renamed.
260
Text has changed since the previous revision.
263
File kind has been changed (e.g. from file to directory).
266
Not versioned and not matching an ignore pattern.
268
Additionally for directories, symlinks and files with an executable
269
bit, Bazaar indicates their type using a trailing character: '/', '@'
272
To see ignored files use 'bzr ignored'. For details on the
273
changes to file texts, use 'bzr diff'.
275
Note that --short or -S gives status flags for each item, similar
276
to Subversion's status command. To get output similar to svn -q,
279
If no arguments are specified, the status of the entire working
280
directory is shown. Otherwise, only the status of the specified
281
files or directories is reported. If a directory is given, status
282
is reported for everything inside that directory.
284
Before merges are committed, the pending merge tip revisions are
285
shown. To see all pending merge revisions, use the -v option.
286
To skip the display of pending merge information altogether, use
287
the no-pending option or specify a file/directory.
289
If a revision argument is given, the status is calculated against
290
that revision, or between two revisions if two are provided.
293
# TODO: --no-recurse, --recurse options
295
takes_args = ['file*']
296
takes_options = ['show-ids', 'revision', 'change', 'verbose',
297
Option('short', help='Use short status indicators.',
299
Option('versioned', help='Only show versioned files.',
301
Option('no-pending', help='Don\'t show pending merges.',
304
aliases = ['st', 'stat']
306
encoding_type = 'replace'
307
_see_also = ['diff', 'revert', 'status-flags']
310
def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
versioned=False, no_pending=False, verbose=False):
312
from bzrlib.status import show_tree_status
314
if revision and len(revision) > 2:
315
raise errors.BzrCommandError('bzr status --revision takes exactly'
316
' one or two revision specifiers')
318
tree, relfile_list = tree_files(file_list)
319
# Avoid asking for specific files when that is not needed.
320
if relfile_list == ['']:
322
# Don't disable pending merges for full trees other than '.'.
323
if file_list == ['.']:
325
# A specific path within a tree was given.
326
elif relfile_list is not None:
328
show_tree_status(tree, show_ids=show_ids,
329
specific_files=relfile_list, revision=revision,
330
to_file=self.outf, short=short, versioned=versioned,
331
show_pending=(not no_pending), verbose=verbose)
334
class cmd_cat_revision(Command):
335
"""Write out metadata for a revision.
337
The revision to print can either be specified by a specific
338
revision identifier, or you can use --revision.
342
takes_args = ['revision_id?']
343
takes_options = ['revision']
344
# cat-revision is more for frontends so should be exact
347
def print_revision(self, revisions, revid):
348
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
record = stream.next()
350
if record.storage_kind == 'absent':
351
raise errors.NoSuchRevision(revisions, revid)
352
revtext = record.get_bytes_as('fulltext')
353
self.outf.write(revtext.decode('utf-8'))
356
def run(self, revision_id=None, revision=None):
357
if revision_id is not None and revision is not None:
358
raise errors.BzrCommandError('You can only supply one of'
359
' revision_id or --revision')
360
if revision_id is None and revision is None:
361
raise errors.BzrCommandError('You must supply either'
362
' --revision or a revision_id')
363
b = WorkingTree.open_containing(u'.')[0].branch
365
revisions = b.repository.revisions
366
if revisions is None:
367
raise errors.BzrCommandError('Repository %r does not support '
368
'access to raw revision texts')
370
b.repository.lock_read()
372
# TODO: jam 20060112 should cat-revision always output utf-8?
373
if revision_id is not None:
374
revision_id = osutils.safe_revision_id(revision_id, warn=False)
376
self.print_revision(revisions, revision_id)
377
except errors.NoSuchRevision:
378
msg = "The repository %s contains no revision %s." % (
379
b.repository.base, revision_id)
380
raise errors.BzrCommandError(msg)
381
elif revision is not None:
384
raise errors.BzrCommandError(
385
'You cannot specify a NULL revision.')
386
rev_id = rev.as_revision_id(b)
387
self.print_revision(revisions, rev_id)
389
b.repository.unlock()
392
class cmd_dump_btree(Command):
393
"""Dump the contents of a btree index file to stdout.
395
PATH is a btree index file, it can be any URL. This includes things like
396
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
398
By default, the tuples stored in the index file will be displayed. With
399
--raw, we will uncompress the pages, but otherwise display the raw bytes
403
# TODO: Do we want to dump the internal nodes as well?
404
# TODO: It would be nice to be able to dump the un-parsed information,
405
# rather than only going through iter_all_entries. However, this is
406
# good enough for a start
408
encoding_type = 'exact'
409
takes_args = ['path']
410
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
411
' rather than the parsed tuples.'),
414
def run(self, path, raw=False):
415
dirname, basename = osutils.split(path)
416
t = transport.get_transport(dirname)
418
self._dump_raw_bytes(t, basename)
420
self._dump_entries(t, basename)
422
def _get_index_and_bytes(self, trans, basename):
423
"""Create a BTreeGraphIndex and raw bytes."""
424
bt = btree_index.BTreeGraphIndex(trans, basename, None)
425
bytes = trans.get_bytes(basename)
426
bt._file = cStringIO.StringIO(bytes)
427
bt._size = len(bytes)
430
def _dump_raw_bytes(self, trans, basename):
433
# We need to parse at least the root node.
434
# This is because the first page of every row starts with an
435
# uncompressed header.
436
bt, bytes = self._get_index_and_bytes(trans, basename)
437
for page_idx, page_start in enumerate(xrange(0, len(bytes),
438
btree_index._PAGE_SIZE)):
439
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
440
page_bytes = bytes[page_start:page_end]
442
self.outf.write('Root node:\n')
443
header_end, data = bt._parse_header_from_bytes(page_bytes)
444
self.outf.write(page_bytes[:header_end])
446
self.outf.write('\nPage %d\n' % (page_idx,))
447
decomp_bytes = zlib.decompress(page_bytes)
448
self.outf.write(decomp_bytes)
449
self.outf.write('\n')
451
def _dump_entries(self, trans, basename):
453
st = trans.stat(basename)
454
except errors.TransportNotPossible:
455
# We can't stat, so we'll fake it because we have to do the 'get()'
457
bt, _ = self._get_index_and_bytes(trans, basename)
459
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
460
for node in bt.iter_all_entries():
461
# Node is made up of:
462
# (index, key, value, [references])
466
refs_as_tuples = None
468
refs_as_tuples = static_tuple.as_tuples(refs)
469
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
self.outf.write('%s\n' % (as_tuple,))
473
class cmd_remove_tree(Command):
474
"""Remove the working tree from a given branch/checkout.
476
Since a lightweight checkout is little more than a working tree
477
this will refuse to run against one.
479
To re-create the working tree, use "bzr checkout".
481
_see_also = ['checkout', 'working-trees']
482
takes_args = ['location*']
485
help='Remove the working tree even if it has '
486
'uncommitted changes.'),
489
def run(self, location_list, force=False):
490
if not location_list:
493
for location in location_list:
494
d = bzrdir.BzrDir.open(location)
497
working = d.open_workingtree()
498
except errors.NoWorkingTree:
499
raise errors.BzrCommandError("No working tree to remove")
500
except errors.NotLocalUrl:
501
raise errors.BzrCommandError("You cannot remove the working tree"
504
if (working.has_changes()):
505
raise errors.UncommittedChanges(working)
507
working_path = working.bzrdir.root_transport.base
508
branch_path = working.branch.bzrdir.root_transport.base
509
if working_path != branch_path:
510
raise errors.BzrCommandError("You cannot remove the working tree"
511
" from a lightweight checkout")
513
d.destroy_workingtree()
516
class cmd_revno(Command):
517
"""Show current revision number.
519
This is equal to the number of revisions on this branch.
523
takes_args = ['location?']
525
Option('tree', help='Show revno of working tree'),
529
def run(self, tree=False, location=u'.'):
532
wt = WorkingTree.open_containing(location)[0]
534
except (errors.NoWorkingTree, errors.NotLocalUrl):
535
raise errors.NoWorkingTree(location)
536
self.add_cleanup(wt.unlock)
537
revid = wt.last_revision()
539
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
540
except errors.NoSuchRevision:
542
revno = ".".join(str(n) for n in revno_t)
544
b = Branch.open_containing(location)[0]
546
self.add_cleanup(b.unlock)
549
self.outf.write(str(revno) + '\n')
552
class cmd_revision_info(Command):
553
"""Show revision number and revision id for a given revision identifier.
556
takes_args = ['revision_info*']
560
help='Branch to examine, '
561
'rather than the one containing the working directory.',
565
Option('tree', help='Show revno of working tree'),
569
def run(self, revision=None, directory=u'.', tree=False,
570
revision_info_list=[]):
573
wt = WorkingTree.open_containing(directory)[0]
576
self.add_cleanup(wt.unlock)
577
except (errors.NoWorkingTree, errors.NotLocalUrl):
579
b = Branch.open_containing(directory)[0]
581
self.add_cleanup(b.unlock)
583
if revision is not None:
584
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
585
if revision_info_list is not None:
586
for rev_str in revision_info_list:
587
rev_spec = RevisionSpec.from_string(rev_str)
588
revision_ids.append(rev_spec.as_revision_id(b))
589
# No arguments supplied, default to the last revision
590
if len(revision_ids) == 0:
593
raise errors.NoWorkingTree(directory)
594
revision_ids.append(wt.last_revision())
596
revision_ids.append(b.last_revision())
600
for revision_id in revision_ids:
602
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
603
revno = '.'.join(str(i) for i in dotted_revno)
604
except errors.NoSuchRevision:
606
maxlen = max(maxlen, len(revno))
607
revinfos.append([revno, revision_id])
611
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
614
class cmd_add(Command):
615
"""Add specified files or directories.
617
In non-recursive mode, all the named items are added, regardless
618
of whether they were previously ignored. A warning is given if
619
any of the named files are already versioned.
621
In recursive mode (the default), files are treated the same way
622
but the behaviour for directories is different. Directories that
623
are already versioned do not give a warning. All directories,
624
whether already versioned or not, are searched for files or
625
subdirectories that are neither versioned or ignored, and these
626
are added. This search proceeds recursively into versioned
627
directories. If no names are given '.' is assumed.
629
Therefore simply saying 'bzr add' will version all files that
630
are currently unknown.
632
Adding a file whose parent directory is not versioned will
633
implicitly add the parent, and so on up to the root. This means
634
you should never need to explicitly add a directory, they'll just
635
get added when you add a file in the directory.
637
--dry-run will show which files would be added, but not actually
640
--file-ids-from will try to use the file ids from the supplied path.
641
It looks up ids trying to find a matching parent directory with the
642
same filename, and then by pure path. This option is rarely needed
643
but can be useful when adding the same logical file into two
644
branches that will be merged later (without showing the two different
645
adds as a conflict). It is also useful when merging another project
646
into a subdirectory of this one.
648
Any files matching patterns in the ignore list will not be added
649
unless they are explicitly mentioned.
651
takes_args = ['file*']
654
help="Don't recursively add the contents of directories."),
656
help="Show what would be done, but don't actually do anything."),
658
Option('file-ids-from',
660
help='Lookup file ids from this tree.'),
662
encoding_type = 'replace'
663
_see_also = ['remove', 'ignore']
665
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
670
if file_ids_from is not None:
672
base_tree, base_path = WorkingTree.open_containing(
674
except errors.NoWorkingTree:
675
base_branch, base_path = Branch.open_containing(
677
base_tree = base_branch.basis_tree()
679
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
680
to_file=self.outf, should_print=(not is_quiet()))
682
action = bzrlib.add.AddAction(to_file=self.outf,
683
should_print=(not is_quiet()))
686
base_tree.lock_read()
687
self.add_cleanup(base_tree.unlock)
688
tree, file_list = tree_files_for_add(file_list)
689
added, ignored = tree.smart_add(file_list, not
690
no_recurse, action=action, save=not dry_run)
694
for glob in sorted(ignored.keys()):
695
for path in ignored[glob]:
696
self.outf.write("ignored %s matching \"%s\"\n"
700
class cmd_mkdir(Command):
701
"""Create a new versioned directory.
703
This is equivalent to creating the directory and then adding it.
706
takes_args = ['dir+']
707
encoding_type = 'replace'
709
def run(self, dir_list):
711
wt, dd = WorkingTree.open_containing(d)
712
base = os.path.dirname(dd)
713
id = wt.path2id(base)
717
self.outf.write('added %s\n' % d)
719
raise errors.NotVersionedError(path=base)
722
class cmd_relpath(Command):
723
"""Show path of a file relative to root"""
725
takes_args = ['filename']
729
def run(self, filename):
730
# TODO: jam 20050106 Can relpath return a munged path if
731
# sys.stdout encoding cannot represent it?
732
tree, relpath = WorkingTree.open_containing(filename)
733
self.outf.write(relpath)
734
self.outf.write('\n')
737
class cmd_inventory(Command):
738
"""Show inventory of the current working copy or a revision.
740
It is possible to limit the output to a particular entry
741
type using the --kind option. For example: --kind file.
743
It is also possible to restrict the list of files to a specific
744
set. For example: bzr inventory --show-ids this/file
753
help='List entries of a particular kind: file, directory, symlink.',
756
takes_args = ['file*']
759
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
760
if kind and kind not in ['file', 'directory', 'symlink']:
761
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
763
revision = _get_one_revision('inventory', revision)
764
work_tree, file_list = tree_files(file_list)
765
work_tree.lock_read()
766
self.add_cleanup(work_tree.unlock)
767
if revision is not None:
768
tree = revision.as_tree(work_tree.branch)
770
extra_trees = [work_tree]
772
self.add_cleanup(tree.unlock)
777
if file_list is not None:
778
file_ids = tree.paths2ids(file_list, trees=extra_trees,
779
require_versioned=True)
780
# find_ids_across_trees may include some paths that don't
782
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
783
for file_id in file_ids if file_id in tree)
785
entries = tree.inventory.entries()
788
for path, entry in entries:
789
if kind and kind != entry.kind:
792
self.outf.write('%-50s %s\n' % (path, entry.file_id))
794
self.outf.write(path)
795
self.outf.write('\n')
798
class cmd_mv(Command):
799
"""Move or rename a file.
802
bzr mv OLDNAME NEWNAME
804
bzr mv SOURCE... DESTINATION
806
If the last argument is a versioned directory, all the other names
807
are moved into it. Otherwise, there must be exactly two arguments
808
and the file is changed to a new name.
810
If OLDNAME does not exist on the filesystem but is versioned and
811
NEWNAME does exist on the filesystem but is not versioned, mv
812
assumes that the file has been manually moved and only updates
813
its internal inventory to reflect that change.
814
The same is valid when moving many SOURCE files to a DESTINATION.
816
Files cannot be moved between branches.
819
takes_args = ['names*']
820
takes_options = [Option("after", help="Move only the bzr identifier"
821
" of the file, because the file has already been moved."),
822
Option('auto', help='Automatically guess renames.'),
823
Option('dry-run', help='Avoid making changes when guessing renames.'),
825
aliases = ['move', 'rename']
826
encoding_type = 'replace'
828
def run(self, names_list, after=False, auto=False, dry_run=False):
830
return self.run_auto(names_list, after, dry_run)
832
raise errors.BzrCommandError('--dry-run requires --auto.')
833
if names_list is None:
835
if len(names_list) < 2:
836
raise errors.BzrCommandError("missing file argument")
837
tree, rel_names = tree_files(names_list, canonicalize=False)
838
tree.lock_tree_write()
839
self.add_cleanup(tree.unlock)
840
self._run(tree, names_list, rel_names, after)
842
def run_auto(self, names_list, after, dry_run):
843
if names_list is not None and len(names_list) > 1:
844
raise errors.BzrCommandError('Only one path may be specified to'
847
raise errors.BzrCommandError('--after cannot be specified with'
849
work_tree, file_list = tree_files(names_list, default_branch='.')
850
work_tree.lock_tree_write()
851
self.add_cleanup(work_tree.unlock)
852
rename_map.RenameMap.guess_renames(work_tree, dry_run)
854
def _run(self, tree, names_list, rel_names, after):
855
into_existing = osutils.isdir(names_list[-1])
856
if into_existing and len(names_list) == 2:
858
# a. case-insensitive filesystem and change case of dir
859
# b. move directory after the fact (if the source used to be
860
# a directory, but now doesn't exist in the working tree
861
# and the target is an existing directory, just rename it)
862
if (not tree.case_sensitive
863
and rel_names[0].lower() == rel_names[1].lower()):
864
into_existing = False
867
# 'fix' the case of a potential 'from'
868
from_id = tree.path2id(
869
tree.get_canonical_inventory_path(rel_names[0]))
870
if (not osutils.lexists(names_list[0]) and
871
from_id and inv.get_file_kind(from_id) == "directory"):
872
into_existing = False
875
# move into existing directory
876
# All entries reference existing inventory items, so fix them up
877
# for cicp file-systems.
878
rel_names = tree.get_canonical_inventory_paths(rel_names)
879
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
881
self.outf.write("%s => %s\n" % (src, dest))
883
if len(names_list) != 2:
884
raise errors.BzrCommandError('to mv multiple files the'
885
' destination must be a versioned'
888
# for cicp file-systems: the src references an existing inventory
890
src = tree.get_canonical_inventory_path(rel_names[0])
891
# Find the canonical version of the destination: In all cases, the
892
# parent of the target must be in the inventory, so we fetch the
893
# canonical version from there (we do not always *use* the
894
# canonicalized tail portion - we may be attempting to rename the
896
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
897
dest_parent = osutils.dirname(canon_dest)
898
spec_tail = osutils.basename(rel_names[1])
899
# For a CICP file-system, we need to avoid creating 2 inventory
900
# entries that differ only by case. So regardless of the case
901
# we *want* to use (ie, specified by the user or the file-system),
902
# we must always choose to use the case of any existing inventory
903
# items. The only exception to this is when we are attempting a
904
# case-only rename (ie, canonical versions of src and dest are
906
dest_id = tree.path2id(canon_dest)
907
if dest_id is None or tree.path2id(src) == dest_id:
908
# No existing item we care about, so work out what case we
909
# are actually going to use.
911
# If 'after' is specified, the tail must refer to a file on disk.
913
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
915
# pathjoin with an empty tail adds a slash, which breaks
917
dest_parent_fq = tree.basedir
919
dest_tail = osutils.canonical_relpath(
921
osutils.pathjoin(dest_parent_fq, spec_tail))
923
# not 'after', so case as specified is used
924
dest_tail = spec_tail
926
# Use the existing item so 'mv' fails with AlreadyVersioned.
927
dest_tail = os.path.basename(canon_dest)
928
dest = osutils.pathjoin(dest_parent, dest_tail)
929
mutter("attempting to move %s => %s", src, dest)
930
tree.rename_one(src, dest, after=after)
932
self.outf.write("%s => %s\n" % (src, dest))
935
class cmd_pull(Command):
936
"""Turn this branch into a mirror of another branch.
938
By default, this command only works on branches that have not diverged.
939
Branches are considered diverged if the destination branch's most recent
940
commit is one that has not been merged (directly or indirectly) into the
943
If branches have diverged, you can use 'bzr merge' to integrate the changes
944
from one into the other. Once one branch has merged, the other should
945
be able to pull it again.
947
If you want to replace your local changes and just want your branch to
948
match the remote one, use pull --overwrite. This will work even if the two
949
branches have diverged.
951
If there is no default location set, the first pull will set it. After
952
that, you can omit the location to use the default. To change the
953
default, use --remember. The value will only be saved if the remote
954
location can be accessed.
956
Note: The location can be specified either in the form of a branch,
957
or in the form of a path to a file containing a merge directive generated
961
_see_also = ['push', 'update', 'status-flags', 'send']
962
takes_options = ['remember', 'overwrite', 'revision',
963
custom_help('verbose',
964
help='Show logs of pulled revisions.'),
966
help='Branch to pull into, '
967
'rather than the one containing the working directory.',
972
help="Perform a local pull in a bound "
973
"branch. Local pulls are not applied to "
977
takes_args = ['location?']
978
encoding_type = 'replace'
980
def run(self, location=None, remember=False, overwrite=False,
981
revision=None, verbose=False,
982
directory=None, local=False):
983
# FIXME: too much stuff is in the command class
986
if directory is None:
989
tree_to = WorkingTree.open_containing(directory)[0]
990
branch_to = tree_to.branch
991
except errors.NoWorkingTree:
993
branch_to = Branch.open_containing(directory)[0]
995
if local and not branch_to.get_bound_location():
996
raise errors.LocalRequiresBoundBranch()
998
possible_transports = []
999
if location is not None:
1001
mergeable = bundle.read_mergeable_from_url(location,
1002
possible_transports=possible_transports)
1003
except errors.NotABundle:
1006
stored_loc = branch_to.get_parent()
1007
if location is None:
1008
if stored_loc is None:
1009
raise errors.BzrCommandError("No pull location known or"
1012
display_url = urlutils.unescape_for_display(stored_loc,
1015
self.outf.write("Using saved parent location: %s\n" % display_url)
1016
location = stored_loc
1018
revision = _get_one_revision('pull', revision)
1019
if mergeable is not None:
1020
if revision is not None:
1021
raise errors.BzrCommandError(
1022
'Cannot use -r with merge directives or bundles')
1023
mergeable.install_revisions(branch_to.repository)
1024
base_revision_id, revision_id, verified = \
1025
mergeable.get_merge_request(branch_to.repository)
1026
branch_from = branch_to
1028
branch_from = Branch.open(location,
1029
possible_transports=possible_transports)
1031
if branch_to.get_parent() is None or remember:
1032
branch_to.set_parent(branch_from.base)
1034
if branch_from is not branch_to:
1035
branch_from.lock_read()
1036
self.add_cleanup(branch_from.unlock)
1037
if revision is not None:
1038
revision_id = revision.as_revision_id(branch_from)
1040
branch_to.lock_write()
1041
self.add_cleanup(branch_to.unlock)
1042
if tree_to is not None:
1043
view_info = _get_view_info_for_change_reporter(tree_to)
1044
change_reporter = delta._ChangeReporter(
1045
unversioned_filter=tree_to.is_ignored,
1046
view_info=view_info)
1047
result = tree_to.pull(
1048
branch_from, overwrite, revision_id, change_reporter,
1049
possible_transports=possible_transports, local=local)
1051
result = branch_to.pull(
1052
branch_from, overwrite, revision_id, local=local)
1054
result.report(self.outf)
1055
if verbose and result.old_revid != result.new_revid:
1056
log.show_branch_change(
1057
branch_to, self.outf, result.old_revno,
1061
class cmd_push(Command):
1062
"""Update a mirror of this branch.
1064
The target branch will not have its working tree populated because this
1065
is both expensive, and is not supported on remote file systems.
1067
Some smart servers or protocols *may* put the working tree in place in
1070
This command only works on branches that have not diverged. Branches are
1071
considered diverged if the destination branch's most recent commit is one
1072
that has not been merged (directly or indirectly) by the source branch.
1074
If branches have diverged, you can use 'bzr push --overwrite' to replace
1075
the other branch completely, discarding its unmerged changes.
1077
If you want to ensure you have the different changes in the other branch,
1078
do a merge (see bzr help merge) from the other branch, and commit that.
1079
After that you will be able to do a push without '--overwrite'.
1081
If there is no default push location set, the first push will set it.
1082
After that, you can omit the location to use the default. To change the
1083
default, use --remember. The value will only be saved if the remote
1084
location can be accessed.
1087
_see_also = ['pull', 'update', 'working-trees']
1088
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1089
Option('create-prefix',
1090
help='Create the path leading up to the branch '
1091
'if it does not already exist.'),
1093
help='Branch to push from, '
1094
'rather than the one containing the working directory.',
1098
Option('use-existing-dir',
1099
help='By default push will fail if the target'
1100
' directory exists, but does not already'
1101
' have a control directory. This flag will'
1102
' allow push to proceed.'),
1104
help='Create a stacked branch that references the public location '
1105
'of the parent branch.'),
1106
Option('stacked-on',
1107
help='Create a stacked branch that refers to another branch '
1108
'for the commit history. Only the work not present in the '
1109
'referenced branch is included in the branch created.',
1112
help='Refuse to push if there are uncommitted changes in'
1113
' the working tree, --no-strict disables the check.'),
1115
takes_args = ['location?']
1116
encoding_type = 'replace'
1118
def run(self, location=None, remember=False, overwrite=False,
1119
create_prefix=False, verbose=False, revision=None,
1120
use_existing_dir=False, directory=None, stacked_on=None,
1121
stacked=False, strict=None):
1122
from bzrlib.push import _show_push_branch
1124
if directory is None:
1126
# Get the source branch
1128
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1130
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1131
if strict is None: strict = True # default value
1132
# Get the tip's revision_id
1133
revision = _get_one_revision('push', revision)
1134
if revision is not None:
1135
revision_id = revision.in_history(br_from).rev_id
1138
if strict and tree is not None and revision_id is None:
1139
if (tree.has_changes()):
1140
raise errors.UncommittedChanges(
1141
tree, more='Use --no-strict to force the push.')
1142
if tree.last_revision() != tree.branch.last_revision():
1143
# The tree has lost sync with its branch, there is little
1144
# chance that the user is aware of it but he can still force
1145
# the push with --no-strict
1146
raise errors.OutOfDateTree(
1147
tree, more='Use --no-strict to force the push.')
1149
# Get the stacked_on branch, if any
1150
if stacked_on is not None:
1151
stacked_on = urlutils.normalize_url(stacked_on)
1153
parent_url = br_from.get_parent()
1155
parent = Branch.open(parent_url)
1156
stacked_on = parent.get_public_branch()
1158
# I considered excluding non-http url's here, thus forcing
1159
# 'public' branches only, but that only works for some
1160
# users, so it's best to just depend on the user spotting an
1161
# error by the feedback given to them. RBC 20080227.
1162
stacked_on = parent_url
1164
raise errors.BzrCommandError(
1165
"Could not determine branch to refer to.")
1167
# Get the destination location
1168
if location is None:
1169
stored_loc = br_from.get_push_location()
1170
if stored_loc is None:
1171
raise errors.BzrCommandError(
1172
"No push location known or specified.")
1174
display_url = urlutils.unescape_for_display(stored_loc,
1176
self.outf.write("Using saved push location: %s\n" % display_url)
1177
location = stored_loc
1179
_show_push_branch(br_from, revision_id, location, self.outf,
1180
verbose=verbose, overwrite=overwrite, remember=remember,
1181
stacked_on=stacked_on, create_prefix=create_prefix,
1182
use_existing_dir=use_existing_dir)
1185
class cmd_branch(Command):
1186
"""Create a new branch that is a copy of an existing branch.
1188
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1189
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1190
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1191
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1192
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1195
To retrieve the branch as of a particular revision, supply the --revision
1196
parameter, as in "branch foo/bar -r 5".
1199
_see_also = ['checkout']
1200
takes_args = ['from_location', 'to_location?']
1201
takes_options = ['revision', Option('hardlink',
1202
help='Hard-link working tree files where possible.'),
1204
help="Create a branch without a working-tree."),
1206
help="Switch the checkout in the current directory "
1207
"to the new branch."),
1209
help='Create a stacked branch referring to the source branch. '
1210
'The new branch will depend on the availability of the source '
1211
'branch for all operations.'),
1212
Option('standalone',
1213
help='Do not use a shared repository, even if available.'),
1214
Option('use-existing-dir',
1215
help='By default branch will fail if the target'
1216
' directory exists, but does not already'
1217
' have a control directory. This flag will'
1218
' allow branch to proceed.'),
1220
help="Bind new branch to from location."),
1222
aliases = ['get', 'clone']
1224
def run(self, from_location, to_location=None, revision=None,
1225
hardlink=False, stacked=False, standalone=False, no_tree=False,
1226
use_existing_dir=False, switch=False, bind=False):
1227
from bzrlib import switch as _mod_switch
1228
from bzrlib.tag import _merge_tags_if_possible
1229
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1231
revision = _get_one_revision('branch', revision)
1233
self.add_cleanup(br_from.unlock)
1234
if revision is not None:
1235
revision_id = revision.as_revision_id(br_from)
1237
# FIXME - wt.last_revision, fallback to branch, fall back to
1238
# None or perhaps NULL_REVISION to mean copy nothing
1240
revision_id = br_from.last_revision()
1241
if to_location is None:
1242
to_location = urlutils.derive_to_location(from_location)
1243
to_transport = transport.get_transport(to_location)
1245
to_transport.mkdir('.')
1246
except errors.FileExists:
1247
if not use_existing_dir:
1248
raise errors.BzrCommandError('Target directory "%s" '
1249
'already exists.' % to_location)
1252
bzrdir.BzrDir.open_from_transport(to_transport)
1253
except errors.NotBranchError:
1256
raise errors.AlreadyBranchError(to_location)
1257
except errors.NoSuchFile:
1258
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1261
# preserve whatever source format we have.
1262
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1263
possible_transports=[to_transport],
1264
accelerator_tree=accelerator_tree,
1265
hardlink=hardlink, stacked=stacked,
1266
force_new_repo=standalone,
1267
create_tree_if_local=not no_tree,
1268
source_branch=br_from)
1269
branch = dir.open_branch()
1270
except errors.NoSuchRevision:
1271
to_transport.delete_tree('.')
1272
msg = "The branch %s has no revision %s." % (from_location,
1274
raise errors.BzrCommandError(msg)
1275
_merge_tags_if_possible(br_from, branch)
1276
# If the source branch is stacked, the new branch may
1277
# be stacked whether we asked for that explicitly or not.
1278
# We therefore need a try/except here and not just 'if stacked:'
1280
note('Created new stacked branch referring to %s.' %
1281
branch.get_stacked_on_url())
1282
except (errors.NotStacked, errors.UnstackableBranchFormat,
1283
errors.UnstackableRepositoryFormat), e:
1284
note('Branched %d revision(s).' % branch.revno())
1286
# Bind to the parent
1287
parent_branch = Branch.open(from_location)
1288
branch.bind(parent_branch)
1289
note('New branch bound to %s' % from_location)
1291
# Switch to the new branch
1292
wt, _ = WorkingTree.open_containing('.')
1293
_mod_switch.switch(wt.bzrdir, branch)
1294
note('Switched to branch: %s',
1295
urlutils.unescape_for_display(branch.base, 'utf-8'))
1298
class cmd_checkout(Command):
1299
"""Create a new checkout of an existing branch.
1301
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1302
the branch found in '.'. This is useful if you have removed the working tree
1303
or if it was never created - i.e. if you pushed the branch to its current
1304
location using SFTP.
1306
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1307
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1308
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1309
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1310
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1313
To retrieve the branch as of a particular revision, supply the --revision
1314
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1315
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1319
_see_also = ['checkouts', 'branch']
1320
takes_args = ['branch_location?', 'to_location?']
1321
takes_options = ['revision',
1322
Option('lightweight',
1323
help="Perform a lightweight checkout. Lightweight "
1324
"checkouts depend on access to the branch for "
1325
"every operation. Normal checkouts can perform "
1326
"common operations like diff and status without "
1327
"such access, and also support local commits."
1329
Option('files-from', type=str,
1330
help="Get file contents from this tree."),
1332
help='Hard-link working tree files where possible.'
1337
def run(self, branch_location=None, to_location=None, revision=None,
1338
lightweight=False, files_from=None, hardlink=False):
1339
if branch_location is None:
1340
branch_location = osutils.getcwd()
1341
to_location = branch_location
1342
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1344
revision = _get_one_revision('checkout', revision)
1345
if files_from is not None:
1346
accelerator_tree = WorkingTree.open(files_from)
1347
if revision is not None:
1348
revision_id = revision.as_revision_id(source)
1351
if to_location is None:
1352
to_location = urlutils.derive_to_location(branch_location)
1353
# if the source and to_location are the same,
1354
# and there is no working tree,
1355
# then reconstitute a branch
1356
if (osutils.abspath(to_location) ==
1357
osutils.abspath(branch_location)):
1359
source.bzrdir.open_workingtree()
1360
except errors.NoWorkingTree:
1361
source.bzrdir.create_workingtree(revision_id)
1363
source.create_checkout(to_location, revision_id, lightweight,
1364
accelerator_tree, hardlink)
1367
class cmd_renames(Command):
1368
"""Show list of renamed files.
1370
# TODO: Option to show renames between two historical versions.
1372
# TODO: Only show renames under dir, rather than in the whole branch.
1373
_see_also = ['status']
1374
takes_args = ['dir?']
1377
def run(self, dir=u'.'):
1378
tree = WorkingTree.open_containing(dir)[0]
1380
self.add_cleanup(tree.unlock)
1381
new_inv = tree.inventory
1382
old_tree = tree.basis_tree()
1383
old_tree.lock_read()
1384
self.add_cleanup(old_tree.unlock)
1385
old_inv = old_tree.inventory
1387
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1388
for f, paths, c, v, p, n, k, e in iterator:
1389
if paths[0] == paths[1]:
1393
renames.append(paths)
1395
for old_name, new_name in renames:
1396
self.outf.write("%s => %s\n" % (old_name, new_name))
1399
class cmd_update(Command):
1400
"""Update a tree to have the latest code committed to its branch.
1402
This will perform a merge into the working tree, and may generate
1403
conflicts. If you have any local changes, you will still
1404
need to commit them after the update for the update to be complete.
1406
If you want to discard your local changes, you can just do a
1407
'bzr revert' instead of 'bzr commit' after the update.
1409
If the tree's branch is bound to a master branch, it will also update
1410
the branch from the master.
1413
_see_also = ['pull', 'working-trees', 'status-flags']
1414
takes_args = ['dir?']
1415
takes_options = ['revision']
1418
def run(self, dir='.', revision=None):
1419
if revision is not None and len(revision) != 1:
1420
raise errors.BzrCommandError(
1421
"bzr update --revision takes exactly one revision")
1422
tree = WorkingTree.open_containing(dir)[0]
1423
branch = tree.branch
1424
possible_transports = []
1425
master = branch.get_master_branch(
1426
possible_transports=possible_transports)
1427
if master is not None:
1429
branch_location = master.base
1431
tree.lock_tree_write()
1432
branch_location = tree.branch.base
1433
self.add_cleanup(tree.unlock)
1434
# get rid of the final '/' and be ready for display
1435
branch_location = urlutils.unescape_for_display(
1436
branch_location.rstrip('/'),
1438
existing_pending_merges = tree.get_parent_ids()[1:]
1442
# may need to fetch data into a heavyweight checkout
1443
# XXX: this may take some time, maybe we should display a
1445
old_tip = branch.update(possible_transports)
1446
if revision is not None:
1447
revision_id = revision[0].as_revision_id(branch)
1449
revision_id = branch.last_revision()
1450
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1451
revno = branch.revision_id_to_revno(revision_id)
1452
note("Tree is up to date at revision %d of branch %s" %
1453
(revno, branch_location))
1455
view_info = _get_view_info_for_change_reporter(tree)
1456
change_reporter = delta._ChangeReporter(
1457
unversioned_filter=tree.is_ignored,
1458
view_info=view_info)
1460
conflicts = tree.update(
1462
possible_transports=possible_transports,
1463
revision=revision_id,
1465
except errors.NoSuchRevision, e:
1466
raise errors.BzrCommandError(
1467
"branch has no revision %s\n"
1468
"bzr update --revision only works"
1469
" for a revision in the branch history"
1471
revno = tree.branch.revision_id_to_revno(
1472
_mod_revision.ensure_null(tree.last_revision()))
1473
note('Updated to revision %d of branch %s' %
1474
(revno, branch_location))
1475
if tree.get_parent_ids()[1:] != existing_pending_merges:
1476
note('Your local commits will now show as pending merges with '
1477
"'bzr status', and can be committed with 'bzr commit'.")
1484
class cmd_info(Command):
1485
"""Show information about a working tree, branch or repository.
1487
This command will show all known locations and formats associated to the
1488
tree, branch or repository.
1490
In verbose mode, statistical information is included with each report.
1491
To see extended statistic information, use a verbosity level of 2 or
1492
higher by specifying the verbose option multiple times, e.g. -vv.
1494
Branches and working trees will also report any missing revisions.
1498
Display information on the format and related locations:
1502
Display the above together with extended format information and
1503
basic statistics (like the number of files in the working tree and
1504
number of revisions in the branch and repository):
1508
Display the above together with number of committers to the branch:
1512
_see_also = ['revno', 'working-trees', 'repositories']
1513
takes_args = ['location?']
1514
takes_options = ['verbose']
1515
encoding_type = 'replace'
1518
def run(self, location=None, verbose=False):
1520
noise_level = get_verbosity_level()
1523
from bzrlib.info import show_bzrdir_info
1524
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1525
verbose=noise_level, outfile=self.outf)
1528
class cmd_remove(Command):
1529
"""Remove files or directories.
1531
This makes bzr stop tracking changes to the specified files. bzr will delete
1532
them if they can easily be recovered using revert. If no options or
1533
parameters are given bzr will scan for files that are being tracked by bzr
1534
but missing in your tree and stop tracking them for you.
1536
takes_args = ['file*']
1537
takes_options = ['verbose',
1538
Option('new', help='Only remove files that have never been committed.'),
1539
RegistryOption.from_kwargs('file-deletion-strategy',
1540
'The file deletion mode to be used.',
1541
title='Deletion Strategy', value_switches=True, enum_switch=False,
1542
safe='Only delete files if they can be'
1543
' safely recovered (default).',
1544
keep='Delete from bzr but leave the working copy.',
1545
force='Delete all the specified files, even if they can not be '
1546
'recovered and even if they are non-empty directories.')]
1547
aliases = ['rm', 'del']
1548
encoding_type = 'replace'
1550
def run(self, file_list, verbose=False, new=False,
1551
file_deletion_strategy='safe'):
1552
tree, file_list = tree_files(file_list)
1554
if file_list is not None:
1555
file_list = [f for f in file_list]
1558
self.add_cleanup(tree.unlock)
1559
# Heuristics should probably all move into tree.remove_smart or
1562
added = tree.changes_from(tree.basis_tree(),
1563
specific_files=file_list).added
1564
file_list = sorted([f[0] for f in added], reverse=True)
1565
if len(file_list) == 0:
1566
raise errors.BzrCommandError('No matching files.')
1567
elif file_list is None:
1568
# missing files show up in iter_changes(basis) as
1569
# versioned-with-no-kind.
1571
for change in tree.iter_changes(tree.basis_tree()):
1572
# Find paths in the working tree that have no kind:
1573
if change[1][1] is not None and change[6][1] is None:
1574
missing.append(change[1][1])
1575
file_list = sorted(missing, reverse=True)
1576
file_deletion_strategy = 'keep'
1577
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1578
keep_files=file_deletion_strategy=='keep',
1579
force=file_deletion_strategy=='force')
1582
class cmd_file_id(Command):
1583
"""Print file_id of a particular file or directory.
1585
The file_id is assigned when the file is first added and remains the
1586
same through all revisions where the file exists, even when it is
1591
_see_also = ['inventory', 'ls']
1592
takes_args = ['filename']
1595
def run(self, filename):
1596
tree, relpath = WorkingTree.open_containing(filename)
1597
i = tree.path2id(relpath)
1599
raise errors.NotVersionedError(filename)
1601
self.outf.write(i + '\n')
1604
class cmd_file_path(Command):
1605
"""Print path of file_ids to a file or directory.
1607
This prints one line for each directory down to the target,
1608
starting at the branch root.
1612
takes_args = ['filename']
1615
def run(self, filename):
1616
tree, relpath = WorkingTree.open_containing(filename)
1617
fid = tree.path2id(relpath)
1619
raise errors.NotVersionedError(filename)
1620
segments = osutils.splitpath(relpath)
1621
for pos in range(1, len(segments) + 1):
1622
path = osutils.joinpath(segments[:pos])
1623
self.outf.write("%s\n" % tree.path2id(path))
1626
class cmd_reconcile(Command):
1627
"""Reconcile bzr metadata in a branch.
1629
This can correct data mismatches that may have been caused by
1630
previous ghost operations or bzr upgrades. You should only
1631
need to run this command if 'bzr check' or a bzr developer
1632
advises you to run it.
1634
If a second branch is provided, cross-branch reconciliation is
1635
also attempted, which will check that data like the tree root
1636
id which was not present in very early bzr versions is represented
1637
correctly in both branches.
1639
At the same time it is run it may recompress data resulting in
1640
a potential saving in disk space or performance gain.
1642
The branch *MUST* be on a listable system such as local disk or sftp.
1645
_see_also = ['check']
1646
takes_args = ['branch?']
1648
def run(self, branch="."):
1649
from bzrlib.reconcile import reconcile
1650
dir = bzrdir.BzrDir.open(branch)
1654
class cmd_revision_history(Command):
1655
"""Display the list of revision ids on a branch."""
1658
takes_args = ['location?']
1663
def run(self, location="."):
1664
branch = Branch.open_containing(location)[0]
1665
for revid in branch.revision_history():
1666
self.outf.write(revid)
1667
self.outf.write('\n')
1670
class cmd_ancestry(Command):
1671
"""List all revisions merged into this branch."""
1673
_see_also = ['log', 'revision-history']
1674
takes_args = ['location?']
1679
def run(self, location="."):
1681
wt = WorkingTree.open_containing(location)[0]
1682
except errors.NoWorkingTree:
1683
b = Branch.open(location)
1684
last_revision = b.last_revision()
1687
last_revision = wt.last_revision()
1689
revision_ids = b.repository.get_ancestry(last_revision)
1691
for revision_id in revision_ids:
1692
self.outf.write(revision_id + '\n')
1695
class cmd_init(Command):
1696
"""Make a directory into a versioned branch.
1698
Use this to create an empty branch, or before importing an
1701
If there is a repository in a parent directory of the location, then
1702
the history of the branch will be stored in the repository. Otherwise
1703
init creates a standalone branch which carries its own history
1704
in the .bzr directory.
1706
If there is already a branch at the location but it has no working tree,
1707
the tree can be populated with 'bzr checkout'.
1709
Recipe for importing a tree of files::
1715
bzr commit -m "imported project"
1718
_see_also = ['init-repository', 'branch', 'checkout']
1719
takes_args = ['location?']
1721
Option('create-prefix',
1722
help='Create the path leading up to the branch '
1723
'if it does not already exist.'),
1724
RegistryOption('format',
1725
help='Specify a format for this branch. '
1726
'See "help formats".',
1727
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1728
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1729
value_switches=True,
1730
title="Branch format",
1732
Option('append-revisions-only',
1733
help='Never change revnos or the existing log.'
1734
' Append revisions to it only.')
1736
def run(self, location=None, format=None, append_revisions_only=False,
1737
create_prefix=False):
1739
format = bzrdir.format_registry.make_bzrdir('default')
1740
if location is None:
1743
to_transport = transport.get_transport(location)
1745
# The path has to exist to initialize a
1746
# branch inside of it.
1747
# Just using os.mkdir, since I don't
1748
# believe that we want to create a bunch of
1749
# locations if the user supplies an extended path
1751
to_transport.ensure_base()
1752
except errors.NoSuchFile:
1753
if not create_prefix:
1754
raise errors.BzrCommandError("Parent directory of %s"
1756
"\nYou may supply --create-prefix to create all"
1757
" leading parent directories."
1759
to_transport.create_prefix()
1762
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1763
except errors.NotBranchError:
1764
# really a NotBzrDir error...
1765
create_branch = bzrdir.BzrDir.create_branch_convenience
1766
branch = create_branch(to_transport.base, format=format,
1767
possible_transports=[to_transport])
1768
a_bzrdir = branch.bzrdir
1770
from bzrlib.transport.local import LocalTransport
1771
if a_bzrdir.has_branch():
1772
if (isinstance(to_transport, LocalTransport)
1773
and not a_bzrdir.has_workingtree()):
1774
raise errors.BranchExistsWithoutWorkingTree(location)
1775
raise errors.AlreadyBranchError(location)
1776
branch = a_bzrdir.create_branch()
1777
a_bzrdir.create_workingtree()
1778
if append_revisions_only:
1780
branch.set_append_revisions_only(True)
1781
except errors.UpgradeRequired:
1782
raise errors.BzrCommandError('This branch format cannot be set'
1783
' to append-revisions-only. Try --default.')
1785
from bzrlib.info import describe_layout, describe_format
1787
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1788
except (errors.NoWorkingTree, errors.NotLocalUrl):
1790
repository = branch.repository
1791
layout = describe_layout(repository, branch, tree).lower()
1792
format = describe_format(a_bzrdir, repository, branch, tree)
1793
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1794
if repository.is_shared():
1795
#XXX: maybe this can be refactored into transport.path_or_url()
1796
url = repository.bzrdir.root_transport.external_url()
1798
url = urlutils.local_path_from_url(url)
1799
except errors.InvalidURL:
1801
self.outf.write("Using shared repository: %s\n" % url)
1804
class cmd_init_repository(Command):
1805
"""Create a shared repository for branches to share storage space.
1807
New branches created under the repository directory will store their
1808
revisions in the repository, not in the branch directory. For branches
1809
with shared history, this reduces the amount of storage needed and
1810
speeds up the creation of new branches.
1812
If the --no-trees option is given then the branches in the repository
1813
will not have working trees by default. They will still exist as
1814
directories on disk, but they will not have separate copies of the
1815
files at a certain revision. This can be useful for repositories that
1816
store branches which are interacted with through checkouts or remote
1817
branches, such as on a server.
1820
Create a shared repository holding just branches::
1822
bzr init-repo --no-trees repo
1825
Make a lightweight checkout elsewhere::
1827
bzr checkout --lightweight repo/trunk trunk-checkout
1832
_see_also = ['init', 'branch', 'checkout', 'repositories']
1833
takes_args = ["location"]
1834
takes_options = [RegistryOption('format',
1835
help='Specify a format for this repository. See'
1836
' "bzr help formats" for details.',
1837
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1838
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1839
value_switches=True, title='Repository format'),
1841
help='Branches in the repository will default to'
1842
' not having a working tree.'),
1844
aliases = ["init-repo"]
1846
def run(self, location, format=None, no_trees=False):
1848
format = bzrdir.format_registry.make_bzrdir('default')
1850
if location is None:
1853
to_transport = transport.get_transport(location)
1854
to_transport.ensure_base()
1856
newdir = format.initialize_on_transport(to_transport)
1857
repo = newdir.create_repository(shared=True)
1858
repo.set_make_working_trees(not no_trees)
1860
from bzrlib.info import show_bzrdir_info
1861
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1864
class cmd_diff(Command):
1865
"""Show differences in the working tree, between revisions or branches.
1867
If no arguments are given, all changes for the current tree are listed.
1868
If files are given, only the changes in those files are listed.
1869
Remote and multiple branches can be compared by using the --old and
1870
--new options. If not provided, the default for both is derived from
1871
the first argument, if any, or the current tree if no arguments are
1874
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1875
produces patches suitable for "patch -p1".
1879
2 - unrepresentable changes
1884
Shows the difference in the working tree versus the last commit::
1888
Difference between the working tree and revision 1::
1892
Difference between revision 3 and revision 1::
1896
Difference between revision 3 and revision 1 for branch xxx::
1900
To see the changes introduced in revision X::
1904
Note that in the case of a merge, the -c option shows the changes
1905
compared to the left hand parent. To see the changes against
1906
another parent, use::
1908
bzr diff -r<chosen_parent>..X
1910
The changes introduced by revision 2 (equivalent to -r1..2)::
1914
Show just the differences for file NEWS::
1918
Show the differences in working tree xxx for file NEWS::
1922
Show the differences from branch xxx to this working tree:
1926
Show the differences between two branches for file NEWS::
1928
bzr diff --old xxx --new yyy NEWS
1930
Same as 'bzr diff' but prefix paths with old/ and new/::
1932
bzr diff --prefix old/:new/
1934
_see_also = ['status']
1935
takes_args = ['file*']
1937
Option('diff-options', type=str,
1938
help='Pass these options to the external diff program.'),
1939
Option('prefix', type=str,
1941
help='Set prefixes added to old and new filenames, as '
1942
'two values separated by a colon. (eg "old/:new/").'),
1944
help='Branch/tree to compare from.',
1948
help='Branch/tree to compare to.',
1954
help='Use this command to compare files.',
1957
RegistryOption('format',
1958
help='Diff format to use.',
1959
lazy_registry=('bzrlib.diff', 'format_registry'),
1960
value_switches=False, title='Diff format'),
1962
aliases = ['di', 'dif']
1963
encoding_type = 'exact'
1966
def run(self, revision=None, file_list=None, diff_options=None,
1967
prefix=None, old=None, new=None, using=None, format=None):
1968
from bzrlib.diff import (get_trees_and_branches_to_diff,
1971
if (prefix is None) or (prefix == '0'):
1979
old_label, new_label = prefix.split(":")
1981
raise errors.BzrCommandError(
1982
'--prefix expects two values separated by a colon'
1983
' (eg "old/:new/")')
1985
if revision and len(revision) > 2:
1986
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1987
' one or two revision specifiers')
1989
if using is not None and format is not None:
1990
raise errors.BzrCommandError('--using and --format are mutually '
1993
(old_tree, new_tree,
1994
old_branch, new_branch,
1995
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1996
file_list, revision, old, new, apply_view=True)
1997
return show_diff_trees(old_tree, new_tree, sys.stdout,
1998
specific_files=specific_files,
1999
external_diff_options=diff_options,
2000
old_label=old_label, new_label=new_label,
2001
extra_trees=extra_trees, using=using,
2005
class cmd_deleted(Command):
2006
"""List files deleted in the working tree.
2008
# TODO: Show files deleted since a previous revision, or
2009
# between two revisions.
2010
# TODO: Much more efficient way to do this: read in new
2011
# directories with readdir, rather than stating each one. Same
2012
# level of effort but possibly much less IO. (Or possibly not,
2013
# if the directories are very large...)
2014
_see_also = ['status', 'ls']
2015
takes_options = ['show-ids']
2018
def run(self, show_ids=False):
2019
tree = WorkingTree.open_containing(u'.')[0]
2021
self.add_cleanup(tree.unlock)
2022
old = tree.basis_tree()
2024
self.add_cleanup(old.unlock)
2025
for path, ie in old.inventory.iter_entries():
2026
if not tree.has_id(ie.file_id):
2027
self.outf.write(path)
2029
self.outf.write(' ')
2030
self.outf.write(ie.file_id)
2031
self.outf.write('\n')
2034
class cmd_modified(Command):
2035
"""List files modified in working tree.
2039
_see_also = ['status', 'ls']
2042
help='Write an ascii NUL (\\0) separator '
2043
'between files rather than a newline.')
2047
def run(self, null=False):
2048
tree = WorkingTree.open_containing(u'.')[0]
2049
td = tree.changes_from(tree.basis_tree())
2050
for path, id, kind, text_modified, meta_modified in td.modified:
2052
self.outf.write(path + '\0')
2054
self.outf.write(osutils.quotefn(path) + '\n')
2057
class cmd_added(Command):
2058
"""List files added in working tree.
2062
_see_also = ['status', 'ls']
2065
help='Write an ascii NUL (\\0) separator '
2066
'between files rather than a newline.')
2070
def run(self, null=False):
2071
wt = WorkingTree.open_containing(u'.')[0]
2073
self.add_cleanup(wt.unlock)
2074
basis = wt.basis_tree()
2076
self.add_cleanup(basis.unlock)
2077
basis_inv = basis.inventory
2080
if file_id in basis_inv:
2082
if inv.is_root(file_id) and len(basis_inv) == 0:
2084
path = inv.id2path(file_id)
2085
if not os.access(osutils.abspath(path), os.F_OK):
2088
self.outf.write(path + '\0')
2090
self.outf.write(osutils.quotefn(path) + '\n')
2093
class cmd_root(Command):
2094
"""Show the tree root directory.
2096
The root is the nearest enclosing directory with a .bzr control
2099
takes_args = ['filename?']
2101
def run(self, filename=None):
2102
"""Print the branch root."""
2103
tree = WorkingTree.open_containing(filename)[0]
2104
self.outf.write(tree.basedir + '\n')
2107
def _parse_limit(limitstring):
2109
return int(limitstring)
2111
msg = "The limit argument must be an integer."
2112
raise errors.BzrCommandError(msg)
2115
def _parse_levels(s):
2119
msg = "The levels argument must be an integer."
2120
raise errors.BzrCommandError(msg)
2123
class cmd_log(Command):
2124
"""Show historical log for a branch or subset of a branch.
2126
log is bzr's default tool for exploring the history of a branch.
2127
The branch to use is taken from the first parameter. If no parameters
2128
are given, the branch containing the working directory is logged.
2129
Here are some simple examples::
2131
bzr log log the current branch
2132
bzr log foo.py log a file in its branch
2133
bzr log http://server/branch log a branch on a server
2135
The filtering, ordering and information shown for each revision can
2136
be controlled as explained below. By default, all revisions are
2137
shown sorted (topologically) so that newer revisions appear before
2138
older ones and descendants always appear before ancestors. If displayed,
2139
merged revisions are shown indented under the revision in which they
2144
The log format controls how information about each revision is
2145
displayed. The standard log formats are called ``long``, ``short``
2146
and ``line``. The default is long. See ``bzr help log-formats``
2147
for more details on log formats.
2149
The following options can be used to control what information is
2152
-l N display a maximum of N revisions
2153
-n N display N levels of revisions (0 for all, 1 for collapsed)
2154
-v display a status summary (delta) for each revision
2155
-p display a diff (patch) for each revision
2156
--show-ids display revision-ids (and file-ids), not just revnos
2158
Note that the default number of levels to display is a function of the
2159
log format. If the -n option is not used, the standard log formats show
2160
just the top level (mainline).
2162
Status summaries are shown using status flags like A, M, etc. To see
2163
the changes explained using words like ``added`` and ``modified``
2164
instead, use the -vv option.
2168
To display revisions from oldest to newest, use the --forward option.
2169
In most cases, using this option will have little impact on the total
2170
time taken to produce a log, though --forward does not incrementally
2171
display revisions like --reverse does when it can.
2173
:Revision filtering:
2175
The -r option can be used to specify what revision or range of revisions
2176
to filter against. The various forms are shown below::
2178
-rX display revision X
2179
-rX.. display revision X and later
2180
-r..Y display up to and including revision Y
2181
-rX..Y display from X to Y inclusive
2183
See ``bzr help revisionspec`` for details on how to specify X and Y.
2184
Some common examples are given below::
2186
-r-1 show just the tip
2187
-r-10.. show the last 10 mainline revisions
2188
-rsubmit:.. show what's new on this branch
2189
-rancestor:path.. show changes since the common ancestor of this
2190
branch and the one at location path
2191
-rdate:yesterday.. show changes since yesterday
2193
When logging a range of revisions using -rX..Y, log starts at
2194
revision Y and searches back in history through the primary
2195
("left-hand") parents until it finds X. When logging just the
2196
top level (using -n1), an error is reported if X is not found
2197
along the way. If multi-level logging is used (-n0), X may be
2198
a nested merge revision and the log will be truncated accordingly.
2202
If parameters are given and the first one is not a branch, the log
2203
will be filtered to show only those revisions that changed the
2204
nominated files or directories.
2206
Filenames are interpreted within their historical context. To log a
2207
deleted file, specify a revision range so that the file existed at
2208
the end or start of the range.
2210
Historical context is also important when interpreting pathnames of
2211
renamed files/directories. Consider the following example:
2213
* revision 1: add tutorial.txt
2214
* revision 2: modify tutorial.txt
2215
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2219
* ``bzr log guide.txt`` will log the file added in revision 1
2221
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2223
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2224
the original file in revision 2.
2226
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2227
was no file called guide.txt in revision 2.
2229
Renames are always followed by log. By design, there is no need to
2230
explicitly ask for this (and no way to stop logging a file back
2231
until it was last renamed).
2235
The --message option can be used for finding revisions that match a
2236
regular expression in a commit message.
2240
GUI tools and IDEs are often better at exploring history than command
2241
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2242
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2243
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2244
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2246
You may find it useful to add the aliases below to ``bazaar.conf``::
2250
top = log -l10 --line
2253
``bzr tip`` will then show the latest revision while ``bzr top``
2254
will show the last 10 mainline revisions. To see the details of a
2255
particular revision X, ``bzr show -rX``.
2257
If you are interested in looking deeper into a particular merge X,
2258
use ``bzr log -n0 -rX``.
2260
``bzr log -v`` on a branch with lots of history is currently
2261
very slow. A fix for this issue is currently under development.
2262
With or without that fix, it is recommended that a revision range
2263
be given when using the -v option.
2265
bzr has a generic full-text matching plugin, bzr-search, that can be
2266
used to find revisions matching user names, commit messages, etc.
2267
Among other features, this plugin can find all revisions containing
2268
a list of words but not others.
2270
When exploring non-mainline history on large projects with deep
2271
history, the performance of log can be greatly improved by installing
2272
the historycache plugin. This plugin buffers historical information
2273
trading disk space for faster speed.
2275
takes_args = ['file*']
2276
_see_also = ['log-formats', 'revisionspec']
2279
help='Show from oldest to newest.'),
2281
custom_help('verbose',
2282
help='Show files changed in each revision.'),
2286
type=bzrlib.option._parse_revision_str,
2288
help='Show just the specified revision.'
2289
' See also "help revisionspec".'),
2293
help='Number of levels to display - 0 for all, 1 for flat.',
2295
type=_parse_levels),
2298
help='Show revisions whose message matches this '
2299
'regular expression.',
2303
help='Limit the output to the first N revisions.',
2308
help='Show changes made in each revision as a patch.'),
2309
Option('include-merges',
2310
help='Show merged revisions like --levels 0 does.'),
2312
encoding_type = 'replace'
2315
def run(self, file_list=None, timezone='original',
2326
include_merges=False):
2327
from bzrlib.log import (
2329
make_log_request_dict,
2330
_get_info_for_log_files,
2332
direction = (forward and 'forward') or 'reverse'
2337
raise errors.BzrCommandError(
2338
'--levels and --include-merges are mutually exclusive')
2340
if change is not None:
2342
raise errors.RangeInChangeOption()
2343
if revision is not None:
2344
raise errors.BzrCommandError(
2345
'--revision and --change are mutually exclusive')
2350
filter_by_dir = False
2352
# find the file ids to log and check for directory filtering
2353
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2354
revision, file_list)
2355
self.add_cleanup(b.unlock)
2356
for relpath, file_id, kind in file_info_list:
2358
raise errors.BzrCommandError(
2359
"Path unknown at end or start of revision range: %s" %
2361
# If the relpath is the top of the tree, we log everything
2366
file_ids.append(file_id)
2367
filter_by_dir = filter_by_dir or (
2368
kind in ['directory', 'tree-reference'])
2371
# FIXME ? log the current subdir only RBC 20060203
2372
if revision is not None \
2373
and len(revision) > 0 and revision[0].get_branch():
2374
location = revision[0].get_branch()
2377
dir, relpath = bzrdir.BzrDir.open_containing(location)
2378
b = dir.open_branch()
2380
self.add_cleanup(b.unlock)
2381
rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
# Decide on the type of delta & diff filtering to use
2384
# TODO: add an --all-files option to make this configurable & consistent
2392
diff_type = 'partial'
2396
# Build the log formatter
2397
if log_format is None:
2398
log_format = log.log_formatter_registry.get_default(b)
2399
# Make a non-encoding output to include the diffs - bug 328007
2400
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2401
lf = log_format(show_ids=show_ids, to_file=self.outf,
2402
to_exact_file=unencoded_output,
2403
show_timezone=timezone,
2404
delta_format=get_verbosity_level(),
2406
show_advice=levels is None)
2408
# Choose the algorithm for doing the logging. It's annoying
2409
# having multiple code paths like this but necessary until
2410
# the underlying repository format is faster at generating
2411
# deltas or can provide everything we need from the indices.
2412
# The default algorithm - match-using-deltas - works for
2413
# multiple files and directories and is faster for small
2414
# amounts of history (200 revisions say). However, it's too
2415
# slow for logging a single file in a repository with deep
2416
# history, i.e. > 10K revisions. In the spirit of "do no
2417
# evil when adding features", we continue to use the
2418
# original algorithm - per-file-graph - for the "single
2419
# file that isn't a directory without showing a delta" case.
2420
partial_history = revision and b.repository._format.supports_chks
2421
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2422
or delta_type or partial_history)
2424
# Build the LogRequest and execute it
2425
if len(file_ids) == 0:
2427
rqst = make_log_request_dict(
2428
direction=direction, specific_fileids=file_ids,
2429
start_revision=rev1, end_revision=rev2, limit=limit,
2430
message_search=message, delta_type=delta_type,
2431
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2432
Logger(b, rqst).show(lf)
2435
def _get_revision_range(revisionspec_list, branch, command_name):
2436
"""Take the input of a revision option and turn it into a revision range.
2438
It returns RevisionInfo objects which can be used to obtain the rev_id's
2439
of the desired revisions. It does some user input validations.
2441
if revisionspec_list is None:
2444
elif len(revisionspec_list) == 1:
2445
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2446
elif len(revisionspec_list) == 2:
2447
start_spec = revisionspec_list[0]
2448
end_spec = revisionspec_list[1]
2449
if end_spec.get_branch() != start_spec.get_branch():
2450
# b is taken from revision[0].get_branch(), and
2451
# show_log will use its revision_history. Having
2452
# different branches will lead to weird behaviors.
2453
raise errors.BzrCommandError(
2454
"bzr %s doesn't accept two revisions in different"
2455
" branches." % command_name)
2456
if start_spec.spec is None:
2457
# Avoid loading all the history.
2458
rev1 = RevisionInfo(branch, None, None)
2460
rev1 = start_spec.in_history(branch)
2461
# Avoid loading all of history when we know a missing
2462
# end of range means the last revision ...
2463
if end_spec.spec is None:
2464
last_revno, last_revision_id = branch.last_revision_info()
2465
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2467
rev2 = end_spec.in_history(branch)
2469
raise errors.BzrCommandError(
2470
'bzr %s --revision takes one or two values.' % command_name)
2474
def _revision_range_to_revid_range(revision_range):
2477
if revision_range[0] is not None:
2478
rev_id1 = revision_range[0].rev_id
2479
if revision_range[1] is not None:
2480
rev_id2 = revision_range[1].rev_id
2481
return rev_id1, rev_id2
2483
def get_log_format(long=False, short=False, line=False, default='long'):
2484
log_format = default
2488
log_format = 'short'
2494
class cmd_touching_revisions(Command):
2495
"""Return revision-ids which affected a particular file.
2497
A more user-friendly interface is "bzr log FILE".
2501
takes_args = ["filename"]
2504
def run(self, filename):
2505
tree, relpath = WorkingTree.open_containing(filename)
2506
file_id = tree.path2id(relpath)
2509
self.add_cleanup(b.unlock)
2510
touching_revs = log.find_touching_revisions(b, file_id)
2511
for revno, revision_id, what in touching_revs:
2512
self.outf.write("%6d %s\n" % (revno, what))
2515
class cmd_ls(Command):
2516
"""List files in a tree.
2519
_see_also = ['status', 'cat']
2520
takes_args = ['path?']
2524
Option('recursive', short_name='R',
2525
help='Recurse into subdirectories.'),
2527
help='Print paths relative to the root of the branch.'),
2528
Option('unknown', help='Print unknown files.'),
2529
Option('versioned', help='Print versioned files.',
2531
Option('ignored', help='Print ignored files.'),
2533
help='Write an ascii NUL (\\0) separator '
2534
'between files rather than a newline.'),
2536
help='List entries of a particular kind: file, directory, symlink.',
2541
def run(self, revision=None, verbose=False,
2542
recursive=False, from_root=False,
2543
unknown=False, versioned=False, ignored=False,
2544
null=False, kind=None, show_ids=False, path=None):
2546
if kind and kind not in ('file', 'directory', 'symlink'):
2547
raise errors.BzrCommandError('invalid kind specified')
2549
if verbose and null:
2550
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2551
all = not (unknown or versioned or ignored)
2553
selection = {'I':ignored, '?':unknown, 'V':versioned}
2559
raise errors.BzrCommandError('cannot specify both --from-root'
2562
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2565
# Calculate the prefix to use
2569
prefix = relpath + '/'
2570
elif fs_path != '.' and not fs_path.endswith('/'):
2571
prefix = fs_path + '/'
2573
if revision is not None or tree is None:
2574
tree = _get_one_revision_tree('ls', revision, branch=branch)
2577
if isinstance(tree, WorkingTree) and tree.supports_views():
2578
view_files = tree.views.lookup_view()
2581
view_str = views.view_display_str(view_files)
2582
note("Ignoring files outside view. View is %s" % view_str)
2585
self.add_cleanup(tree.unlock)
2586
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2587
from_dir=relpath, recursive=recursive):
2588
# Apply additional masking
2589
if not all and not selection[fc]:
2591
if kind is not None and fkind != kind:
2596
fullpath = osutils.pathjoin(relpath, fp)
2599
views.check_path_in_view(tree, fullpath)
2600
except errors.FileOutsideView:
2605
fp = osutils.pathjoin(prefix, fp)
2606
kindch = entry.kind_character()
2607
outstring = fp + kindch
2608
ui.ui_factory.clear_term()
2610
outstring = '%-8s %s' % (fc, outstring)
2611
if show_ids and fid is not None:
2612
outstring = "%-50s %s" % (outstring, fid)
2613
self.outf.write(outstring + '\n')
2615
self.outf.write(fp + '\0')
2618
self.outf.write(fid)
2619
self.outf.write('\0')
2627
self.outf.write('%-50s %s\n' % (outstring, my_id))
2629
self.outf.write(outstring + '\n')
2632
class cmd_unknowns(Command):
2633
"""List unknown files.
2641
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2642
self.outf.write(osutils.quotefn(f) + '\n')
2645
class cmd_ignore(Command):
2646
"""Ignore specified files or patterns.
2648
See ``bzr help patterns`` for details on the syntax of patterns.
2650
If a .bzrignore file does not exist, the ignore command
2651
will create one and add the specified files or patterns to the newly
2652
created file. The ignore command will also automatically add the
2653
.bzrignore file to be versioned. Creating a .bzrignore file without
2654
the use of the ignore command will require an explicit add command.
2656
To remove patterns from the ignore list, edit the .bzrignore file.
2657
After adding, editing or deleting that file either indirectly by
2658
using this command or directly by using an editor, be sure to commit
2661
Patterns prefixed with '!' are exceptions to ignore patterns and take
2662
precedence over regular ignores. Such exceptions are used to specify
2663
files that should be versioned which would otherwise be ignored.
2665
Patterns prefixed with '!!' act as regular ignore patterns, but have
2666
precedence over the '!' exception patterns.
2668
Note: ignore patterns containing shell wildcards must be quoted from
2672
Ignore the top level Makefile::
2674
bzr ignore ./Makefile
2676
Ignore .class files in all directories...::
2678
bzr ignore "*.class"
2680
...but do not ignore "special.class"::
2682
bzr ignore "!special.class"
2684
Ignore .o files under the lib directory::
2686
bzr ignore "lib/**/*.o"
2688
Ignore .o files under the lib directory::
2690
bzr ignore "RE:lib/.*\.o"
2692
Ignore everything but the "debian" toplevel directory::
2694
bzr ignore "RE:(?!debian/).*"
2696
Ignore everything except the "local" toplevel directory,
2697
but always ignore "*~" autosave files, even under local/::
2700
bzr ignore "!./local"
2704
_see_also = ['status', 'ignored', 'patterns']
2705
takes_args = ['name_pattern*']
2707
Option('old-default-rules',
2708
help='Write out the ignore rules bzr < 0.9 always used.')
2711
def run(self, name_pattern_list=None, old_default_rules=None):
2712
from bzrlib import ignores
2713
if old_default_rules is not None:
2714
# dump the rules and exit
2715
for pattern in ignores.OLD_DEFAULTS:
2716
self.outf.write("%s\n" % pattern)
2718
if not name_pattern_list:
2719
raise errors.BzrCommandError("ignore requires at least one "
2720
"NAME_PATTERN or --old-default-rules")
2721
name_pattern_list = [globbing.normalize_pattern(p)
2722
for p in name_pattern_list]
2723
for name_pattern in name_pattern_list:
2724
if (name_pattern[0] == '/' or
2725
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2726
raise errors.BzrCommandError(
2727
"NAME_PATTERN should not be an absolute path")
2728
tree, relpath = WorkingTree.open_containing(u'.')
2729
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2730
ignored = globbing.Globster(name_pattern_list)
2733
for entry in tree.list_files():
2737
if ignored.match(filename):
2738
matches.append(filename)
2740
if len(matches) > 0:
2741
self.outf.write("Warning: the following files are version controlled and"
2742
" match your ignore pattern:\n%s"
2743
"\nThese files will continue to be version controlled"
2744
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2747
class cmd_ignored(Command):
2748
"""List ignored files and the patterns that matched them.
2750
List all the ignored files and the ignore pattern that caused the file to
2753
Alternatively, to list just the files::
2758
encoding_type = 'replace'
2759
_see_also = ['ignore', 'ls']
2763
tree = WorkingTree.open_containing(u'.')[0]
2765
self.add_cleanup(tree.unlock)
2766
for path, file_class, kind, file_id, entry in tree.list_files():
2767
if file_class != 'I':
2769
## XXX: Slightly inefficient since this was already calculated
2770
pat = tree.is_ignored(path)
2771
self.outf.write('%-50s %s\n' % (path, pat))
2774
class cmd_lookup_revision(Command):
2775
"""Lookup the revision-id from a revision-number
2778
bzr lookup-revision 33
2781
takes_args = ['revno']
2784
def run(self, revno):
2788
raise errors.BzrCommandError("not a valid revision-number: %r"
2790
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2791
self.outf.write("%s\n" % revid)
2794
class cmd_export(Command):
2795
"""Export current or past revision to a destination directory or archive.
2797
If no revision is specified this exports the last committed revision.
2799
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2800
given, try to find the format with the extension. If no extension
2801
is found exports to a directory (equivalent to --format=dir).
2803
If root is supplied, it will be used as the root directory inside
2804
container formats (tar, zip, etc). If it is not supplied it will default
2805
to the exported filename. The root option has no effect for 'dir' format.
2807
If branch is omitted then the branch containing the current working
2808
directory will be used.
2810
Note: Export of tree with non-ASCII filenames to zip is not supported.
2812
================= =========================
2813
Supported formats Autodetected by extension
2814
================= =========================
2817
tbz2 .tar.bz2, .tbz2
2820
================= =========================
2822
takes_args = ['dest', 'branch_or_subdir?']
2825
help="Type of file to export to.",
2828
Option('filters', help='Apply content filters to export the '
2829
'convenient form.'),
2832
help="Name of the root directory inside the exported file."),
2833
Option('per-file-timestamps',
2834
help='Set modification time of files to that of the last '
2835
'revision in which it was changed.'),
2837
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2838
root=None, filters=False, per_file_timestamps=False):
2839
from bzrlib.export import export
2841
if branch_or_subdir is None:
2842
tree = WorkingTree.open_containing(u'.')[0]
2846
b, subdir = Branch.open_containing(branch_or_subdir)
2849
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2851
export(rev_tree, dest, format, root, subdir, filtered=filters,
2852
per_file_timestamps=per_file_timestamps)
2853
except errors.NoSuchExportFormat, e:
2854
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2857
class cmd_cat(Command):
2858
"""Write the contents of a file as of a given revision to standard output.
2860
If no revision is nominated, the last revision is used.
2862
Note: Take care to redirect standard output when using this command on a
2868
Option('name-from-revision', help='The path name in the old tree.'),
2869
Option('filters', help='Apply content filters to display the '
2870
'convenience form.'),
2873
takes_args = ['filename']
2874
encoding_type = 'exact'
2877
def run(self, filename, revision=None, name_from_revision=False,
2879
if revision is not None and len(revision) != 1:
2880
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2881
" one revision specifier")
2882
tree, branch, relpath = \
2883
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2885
self.add_cleanup(branch.unlock)
2886
return self._run(tree, branch, relpath, filename, revision,
2887
name_from_revision, filters)
2889
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2892
tree = b.basis_tree()
2893
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2894
rev_tree.lock_read()
2895
self.add_cleanup(rev_tree.unlock)
2897
old_file_id = rev_tree.path2id(relpath)
2899
if name_from_revision:
2900
# Try in revision if requested
2901
if old_file_id is None:
2902
raise errors.BzrCommandError(
2903
"%r is not present in revision %s" % (
2904
filename, rev_tree.get_revision_id()))
2906
content = rev_tree.get_file_text(old_file_id)
2908
cur_file_id = tree.path2id(relpath)
2910
if cur_file_id is not None:
2911
# Then try with the actual file id
2913
content = rev_tree.get_file_text(cur_file_id)
2915
except errors.NoSuchId:
2916
# The actual file id didn't exist at that time
2918
if not found and old_file_id is not None:
2919
# Finally try with the old file id
2920
content = rev_tree.get_file_text(old_file_id)
2923
# Can't be found anywhere
2924
raise errors.BzrCommandError(
2925
"%r is not present in revision %s" % (
2926
filename, rev_tree.get_revision_id()))
2928
from bzrlib.filters import (
2929
ContentFilterContext,
2930
filtered_output_bytes,
2932
filters = rev_tree._content_filter_stack(relpath)
2933
chunks = content.splitlines(True)
2934
content = filtered_output_bytes(chunks, filters,
2935
ContentFilterContext(relpath, rev_tree))
2937
self.outf.writelines(content)
2940
self.outf.write(content)
2943
class cmd_local_time_offset(Command):
2944
"""Show the offset in seconds from GMT to local time."""
2948
self.outf.write("%s\n" % osutils.local_time_offset())
2952
class cmd_commit(Command):
2953
"""Commit changes into a new revision.
2955
An explanatory message needs to be given for each commit. This is
2956
often done by using the --message option (getting the message from the
2957
command line) or by using the --file option (getting the message from
2958
a file). If neither of these options is given, an editor is opened for
2959
the user to enter the message. To see the changed files in the
2960
boilerplate text loaded into the editor, use the --show-diff option.
2962
By default, the entire tree is committed and the person doing the
2963
commit is assumed to be the author. These defaults can be overridden
2968
If selected files are specified, only changes to those files are
2969
committed. If a directory is specified then the directory and
2970
everything within it is committed.
2972
When excludes are given, they take precedence over selected files.
2973
For example, to commit only changes within foo, but not changes
2976
bzr commit foo -x foo/bar
2978
A selective commit after a merge is not yet supported.
2982
If the author of the change is not the same person as the committer,
2983
you can specify the author's name using the --author option. The
2984
name should be in the same format as a committer-id, e.g.
2985
"John Doe <jdoe@example.com>". If there is more than one author of
2986
the change you can specify the option multiple times, once for each
2991
A common mistake is to forget to add a new file or directory before
2992
running the commit command. The --strict option checks for unknown
2993
files and aborts the commit if any are found. More advanced pre-commit
2994
checks can be implemented by defining hooks. See ``bzr help hooks``
2999
If you accidentially commit the wrong changes or make a spelling
3000
mistake in the commit message say, you can use the uncommit command
3001
to undo it. See ``bzr help uncommit`` for details.
3003
Hooks can also be configured to run after a commit. This allows you
3004
to trigger updates to external systems like bug trackers. The --fixes
3005
option can be used to record the association between a revision and
3006
one or more bugs. See ``bzr help bugs`` for details.
3008
A selective commit may fail in some cases where the committed
3009
tree would be invalid. Consider::
3014
bzr commit foo -m "committing foo"
3015
bzr mv foo/bar foo/baz
3018
bzr commit foo/bar -m "committing bar but not baz"
3020
In the example above, the last commit will fail by design. This gives
3021
the user the opportunity to decide whether they want to commit the
3022
rename at the same time, separately first, or not at all. (As a general
3023
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3025
# TODO: Run hooks on tree to-be-committed, and after commit.
3027
# TODO: Strict commit that fails if there are deleted files.
3028
# (what does "deleted files" mean ??)
3030
# TODO: Give better message for -s, --summary, used by tla people
3032
# XXX: verbose currently does nothing
3034
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3035
takes_args = ['selected*']
3037
ListOption('exclude', type=str, short_name='x',
3038
help="Do not consider changes made to a given path."),
3039
Option('message', type=unicode,
3041
help="Description of the new revision."),
3044
help='Commit even if nothing has changed.'),
3045
Option('file', type=str,
3048
help='Take commit message from this file.'),
3050
help="Refuse to commit if there are unknown "
3051
"files in the working tree."),
3052
Option('commit-time', type=str,
3053
help="Manually set a commit time using commit date "
3054
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3055
ListOption('fixes', type=str,
3056
help="Mark a bug as being fixed by this revision "
3057
"(see \"bzr help bugs\")."),
3058
ListOption('author', type=unicode,
3059
help="Set the author's name, if it's different "
3060
"from the committer."),
3062
help="Perform a local commit in a bound "
3063
"branch. Local commits are not pushed to "
3064
"the master branch until a normal commit "
3068
help='When no message is supplied, show the diff along'
3069
' with the status summary in the message editor.'),
3071
aliases = ['ci', 'checkin']
3073
def _iter_bug_fix_urls(self, fixes, branch):
3074
# Configure the properties for bug fixing attributes.
3075
for fixed_bug in fixes:
3076
tokens = fixed_bug.split(':')
3077
if len(tokens) != 2:
3078
raise errors.BzrCommandError(
3079
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3080
"See \"bzr help bugs\" for more information on this "
3081
"feature.\nCommit refused." % fixed_bug)
3082
tag, bug_id = tokens
3084
yield bugtracker.get_bug_url(tag, branch, bug_id)
3085
except errors.UnknownBugTrackerAbbreviation:
3086
raise errors.BzrCommandError(
3087
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3088
except errors.MalformedBugIdentifier, e:
3089
raise errors.BzrCommandError(
3090
"%s\nCommit refused." % (str(e),))
3092
def run(self, message=None, file=None, verbose=False, selected_list=None,
3093
unchanged=False, strict=False, local=False, fixes=None,
3094
author=None, show_diff=False, exclude=None, commit_time=None):
3095
from bzrlib.errors import (
3100
from bzrlib.msgeditor import (
3101
edit_commit_message_encoded,
3102
generate_commit_message_template,
3103
make_commit_message_template_encoded
3106
commit_stamp = offset = None
3107
if commit_time is not None:
3109
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3110
except ValueError, e:
3111
raise errors.BzrCommandError(
3112
"Could not parse --commit-time: " + str(e))
3114
# TODO: Need a blackbox test for invoking the external editor; may be
3115
# slightly problematic to run this cross-platform.
3117
# TODO: do more checks that the commit will succeed before
3118
# spending the user's valuable time typing a commit message.
3122
tree, selected_list = tree_files(selected_list)
3123
if selected_list == ['']:
3124
# workaround - commit of root of tree should be exactly the same
3125
# as just default commit in that tree, and succeed even though
3126
# selected-file merge commit is not done yet
3131
bug_property = bugtracker.encode_fixes_bug_urls(
3132
self._iter_bug_fix_urls(fixes, tree.branch))
3134
properties['bugs'] = bug_property
3136
if local and not tree.branch.get_bound_location():
3137
raise errors.LocalRequiresBoundBranch()
3139
if message is not None:
3141
file_exists = osutils.lexists(message)
3142
except UnicodeError:
3143
# The commit message contains unicode characters that can't be
3144
# represented in the filesystem encoding, so that can't be a
3149
'The commit message is a file name: "%(f)s".\n'
3150
'(use --file "%(f)s" to take commit message from that file)'
3152
ui.ui_factory.show_warning(warning_msg)
3154
def get_message(commit_obj):
3155
"""Callback to get commit message"""
3156
my_message = message
3157
if my_message is not None and '\r' in my_message:
3158
my_message = my_message.replace('\r\n', '\n')
3159
my_message = my_message.replace('\r', '\n')
3160
if my_message is None and not file:
3161
# t is the status of the tree
3162
t = make_commit_message_template_encoded(tree,
3163
selected_list, diff=show_diff,
3164
output_encoding=osutils.get_user_encoding())
3165
# start_message is the template generated from hooks
3166
start_message = generate_commit_message_template(commit_obj)
3167
my_message = edit_commit_message_encoded(t,
3168
start_message=start_message)
3169
if my_message is None:
3170
raise errors.BzrCommandError("please specify a commit"
3171
" message with either --message or --file")
3172
elif my_message and file:
3173
raise errors.BzrCommandError(
3174
"please specify either --message or --file")
3176
my_message = codecs.open(file, 'rt',
3177
osutils.get_user_encoding()).read()
3178
if my_message == "":
3179
raise errors.BzrCommandError("empty commit message specified")
3182
# The API permits a commit with a filter of [] to mean 'select nothing'
3183
# but the command line should not do that.
3184
if not selected_list:
3185
selected_list = None
3187
tree.commit(message_callback=get_message,
3188
specific_files=selected_list,
3189
allow_pointless=unchanged, strict=strict, local=local,
3190
reporter=None, verbose=verbose, revprops=properties,
3191
authors=author, timestamp=commit_stamp,
3193
exclude=safe_relpath_files(tree, exclude))
3194
except PointlessCommit:
3195
# FIXME: This should really happen before the file is read in;
3196
# perhaps prepare the commit; get the message; then actually commit
3197
raise errors.BzrCommandError("No changes to commit."
3198
" Use --unchanged to commit anyhow.")
3199
except ConflictsInTree:
3200
raise errors.BzrCommandError('Conflicts detected in working '
3201
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3203
except StrictCommitFailed:
3204
raise errors.BzrCommandError("Commit refused because there are"
3205
" unknown files in the working tree.")
3206
except errors.BoundBranchOutOfDate, e:
3207
e.extra_help = ("\n"
3208
'To commit to master branch, run update and then commit.\n'
3209
'You can also pass --local to commit to continue working '
3214
class cmd_check(Command):
3215
"""Validate working tree structure, branch consistency and repository history.
3217
This command checks various invariants about branch and repository storage
3218
to detect data corruption or bzr bugs.
3220
The working tree and branch checks will only give output if a problem is
3221
detected. The output fields of the repository check are:
3224
This is just the number of revisions checked. It doesn't
3228
This is just the number of versionedfiles checked. It
3229
doesn't indicate a problem.
3231
unreferenced ancestors
3232
Texts that are ancestors of other texts, but
3233
are not properly referenced by the revision ancestry. This is a
3234
subtle problem that Bazaar can work around.
3237
This is the total number of unique file contents
3238
seen in the checked revisions. It does not indicate a problem.
3241
This is the total number of repeated texts seen
3242
in the checked revisions. Texts can be repeated when their file
3243
entries are modified, but the file contents are not. It does not
3246
If no restrictions are specified, all Bazaar data that is found at the given
3247
location will be checked.
3251
Check the tree and branch at 'foo'::
3253
bzr check --tree --branch foo
3255
Check only the repository at 'bar'::
3257
bzr check --repo bar
3259
Check everything at 'baz'::
3264
_see_also = ['reconcile']
3265
takes_args = ['path?']
3266
takes_options = ['verbose',
3267
Option('branch', help="Check the branch related to the"
3268
" current directory."),
3269
Option('repo', help="Check the repository related to the"
3270
" current directory."),
3271
Option('tree', help="Check the working tree related to"
3272
" the current directory.")]
3274
def run(self, path=None, verbose=False, branch=False, repo=False,
3276
from bzrlib.check import check_dwim
3279
if not branch and not repo and not tree:
3280
branch = repo = tree = True
3281
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3284
class cmd_upgrade(Command):
3285
"""Upgrade branch storage to current format.
3287
The check command or bzr developers may sometimes advise you to run
3288
this command. When the default format has changed you may also be warned
3289
during other operations to upgrade.
3292
_see_also = ['check']
3293
takes_args = ['url?']
3295
RegistryOption('format',
3296
help='Upgrade to a specific format. See "bzr help'
3297
' formats" for details.',
3298
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3299
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3300
value_switches=True, title='Branch format'),
3303
def run(self, url='.', format=None):
3304
from bzrlib.upgrade import upgrade
3305
upgrade(url, format)
3308
class cmd_whoami(Command):
3309
"""Show or set bzr user id.
3312
Show the email of the current user::
3316
Set the current user::
3318
bzr whoami "Frank Chu <fchu@example.com>"
3320
takes_options = [ Option('email',
3321
help='Display email address only.'),
3323
help='Set identity for the current branch instead of '
3326
takes_args = ['name?']
3327
encoding_type = 'replace'
3330
def run(self, email=False, branch=False, name=None):
3332
# use branch if we're inside one; otherwise global config
3334
c = Branch.open_containing('.')[0].get_config()
3335
except errors.NotBranchError:
3336
c = config.GlobalConfig()
3338
self.outf.write(c.user_email() + '\n')
3340
self.outf.write(c.username() + '\n')
3343
# display a warning if an email address isn't included in the given name.
3345
config.extract_email_address(name)
3346
except errors.NoEmailInUsername, e:
3347
warning('"%s" does not seem to contain an email address. '
3348
'This is allowed, but not recommended.', name)
3350
# use global config unless --branch given
3352
c = Branch.open_containing('.')[0].get_config()
3354
c = config.GlobalConfig()
3355
c.set_user_option('email', name)
3358
class cmd_nick(Command):
3359
"""Print or set the branch nickname.
3361
If unset, the tree root directory name is used as the nickname.
3362
To print the current nickname, execute with no argument.
3364
Bound branches use the nickname of its master branch unless it is set
3368
_see_also = ['info']
3369
takes_args = ['nickname?']
3370
def run(self, nickname=None):
3371
branch = Branch.open_containing(u'.')[0]
3372
if nickname is None:
3373
self.printme(branch)
3375
branch.nick = nickname
3378
def printme(self, branch):
3379
self.outf.write('%s\n' % branch.nick)
3382
class cmd_alias(Command):
3383
"""Set/unset and display aliases.
3386
Show the current aliases::
3390
Show the alias specified for 'll'::
3394
Set an alias for 'll'::
3396
bzr alias ll="log --line -r-10..-1"
3398
To remove an alias for 'll'::
3400
bzr alias --remove ll
3403
takes_args = ['name?']
3405
Option('remove', help='Remove the alias.'),
3408
def run(self, name=None, remove=False):
3410
self.remove_alias(name)
3412
self.print_aliases()
3414
equal_pos = name.find('=')
3416
self.print_alias(name)
3418
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3420
def remove_alias(self, alias_name):
3421
if alias_name is None:
3422
raise errors.BzrCommandError(
3423
'bzr alias --remove expects an alias to remove.')
3424
# If alias is not found, print something like:
3425
# unalias: foo: not found
3426
c = config.GlobalConfig()
3427
c.unset_alias(alias_name)
3430
def print_aliases(self):
3431
"""Print out the defined aliases in a similar format to bash."""
3432
aliases = config.GlobalConfig().get_aliases()
3433
for key, value in sorted(aliases.iteritems()):
3434
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3437
def print_alias(self, alias_name):
3438
from bzrlib.commands import get_alias
3439
alias = get_alias(alias_name)
3441
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3444
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3446
def set_alias(self, alias_name, alias_command):
3447
"""Save the alias in the global config."""
3448
c = config.GlobalConfig()
3449
c.set_alias(alias_name, alias_command)
3452
class cmd_selftest(Command):
3453
"""Run internal test suite.
3455
If arguments are given, they are regular expressions that say which tests
3456
should run. Tests matching any expression are run, and other tests are
3459
Alternatively if --first is given, matching tests are run first and then
3460
all other tests are run. This is useful if you have been working in a
3461
particular area, but want to make sure nothing else was broken.
3463
If --exclude is given, tests that match that regular expression are
3464
excluded, regardless of whether they match --first or not.
3466
To help catch accidential dependencies between tests, the --randomize
3467
option is useful. In most cases, the argument used is the word 'now'.
3468
Note that the seed used for the random number generator is displayed
3469
when this option is used. The seed can be explicitly passed as the
3470
argument to this option if required. This enables reproduction of the
3471
actual ordering used if and when an order sensitive problem is encountered.
3473
If --list-only is given, the tests that would be run are listed. This is
3474
useful when combined with --first, --exclude and/or --randomize to
3475
understand their impact. The test harness reports "Listed nn tests in ..."
3476
instead of "Ran nn tests in ..." when list mode is enabled.
3478
If the global option '--no-plugins' is given, plugins are not loaded
3479
before running the selftests. This has two effects: features provided or
3480
modified by plugins will not be tested, and tests provided by plugins will
3483
Tests that need working space on disk use a common temporary directory,
3484
typically inside $TMPDIR or /tmp.
3486
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3487
into a pdb postmortem session.
3490
Run only tests relating to 'ignore'::
3494
Disable plugins and list tests as they're run::
3496
bzr --no-plugins selftest -v
3498
# NB: this is used from the class without creating an instance, which is
3499
# why it does not have a self parameter.
3500
def get_transport_type(typestring):
3501
"""Parse and return a transport specifier."""
3502
if typestring == "sftp":
3503
from bzrlib.tests import stub_sftp
3504
return stub_sftp.SFTPAbsoluteServer
3505
if typestring == "memory":
3506
from bzrlib.tests import test_server
3507
return memory.MemoryServer
3508
if typestring == "fakenfs":
3509
from bzrlib.tests import test_server
3510
return test_server.FakeNFSServer
3511
msg = "No known transport type %s. Supported types are: sftp\n" %\
3513
raise errors.BzrCommandError(msg)
3516
takes_args = ['testspecs*']
3517
takes_options = ['verbose',
3519
help='Stop when one test fails.',
3523
help='Use a different transport by default '
3524
'throughout the test suite.',
3525
type=get_transport_type),
3527
help='Run the benchmarks rather than selftests.'),
3528
Option('lsprof-timed',
3529
help='Generate lsprof output for benchmarked'
3530
' sections of code.'),
3531
Option('lsprof-tests',
3532
help='Generate lsprof output for each test.'),
3533
Option('cache-dir', type=str,
3534
help='Cache intermediate benchmark output in this '
3537
help='Run all tests, but run specified tests first.',
3541
help='List the tests instead of running them.'),
3542
RegistryOption('parallel',
3543
help="Run the test suite in parallel.",
3544
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3545
value_switches=False,
3547
Option('randomize', type=str, argname="SEED",
3548
help='Randomize the order of tests using the given'
3549
' seed or "now" for the current time.'),
3550
Option('exclude', type=str, argname="PATTERN",
3552
help='Exclude tests that match this regular'
3555
help='Output test progress via subunit.'),
3556
Option('strict', help='Fail on missing dependencies or '
3558
Option('load-list', type=str, argname='TESTLISTFILE',
3559
help='Load a test id list from a text file.'),
3560
ListOption('debugflag', type=str, short_name='E',
3561
help='Turn on a selftest debug flag.'),
3562
ListOption('starting-with', type=str, argname='TESTID',
3563
param_name='starting_with', short_name='s',
3565
'Load only the tests starting with TESTID.'),
3567
encoding_type = 'replace'
3570
Command.__init__(self)
3571
self.additional_selftest_args = {}
3573
def run(self, testspecs_list=None, verbose=False, one=False,
3574
transport=None, benchmark=None,
3575
lsprof_timed=None, cache_dir=None,
3576
first=False, list_only=False,
3577
randomize=None, exclude=None, strict=False,
3578
load_list=None, debugflag=None, starting_with=None, subunit=False,
3579
parallel=None, lsprof_tests=False):
3580
from bzrlib.tests import selftest
3581
import bzrlib.benchmarks as benchmarks
3582
from bzrlib.benchmarks import tree_creator
3584
# Make deprecation warnings visible, unless -Werror is set
3585
symbol_versioning.activate_deprecation_warnings(override=False)
3587
if cache_dir is not None:
3588
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3589
if testspecs_list is not None:
3590
pattern = '|'.join(testspecs_list)
3595
from bzrlib.tests import SubUnitBzrRunner
3597
raise errors.BzrCommandError("subunit not available. subunit "
3598
"needs to be installed to use --subunit.")
3599
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3601
self.additional_selftest_args.setdefault(
3602
'suite_decorators', []).append(parallel)
3604
test_suite_factory = benchmarks.test_suite
3605
# Unless user explicitly asks for quiet, be verbose in benchmarks
3606
verbose = not is_quiet()
3607
# TODO: should possibly lock the history file...
3608
benchfile = open(".perf_history", "at", buffering=1)
3609
self.add_cleanup(benchfile.close)
3611
test_suite_factory = None
3613
selftest_kwargs = {"verbose": verbose,
3615
"stop_on_failure": one,
3616
"transport": transport,
3617
"test_suite_factory": test_suite_factory,
3618
"lsprof_timed": lsprof_timed,
3619
"lsprof_tests": lsprof_tests,
3620
"bench_history": benchfile,
3621
"matching_tests_first": first,
3622
"list_only": list_only,
3623
"random_seed": randomize,
3624
"exclude_pattern": exclude,
3626
"load_list": load_list,
3627
"debug_flags": debugflag,
3628
"starting_with": starting_with
3630
selftest_kwargs.update(self.additional_selftest_args)
3631
result = selftest(**selftest_kwargs)
3632
return int(not result)
3635
class cmd_version(Command):
3636
"""Show version of bzr."""
3638
encoding_type = 'replace'
3640
Option("short", help="Print just the version number."),
3644
def run(self, short=False):
3645
from bzrlib.version import show_version
3647
self.outf.write(bzrlib.version_string + '\n')
3649
show_version(to_file=self.outf)
3652
class cmd_rocks(Command):
3653
"""Statement of optimism."""
3659
self.outf.write("It sure does!\n")
3662
class cmd_find_merge_base(Command):
3663
"""Find and print a base revision for merging two branches."""
3664
# TODO: Options to specify revisions on either side, as if
3665
# merging only part of the history.
3666
takes_args = ['branch', 'other']
3670
def run(self, branch, other):
3671
from bzrlib.revision import ensure_null
3673
branch1 = Branch.open_containing(branch)[0]
3674
branch2 = Branch.open_containing(other)[0]
3676
self.add_cleanup(branch1.unlock)
3678
self.add_cleanup(branch2.unlock)
3679
last1 = ensure_null(branch1.last_revision())
3680
last2 = ensure_null(branch2.last_revision())
3682
graph = branch1.repository.get_graph(branch2.repository)
3683
base_rev_id = graph.find_unique_lca(last1, last2)
3685
self.outf.write('merge base is revision %s\n' % base_rev_id)
3688
class cmd_merge(Command):
3689
"""Perform a three-way merge.
3691
The source of the merge can be specified either in the form of a branch,
3692
or in the form of a path to a file containing a merge directive generated
3693
with bzr send. If neither is specified, the default is the upstream branch
3694
or the branch most recently merged using --remember.
3696
When merging a branch, by default the tip will be merged. To pick a different
3697
revision, pass --revision. If you specify two values, the first will be used as
3698
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3699
available revisions, like this is commonly referred to as "cherrypicking".
3701
Revision numbers are always relative to the branch being merged.
3703
By default, bzr will try to merge in all new work from the other
3704
branch, automatically determining an appropriate base. If this
3705
fails, you may need to give an explicit base.
3707
Merge will do its best to combine the changes in two branches, but there
3708
are some kinds of problems only a human can fix. When it encounters those,
3709
it will mark a conflict. A conflict means that you need to fix something,
3710
before you should commit.
3712
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3714
If there is no default branch set, the first merge will set it. After
3715
that, you can omit the branch to use the default. To change the
3716
default, use --remember. The value will only be saved if the remote
3717
location can be accessed.
3719
The results of the merge are placed into the destination working
3720
directory, where they can be reviewed (with bzr diff), tested, and then
3721
committed to record the result of the merge.
3723
merge refuses to run if there are any uncommitted changes, unless
3724
--force is given. The --force option can also be used to create a
3725
merge revision which has more than two parents.
3727
If one would like to merge changes from the working tree of the other
3728
branch without merging any committed revisions, the --uncommitted option
3731
To select only some changes to merge, use "merge -i", which will prompt
3732
you to apply each diff hunk and file change, similar to "shelve".
3735
To merge the latest revision from bzr.dev::
3737
bzr merge ../bzr.dev
3739
To merge changes up to and including revision 82 from bzr.dev::
3741
bzr merge -r 82 ../bzr.dev
3743
To merge the changes introduced by 82, without previous changes::
3745
bzr merge -r 81..82 ../bzr.dev
3747
To apply a merge directive contained in /tmp/merge::
3749
bzr merge /tmp/merge
3751
To create a merge revision with three parents from two branches
3752
feature1a and feature1b:
3754
bzr merge ../feature1a
3755
bzr merge ../feature1b --force
3756
bzr commit -m 'revision with three parents'
3759
encoding_type = 'exact'
3760
_see_also = ['update', 'remerge', 'status-flags', 'send']
3761
takes_args = ['location?']
3766
help='Merge even if the destination tree has uncommitted changes.'),
3770
Option('show-base', help="Show base revision text in "
3772
Option('uncommitted', help='Apply uncommitted changes'
3773
' from a working copy, instead of branch changes.'),
3774
Option('pull', help='If the destination is already'
3775
' completely merged into the source, pull from the'
3776
' source rather than merging. When this happens,'
3777
' you do not need to commit the result.'),
3779
help='Branch to merge into, '
3780
'rather than the one containing the working directory.',
3784
Option('preview', help='Instead of merging, show a diff of the'
3786
Option('interactive', help='Select changes interactively.',
3790
def run(self, location=None, revision=None, force=False,
3791
merge_type=None, show_base=False, reprocess=None, remember=False,
3792
uncommitted=False, pull=False,
3797
if merge_type is None:
3798
merge_type = _mod_merge.Merge3Merger
3800
if directory is None: directory = u'.'
3801
possible_transports = []
3803
allow_pending = True
3804
verified = 'inapplicable'
3805
tree = WorkingTree.open_containing(directory)[0]
3808
basis_tree = tree.revision_tree(tree.last_revision())
3809
except errors.NoSuchRevision:
3810
basis_tree = tree.basis_tree()
3812
# die as quickly as possible if there are uncommitted changes
3814
if tree.has_changes():
3815
raise errors.UncommittedChanges(tree)
3817
view_info = _get_view_info_for_change_reporter(tree)
3818
change_reporter = delta._ChangeReporter(
3819
unversioned_filter=tree.is_ignored, view_info=view_info)
3820
pb = ui.ui_factory.nested_progress_bar()
3821
self.add_cleanup(pb.finished)
3823
self.add_cleanup(tree.unlock)
3824
if location is not None:
3826
mergeable = bundle.read_mergeable_from_url(location,
3827
possible_transports=possible_transports)
3828
except errors.NotABundle:
3832
raise errors.BzrCommandError('Cannot use --uncommitted'
3833
' with bundles or merge directives.')
3835
if revision is not None:
3836
raise errors.BzrCommandError(
3837
'Cannot use -r with merge directives or bundles')
3838
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3841
if merger is None and uncommitted:
3842
if revision is not None and len(revision) > 0:
3843
raise errors.BzrCommandError('Cannot use --uncommitted and'
3844
' --revision at the same time.')
3845
merger = self.get_merger_from_uncommitted(tree, location, None)
3846
allow_pending = False
3849
merger, allow_pending = self._get_merger_from_branch(tree,
3850
location, revision, remember, possible_transports, None)
3852
merger.merge_type = merge_type
3853
merger.reprocess = reprocess
3854
merger.show_base = show_base
3855
self.sanity_check_merger(merger)
3856
if (merger.base_rev_id == merger.other_rev_id and
3857
merger.other_rev_id is not None):
3858
note('Nothing to do.')
3861
if merger.interesting_files is not None:
3862
raise errors.BzrCommandError('Cannot pull individual files')
3863
if (merger.base_rev_id == tree.last_revision()):
3864
result = tree.pull(merger.other_branch, False,
3865
merger.other_rev_id)
3866
result.report(self.outf)
3868
if merger.this_basis is None:
3869
raise errors.BzrCommandError(
3870
"This branch has no commits."
3871
" (perhaps you would prefer 'bzr pull')")
3873
return self._do_preview(merger)
3875
return self._do_interactive(merger)
3877
return self._do_merge(merger, change_reporter, allow_pending,
3880
def _get_preview(self, merger):
3881
tree_merger = merger.make_merger()
3882
tt = tree_merger.make_preview_transform()
3883
self.add_cleanup(tt.finalize)
3884
result_tree = tt.get_preview_tree()
3887
def _do_preview(self, merger):
3888
from bzrlib.diff import show_diff_trees
3889
result_tree = self._get_preview(merger)
3890
show_diff_trees(merger.this_tree, result_tree, self.outf,
3891
old_label='', new_label='')
3893
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3894
merger.change_reporter = change_reporter
3895
conflict_count = merger.do_merge()
3897
merger.set_pending()
3898
if verified == 'failed':
3899
warning('Preview patch does not match changes')
3900
if conflict_count != 0:
3905
def _do_interactive(self, merger):
3906
"""Perform an interactive merge.
3908
This works by generating a preview tree of the merge, then using
3909
Shelver to selectively remove the differences between the working tree
3910
and the preview tree.
3912
from bzrlib import shelf_ui
3913
result_tree = self._get_preview(merger)
3914
writer = bzrlib.option.diff_writer_registry.get()
3915
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3916
reporter=shelf_ui.ApplyReporter(),
3917
diff_writer=writer(sys.stdout))
3923
def sanity_check_merger(self, merger):
3924
if (merger.show_base and
3925
not merger.merge_type is _mod_merge.Merge3Merger):
3926
raise errors.BzrCommandError("Show-base is not supported for this"
3927
" merge type. %s" % merger.merge_type)
3928
if merger.reprocess is None:
3929
if merger.show_base:
3930
merger.reprocess = False
3932
# Use reprocess if the merger supports it
3933
merger.reprocess = merger.merge_type.supports_reprocess
3934
if merger.reprocess and not merger.merge_type.supports_reprocess:
3935
raise errors.BzrCommandError("Conflict reduction is not supported"
3936
" for merge type %s." %
3938
if merger.reprocess and merger.show_base:
3939
raise errors.BzrCommandError("Cannot do conflict reduction and"
3942
def _get_merger_from_branch(self, tree, location, revision, remember,
3943
possible_transports, pb):
3944
"""Produce a merger from a location, assuming it refers to a branch."""
3945
from bzrlib.tag import _merge_tags_if_possible
3946
# find the branch locations
3947
other_loc, user_location = self._select_branch_location(tree, location,
3949
if revision is not None and len(revision) == 2:
3950
base_loc, _unused = self._select_branch_location(tree,
3951
location, revision, 0)
3953
base_loc = other_loc
3955
other_branch, other_path = Branch.open_containing(other_loc,
3956
possible_transports)
3957
if base_loc == other_loc:
3958
base_branch = other_branch
3960
base_branch, base_path = Branch.open_containing(base_loc,
3961
possible_transports)
3962
# Find the revision ids
3963
other_revision_id = None
3964
base_revision_id = None
3965
if revision is not None:
3966
if len(revision) >= 1:
3967
other_revision_id = revision[-1].as_revision_id(other_branch)
3968
if len(revision) == 2:
3969
base_revision_id = revision[0].as_revision_id(base_branch)
3970
if other_revision_id is None:
3971
other_revision_id = _mod_revision.ensure_null(
3972
other_branch.last_revision())
3973
# Remember where we merge from
3974
if ((remember or tree.branch.get_submit_branch() is None) and
3975
user_location is not None):
3976
tree.branch.set_submit_branch(other_branch.base)
3977
_merge_tags_if_possible(other_branch, tree.branch)
3978
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3979
other_revision_id, base_revision_id, other_branch, base_branch)
3980
if other_path != '':
3981
allow_pending = False
3982
merger.interesting_files = [other_path]
3984
allow_pending = True
3985
return merger, allow_pending
3987
def get_merger_from_uncommitted(self, tree, location, pb):
3988
"""Get a merger for uncommitted changes.
3990
:param tree: The tree the merger should apply to.
3991
:param location: The location containing uncommitted changes.
3992
:param pb: The progress bar to use for showing progress.
3994
location = self._select_branch_location(tree, location)[0]
3995
other_tree, other_path = WorkingTree.open_containing(location)
3996
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3997
if other_path != '':
3998
merger.interesting_files = [other_path]
4001
def _select_branch_location(self, tree, user_location, revision=None,
4003
"""Select a branch location, according to possible inputs.
4005
If provided, branches from ``revision`` are preferred. (Both
4006
``revision`` and ``index`` must be supplied.)
4008
Otherwise, the ``location`` parameter is used. If it is None, then the
4009
``submit`` or ``parent`` location is used, and a note is printed.
4011
:param tree: The working tree to select a branch for merging into
4012
:param location: The location entered by the user
4013
:param revision: The revision parameter to the command
4014
:param index: The index to use for the revision parameter. Negative
4015
indices are permitted.
4016
:return: (selected_location, user_location). The default location
4017
will be the user-entered location.
4019
if (revision is not None and index is not None
4020
and revision[index] is not None):
4021
branch = revision[index].get_branch()
4022
if branch is not None:
4023
return branch, branch
4024
if user_location is None:
4025
location = self._get_remembered(tree, 'Merging from')
4027
location = user_location
4028
return location, user_location
4030
def _get_remembered(self, tree, verb_string):
4031
"""Use tree.branch's parent if none was supplied.
4033
Report if the remembered location was used.
4035
stored_location = tree.branch.get_submit_branch()
4036
stored_location_type = "submit"
4037
if stored_location is None:
4038
stored_location = tree.branch.get_parent()
4039
stored_location_type = "parent"
4040
mutter("%s", stored_location)
4041
if stored_location is None:
4042
raise errors.BzrCommandError("No location specified or remembered")
4043
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4044
note(u"%s remembered %s location %s", verb_string,
4045
stored_location_type, display_url)
4046
return stored_location
4049
class cmd_remerge(Command):
4052
Use this if you want to try a different merge technique while resolving
4053
conflicts. Some merge techniques are better than others, and remerge
4054
lets you try different ones on different files.
4056
The options for remerge have the same meaning and defaults as the ones for
4057
merge. The difference is that remerge can (only) be run when there is a
4058
pending merge, and it lets you specify particular files.
4061
Re-do the merge of all conflicted files, and show the base text in
4062
conflict regions, in addition to the usual THIS and OTHER texts::
4064
bzr remerge --show-base
4066
Re-do the merge of "foobar", using the weave merge algorithm, with
4067
additional processing to reduce the size of conflict regions::
4069
bzr remerge --merge-type weave --reprocess foobar
4071
takes_args = ['file*']
4076
help="Show base revision text in conflicts."),
4079
def run(self, file_list=None, merge_type=None, show_base=False,
4081
from bzrlib.conflicts import restore
4082
if merge_type is None:
4083
merge_type = _mod_merge.Merge3Merger
4084
tree, file_list = tree_files(file_list)
4086
self.add_cleanup(tree.unlock)
4087
parents = tree.get_parent_ids()
4088
if len(parents) != 2:
4089
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4090
" merges. Not cherrypicking or"
4092
repository = tree.branch.repository
4093
interesting_ids = None
4095
conflicts = tree.conflicts()
4096
if file_list is not None:
4097
interesting_ids = set()
4098
for filename in file_list:
4099
file_id = tree.path2id(filename)
4101
raise errors.NotVersionedError(filename)
4102
interesting_ids.add(file_id)
4103
if tree.kind(file_id) != "directory":
4106
for name, ie in tree.inventory.iter_entries(file_id):
4107
interesting_ids.add(ie.file_id)
4108
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4110
# Remerge only supports resolving contents conflicts
4111
allowed_conflicts = ('text conflict', 'contents conflict')
4112
restore_files = [c.path for c in conflicts
4113
if c.typestring in allowed_conflicts]
4114
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4115
tree.set_conflicts(ConflictList(new_conflicts))
4116
if file_list is not None:
4117
restore_files = file_list
4118
for filename in restore_files:
4120
restore(tree.abspath(filename))
4121
except errors.NotConflicted:
4123
# Disable pending merges, because the file texts we are remerging
4124
# have not had those merges performed. If we use the wrong parents
4125
# list, we imply that the working tree text has seen and rejected
4126
# all the changes from the other tree, when in fact those changes
4127
# have not yet been seen.
4128
tree.set_parent_ids(parents[:1])
4130
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4131
merger.interesting_ids = interesting_ids
4132
merger.merge_type = merge_type
4133
merger.show_base = show_base
4134
merger.reprocess = reprocess
4135
conflicts = merger.do_merge()
4137
tree.set_parent_ids(parents)
4144
class cmd_revert(Command):
4145
"""Revert files to a previous revision.
4147
Giving a list of files will revert only those files. Otherwise, all files
4148
will be reverted. If the revision is not specified with '--revision', the
4149
last committed revision is used.
4151
To remove only some changes, without reverting to a prior version, use
4152
merge instead. For example, "merge . --revision -2..-3" will remove the
4153
changes introduced by -2, without affecting the changes introduced by -1.
4154
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4156
By default, any files that have been manually changed will be backed up
4157
first. (Files changed only by merge are not backed up.) Backup files have
4158
'.~#~' appended to their name, where # is a number.
4160
When you provide files, you can use their current pathname or the pathname
4161
from the target revision. So you can use revert to "undelete" a file by
4162
name. If you name a directory, all the contents of that directory will be
4165
If you have newly added files since the target revision, they will be
4166
removed. If the files to be removed have been changed, backups will be
4167
created as above. Directories containing unknown files will not be
4170
The working tree contains a list of revisions that have been merged but
4171
not yet committed. These revisions will be included as additional parents
4172
of the next commit. Normally, using revert clears that list as well as
4173
reverting the files. If any files are specified, revert leaves the list
4174
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4175
.`` in the tree root to revert all files but keep the recorded merges,
4176
and ``bzr revert --forget-merges`` to clear the pending merge list without
4177
reverting any files.
4179
Using "bzr revert --forget-merges", it is possible to apply all of the
4180
changes from a branch in a single revision. To do this, perform the merge
4181
as desired. Then doing revert with the "--forget-merges" option will keep
4182
the content of the tree as it was, but it will clear the list of pending
4183
merges. The next commit will then contain all of the changes that are
4184
present in the other branch, but without any other parent revisions.
4185
Because this technique forgets where these changes originated, it may
4186
cause additional conflicts on later merges involving the same source and
4190
_see_also = ['cat', 'export']
4193
Option('no-backup', "Do not save backups of reverted files."),
4194
Option('forget-merges',
4195
'Remove pending merge marker, without changing any files.'),
4197
takes_args = ['file*']
4199
def run(self, revision=None, no_backup=False, file_list=None,
4200
forget_merges=None):
4201
tree, file_list = tree_files(file_list)
4203
self.add_cleanup(tree.unlock)
4205
tree.set_parent_ids(tree.get_parent_ids()[:1])
4207
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4210
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4211
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4212
tree.revert(file_list, rev_tree, not no_backup, None,
4213
report_changes=True)
4216
class cmd_assert_fail(Command):
4217
"""Test reporting of assertion failures"""
4218
# intended just for use in testing
4223
raise AssertionError("always fails")
4226
class cmd_help(Command):
4227
"""Show help on a command or other topic.
4230
_see_also = ['topics']
4232
Option('long', 'Show help on all commands.'),
4234
takes_args = ['topic?']
4235
aliases = ['?', '--help', '-?', '-h']
4238
def run(self, topic=None, long=False):
4240
if topic is None and long:
4242
bzrlib.help.help(topic)
4245
class cmd_shell_complete(Command):
4246
"""Show appropriate completions for context.
4248
For a list of all available commands, say 'bzr shell-complete'.
4250
takes_args = ['context?']
4255
def run(self, context=None):
4256
import shellcomplete
4257
shellcomplete.shellcomplete(context)
4260
class cmd_missing(Command):
4261
"""Show unmerged/unpulled revisions between two branches.
4263
OTHER_BRANCH may be local or remote.
4265
To filter on a range of revisions, you can use the command -r begin..end
4266
-r revision requests a specific revision, -r ..end or -r begin.. are
4270
1 - some missing revisions
4271
0 - no missing revisions
4275
Determine the missing revisions between this and the branch at the
4276
remembered pull location::
4280
Determine the missing revisions between this and another branch::
4282
bzr missing http://server/branch
4284
Determine the missing revisions up to a specific revision on the other
4287
bzr missing -r ..-10
4289
Determine the missing revisions up to a specific revision on this
4292
bzr missing --my-revision ..-10
4295
_see_also = ['merge', 'pull']
4296
takes_args = ['other_branch?']
4298
Option('reverse', 'Reverse the order of revisions.'),
4300
'Display changes in the local branch only.'),
4301
Option('this' , 'Same as --mine-only.'),
4302
Option('theirs-only',
4303
'Display changes in the remote branch only.'),
4304
Option('other', 'Same as --theirs-only.'),
4308
custom_help('revision',
4309
help='Filter on other branch revisions (inclusive). '
4310
'See "help revisionspec" for details.'),
4311
Option('my-revision',
4312
type=_parse_revision_str,
4313
help='Filter on local branch revisions (inclusive). '
4314
'See "help revisionspec" for details.'),
4315
Option('include-merges',
4316
'Show all revisions in addition to the mainline ones.'),
4318
encoding_type = 'replace'
4321
def run(self, other_branch=None, reverse=False, mine_only=False,
4323
log_format=None, long=False, short=False, line=False,
4324
show_ids=False, verbose=False, this=False, other=False,
4325
include_merges=False, revision=None, my_revision=None):
4326
from bzrlib.missing import find_unmerged, iter_log_revisions
4335
# TODO: We should probably check that we don't have mine-only and
4336
# theirs-only set, but it gets complicated because we also have
4337
# this and other which could be used.
4344
local_branch = Branch.open_containing(u".")[0]
4345
parent = local_branch.get_parent()
4346
if other_branch is None:
4347
other_branch = parent
4348
if other_branch is None:
4349
raise errors.BzrCommandError("No peer location known"
4351
display_url = urlutils.unescape_for_display(parent,
4353
message("Using saved parent location: "
4354
+ display_url + "\n")
4356
remote_branch = Branch.open(other_branch)
4357
if remote_branch.base == local_branch.base:
4358
remote_branch = local_branch
4360
local_branch.lock_read()
4361
self.add_cleanup(local_branch.unlock)
4362
local_revid_range = _revision_range_to_revid_range(
4363
_get_revision_range(my_revision, local_branch,
4366
remote_branch.lock_read()
4367
self.add_cleanup(remote_branch.unlock)
4368
remote_revid_range = _revision_range_to_revid_range(
4369
_get_revision_range(revision,
4370
remote_branch, self.name()))
4372
local_extra, remote_extra = find_unmerged(
4373
local_branch, remote_branch, restrict,
4374
backward=not reverse,
4375
include_merges=include_merges,
4376
local_revid_range=local_revid_range,
4377
remote_revid_range=remote_revid_range)
4379
if log_format is None:
4380
registry = log.log_formatter_registry
4381
log_format = registry.get_default(local_branch)
4382
lf = log_format(to_file=self.outf,
4384
show_timezone='original')
4387
if local_extra and not theirs_only:
4388
message("You have %d extra revision(s):\n" %
4390
for revision in iter_log_revisions(local_extra,
4391
local_branch.repository,
4393
lf.log_revision(revision)
4394
printed_local = True
4397
printed_local = False
4399
if remote_extra and not mine_only:
4400
if printed_local is True:
4402
message("You are missing %d revision(s):\n" %
4404
for revision in iter_log_revisions(remote_extra,
4405
remote_branch.repository,
4407
lf.log_revision(revision)
4410
if mine_only and not local_extra:
4411
# We checked local, and found nothing extra
4412
message('This branch is up to date.\n')
4413
elif theirs_only and not remote_extra:
4414
# We checked remote, and found nothing extra
4415
message('Other branch is up to date.\n')
4416
elif not (mine_only or theirs_only or local_extra or
4418
# We checked both branches, and neither one had extra
4420
message("Branches are up to date.\n")
4422
if not status_code and parent is None and other_branch is not None:
4423
local_branch.lock_write()
4424
self.add_cleanup(local_branch.unlock)
4425
# handle race conditions - a parent might be set while we run.
4426
if local_branch.get_parent() is None:
4427
local_branch.set_parent(remote_branch.base)
4431
class cmd_pack(Command):
4432
"""Compress the data within a repository."""
4434
_see_also = ['repositories']
4435
takes_args = ['branch_or_repo?']
4437
def run(self, branch_or_repo='.'):
4438
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4440
branch = dir.open_branch()
4441
repository = branch.repository
4442
except errors.NotBranchError:
4443
repository = dir.open_repository()
4447
class cmd_plugins(Command):
4448
"""List the installed plugins.
4450
This command displays the list of installed plugins including
4451
version of plugin and a short description of each.
4453
--verbose shows the path where each plugin is located.
4455
A plugin is an external component for Bazaar that extends the
4456
revision control system, by adding or replacing code in Bazaar.
4457
Plugins can do a variety of things, including overriding commands,
4458
adding new commands, providing additional network transports and
4459
customizing log output.
4461
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4462
for further information on plugins including where to find them and how to
4463
install them. Instructions are also provided there on how to write new
4464
plugins using the Python programming language.
4466
takes_options = ['verbose']
4469
def run(self, verbose=False):
4470
import bzrlib.plugin
4471
from inspect import getdoc
4473
for name, plugin in bzrlib.plugin.plugins().items():
4474
version = plugin.__version__
4475
if version == 'unknown':
4477
name_ver = '%s %s' % (name, version)
4478
d = getdoc(plugin.module)
4480
doc = d.split('\n')[0]
4482
doc = '(no description)'
4483
result.append((name_ver, doc, plugin.path()))
4484
for name_ver, doc, path in sorted(result):
4485
self.outf.write("%s\n" % name_ver)
4486
self.outf.write(" %s\n" % doc)
4488
self.outf.write(" %s\n" % path)
4489
self.outf.write("\n")
4492
class cmd_testament(Command):
4493
"""Show testament (signing-form) of a revision."""
4496
Option('long', help='Produce long-format testament.'),
4498
help='Produce a strict-format testament.')]
4499
takes_args = ['branch?']
4501
def run(self, branch=u'.', revision=None, long=False, strict=False):
4502
from bzrlib.testament import Testament, StrictTestament
4504
testament_class = StrictTestament
4506
testament_class = Testament
4508
b = Branch.open_containing(branch)[0]
4510
b = Branch.open(branch)
4512
self.add_cleanup(b.unlock)
4513
if revision is None:
4514
rev_id = b.last_revision()
4516
rev_id = revision[0].as_revision_id(b)
4517
t = testament_class.from_revision(b.repository, rev_id)
4519
sys.stdout.writelines(t.as_text_lines())
4521
sys.stdout.write(t.as_short_text())
4524
class cmd_annotate(Command):
4525
"""Show the origin of each line in a file.
4527
This prints out the given file with an annotation on the left side
4528
indicating which revision, author and date introduced the change.
4530
If the origin is the same for a run of consecutive lines, it is
4531
shown only at the top, unless the --all option is given.
4533
# TODO: annotate directories; showing when each file was last changed
4534
# TODO: if the working copy is modified, show annotations on that
4535
# with new uncommitted lines marked
4536
aliases = ['ann', 'blame', 'praise']
4537
takes_args = ['filename']
4538
takes_options = [Option('all', help='Show annotations on all lines.'),
4539
Option('long', help='Show commit date in annotations.'),
4543
encoding_type = 'exact'
4546
def run(self, filename, all=False, long=False, revision=None,
4548
from bzrlib.annotate import annotate_file, annotate_file_tree
4549
wt, branch, relpath = \
4550
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4553
self.add_cleanup(wt.unlock)
4556
self.add_cleanup(branch.unlock)
4557
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
self.add_cleanup(tree.unlock)
4561
file_id = wt.path2id(relpath)
4563
file_id = tree.path2id(relpath)
4565
raise errors.NotVersionedError(filename)
4566
file_version = tree.inventory[file_id].revision
4567
if wt is not None and revision is None:
4568
# If there is a tree and we're not annotating historical
4569
# versions, annotate the working tree's content.
4570
annotate_file_tree(wt, file_id, self.outf, long, all,
4573
annotate_file(branch, file_version, file_id, long, all, self.outf,
4577
class cmd_re_sign(Command):
4578
"""Create a digital signature for an existing revision."""
4579
# TODO be able to replace existing ones.
4581
hidden = True # is this right ?
4582
takes_args = ['revision_id*']
4583
takes_options = ['revision']
4585
def run(self, revision_id_list=None, revision=None):
4586
if revision_id_list is not None and revision is not None:
4587
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4588
if revision_id_list is None and revision is None:
4589
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
b = WorkingTree.open_containing(u'.')[0].branch
4592
self.add_cleanup(b.unlock)
4593
return self._run(b, revision_id_list, revision)
4595
def _run(self, b, revision_id_list, revision):
4596
import bzrlib.gpg as gpg
4597
gpg_strategy = gpg.GPGStrategy(b.get_config())
4598
if revision_id_list is not None:
4599
b.repository.start_write_group()
4601
for revision_id in revision_id_list:
4602
b.repository.sign_revision(revision_id, gpg_strategy)
4604
b.repository.abort_write_group()
4607
b.repository.commit_write_group()
4608
elif revision is not None:
4609
if len(revision) == 1:
4610
revno, rev_id = revision[0].in_history(b)
4611
b.repository.start_write_group()
4613
b.repository.sign_revision(rev_id, gpg_strategy)
4615
b.repository.abort_write_group()
4618
b.repository.commit_write_group()
4619
elif len(revision) == 2:
4620
# are they both on rh- if so we can walk between them
4621
# might be nice to have a range helper for arbitrary
4622
# revision paths. hmm.
4623
from_revno, from_revid = revision[0].in_history(b)
4624
to_revno, to_revid = revision[1].in_history(b)
4625
if to_revid is None:
4626
to_revno = b.revno()
4627
if from_revno is None or to_revno is None:
4628
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4629
b.repository.start_write_group()
4631
for revno in range(from_revno, to_revno + 1):
4632
b.repository.sign_revision(b.get_rev_id(revno),
4635
b.repository.abort_write_group()
4638
b.repository.commit_write_group()
4640
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4643
class cmd_bind(Command):
4644
"""Convert the current branch into a checkout of the supplied branch.
4646
Once converted into a checkout, commits must succeed on the master branch
4647
before they will be applied to the local branch.
4649
Bound branches use the nickname of its master branch unless it is set
4650
locally, in which case binding will update the local nickname to be
4654
_see_also = ['checkouts', 'unbind']
4655
takes_args = ['location?']
4658
def run(self, location=None):
4659
b, relpath = Branch.open_containing(u'.')
4660
if location is None:
4662
location = b.get_old_bound_location()
4663
except errors.UpgradeRequired:
4664
raise errors.BzrCommandError('No location supplied. '
4665
'This format does not remember old locations.')
4667
if location is None:
4668
if b.get_bound_location() is not None:
4669
raise errors.BzrCommandError('Branch is already bound')
4671
raise errors.BzrCommandError('No location supplied '
4672
'and no previous location known')
4673
b_other = Branch.open(location)
4676
except errors.DivergedBranches:
4677
raise errors.BzrCommandError('These branches have diverged.'
4678
' Try merging, and then bind again.')
4679
if b.get_config().has_explicit_nickname():
4680
b.nick = b_other.nick
4683
class cmd_unbind(Command):
4684
"""Convert the current checkout into a regular branch.
4686
After unbinding, the local branch is considered independent and subsequent
4687
commits will be local only.
4690
_see_also = ['checkouts', 'bind']
4695
b, relpath = Branch.open_containing(u'.')
4697
raise errors.BzrCommandError('Local branch is not bound')
4700
class cmd_uncommit(Command):
4701
"""Remove the last committed revision.
4703
--verbose will print out what is being removed.
4704
--dry-run will go through all the motions, but not actually
4707
If --revision is specified, uncommit revisions to leave the branch at the
4708
specified revision. For example, "bzr uncommit -r 15" will leave the
4709
branch at revision 15.
4711
Uncommit leaves the working tree ready for a new commit. The only change
4712
it may make is to restore any pending merges that were present before
4716
# TODO: jam 20060108 Add an option to allow uncommit to remove
4717
# unreferenced information in 'branch-as-repository' branches.
4718
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4719
# information in shared branches as well.
4720
_see_also = ['commit']
4721
takes_options = ['verbose', 'revision',
4722
Option('dry-run', help='Don\'t actually make changes.'),
4723
Option('force', help='Say yes to all questions.'),
4725
help="Only remove the commits from the local branch"
4726
" when in a checkout."
4729
takes_args = ['location?']
4731
encoding_type = 'replace'
4733
def run(self, location=None,
4734
dry_run=False, verbose=False,
4735
revision=None, force=False, local=False):
4736
if location is None:
4738
control, relpath = bzrdir.BzrDir.open_containing(location)
4740
tree = control.open_workingtree()
4742
except (errors.NoWorkingTree, errors.NotLocalUrl):
4744
b = control.open_branch()
4746
if tree is not None:
4748
self.add_cleanup(tree.unlock)
4751
self.add_cleanup(b.unlock)
4752
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4754
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4755
from bzrlib.log import log_formatter, show_log
4756
from bzrlib.uncommit import uncommit
4758
last_revno, last_rev_id = b.last_revision_info()
4761
if revision is None:
4763
rev_id = last_rev_id
4765
# 'bzr uncommit -r 10' actually means uncommit
4766
# so that the final tree is at revno 10.
4767
# but bzrlib.uncommit.uncommit() actually uncommits
4768
# the revisions that are supplied.
4769
# So we need to offset it by one
4770
revno = revision[0].in_history(b).revno + 1
4771
if revno <= last_revno:
4772
rev_id = b.get_rev_id(revno)
4774
if rev_id is None or _mod_revision.is_null(rev_id):
4775
self.outf.write('No revisions to uncommit.\n')
4778
lf = log_formatter('short',
4780
show_timezone='original')
4785
direction='forward',
4786
start_revision=revno,
4787
end_revision=last_revno)
4790
self.outf.write('Dry-run, pretending to remove'
4791
' the above revisions.\n')
4793
self.outf.write('The above revision(s) will be removed.\n')
4796
if not ui.ui_factory.get_boolean('Are you sure'):
4797
self.outf.write('Canceled')
4800
mutter('Uncommitting from {%s} to {%s}',
4801
last_rev_id, rev_id)
4802
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4803
revno=revno, local=local)
4804
self.outf.write('You can restore the old tip by running:\n'
4805
' bzr pull . -r revid:%s\n' % last_rev_id)
4808
class cmd_break_lock(Command):
4809
"""Break a dead lock on a repository, branch or working directory.
4811
CAUTION: Locks should only be broken when you are sure that the process
4812
holding the lock has been stopped.
4814
You can get information on what locks are open via the 'bzr info
4815
[location]' command.
4819
bzr break-lock bzr+ssh://example.com/bzr/foo
4821
takes_args = ['location?']
4823
def run(self, location=None, show=False):
4824
if location is None:
4826
control, relpath = bzrdir.BzrDir.open_containing(location)
4828
control.break_lock()
4829
except NotImplementedError:
4833
class cmd_wait_until_signalled(Command):
4834
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4836
This just prints a line to signal when it is ready, then blocks on stdin.
4842
sys.stdout.write("running\n")
4844
sys.stdin.readline()
4847
class cmd_serve(Command):
4848
"""Run the bzr server."""
4850
aliases = ['server']
4854
help='Serve on stdin/out for use from inetd or sshd.'),
4855
RegistryOption('protocol',
4856
help="Protocol to serve.",
4857
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4858
value_switches=True),
4860
help='Listen for connections on nominated port of the form '
4861
'[hostname:]portnumber. Passing 0 as the port number will '
4862
'result in a dynamically allocated port. The default port '
4863
'depends on the protocol.',
4866
help='Serve contents of this directory.',
4868
Option('allow-writes',
4869
help='By default the server is a readonly server. Supplying '
4870
'--allow-writes enables write access to the contents of '
4871
'the served directory and below. Note that ``bzr serve`` '
4872
'does not perform authentication, so unless some form of '
4873
'external authentication is arranged supplying this '
4874
'option leads to global uncontrolled write access to your '
4879
def get_host_and_port(self, port):
4880
"""Return the host and port to run the smart server on.
4882
If 'port' is None, None will be returned for the host and port.
4884
If 'port' has a colon in it, the string before the colon will be
4885
interpreted as the host.
4887
:param port: A string of the port to run the server on.
4888
:return: A tuple of (host, port), where 'host' is a host name or IP,
4889
and port is an integer TCP/IP port.
4892
if port is not None:
4894
host, port = port.split(':')
4898
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4900
from bzrlib.transport import get_transport, transport_server_registry
4901
if directory is None:
4902
directory = os.getcwd()
4903
if protocol is None:
4904
protocol = transport_server_registry.get()
4905
host, port = self.get_host_and_port(port)
4906
url = urlutils.local_path_to_url(directory)
4907
if not allow_writes:
4908
url = 'readonly+' + url
4909
transport = get_transport(url)
4910
protocol(transport, host, port, inet)
4913
class cmd_join(Command):
4914
"""Combine a tree into its containing tree.
4916
This command requires the target tree to be in a rich-root format.
4918
The TREE argument should be an independent tree, inside another tree, but
4919
not part of it. (Such trees can be produced by "bzr split", but also by
4920
running "bzr branch" with the target inside a tree.)
4922
The result is a combined tree, with the subtree no longer an independant
4923
part. This is marked as a merge of the subtree into the containing tree,
4924
and all history is preserved.
4927
_see_also = ['split']
4928
takes_args = ['tree']
4930
Option('reference', help='Join by reference.', hidden=True),
4933
def run(self, tree, reference=False):
4934
sub_tree = WorkingTree.open(tree)
4935
parent_dir = osutils.dirname(sub_tree.basedir)
4936
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4937
repo = containing_tree.branch.repository
4938
if not repo.supports_rich_root():
4939
raise errors.BzrCommandError(
4940
"Can't join trees because %s doesn't support rich root data.\n"
4941
"You can use bzr upgrade on the repository."
4945
containing_tree.add_reference(sub_tree)
4946
except errors.BadReferenceTarget, e:
4947
# XXX: Would be better to just raise a nicely printable
4948
# exception from the real origin. Also below. mbp 20070306
4949
raise errors.BzrCommandError("Cannot join %s. %s" %
4953
containing_tree.subsume(sub_tree)
4954
except errors.BadSubsumeSource, e:
4955
raise errors.BzrCommandError("Cannot join %s. %s" %
4959
class cmd_split(Command):
4960
"""Split a subdirectory of a tree into a separate tree.
4962
This command will produce a target tree in a format that supports
4963
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4964
converted into earlier formats like 'dirstate-tags'.
4966
The TREE argument should be a subdirectory of a working tree. That
4967
subdirectory will be converted into an independent tree, with its own
4968
branch. Commits in the top-level tree will not apply to the new subtree.
4971
_see_also = ['join']
4972
takes_args = ['tree']
4974
def run(self, tree):
4975
containing_tree, subdir = WorkingTree.open_containing(tree)
4976
sub_id = containing_tree.path2id(subdir)
4978
raise errors.NotVersionedError(subdir)
4980
containing_tree.extract(sub_id)
4981
except errors.RootNotRich:
4982
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4985
class cmd_merge_directive(Command):
4986
"""Generate a merge directive for auto-merge tools.
4988
A directive requests a merge to be performed, and also provides all the
4989
information necessary to do so. This means it must either include a
4990
revision bundle, or the location of a branch containing the desired
4993
A submit branch (the location to merge into) must be supplied the first
4994
time the command is issued. After it has been supplied once, it will
4995
be remembered as the default.
4997
A public branch is optional if a revision bundle is supplied, but required
4998
if --diff or --plain is specified. It will be remembered as the default
4999
after the first use.
5002
takes_args = ['submit_branch?', 'public_branch?']
5006
_see_also = ['send']
5009
RegistryOption.from_kwargs('patch-type',
5010
'The type of patch to include in the directive.',
5012
value_switches=True,
5014
bundle='Bazaar revision bundle (default).',
5015
diff='Normal unified diff.',
5016
plain='No patch, just directive.'),
5017
Option('sign', help='GPG-sign the directive.'), 'revision',
5018
Option('mail-to', type=str,
5019
help='Instead of printing the directive, email to this address.'),
5020
Option('message', type=str, short_name='m',
5021
help='Message to use when committing this merge.')
5024
encoding_type = 'exact'
5026
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5027
sign=False, revision=None, mail_to=None, message=None):
5028
from bzrlib.revision import ensure_null, NULL_REVISION
5029
include_patch, include_bundle = {
5030
'plain': (False, False),
5031
'diff': (True, False),
5032
'bundle': (True, True),
5034
branch = Branch.open('.')
5035
stored_submit_branch = branch.get_submit_branch()
5036
if submit_branch is None:
5037
submit_branch = stored_submit_branch
5039
if stored_submit_branch is None:
5040
branch.set_submit_branch(submit_branch)
5041
if submit_branch is None:
5042
submit_branch = branch.get_parent()
5043
if submit_branch is None:
5044
raise errors.BzrCommandError('No submit branch specified or known')
5046
stored_public_branch = branch.get_public_branch()
5047
if public_branch is None:
5048
public_branch = stored_public_branch
5049
elif stored_public_branch is None:
5050
branch.set_public_branch(public_branch)
5051
if not include_bundle and public_branch is None:
5052
raise errors.BzrCommandError('No public branch specified or'
5054
base_revision_id = None
5055
if revision is not None:
5056
if len(revision) > 2:
5057
raise errors.BzrCommandError('bzr merge-directive takes '
5058
'at most two one revision identifiers')
5059
revision_id = revision[-1].as_revision_id(branch)
5060
if len(revision) == 2:
5061
base_revision_id = revision[0].as_revision_id(branch)
5063
revision_id = branch.last_revision()
5064
revision_id = ensure_null(revision_id)
5065
if revision_id == NULL_REVISION:
5066
raise errors.BzrCommandError('No revisions to bundle.')
5067
directive = merge_directive.MergeDirective2.from_objects(
5068
branch.repository, revision_id, time.time(),
5069
osutils.local_time_offset(), submit_branch,
5070
public_branch=public_branch, include_patch=include_patch,
5071
include_bundle=include_bundle, message=message,
5072
base_revision_id=base_revision_id)
5075
self.outf.write(directive.to_signed(branch))
5077
self.outf.writelines(directive.to_lines())
5079
message = directive.to_email(mail_to, branch, sign)
5080
s = SMTPConnection(branch.get_config())
5081
s.send_email(message)
5084
class cmd_send(Command):
5085
"""Mail or create a merge-directive for submitting changes.
5087
A merge directive provides many things needed for requesting merges:
5089
* A machine-readable description of the merge to perform
5091
* An optional patch that is a preview of the changes requested
5093
* An optional bundle of revision data, so that the changes can be applied
5094
directly from the merge directive, without retrieving data from a
5097
`bzr send` creates a compact data set that, when applied using bzr
5098
merge, has the same effect as merging from the source branch.
5100
By default the merge directive is self-contained and can be applied to any
5101
branch containing submit_branch in its ancestory without needing access to
5104
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5105
revisions, but only a structured request to merge from the
5106
public_location. In that case the public_branch is needed and it must be
5107
up-to-date and accessible to the recipient. The public_branch is always
5108
included if known, so that people can check it later.
5110
The submit branch defaults to the parent of the source branch, but can be
5111
overridden. Both submit branch and public branch will be remembered in
5112
branch.conf the first time they are used for a particular branch. The
5113
source branch defaults to that containing the working directory, but can
5114
be changed using --from.
5116
In order to calculate those changes, bzr must analyse the submit branch.
5117
Therefore it is most efficient for the submit branch to be a local mirror.
5118
If a public location is known for the submit_branch, that location is used
5119
in the merge directive.
5121
The default behaviour is to send the merge directive by mail, unless -o is
5122
given, in which case it is sent to a file.
5124
Mail is sent using your preferred mail program. This should be transparent
5125
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5126
If the preferred client can't be found (or used), your editor will be used.
5128
To use a specific mail program, set the mail_client configuration option.
5129
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5130
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5131
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5132
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5135
If mail is being sent, a to address is required. This can be supplied
5136
either on the commandline, by setting the submit_to configuration
5137
option in the branch itself or the child_submit_to configuration option
5138
in the submit branch.
5140
Two formats are currently supported: "4" uses revision bundle format 4 and
5141
merge directive format 2. It is significantly faster and smaller than
5142
older formats. It is compatible with Bazaar 0.19 and later. It is the
5143
default. "0.9" uses revision bundle format 0.9 and merge directive
5144
format 1. It is compatible with Bazaar 0.12 - 0.18.
5146
The merge directives created by bzr send may be applied using bzr merge or
5147
bzr pull by specifying a file containing a merge directive as the location.
5149
bzr send makes extensive use of public locations to map local locations into
5150
URLs that can be used by other people. See `bzr help configuration` to
5151
set them, and use `bzr info` to display them.
5154
encoding_type = 'exact'
5156
_see_also = ['merge', 'pull']
5158
takes_args = ['submit_branch?', 'public_branch?']
5162
help='Do not include a bundle in the merge directive.'),
5163
Option('no-patch', help='Do not include a preview patch in the merge'
5166
help='Remember submit and public branch.'),
5168
help='Branch to generate the submission from, '
5169
'rather than the one containing the working directory.',
5172
Option('output', short_name='o',
5173
help='Write merge directive to this file or directory; '
5174
'use - for stdout.',
5177
help='Refuse to send if there are uncommitted changes in'
5178
' the working tree, --no-strict disables the check.'),
5179
Option('mail-to', help='Mail the request to this address.',
5183
Option('body', help='Body for the email.', type=unicode),
5184
RegistryOption('format',
5185
help='Use the specified output format.',
5186
lazy_registry=('bzrlib.send', 'format_registry')),
5189
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5190
no_patch=False, revision=None, remember=False, output=None,
5191
format=None, mail_to=None, message=None, body=None,
5192
strict=None, **kwargs):
5193
from bzrlib.send import send
5194
return send(submit_branch, revision, public_branch, remember,
5195
format, no_bundle, no_patch, output,
5196
kwargs.get('from', '.'), mail_to, message, body,
5201
class cmd_bundle_revisions(cmd_send):
5202
"""Create a merge-directive for submitting changes.
5204
A merge directive provides many things needed for requesting merges:
5206
* A machine-readable description of the merge to perform
5208
* An optional patch that is a preview of the changes requested
5210
* An optional bundle of revision data, so that the changes can be applied
5211
directly from the merge directive, without retrieving data from a
5214
If --no-bundle is specified, then public_branch is needed (and must be
5215
up-to-date), so that the receiver can perform the merge using the
5216
public_branch. The public_branch is always included if known, so that
5217
people can check it later.
5219
The submit branch defaults to the parent, but can be overridden. Both
5220
submit branch and public branch will be remembered if supplied.
5222
If a public_branch is known for the submit_branch, that public submit
5223
branch is used in the merge instructions. This means that a local mirror
5224
can be used as your actual submit branch, once you have set public_branch
5227
Two formats are currently supported: "4" uses revision bundle format 4 and
5228
merge directive format 2. It is significantly faster and smaller than
5229
older formats. It is compatible with Bazaar 0.19 and later. It is the
5230
default. "0.9" uses revision bundle format 0.9 and merge directive
5231
format 1. It is compatible with Bazaar 0.12 - 0.18.
5236
help='Do not include a bundle in the merge directive.'),
5237
Option('no-patch', help='Do not include a preview patch in the merge'
5240
help='Remember submit and public branch.'),
5242
help='Branch to generate the submission from, '
5243
'rather than the one containing the working directory.',
5246
Option('output', short_name='o', help='Write directive to this file.',
5249
help='Refuse to bundle revisions if there are uncommitted'
5250
' changes in the working tree, --no-strict disables the check.'),
5252
RegistryOption('format',
5253
help='Use the specified output format.',
5254
lazy_registry=('bzrlib.send', 'format_registry')),
5256
aliases = ['bundle']
5258
_see_also = ['send', 'merge']
5262
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5263
no_patch=False, revision=None, remember=False, output=None,
5264
format=None, strict=None, **kwargs):
5267
from bzrlib.send import send
5268
return send(submit_branch, revision, public_branch, remember,
5269
format, no_bundle, no_patch, output,
5270
kwargs.get('from', '.'), None, None, None,
5271
self.outf, strict=strict)
5274
class cmd_tag(Command):
5275
"""Create, remove or modify a tag naming a revision.
5277
Tags give human-meaningful names to revisions. Commands that take a -r
5278
(--revision) option can be given -rtag:X, where X is any previously
5281
Tags are stored in the branch. Tags are copied from one branch to another
5282
along when you branch, push, pull or merge.
5284
It is an error to give a tag name that already exists unless you pass
5285
--force, in which case the tag is moved to point to the new revision.
5287
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5288
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5290
If no tag name is specified it will be determined through the
5291
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5292
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5296
_see_also = ['commit', 'tags']
5297
takes_args = ['tag_name?']
5300
help='Delete this tag rather than placing it.',
5303
help='Branch in which to place the tag.',
5308
help='Replace existing tags.',
5313
def run(self, tag_name=None,
5319
branch, relpath = Branch.open_containing(directory)
5321
self.add_cleanup(branch.unlock)
5323
if tag_name is None:
5324
raise errors.BzrCommandError("No tag specified to delete.")
5325
branch.tags.delete_tag(tag_name)
5326
self.outf.write('Deleted tag %s.\n' % tag_name)
5329
if len(revision) != 1:
5330
raise errors.BzrCommandError(
5331
"Tags can only be placed on a single revision, "
5333
revision_id = revision[0].as_revision_id(branch)
5335
revision_id = branch.last_revision()
5336
if tag_name is None:
5337
tag_name = branch.automatic_tag_name(revision_id)
5338
if tag_name is None:
5339
raise errors.BzrCommandError(
5340
"Please specify a tag name.")
5341
if (not force) and branch.tags.has_tag(tag_name):
5342
raise errors.TagAlreadyExists(tag_name)
5343
branch.tags.set_tag(tag_name, revision_id)
5344
self.outf.write('Created tag %s.\n' % tag_name)
5347
class cmd_tags(Command):
5350
This command shows a table of tag names and the revisions they reference.
5356
help='Branch whose tags should be displayed.',
5360
RegistryOption.from_kwargs('sort',
5361
'Sort tags by different criteria.', title='Sorting',
5362
alpha='Sort tags lexicographically (default).',
5363
time='Sort tags chronologically.',
5376
branch, relpath = Branch.open_containing(directory)
5378
tags = branch.tags.get_tag_dict().items()
5383
self.add_cleanup(branch.unlock)
5385
graph = branch.repository.get_graph()
5386
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5387
revid1, revid2 = rev1.rev_id, rev2.rev_id
5388
# only show revisions between revid1 and revid2 (inclusive)
5389
tags = [(tag, revid) for tag, revid in tags if
5390
graph.is_between(revid, revid1, revid2)]
5393
elif sort == 'time':
5395
for tag, revid in tags:
5397
revobj = branch.repository.get_revision(revid)
5398
except errors.NoSuchRevision:
5399
timestamp = sys.maxint # place them at the end
5401
timestamp = revobj.timestamp
5402
timestamps[revid] = timestamp
5403
tags.sort(key=lambda x: timestamps[x[1]])
5405
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5406
for index, (tag, revid) in enumerate(tags):
5408
revno = branch.revision_id_to_dotted_revno(revid)
5409
if isinstance(revno, tuple):
5410
revno = '.'.join(map(str, revno))
5411
except errors.NoSuchRevision:
5412
# Bad tag data/merges can lead to tagged revisions
5413
# which are not in this branch. Fail gracefully ...
5415
tags[index] = (tag, revno)
5417
for tag, revspec in tags:
5418
self.outf.write('%-20s %s\n' % (tag, revspec))
5421
class cmd_reconfigure(Command):
5422
"""Reconfigure the type of a bzr directory.
5424
A target configuration must be specified.
5426
For checkouts, the bind-to location will be auto-detected if not specified.
5427
The order of preference is
5428
1. For a lightweight checkout, the current bound location.
5429
2. For branches that used to be checkouts, the previously-bound location.
5430
3. The push location.
5431
4. The parent location.
5432
If none of these is available, --bind-to must be specified.
5435
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5436
takes_args = ['location?']
5438
RegistryOption.from_kwargs(
5440
title='Target type',
5441
help='The type to reconfigure the directory to.',
5442
value_switches=True, enum_switch=False,
5443
branch='Reconfigure to be an unbound branch with no working tree.',
5444
tree='Reconfigure to be an unbound branch with a working tree.',
5445
checkout='Reconfigure to be a bound branch with a working tree.',
5446
lightweight_checkout='Reconfigure to be a lightweight'
5447
' checkout (with no local history).',
5448
standalone='Reconfigure to be a standalone branch '
5449
'(i.e. stop using shared repository).',
5450
use_shared='Reconfigure to use a shared repository.',
5451
with_trees='Reconfigure repository to create '
5452
'working trees on branches by default.',
5453
with_no_trees='Reconfigure repository to not create '
5454
'working trees on branches by default.'
5456
Option('bind-to', help='Branch to bind checkout to.', type=str),
5458
help='Perform reconfiguration even if local changes'
5460
Option('stacked-on',
5461
help='Reconfigure a branch to be stacked on another branch.',
5465
help='Reconfigure a branch to be unstacked. This '
5466
'may require copying substantial data into it.',
5470
def run(self, location=None, target_type=None, bind_to=None, force=False,
5473
directory = bzrdir.BzrDir.open(location)
5474
if stacked_on and unstacked:
5475
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5476
elif stacked_on is not None:
5477
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5479
reconfigure.ReconfigureUnstacked().apply(directory)
5480
# At the moment you can use --stacked-on and a different
5481
# reconfiguration shape at the same time; there seems no good reason
5483
if target_type is None:
5484
if stacked_on or unstacked:
5487
raise errors.BzrCommandError('No target configuration '
5489
elif target_type == 'branch':
5490
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5491
elif target_type == 'tree':
5492
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5493
elif target_type == 'checkout':
5494
reconfiguration = reconfigure.Reconfigure.to_checkout(
5496
elif target_type == 'lightweight-checkout':
5497
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5499
elif target_type == 'use-shared':
5500
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5501
elif target_type == 'standalone':
5502
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5503
elif target_type == 'with-trees':
5504
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5506
elif target_type == 'with-no-trees':
5507
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5509
reconfiguration.apply(force)
5512
class cmd_switch(Command):
5513
"""Set the branch of a checkout and update.
5515
For lightweight checkouts, this changes the branch being referenced.
5516
For heavyweight checkouts, this checks that there are no local commits
5517
versus the current bound branch, then it makes the local branch a mirror
5518
of the new location and binds to it.
5520
In both cases, the working tree is updated and uncommitted changes
5521
are merged. The user can commit or revert these as they desire.
5523
Pending merges need to be committed or reverted before using switch.
5525
The path to the branch to switch to can be specified relative to the parent
5526
directory of the current branch. For example, if you are currently in a
5527
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5530
Bound branches use the nickname of its master branch unless it is set
5531
locally, in which case switching will update the local nickname to be
5535
takes_args = ['to_location?']
5536
takes_options = [Option('force',
5537
help='Switch even if local commits will be lost.'),
5539
Option('create-branch', short_name='b',
5540
help='Create the target branch from this one before'
5541
' switching to it.'),
5544
def run(self, to_location=None, force=False, create_branch=False,
5546
from bzrlib import switch
5548
revision = _get_one_revision('switch', revision)
5549
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5550
if to_location is None:
5551
if revision is None:
5552
raise errors.BzrCommandError('You must supply either a'
5553
' revision or a location')
5556
branch = control_dir.open_branch()
5557
had_explicit_nick = branch.get_config().has_explicit_nickname()
5558
except errors.NotBranchError:
5560
had_explicit_nick = False
5563
raise errors.BzrCommandError('cannot create branch without'
5565
to_location = directory_service.directories.dereference(
5567
if '/' not in to_location and '\\' not in to_location:
5568
# This path is meant to be relative to the existing branch
5569
this_url = self._get_branch_location(control_dir)
5570
to_location = urlutils.join(this_url, '..', to_location)
5571
to_branch = branch.bzrdir.sprout(to_location,
5572
possible_transports=[branch.bzrdir.root_transport],
5573
source_branch=branch).open_branch()
5576
to_branch = Branch.open(to_location)
5577
except errors.NotBranchError:
5578
this_url = self._get_branch_location(control_dir)
5579
to_branch = Branch.open(
5580
urlutils.join(this_url, '..', to_location))
5581
if revision is not None:
5582
revision = revision.as_revision_id(to_branch)
5583
switch.switch(control_dir, to_branch, force, revision_id=revision)
5584
if had_explicit_nick:
5585
branch = control_dir.open_branch() #get the new branch!
5586
branch.nick = to_branch.nick
5587
note('Switched to branch: %s',
5588
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5590
def _get_branch_location(self, control_dir):
5591
"""Return location of branch for this control dir."""
5593
this_branch = control_dir.open_branch()
5594
# This may be a heavy checkout, where we want the master branch
5595
master_location = this_branch.get_bound_location()
5596
if master_location is not None:
5597
return master_location
5598
# If not, use a local sibling
5599
return this_branch.base
5600
except errors.NotBranchError:
5601
format = control_dir.find_branch_format()
5602
if getattr(format, 'get_reference', None) is not None:
5603
return format.get_reference(control_dir)
5605
return control_dir.root_transport.base
5608
class cmd_view(Command):
5609
"""Manage filtered views.
5611
Views provide a mask over the tree so that users can focus on
5612
a subset of a tree when doing their work. After creating a view,
5613
commands that support a list of files - status, diff, commit, etc -
5614
effectively have that list of files implicitly given each time.
5615
An explicit list of files can still be given but those files
5616
must be within the current view.
5618
In most cases, a view has a short life-span: it is created to make
5619
a selected change and is deleted once that change is committed.
5620
At other times, you may wish to create one or more named views
5621
and switch between them.
5623
To disable the current view without deleting it, you can switch to
5624
the pseudo view called ``off``. This can be useful when you need
5625
to see the whole tree for an operation or two (e.g. merge) but
5626
want to switch back to your view after that.
5629
To define the current view::
5631
bzr view file1 dir1 ...
5633
To list the current view::
5637
To delete the current view::
5641
To disable the current view without deleting it::
5643
bzr view --switch off
5645
To define a named view and switch to it::
5647
bzr view --name view-name file1 dir1 ...
5649
To list a named view::
5651
bzr view --name view-name
5653
To delete a named view::
5655
bzr view --name view-name --delete
5657
To switch to a named view::
5659
bzr view --switch view-name
5661
To list all views defined::
5665
To delete all views::
5667
bzr view --delete --all
5671
takes_args = ['file*']
5674
help='Apply list or delete action to all views.',
5677
help='Delete the view.',
5680
help='Name of the view to define, list or delete.',
5684
help='Name of the view to switch to.',
5689
def run(self, file_list,
5695
tree, file_list = tree_files(file_list, apply_view=False)
5696
current_view, view_dict = tree.views.get_view_info()
5701
raise errors.BzrCommandError(
5702
"Both --delete and a file list specified")
5704
raise errors.BzrCommandError(
5705
"Both --delete and --switch specified")
5707
tree.views.set_view_info(None, {})
5708
self.outf.write("Deleted all views.\n")
5710
raise errors.BzrCommandError("No current view to delete")
5712
tree.views.delete_view(name)
5713
self.outf.write("Deleted '%s' view.\n" % name)
5716
raise errors.BzrCommandError(
5717
"Both --switch and a file list specified")
5719
raise errors.BzrCommandError(
5720
"Both --switch and --all specified")
5721
elif switch == 'off':
5722
if current_view is None:
5723
raise errors.BzrCommandError("No current view to disable")
5724
tree.views.set_view_info(None, view_dict)
5725
self.outf.write("Disabled '%s' view.\n" % (current_view))
5727
tree.views.set_view_info(switch, view_dict)
5728
view_str = views.view_display_str(tree.views.lookup_view())
5729
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5732
self.outf.write('Views defined:\n')
5733
for view in sorted(view_dict):
5734
if view == current_view:
5738
view_str = views.view_display_str(view_dict[view])
5739
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5741
self.outf.write('No views defined.\n')
5744
# No name given and no current view set
5747
raise errors.BzrCommandError(
5748
"Cannot change the 'off' pseudo view")
5749
tree.views.set_view(name, sorted(file_list))
5750
view_str = views.view_display_str(tree.views.lookup_view())
5751
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5755
# No name given and no current view set
5756
self.outf.write('No current view.\n')
5758
view_str = views.view_display_str(tree.views.lookup_view(name))
5759
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5762
class cmd_hooks(Command):
5768
for hook_key in sorted(hooks.known_hooks.keys()):
5769
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5770
self.outf.write("%s:\n" % type(some_hooks).__name__)
5771
for hook_name, hook_point in sorted(some_hooks.items()):
5772
self.outf.write(" %s:\n" % (hook_name,))
5773
found_hooks = list(hook_point)
5775
for hook in found_hooks:
5776
self.outf.write(" %s\n" %
5777
(some_hooks.get_hook_name(hook),))
5779
self.outf.write(" <no hooks installed>\n")
5782
class cmd_remove_branch(Command):
5785
This will remove the branch from the specified location but
5786
will keep any working tree or repository in place.
5790
Remove the branch at repo/trunk::
5792
bzr remove-branch repo/trunk
5796
takes_args = ["location?"]
5798
aliases = ["rmbranch"]
5800
def run(self, location=None):
5801
if location is None:
5803
branch = Branch.open_containing(location)[0]
5804
branch.bzrdir.destroy_branch()
5807
class cmd_shelve(Command):
5808
"""Temporarily set aside some changes from the current tree.
5810
Shelve allows you to temporarily put changes you've made "on the shelf",
5811
ie. out of the way, until a later time when you can bring them back from
5812
the shelf with the 'unshelve' command. The changes are stored alongside
5813
your working tree, and so they aren't propagated along with your branch nor
5814
will they survive its deletion.
5816
If shelve --list is specified, previously-shelved changes are listed.
5818
Shelve is intended to help separate several sets of changes that have
5819
been inappropriately mingled. If you just want to get rid of all changes
5820
and you don't need to restore them later, use revert. If you want to
5821
shelve all text changes at once, use shelve --all.
5823
If filenames are specified, only the changes to those files will be
5824
shelved. Other files will be left untouched.
5826
If a revision is specified, changes since that revision will be shelved.
5828
You can put multiple items on the shelf, and by default, 'unshelve' will
5829
restore the most recently shelved changes.
5832
takes_args = ['file*']
5836
Option('all', help='Shelve all changes.'),
5838
RegistryOption('writer', 'Method to use for writing diffs.',
5839
bzrlib.option.diff_writer_registry,
5840
value_switches=True, enum_switch=False),
5842
Option('list', help='List shelved changes.'),
5844
help='Destroy removed changes instead of shelving them.'),
5846
_see_also = ['unshelve']
5848
def run(self, revision=None, all=False, file_list=None, message=None,
5849
writer=None, list=False, destroy=False):
5851
return self.run_for_list()
5852
from bzrlib.shelf_ui import Shelver
5854
writer = bzrlib.option.diff_writer_registry.get()
5856
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5857
file_list, message, destroy=destroy)
5862
except errors.UserAbort:
5865
def run_for_list(self):
5866
tree = WorkingTree.open_containing('.')[0]
5868
self.add_cleanup(tree.unlock)
5869
manager = tree.get_shelf_manager()
5870
shelves = manager.active_shelves()
5871
if len(shelves) == 0:
5872
note('No shelved changes.')
5874
for shelf_id in reversed(shelves):
5875
message = manager.get_metadata(shelf_id).get('message')
5877
message = '<no message>'
5878
self.outf.write('%3d: %s\n' % (shelf_id, message))
5882
class cmd_unshelve(Command):
5883
"""Restore shelved changes.
5885
By default, the most recently shelved changes are restored. However if you
5886
specify a shelf by id those changes will be restored instead. This works
5887
best when the changes don't depend on each other.
5890
takes_args = ['shelf_id?']
5892
RegistryOption.from_kwargs(
5893
'action', help="The action to perform.",
5894
enum_switch=False, value_switches=True,
5895
apply="Apply changes and remove from the shelf.",
5896
dry_run="Show changes, but do not apply or remove them.",
5897
preview="Instead of unshelving the changes, show the diff that "
5898
"would result from unshelving.",
5899
delete_only="Delete changes without applying them.",
5900
keep="Apply changes but don't delete them.",
5903
_see_also = ['shelve']
5905
def run(self, shelf_id=None, action='apply'):
5906
from bzrlib.shelf_ui import Unshelver
5907
unshelver = Unshelver.from_args(shelf_id, action)
5911
unshelver.tree.unlock()
5914
class cmd_clean_tree(Command):
5915
"""Remove unwanted files from working tree.
5917
By default, only unknown files, not ignored files, are deleted. Versioned
5918
files are never deleted.
5920
Another class is 'detritus', which includes files emitted by bzr during
5921
normal operations and selftests. (The value of these files decreases with
5924
If no options are specified, unknown files are deleted. Otherwise, option
5925
flags are respected, and may be combined.
5927
To check what clean-tree will do, use --dry-run.
5929
takes_options = [Option('ignored', help='Delete all ignored files.'),
5930
Option('detritus', help='Delete conflict files, merge'
5931
' backups, and failed selftest dirs.'),
5933
help='Delete files unknown to bzr (default).'),
5934
Option('dry-run', help='Show files to delete instead of'
5936
Option('force', help='Do not prompt before deleting.')]
5937
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5939
from bzrlib.clean_tree import clean_tree
5940
if not (unknown or ignored or detritus):
5944
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5945
dry_run=dry_run, no_prompt=force)
5948
class cmd_reference(Command):
5949
"""list, view and set branch locations for nested trees.
5951
If no arguments are provided, lists the branch locations for nested trees.
5952
If one argument is provided, display the branch location for that tree.
5953
If two arguments are provided, set the branch location for that tree.
5958
takes_args = ['path?', 'location?']
5960
def run(self, path=None, location=None):
5962
if path is not None:
5964
tree, branch, relpath =(
5965
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5966
if path is not None:
5969
tree = branch.basis_tree()
5971
info = branch._get_all_reference_info().iteritems()
5972
self._display_reference_info(tree, branch, info)
5974
file_id = tree.path2id(path)
5976
raise errors.NotVersionedError(path)
5977
if location is None:
5978
info = [(file_id, branch.get_reference_info(file_id))]
5979
self._display_reference_info(tree, branch, info)
5981
branch.set_reference_info(file_id, path, location)
5983
def _display_reference_info(self, tree, branch, info):
5985
for file_id, (path, location) in info:
5987
path = tree.id2path(file_id)
5988
except errors.NoSuchId:
5990
ref_list.append((path, location))
5991
for path, location in sorted(ref_list):
5992
self.outf.write('%s %s\n' % (path, location))
5995
def _register_lazy_builtins():
5996
# register lazy builtins from other modules; called at startup and should
5997
# be only called once.
5998
for (name, aliases, module_name) in [
5999
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6000
('cmd_dpush', [], 'bzrlib.foreign'),
6001
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6002
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6003
('cmd_conflicts', [], 'bzrlib.conflicts'),
6004
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6006
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
