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
992
self.add_cleanup(tree_to.unlock)
993
except errors.NoWorkingTree:
995
branch_to = Branch.open_containing(directory)[0]
996
branch_to.lock_write()
997
self.add_cleanup(branch_to.unlock)
999
if local and not branch_to.get_bound_location():
1000
raise errors.LocalRequiresBoundBranch()
1002
possible_transports = []
1003
if location is not None:
1005
mergeable = bundle.read_mergeable_from_url(location,
1006
possible_transports=possible_transports)
1007
except errors.NotABundle:
1010
stored_loc = branch_to.get_parent()
1011
if location is None:
1012
if stored_loc is None:
1013
raise errors.BzrCommandError("No pull location known or"
1016
display_url = urlutils.unescape_for_display(stored_loc,
1019
self.outf.write("Using saved parent location: %s\n" % display_url)
1020
location = stored_loc
1022
revision = _get_one_revision('pull', revision)
1023
if mergeable is not None:
1024
if revision is not None:
1025
raise errors.BzrCommandError(
1026
'Cannot use -r with merge directives or bundles')
1027
mergeable.install_revisions(branch_to.repository)
1028
base_revision_id, revision_id, verified = \
1029
mergeable.get_merge_request(branch_to.repository)
1030
branch_from = branch_to
1032
branch_from = Branch.open(location,
1033
possible_transports=possible_transports)
1034
branch_from.lock_read()
1035
self.add_cleanup(branch_from.unlock)
1037
if branch_to.get_parent() is None or remember:
1038
branch_to.set_parent(branch_from.base)
1040
if revision is not None:
1041
revision_id = revision.as_revision_id(branch_from)
1043
if tree_to is not None:
1044
view_info = _get_view_info_for_change_reporter(tree_to)
1045
change_reporter = delta._ChangeReporter(
1046
unversioned_filter=tree_to.is_ignored,
1047
view_info=view_info)
1048
result = tree_to.pull(
1049
branch_from, overwrite, revision_id, change_reporter,
1050
possible_transports=possible_transports, local=local)
1052
result = branch_to.pull(
1053
branch_from, overwrite, revision_id, local=local)
1055
result.report(self.outf)
1056
if verbose and result.old_revid != result.new_revid:
1057
log.show_branch_change(
1058
branch_to, self.outf, result.old_revno,
1062
class cmd_push(Command):
1063
"""Update a mirror of this branch.
1065
The target branch will not have its working tree populated because this
1066
is both expensive, and is not supported on remote file systems.
1068
Some smart servers or protocols *may* put the working tree in place in
1071
This command only works on branches that have not diverged. Branches are
1072
considered diverged if the destination branch's most recent commit is one
1073
that has not been merged (directly or indirectly) by the source branch.
1075
If branches have diverged, you can use 'bzr push --overwrite' to replace
1076
the other branch completely, discarding its unmerged changes.
1078
If you want to ensure you have the different changes in the other branch,
1079
do a merge (see bzr help merge) from the other branch, and commit that.
1080
After that you will be able to do a push without '--overwrite'.
1082
If there is no default push location set, the first push will set it.
1083
After that, you can omit the location to use the default. To change the
1084
default, use --remember. The value will only be saved if the remote
1085
location can be accessed.
1088
_see_also = ['pull', 'update', 'working-trees']
1089
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1090
Option('create-prefix',
1091
help='Create the path leading up to the branch '
1092
'if it does not already exist.'),
1094
help='Branch to push from, '
1095
'rather than the one containing the working directory.',
1099
Option('use-existing-dir',
1100
help='By default push will fail if the target'
1101
' directory exists, but does not already'
1102
' have a control directory. This flag will'
1103
' allow push to proceed.'),
1105
help='Create a stacked branch that references the public location '
1106
'of the parent branch.'),
1107
Option('stacked-on',
1108
help='Create a stacked branch that refers to another branch '
1109
'for the commit history. Only the work not present in the '
1110
'referenced branch is included in the branch created.',
1113
help='Refuse to push if there are uncommitted changes in'
1114
' the working tree, --no-strict disables the check.'),
1116
takes_args = ['location?']
1117
encoding_type = 'replace'
1119
def run(self, location=None, remember=False, overwrite=False,
1120
create_prefix=False, verbose=False, revision=None,
1121
use_existing_dir=False, directory=None, stacked_on=None,
1122
stacked=False, strict=None):
1123
from bzrlib.push import _show_push_branch
1125
if directory is None:
1127
# Get the source branch
1129
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1130
# Get the tip's revision_id
1131
revision = _get_one_revision('push', revision)
1132
if revision is not None:
1133
revision_id = revision.in_history(br_from).rev_id
1136
if tree is not None and revision_id is None:
1137
tree.check_changed_or_out_of_date(
1138
strict, 'push_strict',
1139
more_error='Use --no-strict to force the push.',
1140
more_warning='Uncommitted changes will not be pushed.')
1141
# Get the stacked_on branch, if any
1142
if stacked_on is not None:
1143
stacked_on = urlutils.normalize_url(stacked_on)
1145
parent_url = br_from.get_parent()
1147
parent = Branch.open(parent_url)
1148
stacked_on = parent.get_public_branch()
1150
# I considered excluding non-http url's here, thus forcing
1151
# 'public' branches only, but that only works for some
1152
# users, so it's best to just depend on the user spotting an
1153
# error by the feedback given to them. RBC 20080227.
1154
stacked_on = parent_url
1156
raise errors.BzrCommandError(
1157
"Could not determine branch to refer to.")
1159
# Get the destination location
1160
if location is None:
1161
stored_loc = br_from.get_push_location()
1162
if stored_loc is None:
1163
raise errors.BzrCommandError(
1164
"No push location known or specified.")
1166
display_url = urlutils.unescape_for_display(stored_loc,
1168
self.outf.write("Using saved push location: %s\n" % display_url)
1169
location = stored_loc
1171
_show_push_branch(br_from, revision_id, location, self.outf,
1172
verbose=verbose, overwrite=overwrite, remember=remember,
1173
stacked_on=stacked_on, create_prefix=create_prefix,
1174
use_existing_dir=use_existing_dir)
1177
class cmd_branch(Command):
1178
"""Create a new branch that is a copy of an existing branch.
1180
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1181
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1182
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1183
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1184
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1187
To retrieve the branch as of a particular revision, supply the --revision
1188
parameter, as in "branch foo/bar -r 5".
1191
_see_also = ['checkout']
1192
takes_args = ['from_location', 'to_location?']
1193
takes_options = ['revision', Option('hardlink',
1194
help='Hard-link working tree files where possible.'),
1196
help="Create a branch without a working-tree."),
1198
help="Switch the checkout in the current directory "
1199
"to the new branch."),
1201
help='Create a stacked branch referring to the source branch. '
1202
'The new branch will depend on the availability of the source '
1203
'branch for all operations.'),
1204
Option('standalone',
1205
help='Do not use a shared repository, even if available.'),
1206
Option('use-existing-dir',
1207
help='By default branch will fail if the target'
1208
' directory exists, but does not already'
1209
' have a control directory. This flag will'
1210
' allow branch to proceed.'),
1212
help="Bind new branch to from location."),
1214
aliases = ['get', 'clone']
1216
def run(self, from_location, to_location=None, revision=None,
1217
hardlink=False, stacked=False, standalone=False, no_tree=False,
1218
use_existing_dir=False, switch=False, bind=False):
1219
from bzrlib import switch as _mod_switch
1220
from bzrlib.tag import _merge_tags_if_possible
1221
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1223
revision = _get_one_revision('branch', revision)
1225
self.add_cleanup(br_from.unlock)
1226
if revision is not None:
1227
revision_id = revision.as_revision_id(br_from)
1229
# FIXME - wt.last_revision, fallback to branch, fall back to
1230
# None or perhaps NULL_REVISION to mean copy nothing
1232
revision_id = br_from.last_revision()
1233
if to_location is None:
1234
to_location = urlutils.derive_to_location(from_location)
1235
to_transport = transport.get_transport(to_location)
1237
to_transport.mkdir('.')
1238
except errors.FileExists:
1239
if not use_existing_dir:
1240
raise errors.BzrCommandError('Target directory "%s" '
1241
'already exists.' % to_location)
1244
bzrdir.BzrDir.open_from_transport(to_transport)
1245
except errors.NotBranchError:
1248
raise errors.AlreadyBranchError(to_location)
1249
except errors.NoSuchFile:
1250
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1253
# preserve whatever source format we have.
1254
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1255
possible_transports=[to_transport],
1256
accelerator_tree=accelerator_tree,
1257
hardlink=hardlink, stacked=stacked,
1258
force_new_repo=standalone,
1259
create_tree_if_local=not no_tree,
1260
source_branch=br_from)
1261
branch = dir.open_branch()
1262
except errors.NoSuchRevision:
1263
to_transport.delete_tree('.')
1264
msg = "The branch %s has no revision %s." % (from_location,
1266
raise errors.BzrCommandError(msg)
1267
_merge_tags_if_possible(br_from, branch)
1268
# If the source branch is stacked, the new branch may
1269
# be stacked whether we asked for that explicitly or not.
1270
# We therefore need a try/except here and not just 'if stacked:'
1272
note('Created new stacked branch referring to %s.' %
1273
branch.get_stacked_on_url())
1274
except (errors.NotStacked, errors.UnstackableBranchFormat,
1275
errors.UnstackableRepositoryFormat), e:
1276
note('Branched %d revision(s).' % branch.revno())
1278
# Bind to the parent
1279
parent_branch = Branch.open(from_location)
1280
branch.bind(parent_branch)
1281
note('New branch bound to %s' % from_location)
1283
# Switch to the new branch
1284
wt, _ = WorkingTree.open_containing('.')
1285
_mod_switch.switch(wt.bzrdir, branch)
1286
note('Switched to branch: %s',
1287
urlutils.unescape_for_display(branch.base, 'utf-8'))
1290
class cmd_checkout(Command):
1291
"""Create a new checkout of an existing branch.
1293
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1294
the branch found in '.'. This is useful if you have removed the working tree
1295
or if it was never created - i.e. if you pushed the branch to its current
1296
location using SFTP.
1298
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1299
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1300
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1301
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1302
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1305
To retrieve the branch as of a particular revision, supply the --revision
1306
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1307
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1311
_see_also = ['checkouts', 'branch']
1312
takes_args = ['branch_location?', 'to_location?']
1313
takes_options = ['revision',
1314
Option('lightweight',
1315
help="Perform a lightweight checkout. Lightweight "
1316
"checkouts depend on access to the branch for "
1317
"every operation. Normal checkouts can perform "
1318
"common operations like diff and status without "
1319
"such access, and also support local commits."
1321
Option('files-from', type=str,
1322
help="Get file contents from this tree."),
1324
help='Hard-link working tree files where possible.'
1329
def run(self, branch_location=None, to_location=None, revision=None,
1330
lightweight=False, files_from=None, hardlink=False):
1331
if branch_location is None:
1332
branch_location = osutils.getcwd()
1333
to_location = branch_location
1334
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1336
revision = _get_one_revision('checkout', revision)
1337
if files_from is not None:
1338
accelerator_tree = WorkingTree.open(files_from)
1339
if revision is not None:
1340
revision_id = revision.as_revision_id(source)
1343
if to_location is None:
1344
to_location = urlutils.derive_to_location(branch_location)
1345
# if the source and to_location are the same,
1346
# and there is no working tree,
1347
# then reconstitute a branch
1348
if (osutils.abspath(to_location) ==
1349
osutils.abspath(branch_location)):
1351
source.bzrdir.open_workingtree()
1352
except errors.NoWorkingTree:
1353
source.bzrdir.create_workingtree(revision_id)
1355
source.create_checkout(to_location, revision_id, lightweight,
1356
accelerator_tree, hardlink)
1359
class cmd_renames(Command):
1360
"""Show list of renamed files.
1362
# TODO: Option to show renames between two historical versions.
1364
# TODO: Only show renames under dir, rather than in the whole branch.
1365
_see_also = ['status']
1366
takes_args = ['dir?']
1369
def run(self, dir=u'.'):
1370
tree = WorkingTree.open_containing(dir)[0]
1372
self.add_cleanup(tree.unlock)
1373
new_inv = tree.inventory
1374
old_tree = tree.basis_tree()
1375
old_tree.lock_read()
1376
self.add_cleanup(old_tree.unlock)
1377
old_inv = old_tree.inventory
1379
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1380
for f, paths, c, v, p, n, k, e in iterator:
1381
if paths[0] == paths[1]:
1385
renames.append(paths)
1387
for old_name, new_name in renames:
1388
self.outf.write("%s => %s\n" % (old_name, new_name))
1391
class cmd_update(Command):
1392
"""Update a tree to have the latest code committed to its branch.
1394
This will perform a merge into the working tree, and may generate
1395
conflicts. If you have any local changes, you will still
1396
need to commit them after the update for the update to be complete.
1398
If you want to discard your local changes, you can just do a
1399
'bzr revert' instead of 'bzr commit' after the update.
1401
If the tree's branch is bound to a master branch, it will also update
1402
the branch from the master.
1405
_see_also = ['pull', 'working-trees', 'status-flags']
1406
takes_args = ['dir?']
1407
takes_options = ['revision']
1410
def run(self, dir='.', revision=None):
1411
if revision is not None and len(revision) != 1:
1412
raise errors.BzrCommandError(
1413
"bzr update --revision takes exactly one revision")
1414
tree = WorkingTree.open_containing(dir)[0]
1415
branch = tree.branch
1416
possible_transports = []
1417
master = branch.get_master_branch(
1418
possible_transports=possible_transports)
1419
if master is not None:
1421
branch_location = master.base
1423
tree.lock_tree_write()
1424
branch_location = tree.branch.base
1425
self.add_cleanup(tree.unlock)
1426
# get rid of the final '/' and be ready for display
1427
branch_location = urlutils.unescape_for_display(
1428
branch_location.rstrip('/'),
1430
existing_pending_merges = tree.get_parent_ids()[1:]
1434
# may need to fetch data into a heavyweight checkout
1435
# XXX: this may take some time, maybe we should display a
1437
old_tip = branch.update(possible_transports)
1438
if revision is not None:
1439
revision_id = revision[0].as_revision_id(branch)
1441
revision_id = branch.last_revision()
1442
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1443
revno = branch.revision_id_to_dotted_revno(revision_id)
1444
note("Tree is up to date at revision %s of branch %s" %
1445
('.'.join(map(str, revno)), branch_location))
1447
view_info = _get_view_info_for_change_reporter(tree)
1448
change_reporter = delta._ChangeReporter(
1449
unversioned_filter=tree.is_ignored,
1450
view_info=view_info)
1452
conflicts = tree.update(
1454
possible_transports=possible_transports,
1455
revision=revision_id,
1457
except errors.NoSuchRevision, e:
1458
raise errors.BzrCommandError(
1459
"branch has no revision %s\n"
1460
"bzr update --revision only works"
1461
" for a revision in the branch history"
1463
revno = tree.branch.revision_id_to_dotted_revno(
1464
_mod_revision.ensure_null(tree.last_revision()))
1465
note('Updated to revision %s of branch %s' %
1466
('.'.join(map(str, revno)), branch_location))
1467
parent_ids = tree.get_parent_ids()
1468
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1469
note('Your local commits will now show as pending merges with '
1470
"'bzr status', and can be committed with 'bzr commit'.")
1477
class cmd_info(Command):
1478
"""Show information about a working tree, branch or repository.
1480
This command will show all known locations and formats associated to the
1481
tree, branch or repository.
1483
In verbose mode, statistical information is included with each report.
1484
To see extended statistic information, use a verbosity level of 2 or
1485
higher by specifying the verbose option multiple times, e.g. -vv.
1487
Branches and working trees will also report any missing revisions.
1491
Display information on the format and related locations:
1495
Display the above together with extended format information and
1496
basic statistics (like the number of files in the working tree and
1497
number of revisions in the branch and repository):
1501
Display the above together with number of committers to the branch:
1505
_see_also = ['revno', 'working-trees', 'repositories']
1506
takes_args = ['location?']
1507
takes_options = ['verbose']
1508
encoding_type = 'replace'
1511
def run(self, location=None, verbose=False):
1513
noise_level = get_verbosity_level()
1516
from bzrlib.info import show_bzrdir_info
1517
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1518
verbose=noise_level, outfile=self.outf)
1521
class cmd_remove(Command):
1522
"""Remove files or directories.
1524
This makes bzr stop tracking changes to the specified files. bzr will delete
1525
them if they can easily be recovered using revert. If no options or
1526
parameters are given bzr will scan for files that are being tracked by bzr
1527
but missing in your tree and stop tracking them for you.
1529
takes_args = ['file*']
1530
takes_options = ['verbose',
1531
Option('new', help='Only remove files that have never been committed.'),
1532
RegistryOption.from_kwargs('file-deletion-strategy',
1533
'The file deletion mode to be used.',
1534
title='Deletion Strategy', value_switches=True, enum_switch=False,
1535
safe='Only delete files if they can be'
1536
' safely recovered (default).',
1537
keep='Delete from bzr but leave the working copy.',
1538
force='Delete all the specified files, even if they can not be '
1539
'recovered and even if they are non-empty directories.')]
1540
aliases = ['rm', 'del']
1541
encoding_type = 'replace'
1543
def run(self, file_list, verbose=False, new=False,
1544
file_deletion_strategy='safe'):
1545
tree, file_list = tree_files(file_list)
1547
if file_list is not None:
1548
file_list = [f for f in file_list]
1551
self.add_cleanup(tree.unlock)
1552
# Heuristics should probably all move into tree.remove_smart or
1555
added = tree.changes_from(tree.basis_tree(),
1556
specific_files=file_list).added
1557
file_list = sorted([f[0] for f in added], reverse=True)
1558
if len(file_list) == 0:
1559
raise errors.BzrCommandError('No matching files.')
1560
elif file_list is None:
1561
# missing files show up in iter_changes(basis) as
1562
# versioned-with-no-kind.
1564
for change in tree.iter_changes(tree.basis_tree()):
1565
# Find paths in the working tree that have no kind:
1566
if change[1][1] is not None and change[6][1] is None:
1567
missing.append(change[1][1])
1568
file_list = sorted(missing, reverse=True)
1569
file_deletion_strategy = 'keep'
1570
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1571
keep_files=file_deletion_strategy=='keep',
1572
force=file_deletion_strategy=='force')
1575
class cmd_file_id(Command):
1576
"""Print file_id of a particular file or directory.
1578
The file_id is assigned when the file is first added and remains the
1579
same through all revisions where the file exists, even when it is
1584
_see_also = ['inventory', 'ls']
1585
takes_args = ['filename']
1588
def run(self, filename):
1589
tree, relpath = WorkingTree.open_containing(filename)
1590
i = tree.path2id(relpath)
1592
raise errors.NotVersionedError(filename)
1594
self.outf.write(i + '\n')
1597
class cmd_file_path(Command):
1598
"""Print path of file_ids to a file or directory.
1600
This prints one line for each directory down to the target,
1601
starting at the branch root.
1605
takes_args = ['filename']
1608
def run(self, filename):
1609
tree, relpath = WorkingTree.open_containing(filename)
1610
fid = tree.path2id(relpath)
1612
raise errors.NotVersionedError(filename)
1613
segments = osutils.splitpath(relpath)
1614
for pos in range(1, len(segments) + 1):
1615
path = osutils.joinpath(segments[:pos])
1616
self.outf.write("%s\n" % tree.path2id(path))
1619
class cmd_reconcile(Command):
1620
"""Reconcile bzr metadata in a branch.
1622
This can correct data mismatches that may have been caused by
1623
previous ghost operations or bzr upgrades. You should only
1624
need to run this command if 'bzr check' or a bzr developer
1625
advises you to run it.
1627
If a second branch is provided, cross-branch reconciliation is
1628
also attempted, which will check that data like the tree root
1629
id which was not present in very early bzr versions is represented
1630
correctly in both branches.
1632
At the same time it is run it may recompress data resulting in
1633
a potential saving in disk space or performance gain.
1635
The branch *MUST* be on a listable system such as local disk or sftp.
1638
_see_also = ['check']
1639
takes_args = ['branch?']
1641
def run(self, branch="."):
1642
from bzrlib.reconcile import reconcile
1643
dir = bzrdir.BzrDir.open(branch)
1647
class cmd_revision_history(Command):
1648
"""Display the list of revision ids on a branch."""
1651
takes_args = ['location?']
1656
def run(self, location="."):
1657
branch = Branch.open_containing(location)[0]
1658
for revid in branch.revision_history():
1659
self.outf.write(revid)
1660
self.outf.write('\n')
1663
class cmd_ancestry(Command):
1664
"""List all revisions merged into this branch."""
1666
_see_also = ['log', 'revision-history']
1667
takes_args = ['location?']
1672
def run(self, location="."):
1674
wt = WorkingTree.open_containing(location)[0]
1675
except errors.NoWorkingTree:
1676
b = Branch.open(location)
1677
last_revision = b.last_revision()
1680
last_revision = wt.last_revision()
1682
revision_ids = b.repository.get_ancestry(last_revision)
1684
for revision_id in revision_ids:
1685
self.outf.write(revision_id + '\n')
1688
class cmd_init(Command):
1689
"""Make a directory into a versioned branch.
1691
Use this to create an empty branch, or before importing an
1694
If there is a repository in a parent directory of the location, then
1695
the history of the branch will be stored in the repository. Otherwise
1696
init creates a standalone branch which carries its own history
1697
in the .bzr directory.
1699
If there is already a branch at the location but it has no working tree,
1700
the tree can be populated with 'bzr checkout'.
1702
Recipe for importing a tree of files::
1708
bzr commit -m "imported project"
1711
_see_also = ['init-repository', 'branch', 'checkout']
1712
takes_args = ['location?']
1714
Option('create-prefix',
1715
help='Create the path leading up to the branch '
1716
'if it does not already exist.'),
1717
RegistryOption('format',
1718
help='Specify a format for this branch. '
1719
'See "help formats".',
1720
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1721
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1722
value_switches=True,
1723
title="Branch format",
1725
Option('append-revisions-only',
1726
help='Never change revnos or the existing log.'
1727
' Append revisions to it only.')
1729
def run(self, location=None, format=None, append_revisions_only=False,
1730
create_prefix=False):
1732
format = bzrdir.format_registry.make_bzrdir('default')
1733
if location is None:
1736
to_transport = transport.get_transport(location)
1738
# The path has to exist to initialize a
1739
# branch inside of it.
1740
# Just using os.mkdir, since I don't
1741
# believe that we want to create a bunch of
1742
# locations if the user supplies an extended path
1744
to_transport.ensure_base()
1745
except errors.NoSuchFile:
1746
if not create_prefix:
1747
raise errors.BzrCommandError("Parent directory of %s"
1749
"\nYou may supply --create-prefix to create all"
1750
" leading parent directories."
1752
to_transport.create_prefix()
1755
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1756
except errors.NotBranchError:
1757
# really a NotBzrDir error...
1758
create_branch = bzrdir.BzrDir.create_branch_convenience
1759
branch = create_branch(to_transport.base, format=format,
1760
possible_transports=[to_transport])
1761
a_bzrdir = branch.bzrdir
1763
from bzrlib.transport.local import LocalTransport
1764
if a_bzrdir.has_branch():
1765
if (isinstance(to_transport, LocalTransport)
1766
and not a_bzrdir.has_workingtree()):
1767
raise errors.BranchExistsWithoutWorkingTree(location)
1768
raise errors.AlreadyBranchError(location)
1769
branch = a_bzrdir.create_branch()
1770
a_bzrdir.create_workingtree()
1771
if append_revisions_only:
1773
branch.set_append_revisions_only(True)
1774
except errors.UpgradeRequired:
1775
raise errors.BzrCommandError('This branch format cannot be set'
1776
' to append-revisions-only. Try --default.')
1778
from bzrlib.info import describe_layout, describe_format
1780
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1781
except (errors.NoWorkingTree, errors.NotLocalUrl):
1783
repository = branch.repository
1784
layout = describe_layout(repository, branch, tree).lower()
1785
format = describe_format(a_bzrdir, repository, branch, tree)
1786
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1787
if repository.is_shared():
1788
#XXX: maybe this can be refactored into transport.path_or_url()
1789
url = repository.bzrdir.root_transport.external_url()
1791
url = urlutils.local_path_from_url(url)
1792
except errors.InvalidURL:
1794
self.outf.write("Using shared repository: %s\n" % url)
1797
class cmd_init_repository(Command):
1798
"""Create a shared repository for branches to share storage space.
1800
New branches created under the repository directory will store their
1801
revisions in the repository, not in the branch directory. For branches
1802
with shared history, this reduces the amount of storage needed and
1803
speeds up the creation of new branches.
1805
If the --no-trees option is given then the branches in the repository
1806
will not have working trees by default. They will still exist as
1807
directories on disk, but they will not have separate copies of the
1808
files at a certain revision. This can be useful for repositories that
1809
store branches which are interacted with through checkouts or remote
1810
branches, such as on a server.
1813
Create a shared repository holding just branches::
1815
bzr init-repo --no-trees repo
1818
Make a lightweight checkout elsewhere::
1820
bzr checkout --lightweight repo/trunk trunk-checkout
1825
_see_also = ['init', 'branch', 'checkout', 'repositories']
1826
takes_args = ["location"]
1827
takes_options = [RegistryOption('format',
1828
help='Specify a format for this repository. See'
1829
' "bzr help formats" for details.',
1830
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1831
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1832
value_switches=True, title='Repository format'),
1834
help='Branches in the repository will default to'
1835
' not having a working tree.'),
1837
aliases = ["init-repo"]
1839
def run(self, location, format=None, no_trees=False):
1841
format = bzrdir.format_registry.make_bzrdir('default')
1843
if location is None:
1846
to_transport = transport.get_transport(location)
1847
to_transport.ensure_base()
1849
newdir = format.initialize_on_transport(to_transport)
1850
repo = newdir.create_repository(shared=True)
1851
repo.set_make_working_trees(not no_trees)
1853
from bzrlib.info import show_bzrdir_info
1854
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1857
class cmd_diff(Command):
1858
"""Show differences in the working tree, between revisions or branches.
1860
If no arguments are given, all changes for the current tree are listed.
1861
If files are given, only the changes in those files are listed.
1862
Remote and multiple branches can be compared by using the --old and
1863
--new options. If not provided, the default for both is derived from
1864
the first argument, if any, or the current tree if no arguments are
1867
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1868
produces patches suitable for "patch -p1".
1872
2 - unrepresentable changes
1877
Shows the difference in the working tree versus the last commit::
1881
Difference between the working tree and revision 1::
1885
Difference between revision 3 and revision 1::
1889
Difference between revision 3 and revision 1 for branch xxx::
1893
To see the changes introduced in revision X::
1897
Note that in the case of a merge, the -c option shows the changes
1898
compared to the left hand parent. To see the changes against
1899
another parent, use::
1901
bzr diff -r<chosen_parent>..X
1903
The changes introduced by revision 2 (equivalent to -r1..2)::
1907
Show just the differences for file NEWS::
1911
Show the differences in working tree xxx for file NEWS::
1915
Show the differences from branch xxx to this working tree:
1919
Show the differences between two branches for file NEWS::
1921
bzr diff --old xxx --new yyy NEWS
1923
Same as 'bzr diff' but prefix paths with old/ and new/::
1925
bzr diff --prefix old/:new/
1927
_see_also = ['status']
1928
takes_args = ['file*']
1930
Option('diff-options', type=str,
1931
help='Pass these options to the external diff program.'),
1932
Option('prefix', type=str,
1934
help='Set prefixes added to old and new filenames, as '
1935
'two values separated by a colon. (eg "old/:new/").'),
1937
help='Branch/tree to compare from.',
1941
help='Branch/tree to compare to.',
1947
help='Use this command to compare files.',
1950
RegistryOption('format',
1951
help='Diff format to use.',
1952
lazy_registry=('bzrlib.diff', 'format_registry'),
1953
value_switches=False, title='Diff format'),
1955
aliases = ['di', 'dif']
1956
encoding_type = 'exact'
1959
def run(self, revision=None, file_list=None, diff_options=None,
1960
prefix=None, old=None, new=None, using=None, format=None):
1961
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1964
if (prefix is None) or (prefix == '0'):
1972
old_label, new_label = prefix.split(":")
1974
raise errors.BzrCommandError(
1975
'--prefix expects two values separated by a colon'
1976
' (eg "old/:new/")')
1978
if revision and len(revision) > 2:
1979
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1980
' one or two revision specifiers')
1982
if using is not None and format is not None:
1983
raise errors.BzrCommandError('--using and --format are mutually '
1986
(old_tree, new_tree,
1987
old_branch, new_branch,
1988
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1989
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1990
return show_diff_trees(old_tree, new_tree, sys.stdout,
1991
specific_files=specific_files,
1992
external_diff_options=diff_options,
1993
old_label=old_label, new_label=new_label,
1994
extra_trees=extra_trees, using=using,
1998
class cmd_deleted(Command):
1999
"""List files deleted in the working tree.
2001
# TODO: Show files deleted since a previous revision, or
2002
# between two revisions.
2003
# TODO: Much more efficient way to do this: read in new
2004
# directories with readdir, rather than stating each one. Same
2005
# level of effort but possibly much less IO. (Or possibly not,
2006
# if the directories are very large...)
2007
_see_also = ['status', 'ls']
2008
takes_options = ['show-ids']
2011
def run(self, show_ids=False):
2012
tree = WorkingTree.open_containing(u'.')[0]
2014
self.add_cleanup(tree.unlock)
2015
old = tree.basis_tree()
2017
self.add_cleanup(old.unlock)
2018
for path, ie in old.inventory.iter_entries():
2019
if not tree.has_id(ie.file_id):
2020
self.outf.write(path)
2022
self.outf.write(' ')
2023
self.outf.write(ie.file_id)
2024
self.outf.write('\n')
2027
class cmd_modified(Command):
2028
"""List files modified in working tree.
2032
_see_also = ['status', 'ls']
2035
help='Write an ascii NUL (\\0) separator '
2036
'between files rather than a newline.')
2040
def run(self, null=False):
2041
tree = WorkingTree.open_containing(u'.')[0]
2042
td = tree.changes_from(tree.basis_tree())
2043
for path, id, kind, text_modified, meta_modified in td.modified:
2045
self.outf.write(path + '\0')
2047
self.outf.write(osutils.quotefn(path) + '\n')
2050
class cmd_added(Command):
2051
"""List files added in working tree.
2055
_see_also = ['status', 'ls']
2058
help='Write an ascii NUL (\\0) separator '
2059
'between files rather than a newline.')
2063
def run(self, null=False):
2064
wt = WorkingTree.open_containing(u'.')[0]
2066
self.add_cleanup(wt.unlock)
2067
basis = wt.basis_tree()
2069
self.add_cleanup(basis.unlock)
2070
basis_inv = basis.inventory
2073
if file_id in basis_inv:
2075
if inv.is_root(file_id) and len(basis_inv) == 0:
2077
path = inv.id2path(file_id)
2078
if not os.access(osutils.abspath(path), os.F_OK):
2081
self.outf.write(path + '\0')
2083
self.outf.write(osutils.quotefn(path) + '\n')
2086
class cmd_root(Command):
2087
"""Show the tree root directory.
2089
The root is the nearest enclosing directory with a .bzr control
2092
takes_args = ['filename?']
2094
def run(self, filename=None):
2095
"""Print the branch root."""
2096
tree = WorkingTree.open_containing(filename)[0]
2097
self.outf.write(tree.basedir + '\n')
2100
def _parse_limit(limitstring):
2102
return int(limitstring)
2104
msg = "The limit argument must be an integer."
2105
raise errors.BzrCommandError(msg)
2108
def _parse_levels(s):
2112
msg = "The levels argument must be an integer."
2113
raise errors.BzrCommandError(msg)
2116
class cmd_log(Command):
2117
"""Show historical log for a branch or subset of a branch.
2119
log is bzr's default tool for exploring the history of a branch.
2120
The branch to use is taken from the first parameter. If no parameters
2121
are given, the branch containing the working directory is logged.
2122
Here are some simple examples::
2124
bzr log log the current branch
2125
bzr log foo.py log a file in its branch
2126
bzr log http://server/branch log a branch on a server
2128
The filtering, ordering and information shown for each revision can
2129
be controlled as explained below. By default, all revisions are
2130
shown sorted (topologically) so that newer revisions appear before
2131
older ones and descendants always appear before ancestors. If displayed,
2132
merged revisions are shown indented under the revision in which they
2137
The log format controls how information about each revision is
2138
displayed. The standard log formats are called ``long``, ``short``
2139
and ``line``. The default is long. See ``bzr help log-formats``
2140
for more details on log formats.
2142
The following options can be used to control what information is
2145
-l N display a maximum of N revisions
2146
-n N display N levels of revisions (0 for all, 1 for collapsed)
2147
-v display a status summary (delta) for each revision
2148
-p display a diff (patch) for each revision
2149
--show-ids display revision-ids (and file-ids), not just revnos
2151
Note that the default number of levels to display is a function of the
2152
log format. If the -n option is not used, the standard log formats show
2153
just the top level (mainline).
2155
Status summaries are shown using status flags like A, M, etc. To see
2156
the changes explained using words like ``added`` and ``modified``
2157
instead, use the -vv option.
2161
To display revisions from oldest to newest, use the --forward option.
2162
In most cases, using this option will have little impact on the total
2163
time taken to produce a log, though --forward does not incrementally
2164
display revisions like --reverse does when it can.
2166
:Revision filtering:
2168
The -r option can be used to specify what revision or range of revisions
2169
to filter against. The various forms are shown below::
2171
-rX display revision X
2172
-rX.. display revision X and later
2173
-r..Y display up to and including revision Y
2174
-rX..Y display from X to Y inclusive
2176
See ``bzr help revisionspec`` for details on how to specify X and Y.
2177
Some common examples are given below::
2179
-r-1 show just the tip
2180
-r-10.. show the last 10 mainline revisions
2181
-rsubmit:.. show what's new on this branch
2182
-rancestor:path.. show changes since the common ancestor of this
2183
branch and the one at location path
2184
-rdate:yesterday.. show changes since yesterday
2186
When logging a range of revisions using -rX..Y, log starts at
2187
revision Y and searches back in history through the primary
2188
("left-hand") parents until it finds X. When logging just the
2189
top level (using -n1), an error is reported if X is not found
2190
along the way. If multi-level logging is used (-n0), X may be
2191
a nested merge revision and the log will be truncated accordingly.
2195
If parameters are given and the first one is not a branch, the log
2196
will be filtered to show only those revisions that changed the
2197
nominated files or directories.
2199
Filenames are interpreted within their historical context. To log a
2200
deleted file, specify a revision range so that the file existed at
2201
the end or start of the range.
2203
Historical context is also important when interpreting pathnames of
2204
renamed files/directories. Consider the following example:
2206
* revision 1: add tutorial.txt
2207
* revision 2: modify tutorial.txt
2208
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2212
* ``bzr log guide.txt`` will log the file added in revision 1
2214
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2216
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2217
the original file in revision 2.
2219
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2220
was no file called guide.txt in revision 2.
2222
Renames are always followed by log. By design, there is no need to
2223
explicitly ask for this (and no way to stop logging a file back
2224
until it was last renamed).
2228
The --message option can be used for finding revisions that match a
2229
regular expression in a commit message.
2233
GUI tools and IDEs are often better at exploring history than command
2234
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2235
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2236
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2237
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2239
You may find it useful to add the aliases below to ``bazaar.conf``::
2243
top = log -l10 --line
2246
``bzr tip`` will then show the latest revision while ``bzr top``
2247
will show the last 10 mainline revisions. To see the details of a
2248
particular revision X, ``bzr show -rX``.
2250
If you are interested in looking deeper into a particular merge X,
2251
use ``bzr log -n0 -rX``.
2253
``bzr log -v`` on a branch with lots of history is currently
2254
very slow. A fix for this issue is currently under development.
2255
With or without that fix, it is recommended that a revision range
2256
be given when using the -v option.
2258
bzr has a generic full-text matching plugin, bzr-search, that can be
2259
used to find revisions matching user names, commit messages, etc.
2260
Among other features, this plugin can find all revisions containing
2261
a list of words but not others.
2263
When exploring non-mainline history on large projects with deep
2264
history, the performance of log can be greatly improved by installing
2265
the historycache plugin. This plugin buffers historical information
2266
trading disk space for faster speed.
2268
takes_args = ['file*']
2269
_see_also = ['log-formats', 'revisionspec']
2272
help='Show from oldest to newest.'),
2274
custom_help('verbose',
2275
help='Show files changed in each revision.'),
2279
type=bzrlib.option._parse_revision_str,
2281
help='Show just the specified revision.'
2282
' See also "help revisionspec".'),
2286
help='Number of levels to display - 0 for all, 1 for flat.',
2288
type=_parse_levels),
2291
help='Show revisions whose message matches this '
2292
'regular expression.',
2296
help='Limit the output to the first N revisions.',
2301
help='Show changes made in each revision as a patch.'),
2302
Option('include-merges',
2303
help='Show merged revisions like --levels 0 does.'),
2305
encoding_type = 'replace'
2308
def run(self, file_list=None, timezone='original',
2319
include_merges=False):
2320
from bzrlib.log import (
2322
make_log_request_dict,
2323
_get_info_for_log_files,
2325
direction = (forward and 'forward') or 'reverse'
2330
raise errors.BzrCommandError(
2331
'--levels and --include-merges are mutually exclusive')
2333
if change is not None:
2335
raise errors.RangeInChangeOption()
2336
if revision is not None:
2337
raise errors.BzrCommandError(
2338
'--revision and --change are mutually exclusive')
2343
filter_by_dir = False
2345
# find the file ids to log and check for directory filtering
2346
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2347
revision, file_list)
2348
self.add_cleanup(b.unlock)
2349
for relpath, file_id, kind in file_info_list:
2351
raise errors.BzrCommandError(
2352
"Path unknown at end or start of revision range: %s" %
2354
# If the relpath is the top of the tree, we log everything
2359
file_ids.append(file_id)
2360
filter_by_dir = filter_by_dir or (
2361
kind in ['directory', 'tree-reference'])
2364
# FIXME ? log the current subdir only RBC 20060203
2365
if revision is not None \
2366
and len(revision) > 0 and revision[0].get_branch():
2367
location = revision[0].get_branch()
2370
dir, relpath = bzrdir.BzrDir.open_containing(location)
2371
b = dir.open_branch()
2373
self.add_cleanup(b.unlock)
2374
rev1, rev2 = _get_revision_range(revision, b, self.name())
2376
# Decide on the type of delta & diff filtering to use
2377
# TODO: add an --all-files option to make this configurable & consistent
2385
diff_type = 'partial'
2389
# Build the log formatter
2390
if log_format is None:
2391
log_format = log.log_formatter_registry.get_default(b)
2392
# Make a non-encoding output to include the diffs - bug 328007
2393
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2394
lf = log_format(show_ids=show_ids, to_file=self.outf,
2395
to_exact_file=unencoded_output,
2396
show_timezone=timezone,
2397
delta_format=get_verbosity_level(),
2399
show_advice=levels is None)
2401
# Choose the algorithm for doing the logging. It's annoying
2402
# having multiple code paths like this but necessary until
2403
# the underlying repository format is faster at generating
2404
# deltas or can provide everything we need from the indices.
2405
# The default algorithm - match-using-deltas - works for
2406
# multiple files and directories and is faster for small
2407
# amounts of history (200 revisions say). However, it's too
2408
# slow for logging a single file in a repository with deep
2409
# history, i.e. > 10K revisions. In the spirit of "do no
2410
# evil when adding features", we continue to use the
2411
# original algorithm - per-file-graph - for the "single
2412
# file that isn't a directory without showing a delta" case.
2413
partial_history = revision and b.repository._format.supports_chks
2414
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2415
or delta_type or partial_history)
2417
# Build the LogRequest and execute it
2418
if len(file_ids) == 0:
2420
rqst = make_log_request_dict(
2421
direction=direction, specific_fileids=file_ids,
2422
start_revision=rev1, end_revision=rev2, limit=limit,
2423
message_search=message, delta_type=delta_type,
2424
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2425
Logger(b, rqst).show(lf)
2428
def _get_revision_range(revisionspec_list, branch, command_name):
2429
"""Take the input of a revision option and turn it into a revision range.
2431
It returns RevisionInfo objects which can be used to obtain the rev_id's
2432
of the desired revisions. It does some user input validations.
2434
if revisionspec_list is None:
2437
elif len(revisionspec_list) == 1:
2438
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2439
elif len(revisionspec_list) == 2:
2440
start_spec = revisionspec_list[0]
2441
end_spec = revisionspec_list[1]
2442
if end_spec.get_branch() != start_spec.get_branch():
2443
# b is taken from revision[0].get_branch(), and
2444
# show_log will use its revision_history. Having
2445
# different branches will lead to weird behaviors.
2446
raise errors.BzrCommandError(
2447
"bzr %s doesn't accept two revisions in different"
2448
" branches." % command_name)
2449
if start_spec.spec is None:
2450
# Avoid loading all the history.
2451
rev1 = RevisionInfo(branch, None, None)
2453
rev1 = start_spec.in_history(branch)
2454
# Avoid loading all of history when we know a missing
2455
# end of range means the last revision ...
2456
if end_spec.spec is None:
2457
last_revno, last_revision_id = branch.last_revision_info()
2458
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2460
rev2 = end_spec.in_history(branch)
2462
raise errors.BzrCommandError(
2463
'bzr %s --revision takes one or two values.' % command_name)
2467
def _revision_range_to_revid_range(revision_range):
2470
if revision_range[0] is not None:
2471
rev_id1 = revision_range[0].rev_id
2472
if revision_range[1] is not None:
2473
rev_id2 = revision_range[1].rev_id
2474
return rev_id1, rev_id2
2476
def get_log_format(long=False, short=False, line=False, default='long'):
2477
log_format = default
2481
log_format = 'short'
2487
class cmd_touching_revisions(Command):
2488
"""Return revision-ids which affected a particular file.
2490
A more user-friendly interface is "bzr log FILE".
2494
takes_args = ["filename"]
2497
def run(self, filename):
2498
tree, relpath = WorkingTree.open_containing(filename)
2499
file_id = tree.path2id(relpath)
2502
self.add_cleanup(b.unlock)
2503
touching_revs = log.find_touching_revisions(b, file_id)
2504
for revno, revision_id, what in touching_revs:
2505
self.outf.write("%6d %s\n" % (revno, what))
2508
class cmd_ls(Command):
2509
"""List files in a tree.
2512
_see_also = ['status', 'cat']
2513
takes_args = ['path?']
2517
Option('recursive', short_name='R',
2518
help='Recurse into subdirectories.'),
2520
help='Print paths relative to the root of the branch.'),
2521
Option('unknown', help='Print unknown files.'),
2522
Option('versioned', help='Print versioned files.',
2524
Option('ignored', help='Print ignored files.'),
2526
help='Write an ascii NUL (\\0) separator '
2527
'between files rather than a newline.'),
2529
help='List entries of a particular kind: file, directory, symlink.',
2534
def run(self, revision=None, verbose=False,
2535
recursive=False, from_root=False,
2536
unknown=False, versioned=False, ignored=False,
2537
null=False, kind=None, show_ids=False, path=None):
2539
if kind and kind not in ('file', 'directory', 'symlink'):
2540
raise errors.BzrCommandError('invalid kind specified')
2542
if verbose and null:
2543
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2544
all = not (unknown or versioned or ignored)
2546
selection = {'I':ignored, '?':unknown, 'V':versioned}
2552
raise errors.BzrCommandError('cannot specify both --from-root'
2555
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2558
# Calculate the prefix to use
2562
prefix = relpath + '/'
2563
elif fs_path != '.' and not fs_path.endswith('/'):
2564
prefix = fs_path + '/'
2566
if revision is not None or tree is None:
2567
tree = _get_one_revision_tree('ls', revision, branch=branch)
2570
if isinstance(tree, WorkingTree) and tree.supports_views():
2571
view_files = tree.views.lookup_view()
2574
view_str = views.view_display_str(view_files)
2575
note("Ignoring files outside view. View is %s" % view_str)
2578
self.add_cleanup(tree.unlock)
2579
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2580
from_dir=relpath, recursive=recursive):
2581
# Apply additional masking
2582
if not all and not selection[fc]:
2584
if kind is not None and fkind != kind:
2589
fullpath = osutils.pathjoin(relpath, fp)
2592
views.check_path_in_view(tree, fullpath)
2593
except errors.FileOutsideView:
2598
fp = osutils.pathjoin(prefix, fp)
2599
kindch = entry.kind_character()
2600
outstring = fp + kindch
2601
ui.ui_factory.clear_term()
2603
outstring = '%-8s %s' % (fc, outstring)
2604
if show_ids and fid is not None:
2605
outstring = "%-50s %s" % (outstring, fid)
2606
self.outf.write(outstring + '\n')
2608
self.outf.write(fp + '\0')
2611
self.outf.write(fid)
2612
self.outf.write('\0')
2620
self.outf.write('%-50s %s\n' % (outstring, my_id))
2622
self.outf.write(outstring + '\n')
2625
class cmd_unknowns(Command):
2626
"""List unknown files.
2634
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2635
self.outf.write(osutils.quotefn(f) + '\n')
2638
class cmd_ignore(Command):
2639
"""Ignore specified files or patterns.
2641
See ``bzr help patterns`` for details on the syntax of patterns.
2643
If a .bzrignore file does not exist, the ignore command
2644
will create one and add the specified files or patterns to the newly
2645
created file. The ignore command will also automatically add the
2646
.bzrignore file to be versioned. Creating a .bzrignore file without
2647
the use of the ignore command will require an explicit add command.
2649
To remove patterns from the ignore list, edit the .bzrignore file.
2650
After adding, editing or deleting that file either indirectly by
2651
using this command or directly by using an editor, be sure to commit
2654
Patterns prefixed with '!' are exceptions to ignore patterns and take
2655
precedence over regular ignores. Such exceptions are used to specify
2656
files that should be versioned which would otherwise be ignored.
2658
Patterns prefixed with '!!' act as regular ignore patterns, but have
2659
precedence over the '!' exception patterns.
2661
Note: ignore patterns containing shell wildcards must be quoted from
2665
Ignore the top level Makefile::
2667
bzr ignore ./Makefile
2669
Ignore .class files in all directories...::
2671
bzr ignore "*.class"
2673
...but do not ignore "special.class"::
2675
bzr ignore "!special.class"
2677
Ignore .o files under the lib directory::
2679
bzr ignore "lib/**/*.o"
2681
Ignore .o files under the lib directory::
2683
bzr ignore "RE:lib/.*\.o"
2685
Ignore everything but the "debian" toplevel directory::
2687
bzr ignore "RE:(?!debian/).*"
2689
Ignore everything except the "local" toplevel directory,
2690
but always ignore "*~" autosave files, even under local/::
2693
bzr ignore "!./local"
2697
_see_also = ['status', 'ignored', 'patterns']
2698
takes_args = ['name_pattern*']
2700
Option('old-default-rules',
2701
help='Write out the ignore rules bzr < 0.9 always used.')
2704
def run(self, name_pattern_list=None, old_default_rules=None):
2705
from bzrlib import ignores
2706
if old_default_rules is not None:
2707
# dump the rules and exit
2708
for pattern in ignores.OLD_DEFAULTS:
2709
self.outf.write("%s\n" % pattern)
2711
if not name_pattern_list:
2712
raise errors.BzrCommandError("ignore requires at least one "
2713
"NAME_PATTERN or --old-default-rules")
2714
name_pattern_list = [globbing.normalize_pattern(p)
2715
for p in name_pattern_list]
2716
for name_pattern in name_pattern_list:
2717
if (name_pattern[0] == '/' or
2718
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2719
raise errors.BzrCommandError(
2720
"NAME_PATTERN should not be an absolute path")
2721
tree, relpath = WorkingTree.open_containing(u'.')
2722
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2723
ignored = globbing.Globster(name_pattern_list)
2726
for entry in tree.list_files():
2730
if ignored.match(filename):
2731
matches.append(filename)
2733
if len(matches) > 0:
2734
self.outf.write("Warning: the following files are version controlled and"
2735
" match your ignore pattern:\n%s"
2736
"\nThese files will continue to be version controlled"
2737
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2740
class cmd_ignored(Command):
2741
"""List ignored files and the patterns that matched them.
2743
List all the ignored files and the ignore pattern that caused the file to
2746
Alternatively, to list just the files::
2751
encoding_type = 'replace'
2752
_see_also = ['ignore', 'ls']
2756
tree = WorkingTree.open_containing(u'.')[0]
2758
self.add_cleanup(tree.unlock)
2759
for path, file_class, kind, file_id, entry in tree.list_files():
2760
if file_class != 'I':
2762
## XXX: Slightly inefficient since this was already calculated
2763
pat = tree.is_ignored(path)
2764
self.outf.write('%-50s %s\n' % (path, pat))
2767
class cmd_lookup_revision(Command):
2768
"""Lookup the revision-id from a revision-number
2771
bzr lookup-revision 33
2774
takes_args = ['revno']
2777
def run(self, revno):
2781
raise errors.BzrCommandError("not a valid revision-number: %r"
2783
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2784
self.outf.write("%s\n" % revid)
2787
class cmd_export(Command):
2788
"""Export current or past revision to a destination directory or archive.
2790
If no revision is specified this exports the last committed revision.
2792
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2793
given, try to find the format with the extension. If no extension
2794
is found exports to a directory (equivalent to --format=dir).
2796
If root is supplied, it will be used as the root directory inside
2797
container formats (tar, zip, etc). If it is not supplied it will default
2798
to the exported filename. The root option has no effect for 'dir' format.
2800
If branch is omitted then the branch containing the current working
2801
directory will be used.
2803
Note: Export of tree with non-ASCII filenames to zip is not supported.
2805
================= =========================
2806
Supported formats Autodetected by extension
2807
================= =========================
2810
tbz2 .tar.bz2, .tbz2
2813
================= =========================
2815
takes_args = ['dest', 'branch_or_subdir?']
2818
help="Type of file to export to.",
2821
Option('filters', help='Apply content filters to export the '
2822
'convenient form.'),
2825
help="Name of the root directory inside the exported file."),
2826
Option('per-file-timestamps',
2827
help='Set modification time of files to that of the last '
2828
'revision in which it was changed.'),
2830
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2831
root=None, filters=False, per_file_timestamps=False):
2832
from bzrlib.export import export
2834
if branch_or_subdir is None:
2835
tree = WorkingTree.open_containing(u'.')[0]
2839
b, subdir = Branch.open_containing(branch_or_subdir)
2842
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2844
export(rev_tree, dest, format, root, subdir, filtered=filters,
2845
per_file_timestamps=per_file_timestamps)
2846
except errors.NoSuchExportFormat, e:
2847
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2850
class cmd_cat(Command):
2851
"""Write the contents of a file as of a given revision to standard output.
2853
If no revision is nominated, the last revision is used.
2855
Note: Take care to redirect standard output when using this command on a
2861
Option('name-from-revision', help='The path name in the old tree.'),
2862
Option('filters', help='Apply content filters to display the '
2863
'convenience form.'),
2866
takes_args = ['filename']
2867
encoding_type = 'exact'
2870
def run(self, filename, revision=None, name_from_revision=False,
2872
if revision is not None and len(revision) != 1:
2873
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2874
" one revision specifier")
2875
tree, branch, relpath = \
2876
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2878
self.add_cleanup(branch.unlock)
2879
return self._run(tree, branch, relpath, filename, revision,
2880
name_from_revision, filters)
2882
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2885
tree = b.basis_tree()
2886
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2887
rev_tree.lock_read()
2888
self.add_cleanup(rev_tree.unlock)
2890
old_file_id = rev_tree.path2id(relpath)
2892
if name_from_revision:
2893
# Try in revision if requested
2894
if old_file_id is None:
2895
raise errors.BzrCommandError(
2896
"%r is not present in revision %s" % (
2897
filename, rev_tree.get_revision_id()))
2899
content = rev_tree.get_file_text(old_file_id)
2901
cur_file_id = tree.path2id(relpath)
2903
if cur_file_id is not None:
2904
# Then try with the actual file id
2906
content = rev_tree.get_file_text(cur_file_id)
2908
except errors.NoSuchId:
2909
# The actual file id didn't exist at that time
2911
if not found and old_file_id is not None:
2912
# Finally try with the old file id
2913
content = rev_tree.get_file_text(old_file_id)
2916
# Can't be found anywhere
2917
raise errors.BzrCommandError(
2918
"%r is not present in revision %s" % (
2919
filename, rev_tree.get_revision_id()))
2921
from bzrlib.filters import (
2922
ContentFilterContext,
2923
filtered_output_bytes,
2925
filters = rev_tree._content_filter_stack(relpath)
2926
chunks = content.splitlines(True)
2927
content = filtered_output_bytes(chunks, filters,
2928
ContentFilterContext(relpath, rev_tree))
2930
self.outf.writelines(content)
2933
self.outf.write(content)
2936
class cmd_local_time_offset(Command):
2937
"""Show the offset in seconds from GMT to local time."""
2941
self.outf.write("%s\n" % osutils.local_time_offset())
2945
class cmd_commit(Command):
2946
"""Commit changes into a new revision.
2948
An explanatory message needs to be given for each commit. This is
2949
often done by using the --message option (getting the message from the
2950
command line) or by using the --file option (getting the message from
2951
a file). If neither of these options is given, an editor is opened for
2952
the user to enter the message. To see the changed files in the
2953
boilerplate text loaded into the editor, use the --show-diff option.
2955
By default, the entire tree is committed and the person doing the
2956
commit is assumed to be the author. These defaults can be overridden
2961
If selected files are specified, only changes to those files are
2962
committed. If a directory is specified then the directory and
2963
everything within it is committed.
2965
When excludes are given, they take precedence over selected files.
2966
For example, to commit only changes within foo, but not changes
2969
bzr commit foo -x foo/bar
2971
A selective commit after a merge is not yet supported.
2975
If the author of the change is not the same person as the committer,
2976
you can specify the author's name using the --author option. The
2977
name should be in the same format as a committer-id, e.g.
2978
"John Doe <jdoe@example.com>". If there is more than one author of
2979
the change you can specify the option multiple times, once for each
2984
A common mistake is to forget to add a new file or directory before
2985
running the commit command. The --strict option checks for unknown
2986
files and aborts the commit if any are found. More advanced pre-commit
2987
checks can be implemented by defining hooks. See ``bzr help hooks``
2992
If you accidentially commit the wrong changes or make a spelling
2993
mistake in the commit message say, you can use the uncommit command
2994
to undo it. See ``bzr help uncommit`` for details.
2996
Hooks can also be configured to run after a commit. This allows you
2997
to trigger updates to external systems like bug trackers. The --fixes
2998
option can be used to record the association between a revision and
2999
one or more bugs. See ``bzr help bugs`` for details.
3001
A selective commit may fail in some cases where the committed
3002
tree would be invalid. Consider::
3007
bzr commit foo -m "committing foo"
3008
bzr mv foo/bar foo/baz
3011
bzr commit foo/bar -m "committing bar but not baz"
3013
In the example above, the last commit will fail by design. This gives
3014
the user the opportunity to decide whether they want to commit the
3015
rename at the same time, separately first, or not at all. (As a general
3016
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3018
# TODO: Run hooks on tree to-be-committed, and after commit.
3020
# TODO: Strict commit that fails if there are deleted files.
3021
# (what does "deleted files" mean ??)
3023
# TODO: Give better message for -s, --summary, used by tla people
3025
# XXX: verbose currently does nothing
3027
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3028
takes_args = ['selected*']
3030
ListOption('exclude', type=str, short_name='x',
3031
help="Do not consider changes made to a given path."),
3032
Option('message', type=unicode,
3034
help="Description of the new revision."),
3037
help='Commit even if nothing has changed.'),
3038
Option('file', type=str,
3041
help='Take commit message from this file.'),
3043
help="Refuse to commit if there are unknown "
3044
"files in the working tree."),
3045
Option('commit-time', type=str,
3046
help="Manually set a commit time using commit date "
3047
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3048
ListOption('fixes', type=str,
3049
help="Mark a bug as being fixed by this revision "
3050
"(see \"bzr help bugs\")."),
3051
ListOption('author', type=unicode,
3052
help="Set the author's name, if it's different "
3053
"from the committer."),
3055
help="Perform a local commit in a bound "
3056
"branch. Local commits are not pushed to "
3057
"the master branch until a normal commit "
3061
help='When no message is supplied, show the diff along'
3062
' with the status summary in the message editor.'),
3064
aliases = ['ci', 'checkin']
3066
def _iter_bug_fix_urls(self, fixes, branch):
3067
# Configure the properties for bug fixing attributes.
3068
for fixed_bug in fixes:
3069
tokens = fixed_bug.split(':')
3070
if len(tokens) != 2:
3071
raise errors.BzrCommandError(
3072
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3073
"See \"bzr help bugs\" for more information on this "
3074
"feature.\nCommit refused." % fixed_bug)
3075
tag, bug_id = tokens
3077
yield bugtracker.get_bug_url(tag, branch, bug_id)
3078
except errors.UnknownBugTrackerAbbreviation:
3079
raise errors.BzrCommandError(
3080
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3081
except errors.MalformedBugIdentifier, e:
3082
raise errors.BzrCommandError(
3083
"%s\nCommit refused." % (str(e),))
3085
def run(self, message=None, file=None, verbose=False, selected_list=None,
3086
unchanged=False, strict=False, local=False, fixes=None,
3087
author=None, show_diff=False, exclude=None, commit_time=None):
3088
from bzrlib.errors import (
3093
from bzrlib.msgeditor import (
3094
edit_commit_message_encoded,
3095
generate_commit_message_template,
3096
make_commit_message_template_encoded
3099
commit_stamp = offset = None
3100
if commit_time is not None:
3102
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3103
except ValueError, e:
3104
raise errors.BzrCommandError(
3105
"Could not parse --commit-time: " + str(e))
3107
# TODO: Need a blackbox test for invoking the external editor; may be
3108
# slightly problematic to run this cross-platform.
3110
# TODO: do more checks that the commit will succeed before
3111
# spending the user's valuable time typing a commit message.
3115
tree, selected_list = tree_files(selected_list)
3116
if selected_list == ['']:
3117
# workaround - commit of root of tree should be exactly the same
3118
# as just default commit in that tree, and succeed even though
3119
# selected-file merge commit is not done yet
3124
bug_property = bugtracker.encode_fixes_bug_urls(
3125
self._iter_bug_fix_urls(fixes, tree.branch))
3127
properties['bugs'] = bug_property
3129
if local and not tree.branch.get_bound_location():
3130
raise errors.LocalRequiresBoundBranch()
3132
if message is not None:
3134
file_exists = osutils.lexists(message)
3135
except UnicodeError:
3136
# The commit message contains unicode characters that can't be
3137
# represented in the filesystem encoding, so that can't be a
3142
'The commit message is a file name: "%(f)s".\n'
3143
'(use --file "%(f)s" to take commit message from that file)'
3145
ui.ui_factory.show_warning(warning_msg)
3147
message = message.replace('\r\n', '\n')
3148
message = message.replace('\r', '\n')
3150
raise errors.BzrCommandError(
3151
"please specify either --message or --file")
3153
def get_message(commit_obj):
3154
"""Callback to get commit message"""
3156
my_message = codecs.open(
3157
file, 'rt', osutils.get_user_encoding()).read()
3158
elif message is not None:
3159
my_message = message
3161
# No message supplied: make one up.
3162
# text is the status of the tree
3163
text = make_commit_message_template_encoded(tree,
3164
selected_list, diff=show_diff,
3165
output_encoding=osutils.get_user_encoding())
3166
# start_message is the template generated from hooks
3167
# XXX: Warning - looks like hooks return unicode,
3168
# make_commit_message_template_encoded returns user encoding.
3169
# We probably want to be using edit_commit_message instead to
3171
start_message = generate_commit_message_template(commit_obj)
3172
my_message = edit_commit_message_encoded(text,
3173
start_message=start_message)
3174
if my_message is None:
3175
raise errors.BzrCommandError("please specify a commit"
3176
" message with either --message or --file")
3177
if my_message == "":
3178
raise errors.BzrCommandError("empty commit message specified")
3181
# The API permits a commit with a filter of [] to mean 'select nothing'
3182
# but the command line should not do that.
3183
if not selected_list:
3184
selected_list = None
3186
tree.commit(message_callback=get_message,
3187
specific_files=selected_list,
3188
allow_pointless=unchanged, strict=strict, local=local,
3189
reporter=None, verbose=verbose, revprops=properties,
3190
authors=author, timestamp=commit_stamp,
3192
exclude=safe_relpath_files(tree, exclude))
3193
except PointlessCommit:
3194
raise errors.BzrCommandError("No changes to commit."
3195
" Use --unchanged to commit anyhow.")
3196
except ConflictsInTree:
3197
raise errors.BzrCommandError('Conflicts detected in working '
3198
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3200
except StrictCommitFailed:
3201
raise errors.BzrCommandError("Commit refused because there are"
3202
" unknown files in the working tree.")
3203
except errors.BoundBranchOutOfDate, e:
3204
e.extra_help = ("\n"
3205
'To commit to master branch, run update and then commit.\n'
3206
'You can also pass --local to commit to continue working '
3211
class cmd_check(Command):
3212
"""Validate working tree structure, branch consistency and repository history.
3214
This command checks various invariants about branch and repository storage
3215
to detect data corruption or bzr bugs.
3217
The working tree and branch checks will only give output if a problem is
3218
detected. The output fields of the repository check are:
3221
This is just the number of revisions checked. It doesn't
3225
This is just the number of versionedfiles checked. It
3226
doesn't indicate a problem.
3228
unreferenced ancestors
3229
Texts that are ancestors of other texts, but
3230
are not properly referenced by the revision ancestry. This is a
3231
subtle problem that Bazaar can work around.
3234
This is the total number of unique file contents
3235
seen in the checked revisions. It does not indicate a problem.
3238
This is the total number of repeated texts seen
3239
in the checked revisions. Texts can be repeated when their file
3240
entries are modified, but the file contents are not. It does not
3243
If no restrictions are specified, all Bazaar data that is found at the given
3244
location will be checked.
3248
Check the tree and branch at 'foo'::
3250
bzr check --tree --branch foo
3252
Check only the repository at 'bar'::
3254
bzr check --repo bar
3256
Check everything at 'baz'::
3261
_see_also = ['reconcile']
3262
takes_args = ['path?']
3263
takes_options = ['verbose',
3264
Option('branch', help="Check the branch related to the"
3265
" current directory."),
3266
Option('repo', help="Check the repository related to the"
3267
" current directory."),
3268
Option('tree', help="Check the working tree related to"
3269
" the current directory.")]
3271
def run(self, path=None, verbose=False, branch=False, repo=False,
3273
from bzrlib.check import check_dwim
3276
if not branch and not repo and not tree:
3277
branch = repo = tree = True
3278
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3281
class cmd_upgrade(Command):
3282
"""Upgrade branch storage to current format.
3284
The check command or bzr developers may sometimes advise you to run
3285
this command. When the default format has changed you may also be warned
3286
during other operations to upgrade.
3289
_see_also = ['check']
3290
takes_args = ['url?']
3292
RegistryOption('format',
3293
help='Upgrade to a specific format. See "bzr help'
3294
' formats" for details.',
3295
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3296
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3297
value_switches=True, title='Branch format'),
3300
def run(self, url='.', format=None):
3301
from bzrlib.upgrade import upgrade
3302
upgrade(url, format)
3305
class cmd_whoami(Command):
3306
"""Show or set bzr user id.
3309
Show the email of the current user::
3313
Set the current user::
3315
bzr whoami "Frank Chu <fchu@example.com>"
3317
takes_options = [ Option('email',
3318
help='Display email address only.'),
3320
help='Set identity for the current branch instead of '
3323
takes_args = ['name?']
3324
encoding_type = 'replace'
3327
def run(self, email=False, branch=False, name=None):
3329
# use branch if we're inside one; otherwise global config
3331
c = Branch.open_containing('.')[0].get_config()
3332
except errors.NotBranchError:
3333
c = config.GlobalConfig()
3335
self.outf.write(c.user_email() + '\n')
3337
self.outf.write(c.username() + '\n')
3340
# display a warning if an email address isn't included in the given name.
3342
config.extract_email_address(name)
3343
except errors.NoEmailInUsername, e:
3344
warning('"%s" does not seem to contain an email address. '
3345
'This is allowed, but not recommended.', name)
3347
# use global config unless --branch given
3349
c = Branch.open_containing('.')[0].get_config()
3351
c = config.GlobalConfig()
3352
c.set_user_option('email', name)
3355
class cmd_nick(Command):
3356
"""Print or set the branch nickname.
3358
If unset, the tree root directory name is used as the nickname.
3359
To print the current nickname, execute with no argument.
3361
Bound branches use the nickname of its master branch unless it is set
3365
_see_also = ['info']
3366
takes_args = ['nickname?']
3367
def run(self, nickname=None):
3368
branch = Branch.open_containing(u'.')[0]
3369
if nickname is None:
3370
self.printme(branch)
3372
branch.nick = nickname
3375
def printme(self, branch):
3376
self.outf.write('%s\n' % branch.nick)
3379
class cmd_alias(Command):
3380
"""Set/unset and display aliases.
3383
Show the current aliases::
3387
Show the alias specified for 'll'::
3391
Set an alias for 'll'::
3393
bzr alias ll="log --line -r-10..-1"
3395
To remove an alias for 'll'::
3397
bzr alias --remove ll
3400
takes_args = ['name?']
3402
Option('remove', help='Remove the alias.'),
3405
def run(self, name=None, remove=False):
3407
self.remove_alias(name)
3409
self.print_aliases()
3411
equal_pos = name.find('=')
3413
self.print_alias(name)
3415
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3417
def remove_alias(self, alias_name):
3418
if alias_name is None:
3419
raise errors.BzrCommandError(
3420
'bzr alias --remove expects an alias to remove.')
3421
# If alias is not found, print something like:
3422
# unalias: foo: not found
3423
c = config.GlobalConfig()
3424
c.unset_alias(alias_name)
3427
def print_aliases(self):
3428
"""Print out the defined aliases in a similar format to bash."""
3429
aliases = config.GlobalConfig().get_aliases()
3430
for key, value in sorted(aliases.iteritems()):
3431
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3434
def print_alias(self, alias_name):
3435
from bzrlib.commands import get_alias
3436
alias = get_alias(alias_name)
3438
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3441
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3443
def set_alias(self, alias_name, alias_command):
3444
"""Save the alias in the global config."""
3445
c = config.GlobalConfig()
3446
c.set_alias(alias_name, alias_command)
3449
class cmd_selftest(Command):
3450
"""Run internal test suite.
3452
If arguments are given, they are regular expressions that say which tests
3453
should run. Tests matching any expression are run, and other tests are
3456
Alternatively if --first is given, matching tests are run first and then
3457
all other tests are run. This is useful if you have been working in a
3458
particular area, but want to make sure nothing else was broken.
3460
If --exclude is given, tests that match that regular expression are
3461
excluded, regardless of whether they match --first or not.
3463
To help catch accidential dependencies between tests, the --randomize
3464
option is useful. In most cases, the argument used is the word 'now'.
3465
Note that the seed used for the random number generator is displayed
3466
when this option is used. The seed can be explicitly passed as the
3467
argument to this option if required. This enables reproduction of the
3468
actual ordering used if and when an order sensitive problem is encountered.
3470
If --list-only is given, the tests that would be run are listed. This is
3471
useful when combined with --first, --exclude and/or --randomize to
3472
understand their impact. The test harness reports "Listed nn tests in ..."
3473
instead of "Ran nn tests in ..." when list mode is enabled.
3475
If the global option '--no-plugins' is given, plugins are not loaded
3476
before running the selftests. This has two effects: features provided or
3477
modified by plugins will not be tested, and tests provided by plugins will
3480
Tests that need working space on disk use a common temporary directory,
3481
typically inside $TMPDIR or /tmp.
3483
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3484
into a pdb postmortem session.
3487
Run only tests relating to 'ignore'::
3491
Disable plugins and list tests as they're run::
3493
bzr --no-plugins selftest -v
3495
# NB: this is used from the class without creating an instance, which is
3496
# why it does not have a self parameter.
3497
def get_transport_type(typestring):
3498
"""Parse and return a transport specifier."""
3499
if typestring == "sftp":
3500
from bzrlib.tests import stub_sftp
3501
return stub_sftp.SFTPAbsoluteServer
3502
if typestring == "memory":
3503
from bzrlib.tests import test_server
3504
return memory.MemoryServer
3505
if typestring == "fakenfs":
3506
from bzrlib.tests import test_server
3507
return test_server.FakeNFSServer
3508
msg = "No known transport type %s. Supported types are: sftp\n" %\
3510
raise errors.BzrCommandError(msg)
3513
takes_args = ['testspecs*']
3514
takes_options = ['verbose',
3516
help='Stop when one test fails.',
3520
help='Use a different transport by default '
3521
'throughout the test suite.',
3522
type=get_transport_type),
3524
help='Run the benchmarks rather than selftests.'),
3525
Option('lsprof-timed',
3526
help='Generate lsprof output for benchmarked'
3527
' sections of code.'),
3528
Option('lsprof-tests',
3529
help='Generate lsprof output for each test.'),
3530
Option('cache-dir', type=str,
3531
help='Cache intermediate benchmark output in this '
3534
help='Run all tests, but run specified tests first.',
3538
help='List the tests instead of running them.'),
3539
RegistryOption('parallel',
3540
help="Run the test suite in parallel.",
3541
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3542
value_switches=False,
3544
Option('randomize', type=str, argname="SEED",
3545
help='Randomize the order of tests using the given'
3546
' seed or "now" for the current time.'),
3547
Option('exclude', type=str, argname="PATTERN",
3549
help='Exclude tests that match this regular'
3552
help='Output test progress via subunit.'),
3553
Option('strict', help='Fail on missing dependencies or '
3555
Option('load-list', type=str, argname='TESTLISTFILE',
3556
help='Load a test id list from a text file.'),
3557
ListOption('debugflag', type=str, short_name='E',
3558
help='Turn on a selftest debug flag.'),
3559
ListOption('starting-with', type=str, argname='TESTID',
3560
param_name='starting_with', short_name='s',
3562
'Load only the tests starting with TESTID.'),
3564
encoding_type = 'replace'
3567
Command.__init__(self)
3568
self.additional_selftest_args = {}
3570
def run(self, testspecs_list=None, verbose=False, one=False,
3571
transport=None, benchmark=None,
3572
lsprof_timed=None, cache_dir=None,
3573
first=False, list_only=False,
3574
randomize=None, exclude=None, strict=False,
3575
load_list=None, debugflag=None, starting_with=None, subunit=False,
3576
parallel=None, lsprof_tests=False):
3577
from bzrlib.tests import selftest
3578
import bzrlib.benchmarks as benchmarks
3579
from bzrlib.benchmarks import tree_creator
3581
# Make deprecation warnings visible, unless -Werror is set
3582
symbol_versioning.activate_deprecation_warnings(override=False)
3584
if cache_dir is not None:
3585
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3586
if testspecs_list is not None:
3587
pattern = '|'.join(testspecs_list)
3592
from bzrlib.tests import SubUnitBzrRunner
3594
raise errors.BzrCommandError("subunit not available. subunit "
3595
"needs to be installed to use --subunit.")
3596
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3598
self.additional_selftest_args.setdefault(
3599
'suite_decorators', []).append(parallel)
3601
test_suite_factory = benchmarks.test_suite
3602
# Unless user explicitly asks for quiet, be verbose in benchmarks
3603
verbose = not is_quiet()
3604
# TODO: should possibly lock the history file...
3605
benchfile = open(".perf_history", "at", buffering=1)
3606
self.add_cleanup(benchfile.close)
3608
test_suite_factory = None
3610
selftest_kwargs = {"verbose": verbose,
3612
"stop_on_failure": one,
3613
"transport": transport,
3614
"test_suite_factory": test_suite_factory,
3615
"lsprof_timed": lsprof_timed,
3616
"lsprof_tests": lsprof_tests,
3617
"bench_history": benchfile,
3618
"matching_tests_first": first,
3619
"list_only": list_only,
3620
"random_seed": randomize,
3621
"exclude_pattern": exclude,
3623
"load_list": load_list,
3624
"debug_flags": debugflag,
3625
"starting_with": starting_with
3627
selftest_kwargs.update(self.additional_selftest_args)
3628
result = selftest(**selftest_kwargs)
3629
return int(not result)
3632
class cmd_version(Command):
3633
"""Show version of bzr."""
3635
encoding_type = 'replace'
3637
Option("short", help="Print just the version number."),
3641
def run(self, short=False):
3642
from bzrlib.version import show_version
3644
self.outf.write(bzrlib.version_string + '\n')
3646
show_version(to_file=self.outf)
3649
class cmd_rocks(Command):
3650
"""Statement of optimism."""
3656
self.outf.write("It sure does!\n")
3659
class cmd_find_merge_base(Command):
3660
"""Find and print a base revision for merging two branches."""
3661
# TODO: Options to specify revisions on either side, as if
3662
# merging only part of the history.
3663
takes_args = ['branch', 'other']
3667
def run(self, branch, other):
3668
from bzrlib.revision import ensure_null
3670
branch1 = Branch.open_containing(branch)[0]
3671
branch2 = Branch.open_containing(other)[0]
3673
self.add_cleanup(branch1.unlock)
3675
self.add_cleanup(branch2.unlock)
3676
last1 = ensure_null(branch1.last_revision())
3677
last2 = ensure_null(branch2.last_revision())
3679
graph = branch1.repository.get_graph(branch2.repository)
3680
base_rev_id = graph.find_unique_lca(last1, last2)
3682
self.outf.write('merge base is revision %s\n' % base_rev_id)
3685
class cmd_merge(Command):
3686
"""Perform a three-way merge.
3688
The source of the merge can be specified either in the form of a branch,
3689
or in the form of a path to a file containing a merge directive generated
3690
with bzr send. If neither is specified, the default is the upstream branch
3691
or the branch most recently merged using --remember.
3693
When merging a branch, by default the tip will be merged. To pick a different
3694
revision, pass --revision. If you specify two values, the first will be used as
3695
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3696
available revisions, like this is commonly referred to as "cherrypicking".
3698
Revision numbers are always relative to the branch being merged.
3700
By default, bzr will try to merge in all new work from the other
3701
branch, automatically determining an appropriate base. If this
3702
fails, you may need to give an explicit base.
3704
Merge will do its best to combine the changes in two branches, but there
3705
are some kinds of problems only a human can fix. When it encounters those,
3706
it will mark a conflict. A conflict means that you need to fix something,
3707
before you should commit.
3709
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3711
If there is no default branch set, the first merge will set it. After
3712
that, you can omit the branch to use the default. To change the
3713
default, use --remember. The value will only be saved if the remote
3714
location can be accessed.
3716
The results of the merge are placed into the destination working
3717
directory, where they can be reviewed (with bzr diff), tested, and then
3718
committed to record the result of the merge.
3720
merge refuses to run if there are any uncommitted changes, unless
3721
--force is given. The --force option can also be used to create a
3722
merge revision which has more than two parents.
3724
If one would like to merge changes from the working tree of the other
3725
branch without merging any committed revisions, the --uncommitted option
3728
To select only some changes to merge, use "merge -i", which will prompt
3729
you to apply each diff hunk and file change, similar to "shelve".
3732
To merge the latest revision from bzr.dev::
3734
bzr merge ../bzr.dev
3736
To merge changes up to and including revision 82 from bzr.dev::
3738
bzr merge -r 82 ../bzr.dev
3740
To merge the changes introduced by 82, without previous changes::
3742
bzr merge -r 81..82 ../bzr.dev
3744
To apply a merge directive contained in /tmp/merge::
3746
bzr merge /tmp/merge
3748
To create a merge revision with three parents from two branches
3749
feature1a and feature1b:
3751
bzr merge ../feature1a
3752
bzr merge ../feature1b --force
3753
bzr commit -m 'revision with three parents'
3756
encoding_type = 'exact'
3757
_see_also = ['update', 'remerge', 'status-flags', 'send']
3758
takes_args = ['location?']
3763
help='Merge even if the destination tree has uncommitted changes.'),
3767
Option('show-base', help="Show base revision text in "
3769
Option('uncommitted', help='Apply uncommitted changes'
3770
' from a working copy, instead of branch changes.'),
3771
Option('pull', help='If the destination is already'
3772
' completely merged into the source, pull from the'
3773
' source rather than merging. When this happens,'
3774
' you do not need to commit the result.'),
3776
help='Branch to merge into, '
3777
'rather than the one containing the working directory.',
3781
Option('preview', help='Instead of merging, show a diff of the'
3783
Option('interactive', help='Select changes interactively.',
3787
def run(self, location=None, revision=None, force=False,
3788
merge_type=None, show_base=False, reprocess=None, remember=False,
3789
uncommitted=False, pull=False,
3794
if merge_type is None:
3795
merge_type = _mod_merge.Merge3Merger
3797
if directory is None: directory = u'.'
3798
possible_transports = []
3800
allow_pending = True
3801
verified = 'inapplicable'
3802
tree = WorkingTree.open_containing(directory)[0]
3805
basis_tree = tree.revision_tree(tree.last_revision())
3806
except errors.NoSuchRevision:
3807
basis_tree = tree.basis_tree()
3809
# die as quickly as possible if there are uncommitted changes
3811
if tree.has_changes():
3812
raise errors.UncommittedChanges(tree)
3814
view_info = _get_view_info_for_change_reporter(tree)
3815
change_reporter = delta._ChangeReporter(
3816
unversioned_filter=tree.is_ignored, view_info=view_info)
3817
pb = ui.ui_factory.nested_progress_bar()
3818
self.add_cleanup(pb.finished)
3820
self.add_cleanup(tree.unlock)
3821
if location is not None:
3823
mergeable = bundle.read_mergeable_from_url(location,
3824
possible_transports=possible_transports)
3825
except errors.NotABundle:
3829
raise errors.BzrCommandError('Cannot use --uncommitted'
3830
' with bundles or merge directives.')
3832
if revision is not None:
3833
raise errors.BzrCommandError(
3834
'Cannot use -r with merge directives or bundles')
3835
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3838
if merger is None and uncommitted:
3839
if revision is not None and len(revision) > 0:
3840
raise errors.BzrCommandError('Cannot use --uncommitted and'
3841
' --revision at the same time.')
3842
merger = self.get_merger_from_uncommitted(tree, location, None)
3843
allow_pending = False
3846
merger, allow_pending = self._get_merger_from_branch(tree,
3847
location, revision, remember, possible_transports, None)
3849
merger.merge_type = merge_type
3850
merger.reprocess = reprocess
3851
merger.show_base = show_base
3852
self.sanity_check_merger(merger)
3853
if (merger.base_rev_id == merger.other_rev_id and
3854
merger.other_rev_id is not None):
3855
note('Nothing to do.')
3858
if merger.interesting_files is not None:
3859
raise errors.BzrCommandError('Cannot pull individual files')
3860
if (merger.base_rev_id == tree.last_revision()):
3861
result = tree.pull(merger.other_branch, False,
3862
merger.other_rev_id)
3863
result.report(self.outf)
3865
if merger.this_basis is None:
3866
raise errors.BzrCommandError(
3867
"This branch has no commits."
3868
" (perhaps you would prefer 'bzr pull')")
3870
return self._do_preview(merger)
3872
return self._do_interactive(merger)
3874
return self._do_merge(merger, change_reporter, allow_pending,
3877
def _get_preview(self, merger):
3878
tree_merger = merger.make_merger()
3879
tt = tree_merger.make_preview_transform()
3880
self.add_cleanup(tt.finalize)
3881
result_tree = tt.get_preview_tree()
3884
def _do_preview(self, merger):
3885
from bzrlib.diff import show_diff_trees
3886
result_tree = self._get_preview(merger)
3887
show_diff_trees(merger.this_tree, result_tree, self.outf,
3888
old_label='', new_label='')
3890
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3891
merger.change_reporter = change_reporter
3892
conflict_count = merger.do_merge()
3894
merger.set_pending()
3895
if verified == 'failed':
3896
warning('Preview patch does not match changes')
3897
if conflict_count != 0:
3902
def _do_interactive(self, merger):
3903
"""Perform an interactive merge.
3905
This works by generating a preview tree of the merge, then using
3906
Shelver to selectively remove the differences between the working tree
3907
and the preview tree.
3909
from bzrlib import shelf_ui
3910
result_tree = self._get_preview(merger)
3911
writer = bzrlib.option.diff_writer_registry.get()
3912
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3913
reporter=shelf_ui.ApplyReporter(),
3914
diff_writer=writer(sys.stdout))
3920
def sanity_check_merger(self, merger):
3921
if (merger.show_base and
3922
not merger.merge_type is _mod_merge.Merge3Merger):
3923
raise errors.BzrCommandError("Show-base is not supported for this"
3924
" merge type. %s" % merger.merge_type)
3925
if merger.reprocess is None:
3926
if merger.show_base:
3927
merger.reprocess = False
3929
# Use reprocess if the merger supports it
3930
merger.reprocess = merger.merge_type.supports_reprocess
3931
if merger.reprocess and not merger.merge_type.supports_reprocess:
3932
raise errors.BzrCommandError("Conflict reduction is not supported"
3933
" for merge type %s." %
3935
if merger.reprocess and merger.show_base:
3936
raise errors.BzrCommandError("Cannot do conflict reduction and"
3939
def _get_merger_from_branch(self, tree, location, revision, remember,
3940
possible_transports, pb):
3941
"""Produce a merger from a location, assuming it refers to a branch."""
3942
from bzrlib.tag import _merge_tags_if_possible
3943
# find the branch locations
3944
other_loc, user_location = self._select_branch_location(tree, location,
3946
if revision is not None and len(revision) == 2:
3947
base_loc, _unused = self._select_branch_location(tree,
3948
location, revision, 0)
3950
base_loc = other_loc
3952
other_branch, other_path = Branch.open_containing(other_loc,
3953
possible_transports)
3954
if base_loc == other_loc:
3955
base_branch = other_branch
3957
base_branch, base_path = Branch.open_containing(base_loc,
3958
possible_transports)
3959
# Find the revision ids
3960
other_revision_id = None
3961
base_revision_id = None
3962
if revision is not None:
3963
if len(revision) >= 1:
3964
other_revision_id = revision[-1].as_revision_id(other_branch)
3965
if len(revision) == 2:
3966
base_revision_id = revision[0].as_revision_id(base_branch)
3967
if other_revision_id is None:
3968
other_revision_id = _mod_revision.ensure_null(
3969
other_branch.last_revision())
3970
# Remember where we merge from
3971
if ((remember or tree.branch.get_submit_branch() is None) and
3972
user_location is not None):
3973
tree.branch.set_submit_branch(other_branch.base)
3974
_merge_tags_if_possible(other_branch, tree.branch)
3975
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3976
other_revision_id, base_revision_id, other_branch, base_branch)
3977
if other_path != '':
3978
allow_pending = False
3979
merger.interesting_files = [other_path]
3981
allow_pending = True
3982
return merger, allow_pending
3984
def get_merger_from_uncommitted(self, tree, location, pb):
3985
"""Get a merger for uncommitted changes.
3987
:param tree: The tree the merger should apply to.
3988
:param location: The location containing uncommitted changes.
3989
:param pb: The progress bar to use for showing progress.
3991
location = self._select_branch_location(tree, location)[0]
3992
other_tree, other_path = WorkingTree.open_containing(location)
3993
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3994
if other_path != '':
3995
merger.interesting_files = [other_path]
3998
def _select_branch_location(self, tree, user_location, revision=None,
4000
"""Select a branch location, according to possible inputs.
4002
If provided, branches from ``revision`` are preferred. (Both
4003
``revision`` and ``index`` must be supplied.)
4005
Otherwise, the ``location`` parameter is used. If it is None, then the
4006
``submit`` or ``parent`` location is used, and a note is printed.
4008
:param tree: The working tree to select a branch for merging into
4009
:param location: The location entered by the user
4010
:param revision: The revision parameter to the command
4011
:param index: The index to use for the revision parameter. Negative
4012
indices are permitted.
4013
:return: (selected_location, user_location). The default location
4014
will be the user-entered location.
4016
if (revision is not None and index is not None
4017
and revision[index] is not None):
4018
branch = revision[index].get_branch()
4019
if branch is not None:
4020
return branch, branch
4021
if user_location is None:
4022
location = self._get_remembered(tree, 'Merging from')
4024
location = user_location
4025
return location, user_location
4027
def _get_remembered(self, tree, verb_string):
4028
"""Use tree.branch's parent if none was supplied.
4030
Report if the remembered location was used.
4032
stored_location = tree.branch.get_submit_branch()
4033
stored_location_type = "submit"
4034
if stored_location is None:
4035
stored_location = tree.branch.get_parent()
4036
stored_location_type = "parent"
4037
mutter("%s", stored_location)
4038
if stored_location is None:
4039
raise errors.BzrCommandError("No location specified or remembered")
4040
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4041
note(u"%s remembered %s location %s", verb_string,
4042
stored_location_type, display_url)
4043
return stored_location
4046
class cmd_remerge(Command):
4049
Use this if you want to try a different merge technique while resolving
4050
conflicts. Some merge techniques are better than others, and remerge
4051
lets you try different ones on different files.
4053
The options for remerge have the same meaning and defaults as the ones for
4054
merge. The difference is that remerge can (only) be run when there is a
4055
pending merge, and it lets you specify particular files.
4058
Re-do the merge of all conflicted files, and show the base text in
4059
conflict regions, in addition to the usual THIS and OTHER texts::
4061
bzr remerge --show-base
4063
Re-do the merge of "foobar", using the weave merge algorithm, with
4064
additional processing to reduce the size of conflict regions::
4066
bzr remerge --merge-type weave --reprocess foobar
4068
takes_args = ['file*']
4073
help="Show base revision text in conflicts."),
4076
def run(self, file_list=None, merge_type=None, show_base=False,
4078
from bzrlib.conflicts import restore
4079
if merge_type is None:
4080
merge_type = _mod_merge.Merge3Merger
4081
tree, file_list = tree_files(file_list)
4083
self.add_cleanup(tree.unlock)
4084
parents = tree.get_parent_ids()
4085
if len(parents) != 2:
4086
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4087
" merges. Not cherrypicking or"
4089
repository = tree.branch.repository
4090
interesting_ids = None
4092
conflicts = tree.conflicts()
4093
if file_list is not None:
4094
interesting_ids = set()
4095
for filename in file_list:
4096
file_id = tree.path2id(filename)
4098
raise errors.NotVersionedError(filename)
4099
interesting_ids.add(file_id)
4100
if tree.kind(file_id) != "directory":
4103
for name, ie in tree.inventory.iter_entries(file_id):
4104
interesting_ids.add(ie.file_id)
4105
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4107
# Remerge only supports resolving contents conflicts
4108
allowed_conflicts = ('text conflict', 'contents conflict')
4109
restore_files = [c.path for c in conflicts
4110
if c.typestring in allowed_conflicts]
4111
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4112
tree.set_conflicts(ConflictList(new_conflicts))
4113
if file_list is not None:
4114
restore_files = file_list
4115
for filename in restore_files:
4117
restore(tree.abspath(filename))
4118
except errors.NotConflicted:
4120
# Disable pending merges, because the file texts we are remerging
4121
# have not had those merges performed. If we use the wrong parents
4122
# list, we imply that the working tree text has seen and rejected
4123
# all the changes from the other tree, when in fact those changes
4124
# have not yet been seen.
4125
tree.set_parent_ids(parents[:1])
4127
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4128
merger.interesting_ids = interesting_ids
4129
merger.merge_type = merge_type
4130
merger.show_base = show_base
4131
merger.reprocess = reprocess
4132
conflicts = merger.do_merge()
4134
tree.set_parent_ids(parents)
4141
class cmd_revert(Command):
4142
"""Revert files to a previous revision.
4144
Giving a list of files will revert only those files. Otherwise, all files
4145
will be reverted. If the revision is not specified with '--revision', the
4146
last committed revision is used.
4148
To remove only some changes, without reverting to a prior version, use
4149
merge instead. For example, "merge . --revision -2..-3" will remove the
4150
changes introduced by -2, without affecting the changes introduced by -1.
4151
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4153
By default, any files that have been manually changed will be backed up
4154
first. (Files changed only by merge are not backed up.) Backup files have
4155
'.~#~' appended to their name, where # is a number.
4157
When you provide files, you can use their current pathname or the pathname
4158
from the target revision. So you can use revert to "undelete" a file by
4159
name. If you name a directory, all the contents of that directory will be
4162
If you have newly added files since the target revision, they will be
4163
removed. If the files to be removed have been changed, backups will be
4164
created as above. Directories containing unknown files will not be
4167
The working tree contains a list of revisions that have been merged but
4168
not yet committed. These revisions will be included as additional parents
4169
of the next commit. Normally, using revert clears that list as well as
4170
reverting the files. If any files are specified, revert leaves the list
4171
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4172
.`` in the tree root to revert all files but keep the recorded merges,
4173
and ``bzr revert --forget-merges`` to clear the pending merge list without
4174
reverting any files.
4176
Using "bzr revert --forget-merges", it is possible to apply all of the
4177
changes from a branch in a single revision. To do this, perform the merge
4178
as desired. Then doing revert with the "--forget-merges" option will keep
4179
the content of the tree as it was, but it will clear the list of pending
4180
merges. The next commit will then contain all of the changes that are
4181
present in the other branch, but without any other parent revisions.
4182
Because this technique forgets where these changes originated, it may
4183
cause additional conflicts on later merges involving the same source and
4187
_see_also = ['cat', 'export']
4190
Option('no-backup', "Do not save backups of reverted files."),
4191
Option('forget-merges',
4192
'Remove pending merge marker, without changing any files.'),
4194
takes_args = ['file*']
4196
def run(self, revision=None, no_backup=False, file_list=None,
4197
forget_merges=None):
4198
tree, file_list = tree_files(file_list)
4199
tree.lock_tree_write()
4200
self.add_cleanup(tree.unlock)
4202
tree.set_parent_ids(tree.get_parent_ids()[:1])
4204
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4207
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4208
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4209
tree.revert(file_list, rev_tree, not no_backup, None,
4210
report_changes=True)
4213
class cmd_assert_fail(Command):
4214
"""Test reporting of assertion failures"""
4215
# intended just for use in testing
4220
raise AssertionError("always fails")
4223
class cmd_help(Command):
4224
"""Show help on a command or other topic.
4227
_see_also = ['topics']
4229
Option('long', 'Show help on all commands.'),
4231
takes_args = ['topic?']
4232
aliases = ['?', '--help', '-?', '-h']
4235
def run(self, topic=None, long=False):
4237
if topic is None and long:
4239
bzrlib.help.help(topic)
4242
class cmd_shell_complete(Command):
4243
"""Show appropriate completions for context.
4245
For a list of all available commands, say 'bzr shell-complete'.
4247
takes_args = ['context?']
4252
def run(self, context=None):
4253
import shellcomplete
4254
shellcomplete.shellcomplete(context)
4257
class cmd_missing(Command):
4258
"""Show unmerged/unpulled revisions between two branches.
4260
OTHER_BRANCH may be local or remote.
4262
To filter on a range of revisions, you can use the command -r begin..end
4263
-r revision requests a specific revision, -r ..end or -r begin.. are
4267
1 - some missing revisions
4268
0 - no missing revisions
4272
Determine the missing revisions between this and the branch at the
4273
remembered pull location::
4277
Determine the missing revisions between this and another branch::
4279
bzr missing http://server/branch
4281
Determine the missing revisions up to a specific revision on the other
4284
bzr missing -r ..-10
4286
Determine the missing revisions up to a specific revision on this
4289
bzr missing --my-revision ..-10
4292
_see_also = ['merge', 'pull']
4293
takes_args = ['other_branch?']
4295
Option('reverse', 'Reverse the order of revisions.'),
4297
'Display changes in the local branch only.'),
4298
Option('this' , 'Same as --mine-only.'),
4299
Option('theirs-only',
4300
'Display changes in the remote branch only.'),
4301
Option('other', 'Same as --theirs-only.'),
4305
custom_help('revision',
4306
help='Filter on other branch revisions (inclusive). '
4307
'See "help revisionspec" for details.'),
4308
Option('my-revision',
4309
type=_parse_revision_str,
4310
help='Filter on local branch revisions (inclusive). '
4311
'See "help revisionspec" for details.'),
4312
Option('include-merges',
4313
'Show all revisions in addition to the mainline ones.'),
4315
encoding_type = 'replace'
4318
def run(self, other_branch=None, reverse=False, mine_only=False,
4320
log_format=None, long=False, short=False, line=False,
4321
show_ids=False, verbose=False, this=False, other=False,
4322
include_merges=False, revision=None, my_revision=None):
4323
from bzrlib.missing import find_unmerged, iter_log_revisions
4332
# TODO: We should probably check that we don't have mine-only and
4333
# theirs-only set, but it gets complicated because we also have
4334
# this and other which could be used.
4341
local_branch = Branch.open_containing(u".")[0]
4342
local_branch.lock_read()
4343
self.add_cleanup(local_branch.unlock)
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
remote_branch.lock_read()
4361
self.add_cleanup(remote_branch.unlock)
4363
local_revid_range = _revision_range_to_revid_range(
4364
_get_revision_range(my_revision, local_branch,
4367
remote_revid_range = _revision_range_to_revid_range(
4368
_get_revision_range(revision,
4369
remote_branch, self.name()))
4371
local_extra, remote_extra = find_unmerged(
4372
local_branch, remote_branch, restrict,
4373
backward=not reverse,
4374
include_merges=include_merges,
4375
local_revid_range=local_revid_range,
4376
remote_revid_range=remote_revid_range)
4378
if log_format is None:
4379
registry = log.log_formatter_registry
4380
log_format = registry.get_default(local_branch)
4381
lf = log_format(to_file=self.outf,
4383
show_timezone='original')
4386
if local_extra and not theirs_only:
4387
message("You have %d extra revision(s):\n" %
4389
for revision in iter_log_revisions(local_extra,
4390
local_branch.repository,
4392
lf.log_revision(revision)
4393
printed_local = True
4396
printed_local = False
4398
if remote_extra and not mine_only:
4399
if printed_local is True:
4401
message("You are missing %d revision(s):\n" %
4403
for revision in iter_log_revisions(remote_extra,
4404
remote_branch.repository,
4406
lf.log_revision(revision)
4409
if mine_only and not local_extra:
4410
# We checked local, and found nothing extra
4411
message('This branch is up to date.\n')
4412
elif theirs_only and not remote_extra:
4413
# We checked remote, and found nothing extra
4414
message('Other branch is up to date.\n')
4415
elif not (mine_only or theirs_only or local_extra or
4417
# We checked both branches, and neither one had extra
4419
message("Branches are up to date.\n")
4421
if not status_code and parent is None and other_branch is not None:
4422
local_branch.lock_write()
4423
self.add_cleanup(local_branch.unlock)
4424
# handle race conditions - a parent might be set while we run.
4425
if local_branch.get_parent() is None:
4426
local_branch.set_parent(remote_branch.base)
4430
class cmd_pack(Command):
4431
"""Compress the data within a repository.
4433
This operation compresses the data within a bazaar repository. As
4434
bazaar supports automatic packing of repository, this operation is
4435
normally not required to be done manually.
4437
During the pack operation, bazaar takes a backup of existing repository
4438
data, i.e. pack files. This backup is eventually removed by bazaar
4439
automatically when it is safe to do so. To save disk space by removing
4440
the backed up pack files, the --clean-obsolete-packs option may be
4443
Warning: If you use --clean-obsolete-packs and your machine crashes
4444
during or immediately after repacking, you may be left with a state
4445
where the deletion has been written to disk but the new packs have not
4446
been. In this case the repository may be unusable.
4449
_see_also = ['repositories']
4450
takes_args = ['branch_or_repo?']
4452
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4455
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4456
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4458
branch = dir.open_branch()
4459
repository = branch.repository
4460
except errors.NotBranchError:
4461
repository = dir.open_repository()
4462
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4465
class cmd_plugins(Command):
4466
"""List the installed plugins.
4468
This command displays the list of installed plugins including
4469
version of plugin and a short description of each.
4471
--verbose shows the path where each plugin is located.
4473
A plugin is an external component for Bazaar that extends the
4474
revision control system, by adding or replacing code in Bazaar.
4475
Plugins can do a variety of things, including overriding commands,
4476
adding new commands, providing additional network transports and
4477
customizing log output.
4479
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4480
for further information on plugins including where to find them and how to
4481
install them. Instructions are also provided there on how to write new
4482
plugins using the Python programming language.
4484
takes_options = ['verbose']
4487
def run(self, verbose=False):
4488
import bzrlib.plugin
4489
from inspect import getdoc
4491
for name, plugin in bzrlib.plugin.plugins().items():
4492
version = plugin.__version__
4493
if version == 'unknown':
4495
name_ver = '%s %s' % (name, version)
4496
d = getdoc(plugin.module)
4498
doc = d.split('\n')[0]
4500
doc = '(no description)'
4501
result.append((name_ver, doc, plugin.path()))
4502
for name_ver, doc, path in sorted(result):
4503
self.outf.write("%s\n" % name_ver)
4504
self.outf.write(" %s\n" % doc)
4506
self.outf.write(" %s\n" % path)
4507
self.outf.write("\n")
4510
class cmd_testament(Command):
4511
"""Show testament (signing-form) of a revision."""
4514
Option('long', help='Produce long-format testament.'),
4516
help='Produce a strict-format testament.')]
4517
takes_args = ['branch?']
4519
def run(self, branch=u'.', revision=None, long=False, strict=False):
4520
from bzrlib.testament import Testament, StrictTestament
4522
testament_class = StrictTestament
4524
testament_class = Testament
4526
b = Branch.open_containing(branch)[0]
4528
b = Branch.open(branch)
4530
self.add_cleanup(b.unlock)
4531
if revision is None:
4532
rev_id = b.last_revision()
4534
rev_id = revision[0].as_revision_id(b)
4535
t = testament_class.from_revision(b.repository, rev_id)
4537
sys.stdout.writelines(t.as_text_lines())
4539
sys.stdout.write(t.as_short_text())
4542
class cmd_annotate(Command):
4543
"""Show the origin of each line in a file.
4545
This prints out the given file with an annotation on the left side
4546
indicating which revision, author and date introduced the change.
4548
If the origin is the same for a run of consecutive lines, it is
4549
shown only at the top, unless the --all option is given.
4551
# TODO: annotate directories; showing when each file was last changed
4552
# TODO: if the working copy is modified, show annotations on that
4553
# with new uncommitted lines marked
4554
aliases = ['ann', 'blame', 'praise']
4555
takes_args = ['filename']
4556
takes_options = [Option('all', help='Show annotations on all lines.'),
4557
Option('long', help='Show commit date in annotations.'),
4561
encoding_type = 'exact'
4564
def run(self, filename, all=False, long=False, revision=None,
4566
from bzrlib.annotate import annotate_file, annotate_file_tree
4567
wt, branch, relpath = \
4568
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4571
self.add_cleanup(wt.unlock)
4574
self.add_cleanup(branch.unlock)
4575
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4577
self.add_cleanup(tree.unlock)
4579
file_id = wt.path2id(relpath)
4581
file_id = tree.path2id(relpath)
4583
raise errors.NotVersionedError(filename)
4584
file_version = tree.inventory[file_id].revision
4585
if wt is not None and revision is None:
4586
# If there is a tree and we're not annotating historical
4587
# versions, annotate the working tree's content.
4588
annotate_file_tree(wt, file_id, self.outf, long, all,
4591
annotate_file(branch, file_version, file_id, long, all, self.outf,
4595
class cmd_re_sign(Command):
4596
"""Create a digital signature for an existing revision."""
4597
# TODO be able to replace existing ones.
4599
hidden = True # is this right ?
4600
takes_args = ['revision_id*']
4601
takes_options = ['revision']
4603
def run(self, revision_id_list=None, revision=None):
4604
if revision_id_list is not None and revision is not None:
4605
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4606
if revision_id_list is None and revision is None:
4607
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4608
b = WorkingTree.open_containing(u'.')[0].branch
4610
self.add_cleanup(b.unlock)
4611
return self._run(b, revision_id_list, revision)
4613
def _run(self, b, revision_id_list, revision):
4614
import bzrlib.gpg as gpg
4615
gpg_strategy = gpg.GPGStrategy(b.get_config())
4616
if revision_id_list is not None:
4617
b.repository.start_write_group()
4619
for revision_id in revision_id_list:
4620
b.repository.sign_revision(revision_id, gpg_strategy)
4622
b.repository.abort_write_group()
4625
b.repository.commit_write_group()
4626
elif revision is not None:
4627
if len(revision) == 1:
4628
revno, rev_id = revision[0].in_history(b)
4629
b.repository.start_write_group()
4631
b.repository.sign_revision(rev_id, gpg_strategy)
4633
b.repository.abort_write_group()
4636
b.repository.commit_write_group()
4637
elif len(revision) == 2:
4638
# are they both on rh- if so we can walk between them
4639
# might be nice to have a range helper for arbitrary
4640
# revision paths. hmm.
4641
from_revno, from_revid = revision[0].in_history(b)
4642
to_revno, to_revid = revision[1].in_history(b)
4643
if to_revid is None:
4644
to_revno = b.revno()
4645
if from_revno is None or to_revno is None:
4646
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4647
b.repository.start_write_group()
4649
for revno in range(from_revno, to_revno + 1):
4650
b.repository.sign_revision(b.get_rev_id(revno),
4653
b.repository.abort_write_group()
4656
b.repository.commit_write_group()
4658
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4661
class cmd_bind(Command):
4662
"""Convert the current branch into a checkout of the supplied branch.
4664
Once converted into a checkout, commits must succeed on the master branch
4665
before they will be applied to the local branch.
4667
Bound branches use the nickname of its master branch unless it is set
4668
locally, in which case binding will update the local nickname to be
4672
_see_also = ['checkouts', 'unbind']
4673
takes_args = ['location?']
4676
def run(self, location=None):
4677
b, relpath = Branch.open_containing(u'.')
4678
if location is None:
4680
location = b.get_old_bound_location()
4681
except errors.UpgradeRequired:
4682
raise errors.BzrCommandError('No location supplied. '
4683
'This format does not remember old locations.')
4685
if location is None:
4686
if b.get_bound_location() is not None:
4687
raise errors.BzrCommandError('Branch is already bound')
4689
raise errors.BzrCommandError('No location supplied '
4690
'and no previous location known')
4691
b_other = Branch.open(location)
4694
except errors.DivergedBranches:
4695
raise errors.BzrCommandError('These branches have diverged.'
4696
' Try merging, and then bind again.')
4697
if b.get_config().has_explicit_nickname():
4698
b.nick = b_other.nick
4701
class cmd_unbind(Command):
4702
"""Convert the current checkout into a regular branch.
4704
After unbinding, the local branch is considered independent and subsequent
4705
commits will be local only.
4708
_see_also = ['checkouts', 'bind']
4713
b, relpath = Branch.open_containing(u'.')
4715
raise errors.BzrCommandError('Local branch is not bound')
4718
class cmd_uncommit(Command):
4719
"""Remove the last committed revision.
4721
--verbose will print out what is being removed.
4722
--dry-run will go through all the motions, but not actually
4725
If --revision is specified, uncommit revisions to leave the branch at the
4726
specified revision. For example, "bzr uncommit -r 15" will leave the
4727
branch at revision 15.
4729
Uncommit leaves the working tree ready for a new commit. The only change
4730
it may make is to restore any pending merges that were present before
4734
# TODO: jam 20060108 Add an option to allow uncommit to remove
4735
# unreferenced information in 'branch-as-repository' branches.
4736
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4737
# information in shared branches as well.
4738
_see_also = ['commit']
4739
takes_options = ['verbose', 'revision',
4740
Option('dry-run', help='Don\'t actually make changes.'),
4741
Option('force', help='Say yes to all questions.'),
4743
help="Only remove the commits from the local branch"
4744
" when in a checkout."
4747
takes_args = ['location?']
4749
encoding_type = 'replace'
4751
def run(self, location=None,
4752
dry_run=False, verbose=False,
4753
revision=None, force=False, local=False):
4754
if location is None:
4756
control, relpath = bzrdir.BzrDir.open_containing(location)
4758
tree = control.open_workingtree()
4760
except (errors.NoWorkingTree, errors.NotLocalUrl):
4762
b = control.open_branch()
4764
if tree is not None:
4766
self.add_cleanup(tree.unlock)
4769
self.add_cleanup(b.unlock)
4770
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4772
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4773
from bzrlib.log import log_formatter, show_log
4774
from bzrlib.uncommit import uncommit
4776
last_revno, last_rev_id = b.last_revision_info()
4779
if revision is None:
4781
rev_id = last_rev_id
4783
# 'bzr uncommit -r 10' actually means uncommit
4784
# so that the final tree is at revno 10.
4785
# but bzrlib.uncommit.uncommit() actually uncommits
4786
# the revisions that are supplied.
4787
# So we need to offset it by one
4788
revno = revision[0].in_history(b).revno + 1
4789
if revno <= last_revno:
4790
rev_id = b.get_rev_id(revno)
4792
if rev_id is None or _mod_revision.is_null(rev_id):
4793
self.outf.write('No revisions to uncommit.\n')
4796
lf = log_formatter('short',
4798
show_timezone='original')
4803
direction='forward',
4804
start_revision=revno,
4805
end_revision=last_revno)
4808
self.outf.write('Dry-run, pretending to remove'
4809
' the above revisions.\n')
4811
self.outf.write('The above revision(s) will be removed.\n')
4814
if not ui.ui_factory.get_boolean('Are you sure'):
4815
self.outf.write('Canceled')
4818
mutter('Uncommitting from {%s} to {%s}',
4819
last_rev_id, rev_id)
4820
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4821
revno=revno, local=local)
4822
self.outf.write('You can restore the old tip by running:\n'
4823
' bzr pull . -r revid:%s\n' % last_rev_id)
4826
class cmd_break_lock(Command):
4827
"""Break a dead lock on a repository, branch or working directory.
4829
CAUTION: Locks should only be broken when you are sure that the process
4830
holding the lock has been stopped.
4832
You can get information on what locks are open via the 'bzr info
4833
[location]' command.
4837
bzr break-lock bzr+ssh://example.com/bzr/foo
4839
takes_args = ['location?']
4841
def run(self, location=None, show=False):
4842
if location is None:
4844
control, relpath = bzrdir.BzrDir.open_containing(location)
4846
control.break_lock()
4847
except NotImplementedError:
4851
class cmd_wait_until_signalled(Command):
4852
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4854
This just prints a line to signal when it is ready, then blocks on stdin.
4860
sys.stdout.write("running\n")
4862
sys.stdin.readline()
4865
class cmd_serve(Command):
4866
"""Run the bzr server."""
4868
aliases = ['server']
4872
help='Serve on stdin/out for use from inetd or sshd.'),
4873
RegistryOption('protocol',
4874
help="Protocol to serve.",
4875
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4876
value_switches=True),
4878
help='Listen for connections on nominated port of the form '
4879
'[hostname:]portnumber. Passing 0 as the port number will '
4880
'result in a dynamically allocated port. The default port '
4881
'depends on the protocol.',
4884
help='Serve contents of this directory.',
4886
Option('allow-writes',
4887
help='By default the server is a readonly server. Supplying '
4888
'--allow-writes enables write access to the contents of '
4889
'the served directory and below. Note that ``bzr serve`` '
4890
'does not perform authentication, so unless some form of '
4891
'external authentication is arranged supplying this '
4892
'option leads to global uncontrolled write access to your '
4897
def get_host_and_port(self, port):
4898
"""Return the host and port to run the smart server on.
4900
If 'port' is None, None will be returned for the host and port.
4902
If 'port' has a colon in it, the string before the colon will be
4903
interpreted as the host.
4905
:param port: A string of the port to run the server on.
4906
:return: A tuple of (host, port), where 'host' is a host name or IP,
4907
and port is an integer TCP/IP port.
4910
if port is not None:
4912
host, port = port.split(':')
4916
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4918
from bzrlib.transport import get_transport, transport_server_registry
4919
if directory is None:
4920
directory = os.getcwd()
4921
if protocol is None:
4922
protocol = transport_server_registry.get()
4923
host, port = self.get_host_and_port(port)
4924
url = urlutils.local_path_to_url(directory)
4925
if not allow_writes:
4926
url = 'readonly+' + url
4927
transport = get_transport(url)
4928
protocol(transport, host, port, inet)
4931
class cmd_join(Command):
4932
"""Combine a tree into its containing tree.
4934
This command requires the target tree to be in a rich-root format.
4936
The TREE argument should be an independent tree, inside another tree, but
4937
not part of it. (Such trees can be produced by "bzr split", but also by
4938
running "bzr branch" with the target inside a tree.)
4940
The result is a combined tree, with the subtree no longer an independant
4941
part. This is marked as a merge of the subtree into the containing tree,
4942
and all history is preserved.
4945
_see_also = ['split']
4946
takes_args = ['tree']
4948
Option('reference', help='Join by reference.', hidden=True),
4951
def run(self, tree, reference=False):
4952
sub_tree = WorkingTree.open(tree)
4953
parent_dir = osutils.dirname(sub_tree.basedir)
4954
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4955
repo = containing_tree.branch.repository
4956
if not repo.supports_rich_root():
4957
raise errors.BzrCommandError(
4958
"Can't join trees because %s doesn't support rich root data.\n"
4959
"You can use bzr upgrade on the repository."
4963
containing_tree.add_reference(sub_tree)
4964
except errors.BadReferenceTarget, e:
4965
# XXX: Would be better to just raise a nicely printable
4966
# exception from the real origin. Also below. mbp 20070306
4967
raise errors.BzrCommandError("Cannot join %s. %s" %
4971
containing_tree.subsume(sub_tree)
4972
except errors.BadSubsumeSource, e:
4973
raise errors.BzrCommandError("Cannot join %s. %s" %
4977
class cmd_split(Command):
4978
"""Split a subdirectory of a tree into a separate tree.
4980
This command will produce a target tree in a format that supports
4981
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4982
converted into earlier formats like 'dirstate-tags'.
4984
The TREE argument should be a subdirectory of a working tree. That
4985
subdirectory will be converted into an independent tree, with its own
4986
branch. Commits in the top-level tree will not apply to the new subtree.
4989
_see_also = ['join']
4990
takes_args = ['tree']
4992
def run(self, tree):
4993
containing_tree, subdir = WorkingTree.open_containing(tree)
4994
sub_id = containing_tree.path2id(subdir)
4996
raise errors.NotVersionedError(subdir)
4998
containing_tree.extract(sub_id)
4999
except errors.RootNotRich:
5000
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5003
class cmd_merge_directive(Command):
5004
"""Generate a merge directive for auto-merge tools.
5006
A directive requests a merge to be performed, and also provides all the
5007
information necessary to do so. This means it must either include a
5008
revision bundle, or the location of a branch containing the desired
5011
A submit branch (the location to merge into) must be supplied the first
5012
time the command is issued. After it has been supplied once, it will
5013
be remembered as the default.
5015
A public branch is optional if a revision bundle is supplied, but required
5016
if --diff or --plain is specified. It will be remembered as the default
5017
after the first use.
5020
takes_args = ['submit_branch?', 'public_branch?']
5024
_see_also = ['send']
5027
RegistryOption.from_kwargs('patch-type',
5028
'The type of patch to include in the directive.',
5030
value_switches=True,
5032
bundle='Bazaar revision bundle (default).',
5033
diff='Normal unified diff.',
5034
plain='No patch, just directive.'),
5035
Option('sign', help='GPG-sign the directive.'), 'revision',
5036
Option('mail-to', type=str,
5037
help='Instead of printing the directive, email to this address.'),
5038
Option('message', type=str, short_name='m',
5039
help='Message to use when committing this merge.')
5042
encoding_type = 'exact'
5044
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5045
sign=False, revision=None, mail_to=None, message=None):
5046
from bzrlib.revision import ensure_null, NULL_REVISION
5047
include_patch, include_bundle = {
5048
'plain': (False, False),
5049
'diff': (True, False),
5050
'bundle': (True, True),
5052
branch = Branch.open('.')
5053
stored_submit_branch = branch.get_submit_branch()
5054
if submit_branch is None:
5055
submit_branch = stored_submit_branch
5057
if stored_submit_branch is None:
5058
branch.set_submit_branch(submit_branch)
5059
if submit_branch is None:
5060
submit_branch = branch.get_parent()
5061
if submit_branch is None:
5062
raise errors.BzrCommandError('No submit branch specified or known')
5064
stored_public_branch = branch.get_public_branch()
5065
if public_branch is None:
5066
public_branch = stored_public_branch
5067
elif stored_public_branch is None:
5068
branch.set_public_branch(public_branch)
5069
if not include_bundle and public_branch is None:
5070
raise errors.BzrCommandError('No public branch specified or'
5072
base_revision_id = None
5073
if revision is not None:
5074
if len(revision) > 2:
5075
raise errors.BzrCommandError('bzr merge-directive takes '
5076
'at most two one revision identifiers')
5077
revision_id = revision[-1].as_revision_id(branch)
5078
if len(revision) == 2:
5079
base_revision_id = revision[0].as_revision_id(branch)
5081
revision_id = branch.last_revision()
5082
revision_id = ensure_null(revision_id)
5083
if revision_id == NULL_REVISION:
5084
raise errors.BzrCommandError('No revisions to bundle.')
5085
directive = merge_directive.MergeDirective2.from_objects(
5086
branch.repository, revision_id, time.time(),
5087
osutils.local_time_offset(), submit_branch,
5088
public_branch=public_branch, include_patch=include_patch,
5089
include_bundle=include_bundle, message=message,
5090
base_revision_id=base_revision_id)
5093
self.outf.write(directive.to_signed(branch))
5095
self.outf.writelines(directive.to_lines())
5097
message = directive.to_email(mail_to, branch, sign)
5098
s = SMTPConnection(branch.get_config())
5099
s.send_email(message)
5102
class cmd_send(Command):
5103
"""Mail or create a merge-directive for submitting changes.
5105
A merge directive provides many things needed for requesting merges:
5107
* A machine-readable description of the merge to perform
5109
* An optional patch that is a preview of the changes requested
5111
* An optional bundle of revision data, so that the changes can be applied
5112
directly from the merge directive, without retrieving data from a
5115
`bzr send` creates a compact data set that, when applied using bzr
5116
merge, has the same effect as merging from the source branch.
5118
By default the merge directive is self-contained and can be applied to any
5119
branch containing submit_branch in its ancestory without needing access to
5122
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5123
revisions, but only a structured request to merge from the
5124
public_location. In that case the public_branch is needed and it must be
5125
up-to-date and accessible to the recipient. The public_branch is always
5126
included if known, so that people can check it later.
5128
The submit branch defaults to the parent of the source branch, but can be
5129
overridden. Both submit branch and public branch will be remembered in
5130
branch.conf the first time they are used for a particular branch. The
5131
source branch defaults to that containing the working directory, but can
5132
be changed using --from.
5134
In order to calculate those changes, bzr must analyse the submit branch.
5135
Therefore it is most efficient for the submit branch to be a local mirror.
5136
If a public location is known for the submit_branch, that location is used
5137
in the merge directive.
5139
The default behaviour is to send the merge directive by mail, unless -o is
5140
given, in which case it is sent to a file.
5142
Mail is sent using your preferred mail program. This should be transparent
5143
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5144
If the preferred client can't be found (or used), your editor will be used.
5146
To use a specific mail program, set the mail_client configuration option.
5147
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5148
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5149
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5150
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5153
If mail is being sent, a to address is required. This can be supplied
5154
either on the commandline, by setting the submit_to configuration
5155
option in the branch itself or the child_submit_to configuration option
5156
in the submit branch.
5158
Two formats are currently supported: "4" uses revision bundle format 4 and
5159
merge directive format 2. It is significantly faster and smaller than
5160
older formats. It is compatible with Bazaar 0.19 and later. It is the
5161
default. "0.9" uses revision bundle format 0.9 and merge directive
5162
format 1. It is compatible with Bazaar 0.12 - 0.18.
5164
The merge directives created by bzr send may be applied using bzr merge or
5165
bzr pull by specifying a file containing a merge directive as the location.
5167
bzr send makes extensive use of public locations to map local locations into
5168
URLs that can be used by other people. See `bzr help configuration` to
5169
set them, and use `bzr info` to display them.
5172
encoding_type = 'exact'
5174
_see_also = ['merge', 'pull']
5176
takes_args = ['submit_branch?', 'public_branch?']
5180
help='Do not include a bundle in the merge directive.'),
5181
Option('no-patch', help='Do not include a preview patch in the merge'
5184
help='Remember submit and public branch.'),
5186
help='Branch to generate the submission from, '
5187
'rather than the one containing the working directory.',
5190
Option('output', short_name='o',
5191
help='Write merge directive to this file or directory; '
5192
'use - for stdout.',
5195
help='Refuse to send if there are uncommitted changes in'
5196
' the working tree, --no-strict disables the check.'),
5197
Option('mail-to', help='Mail the request to this address.',
5201
Option('body', help='Body for the email.', type=unicode),
5202
RegistryOption('format',
5203
help='Use the specified output format.',
5204
lazy_registry=('bzrlib.send', 'format_registry')),
5207
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5208
no_patch=False, revision=None, remember=False, output=None,
5209
format=None, mail_to=None, message=None, body=None,
5210
strict=None, **kwargs):
5211
from bzrlib.send import send
5212
return send(submit_branch, revision, public_branch, remember,
5213
format, no_bundle, no_patch, output,
5214
kwargs.get('from', '.'), mail_to, message, body,
5219
class cmd_bundle_revisions(cmd_send):
5220
"""Create a merge-directive for submitting changes.
5222
A merge directive provides many things needed for requesting merges:
5224
* A machine-readable description of the merge to perform
5226
* An optional patch that is a preview of the changes requested
5228
* An optional bundle of revision data, so that the changes can be applied
5229
directly from the merge directive, without retrieving data from a
5232
If --no-bundle is specified, then public_branch is needed (and must be
5233
up-to-date), so that the receiver can perform the merge using the
5234
public_branch. The public_branch is always included if known, so that
5235
people can check it later.
5237
The submit branch defaults to the parent, but can be overridden. Both
5238
submit branch and public branch will be remembered if supplied.
5240
If a public_branch is known for the submit_branch, that public submit
5241
branch is used in the merge instructions. This means that a local mirror
5242
can be used as your actual submit branch, once you have set public_branch
5245
Two formats are currently supported: "4" uses revision bundle format 4 and
5246
merge directive format 2. It is significantly faster and smaller than
5247
older formats. It is compatible with Bazaar 0.19 and later. It is the
5248
default. "0.9" uses revision bundle format 0.9 and merge directive
5249
format 1. It is compatible with Bazaar 0.12 - 0.18.
5254
help='Do not include a bundle in the merge directive.'),
5255
Option('no-patch', help='Do not include a preview patch in the merge'
5258
help='Remember submit and public branch.'),
5260
help='Branch to generate the submission from, '
5261
'rather than the one containing the working directory.',
5264
Option('output', short_name='o', help='Write directive to this file.',
5267
help='Refuse to bundle revisions if there are uncommitted'
5268
' changes in the working tree, --no-strict disables the check.'),
5270
RegistryOption('format',
5271
help='Use the specified output format.',
5272
lazy_registry=('bzrlib.send', 'format_registry')),
5274
aliases = ['bundle']
5276
_see_also = ['send', 'merge']
5280
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5281
no_patch=False, revision=None, remember=False, output=None,
5282
format=None, strict=None, **kwargs):
5285
from bzrlib.send import send
5286
return send(submit_branch, revision, public_branch, remember,
5287
format, no_bundle, no_patch, output,
5288
kwargs.get('from', '.'), None, None, None,
5289
self.outf, strict=strict)
5292
class cmd_tag(Command):
5293
"""Create, remove or modify a tag naming a revision.
5295
Tags give human-meaningful names to revisions. Commands that take a -r
5296
(--revision) option can be given -rtag:X, where X is any previously
5299
Tags are stored in the branch. Tags are copied from one branch to another
5300
along when you branch, push, pull or merge.
5302
It is an error to give a tag name that already exists unless you pass
5303
--force, in which case the tag is moved to point to the new revision.
5305
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5306
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5308
If no tag name is specified it will be determined through the
5309
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5310
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5314
_see_also = ['commit', 'tags']
5315
takes_args = ['tag_name?']
5318
help='Delete this tag rather than placing it.',
5321
help='Branch in which to place the tag.',
5326
help='Replace existing tags.',
5331
def run(self, tag_name=None,
5337
branch, relpath = Branch.open_containing(directory)
5339
self.add_cleanup(branch.unlock)
5341
if tag_name is None:
5342
raise errors.BzrCommandError("No tag specified to delete.")
5343
branch.tags.delete_tag(tag_name)
5344
self.outf.write('Deleted tag %s.\n' % tag_name)
5347
if len(revision) != 1:
5348
raise errors.BzrCommandError(
5349
"Tags can only be placed on a single revision, "
5351
revision_id = revision[0].as_revision_id(branch)
5353
revision_id = branch.last_revision()
5354
if tag_name is None:
5355
tag_name = branch.automatic_tag_name(revision_id)
5356
if tag_name is None:
5357
raise errors.BzrCommandError(
5358
"Please specify a tag name.")
5359
if (not force) and branch.tags.has_tag(tag_name):
5360
raise errors.TagAlreadyExists(tag_name)
5361
branch.tags.set_tag(tag_name, revision_id)
5362
self.outf.write('Created tag %s.\n' % tag_name)
5365
class cmd_tags(Command):
5368
This command shows a table of tag names and the revisions they reference.
5374
help='Branch whose tags should be displayed.',
5378
RegistryOption.from_kwargs('sort',
5379
'Sort tags by different criteria.', title='Sorting',
5380
alpha='Sort tags lexicographically (default).',
5381
time='Sort tags chronologically.',
5394
branch, relpath = Branch.open_containing(directory)
5396
tags = branch.tags.get_tag_dict().items()
5401
self.add_cleanup(branch.unlock)
5403
graph = branch.repository.get_graph()
5404
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5405
revid1, revid2 = rev1.rev_id, rev2.rev_id
5406
# only show revisions between revid1 and revid2 (inclusive)
5407
tags = [(tag, revid) for tag, revid in tags if
5408
graph.is_between(revid, revid1, revid2)]
5411
elif sort == 'time':
5413
for tag, revid in tags:
5415
revobj = branch.repository.get_revision(revid)
5416
except errors.NoSuchRevision:
5417
timestamp = sys.maxint # place them at the end
5419
timestamp = revobj.timestamp
5420
timestamps[revid] = timestamp
5421
tags.sort(key=lambda x: timestamps[x[1]])
5423
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5424
for index, (tag, revid) in enumerate(tags):
5426
revno = branch.revision_id_to_dotted_revno(revid)
5427
if isinstance(revno, tuple):
5428
revno = '.'.join(map(str, revno))
5429
except errors.NoSuchRevision:
5430
# Bad tag data/merges can lead to tagged revisions
5431
# which are not in this branch. Fail gracefully ...
5433
tags[index] = (tag, revno)
5435
for tag, revspec in tags:
5436
self.outf.write('%-20s %s\n' % (tag, revspec))
5439
class cmd_reconfigure(Command):
5440
"""Reconfigure the type of a bzr directory.
5442
A target configuration must be specified.
5444
For checkouts, the bind-to location will be auto-detected if not specified.
5445
The order of preference is
5446
1. For a lightweight checkout, the current bound location.
5447
2. For branches that used to be checkouts, the previously-bound location.
5448
3. The push location.
5449
4. The parent location.
5450
If none of these is available, --bind-to must be specified.
5453
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5454
takes_args = ['location?']
5456
RegistryOption.from_kwargs(
5458
title='Target type',
5459
help='The type to reconfigure the directory to.',
5460
value_switches=True, enum_switch=False,
5461
branch='Reconfigure to be an unbound branch with no working tree.',
5462
tree='Reconfigure to be an unbound branch with a working tree.',
5463
checkout='Reconfigure to be a bound branch with a working tree.',
5464
lightweight_checkout='Reconfigure to be a lightweight'
5465
' checkout (with no local history).',
5466
standalone='Reconfigure to be a standalone branch '
5467
'(i.e. stop using shared repository).',
5468
use_shared='Reconfigure to use a shared repository.',
5469
with_trees='Reconfigure repository to create '
5470
'working trees on branches by default.',
5471
with_no_trees='Reconfigure repository to not create '
5472
'working trees on branches by default.'
5474
Option('bind-to', help='Branch to bind checkout to.', type=str),
5476
help='Perform reconfiguration even if local changes'
5478
Option('stacked-on',
5479
help='Reconfigure a branch to be stacked on another branch.',
5483
help='Reconfigure a branch to be unstacked. This '
5484
'may require copying substantial data into it.',
5488
def run(self, location=None, target_type=None, bind_to=None, force=False,
5491
directory = bzrdir.BzrDir.open(location)
5492
if stacked_on and unstacked:
5493
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5494
elif stacked_on is not None:
5495
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5497
reconfigure.ReconfigureUnstacked().apply(directory)
5498
# At the moment you can use --stacked-on and a different
5499
# reconfiguration shape at the same time; there seems no good reason
5501
if target_type is None:
5502
if stacked_on or unstacked:
5505
raise errors.BzrCommandError('No target configuration '
5507
elif target_type == 'branch':
5508
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5509
elif target_type == 'tree':
5510
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5511
elif target_type == 'checkout':
5512
reconfiguration = reconfigure.Reconfigure.to_checkout(
5514
elif target_type == 'lightweight-checkout':
5515
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5517
elif target_type == 'use-shared':
5518
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5519
elif target_type == 'standalone':
5520
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5521
elif target_type == 'with-trees':
5522
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5524
elif target_type == 'with-no-trees':
5525
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5527
reconfiguration.apply(force)
5530
class cmd_switch(Command):
5531
"""Set the branch of a checkout and update.
5533
For lightweight checkouts, this changes the branch being referenced.
5534
For heavyweight checkouts, this checks that there are no local commits
5535
versus the current bound branch, then it makes the local branch a mirror
5536
of the new location and binds to it.
5538
In both cases, the working tree is updated and uncommitted changes
5539
are merged. The user can commit or revert these as they desire.
5541
Pending merges need to be committed or reverted before using switch.
5543
The path to the branch to switch to can be specified relative to the parent
5544
directory of the current branch. For example, if you are currently in a
5545
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5548
Bound branches use the nickname of its master branch unless it is set
5549
locally, in which case switching will update the local nickname to be
5553
takes_args = ['to_location?']
5554
takes_options = [Option('force',
5555
help='Switch even if local commits will be lost.'),
5557
Option('create-branch', short_name='b',
5558
help='Create the target branch from this one before'
5559
' switching to it.'),
5562
def run(self, to_location=None, force=False, create_branch=False,
5564
from bzrlib import switch
5566
revision = _get_one_revision('switch', revision)
5567
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5568
if to_location is None:
5569
if revision is None:
5570
raise errors.BzrCommandError('You must supply either a'
5571
' revision or a location')
5574
branch = control_dir.open_branch()
5575
had_explicit_nick = branch.get_config().has_explicit_nickname()
5576
except errors.NotBranchError:
5578
had_explicit_nick = False
5581
raise errors.BzrCommandError('cannot create branch without'
5583
to_location = directory_service.directories.dereference(
5585
if '/' not in to_location and '\\' not in to_location:
5586
# This path is meant to be relative to the existing branch
5587
this_url = self._get_branch_location(control_dir)
5588
to_location = urlutils.join(this_url, '..', to_location)
5589
to_branch = branch.bzrdir.sprout(to_location,
5590
possible_transports=[branch.bzrdir.root_transport],
5591
source_branch=branch).open_branch()
5594
to_branch = Branch.open(to_location)
5595
except errors.NotBranchError:
5596
this_url = self._get_branch_location(control_dir)
5597
to_branch = Branch.open(
5598
urlutils.join(this_url, '..', to_location))
5599
if revision is not None:
5600
revision = revision.as_revision_id(to_branch)
5601
switch.switch(control_dir, to_branch, force, revision_id=revision)
5602
if had_explicit_nick:
5603
branch = control_dir.open_branch() #get the new branch!
5604
branch.nick = to_branch.nick
5605
note('Switched to branch: %s',
5606
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5608
def _get_branch_location(self, control_dir):
5609
"""Return location of branch for this control dir."""
5611
this_branch = control_dir.open_branch()
5612
# This may be a heavy checkout, where we want the master branch
5613
master_location = this_branch.get_bound_location()
5614
if master_location is not None:
5615
return master_location
5616
# If not, use a local sibling
5617
return this_branch.base
5618
except errors.NotBranchError:
5619
format = control_dir.find_branch_format()
5620
if getattr(format, 'get_reference', None) is not None:
5621
return format.get_reference(control_dir)
5623
return control_dir.root_transport.base
5626
class cmd_view(Command):
5627
"""Manage filtered views.
5629
Views provide a mask over the tree so that users can focus on
5630
a subset of a tree when doing their work. After creating a view,
5631
commands that support a list of files - status, diff, commit, etc -
5632
effectively have that list of files implicitly given each time.
5633
An explicit list of files can still be given but those files
5634
must be within the current view.
5636
In most cases, a view has a short life-span: it is created to make
5637
a selected change and is deleted once that change is committed.
5638
At other times, you may wish to create one or more named views
5639
and switch between them.
5641
To disable the current view without deleting it, you can switch to
5642
the pseudo view called ``off``. This can be useful when you need
5643
to see the whole tree for an operation or two (e.g. merge) but
5644
want to switch back to your view after that.
5647
To define the current view::
5649
bzr view file1 dir1 ...
5651
To list the current view::
5655
To delete the current view::
5659
To disable the current view without deleting it::
5661
bzr view --switch off
5663
To define a named view and switch to it::
5665
bzr view --name view-name file1 dir1 ...
5667
To list a named view::
5669
bzr view --name view-name
5671
To delete a named view::
5673
bzr view --name view-name --delete
5675
To switch to a named view::
5677
bzr view --switch view-name
5679
To list all views defined::
5683
To delete all views::
5685
bzr view --delete --all
5689
takes_args = ['file*']
5692
help='Apply list or delete action to all views.',
5695
help='Delete the view.',
5698
help='Name of the view to define, list or delete.',
5702
help='Name of the view to switch to.',
5707
def run(self, file_list,
5713
tree, file_list = tree_files(file_list, apply_view=False)
5714
current_view, view_dict = tree.views.get_view_info()
5719
raise errors.BzrCommandError(
5720
"Both --delete and a file list specified")
5722
raise errors.BzrCommandError(
5723
"Both --delete and --switch specified")
5725
tree.views.set_view_info(None, {})
5726
self.outf.write("Deleted all views.\n")
5728
raise errors.BzrCommandError("No current view to delete")
5730
tree.views.delete_view(name)
5731
self.outf.write("Deleted '%s' view.\n" % name)
5734
raise errors.BzrCommandError(
5735
"Both --switch and a file list specified")
5737
raise errors.BzrCommandError(
5738
"Both --switch and --all specified")
5739
elif switch == 'off':
5740
if current_view is None:
5741
raise errors.BzrCommandError("No current view to disable")
5742
tree.views.set_view_info(None, view_dict)
5743
self.outf.write("Disabled '%s' view.\n" % (current_view))
5745
tree.views.set_view_info(switch, view_dict)
5746
view_str = views.view_display_str(tree.views.lookup_view())
5747
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5750
self.outf.write('Views defined:\n')
5751
for view in sorted(view_dict):
5752
if view == current_view:
5756
view_str = views.view_display_str(view_dict[view])
5757
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5759
self.outf.write('No views defined.\n')
5762
# No name given and no current view set
5765
raise errors.BzrCommandError(
5766
"Cannot change the 'off' pseudo view")
5767
tree.views.set_view(name, sorted(file_list))
5768
view_str = views.view_display_str(tree.views.lookup_view())
5769
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5773
# No name given and no current view set
5774
self.outf.write('No current view.\n')
5776
view_str = views.view_display_str(tree.views.lookup_view(name))
5777
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5780
class cmd_hooks(Command):
5786
for hook_key in sorted(hooks.known_hooks.keys()):
5787
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5788
self.outf.write("%s:\n" % type(some_hooks).__name__)
5789
for hook_name, hook_point in sorted(some_hooks.items()):
5790
self.outf.write(" %s:\n" % (hook_name,))
5791
found_hooks = list(hook_point)
5793
for hook in found_hooks:
5794
self.outf.write(" %s\n" %
5795
(some_hooks.get_hook_name(hook),))
5797
self.outf.write(" <no hooks installed>\n")
5800
class cmd_remove_branch(Command):
5803
This will remove the branch from the specified location but
5804
will keep any working tree or repository in place.
5808
Remove the branch at repo/trunk::
5810
bzr remove-branch repo/trunk
5814
takes_args = ["location?"]
5816
aliases = ["rmbranch"]
5818
def run(self, location=None):
5819
if location is None:
5821
branch = Branch.open_containing(location)[0]
5822
branch.bzrdir.destroy_branch()
5825
class cmd_shelve(Command):
5826
"""Temporarily set aside some changes from the current tree.
5828
Shelve allows you to temporarily put changes you've made "on the shelf",
5829
ie. out of the way, until a later time when you can bring them back from
5830
the shelf with the 'unshelve' command. The changes are stored alongside
5831
your working tree, and so they aren't propagated along with your branch nor
5832
will they survive its deletion.
5834
If shelve --list is specified, previously-shelved changes are listed.
5836
Shelve is intended to help separate several sets of changes that have
5837
been inappropriately mingled. If you just want to get rid of all changes
5838
and you don't need to restore them later, use revert. If you want to
5839
shelve all text changes at once, use shelve --all.
5841
If filenames are specified, only the changes to those files will be
5842
shelved. Other files will be left untouched.
5844
If a revision is specified, changes since that revision will be shelved.
5846
You can put multiple items on the shelf, and by default, 'unshelve' will
5847
restore the most recently shelved changes.
5850
takes_args = ['file*']
5854
Option('all', help='Shelve all changes.'),
5856
RegistryOption('writer', 'Method to use for writing diffs.',
5857
bzrlib.option.diff_writer_registry,
5858
value_switches=True, enum_switch=False),
5860
Option('list', help='List shelved changes.'),
5862
help='Destroy removed changes instead of shelving them.'),
5864
_see_also = ['unshelve']
5866
def run(self, revision=None, all=False, file_list=None, message=None,
5867
writer=None, list=False, destroy=False):
5869
return self.run_for_list()
5870
from bzrlib.shelf_ui import Shelver
5872
writer = bzrlib.option.diff_writer_registry.get()
5874
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5875
file_list, message, destroy=destroy)
5880
except errors.UserAbort:
5883
def run_for_list(self):
5884
tree = WorkingTree.open_containing('.')[0]
5886
self.add_cleanup(tree.unlock)
5887
manager = tree.get_shelf_manager()
5888
shelves = manager.active_shelves()
5889
if len(shelves) == 0:
5890
note('No shelved changes.')
5892
for shelf_id in reversed(shelves):
5893
message = manager.get_metadata(shelf_id).get('message')
5895
message = '<no message>'
5896
self.outf.write('%3d: %s\n' % (shelf_id, message))
5900
class cmd_unshelve(Command):
5901
"""Restore shelved changes.
5903
By default, the most recently shelved changes are restored. However if you
5904
specify a shelf by id those changes will be restored instead. This works
5905
best when the changes don't depend on each other.
5908
takes_args = ['shelf_id?']
5910
RegistryOption.from_kwargs(
5911
'action', help="The action to perform.",
5912
enum_switch=False, value_switches=True,
5913
apply="Apply changes and remove from the shelf.",
5914
dry_run="Show changes, but do not apply or remove them.",
5915
preview="Instead of unshelving the changes, show the diff that "
5916
"would result from unshelving.",
5917
delete_only="Delete changes without applying them.",
5918
keep="Apply changes but don't delete them.",
5921
_see_also = ['shelve']
5923
def run(self, shelf_id=None, action='apply'):
5924
from bzrlib.shelf_ui import Unshelver
5925
unshelver = Unshelver.from_args(shelf_id, action)
5929
unshelver.tree.unlock()
5932
class cmd_clean_tree(Command):
5933
"""Remove unwanted files from working tree.
5935
By default, only unknown files, not ignored files, are deleted. Versioned
5936
files are never deleted.
5938
Another class is 'detritus', which includes files emitted by bzr during
5939
normal operations and selftests. (The value of these files decreases with
5942
If no options are specified, unknown files are deleted. Otherwise, option
5943
flags are respected, and may be combined.
5945
To check what clean-tree will do, use --dry-run.
5947
takes_options = [Option('ignored', help='Delete all ignored files.'),
5948
Option('detritus', help='Delete conflict files, merge'
5949
' backups, and failed selftest dirs.'),
5951
help='Delete files unknown to bzr (default).'),
5952
Option('dry-run', help='Show files to delete instead of'
5954
Option('force', help='Do not prompt before deleting.')]
5955
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5957
from bzrlib.clean_tree import clean_tree
5958
if not (unknown or ignored or detritus):
5962
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5963
dry_run=dry_run, no_prompt=force)
5966
class cmd_reference(Command):
5967
"""list, view and set branch locations for nested trees.
5969
If no arguments are provided, lists the branch locations for nested trees.
5970
If one argument is provided, display the branch location for that tree.
5971
If two arguments are provided, set the branch location for that tree.
5976
takes_args = ['path?', 'location?']
5978
def run(self, path=None, location=None):
5980
if path is not None:
5982
tree, branch, relpath =(
5983
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5984
if path is not None:
5987
tree = branch.basis_tree()
5989
info = branch._get_all_reference_info().iteritems()
5990
self._display_reference_info(tree, branch, info)
5992
file_id = tree.path2id(path)
5994
raise errors.NotVersionedError(path)
5995
if location is None:
5996
info = [(file_id, branch.get_reference_info(file_id))]
5997
self._display_reference_info(tree, branch, info)
5999
branch.set_reference_info(file_id, path, location)
6001
def _display_reference_info(self, tree, branch, info):
6003
for file_id, (path, location) in info:
6005
path = tree.id2path(file_id)
6006
except errors.NoSuchId:
6008
ref_list.append((path, location))
6009
for path, location in sorted(ref_list):
6010
self.outf.write('%s %s\n' % (path, location))
6013
def _register_lazy_builtins():
6014
# register lazy builtins from other modules; called at startup and should
6015
# be only called once.
6016
for (name, aliases, module_name) in [
6017
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6018
('cmd_dpush', [], 'bzrlib.foreign'),
6019
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6020
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6021
('cmd_conflicts', [], 'bzrlib.conflicts'),
6022
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6024
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
