1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import (
71
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
74
def tree_files(file_list, default_branch=u'.', canonicalize=True,
77
return internal_tree_files(file_list, default_branch, canonicalize,
79
except errors.FileInWrongBranch, e:
80
raise errors.BzrCommandError("%s is not in the same branch as %s" %
81
(e.path, file_list[0]))
84
def tree_files_for_add(file_list):
86
Return a tree and list of absolute paths from a file list.
88
Similar to tree_files, but add handles files a bit differently, so it a
89
custom implementation. In particular, MutableTreeTree.smart_add expects
90
absolute paths, which it immediately converts to relative paths.
92
# FIXME Would be nice to just return the relative paths like
93
# internal_tree_files does, but there are a large number of unit tests
94
# that assume the current interface to mutabletree.smart_add
96
tree, relpath = WorkingTree.open_containing(file_list[0])
97
if tree.supports_views():
98
view_files = tree.views.lookup_view()
100
for filename in file_list:
101
if not osutils.is_inside_any(view_files, filename):
102
raise errors.FileOutsideView(filename, view_files)
103
file_list = file_list[:]
104
file_list[0] = tree.abspath(relpath)
106
tree = WorkingTree.open_containing(u'.')[0]
107
if tree.supports_views():
108
view_files = tree.views.lookup_view()
110
file_list = view_files
111
view_str = views.view_display_str(view_files)
112
note("Ignoring files outside view. View is %s" % view_str)
113
return tree, file_list
116
def _get_one_revision(command_name, revisions):
117
if revisions is None:
119
if len(revisions) != 1:
120
raise errors.BzrCommandError(
121
'bzr %s --revision takes exactly one revision identifier' % (
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
127
"""Get a revision tree. Not suitable for commands that change the tree.
129
Specifically, the basis tree in dirstate trees is coupled to the dirstate
130
and doing a commit/uncommit/pull will at best fail due to changing the
133
If tree is passed in, it should be already locked, for lifetime management
134
of the trees internal cached state.
138
if revisions is None:
140
rev_tree = tree.basis_tree()
142
rev_tree = branch.basis_tree()
144
revision = _get_one_revision(command_name, revisions)
145
rev_tree = revision.as_tree(branch)
149
# XXX: Bad function name; should possibly also be a class method of
150
# WorkingTree rather than a function.
151
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
"""Convert command-line paths to a WorkingTree and relative paths.
155
This is typically used for command-line processors that take one or
156
more filenames, and infer the workingtree that contains them.
158
The filenames given are not required to exist.
160
:param file_list: Filenames to convert.
162
:param default_branch: Fallback tree path to use if file_list is empty or
165
:param apply_view: if True and a view is set, apply it or check that
166
specified files are within it
168
:return: workingtree, [relative_paths]
170
if file_list is None or len(file_list) == 0:
171
tree = WorkingTree.open_containing(default_branch)[0]
172
if tree.supports_views() and apply_view:
173
view_files = tree.views.lookup_view()
175
file_list = view_files
176
view_str = views.view_display_str(view_files)
177
note("Ignoring files outside view. View is %s" % view_str)
178
return tree, file_list
179
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
180
return tree, safe_relpath_files(tree, file_list, canonicalize,
181
apply_view=apply_view)
184
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
185
"""Convert file_list into a list of relpaths in tree.
187
:param tree: A tree to operate on.
188
:param file_list: A list of user provided paths or None.
189
:param apply_view: if True and a view is set, apply it or check that
190
specified files are within it
191
:return: A list of relative paths.
192
:raises errors.PathNotChild: When a provided path is in a different tree
195
if file_list is None:
197
if tree.supports_views() and apply_view:
198
view_files = tree.views.lookup_view()
202
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
203
# doesn't - fix that up here before we enter the loop.
205
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
208
for filename in file_list:
210
relpath = fixer(osutils.dereference_path(filename))
211
if view_files and not osutils.is_inside_any(view_files, relpath):
212
raise errors.FileOutsideView(filename, view_files)
213
new_list.append(relpath)
214
except errors.PathNotChild:
215
raise errors.FileInWrongBranch(tree.branch, filename)
219
def _get_view_info_for_change_reporter(tree):
220
"""Get the view information from a tree for change reporting."""
223
current_view = tree.views.get_view_info()[0]
224
if current_view is not None:
225
view_info = (current_view, tree.views.lookup_view())
226
except errors.ViewsNotSupported:
231
# TODO: Make sure no commands unconditionally use the working directory as a
232
# branch. If a filename argument is used, the first of them should be used to
233
# specify the branch. (Perhaps this can be factored out into some kind of
234
# Argument class, representing a file in a branch, where the first occurrence
237
class cmd_status(Command):
238
"""Display status summary.
240
This reports on versioned and unknown files, reporting them
241
grouped by state. Possible states are:
244
Versioned in the working copy but not in the previous revision.
247
Versioned in the previous revision but removed or deleted
251
Path of this file changed from the previous revision;
252
the text may also have changed. This includes files whose
253
parent directory was renamed.
256
Text has changed since the previous revision.
259
File kind has been changed (e.g. from file to directory).
262
Not versioned and not matching an ignore pattern.
264
Additionally for directories, symlinks and files with an executable
265
bit, Bazaar indicates their type using a trailing character: '/', '@'
268
To see ignored files use 'bzr ignored'. For details on the
269
changes to file texts, use 'bzr diff'.
271
Note that --short or -S gives status flags for each item, similar
272
to Subversion's status command. To get output similar to svn -q,
275
If no arguments are specified, the status of the entire working
276
directory is shown. Otherwise, only the status of the specified
277
files or directories is reported. If a directory is given, status
278
is reported for everything inside that directory.
280
Before merges are committed, the pending merge tip revisions are
281
shown. To see all pending merge revisions, use the -v option.
282
To skip the display of pending merge information altogether, use
283
the no-pending option or specify a file/directory.
285
If a revision argument is given, the status is calculated against
286
that revision, or between two revisions if two are provided.
289
# TODO: --no-recurse, --recurse options
291
takes_args = ['file*']
292
takes_options = ['show-ids', 'revision', 'change', 'verbose',
293
Option('short', help='Use short status indicators.',
295
Option('versioned', help='Only show versioned files.',
297
Option('no-pending', help='Don\'t show pending merges.',
300
aliases = ['st', 'stat']
302
encoding_type = 'replace'
303
_see_also = ['diff', 'revert', 'status-flags']
306
def run(self, show_ids=False, file_list=None, revision=None, short=False,
307
versioned=False, no_pending=False, verbose=False):
308
from bzrlib.status import show_tree_status
310
if revision and len(revision) > 2:
311
raise errors.BzrCommandError('bzr status --revision takes exactly'
312
' one or two revision specifiers')
314
tree, relfile_list = tree_files(file_list)
315
# Avoid asking for specific files when that is not needed.
316
if relfile_list == ['']:
318
# Don't disable pending merges for full trees other than '.'.
319
if file_list == ['.']:
321
# A specific path within a tree was given.
322
elif relfile_list is not None:
324
show_tree_status(tree, show_ids=show_ids,
325
specific_files=relfile_list, revision=revision,
326
to_file=self.outf, short=short, versioned=versioned,
327
show_pending=(not no_pending), verbose=verbose)
330
class cmd_cat_revision(Command):
331
"""Write out metadata for a revision.
333
The revision to print can either be specified by a specific
334
revision identifier, or you can use --revision.
338
takes_args = ['revision_id?']
339
takes_options = ['revision']
340
# cat-revision is more for frontends so should be exact
343
def print_revision(self, revisions, revid):
344
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
345
record = stream.next()
346
if record.storage_kind == 'absent':
347
raise errors.NoSuchRevision(revisions, revid)
348
revtext = record.get_bytes_as('fulltext')
349
self.outf.write(revtext.decode('utf-8'))
352
def run(self, revision_id=None, revision=None):
353
if revision_id is not None and revision is not None:
354
raise errors.BzrCommandError('You can only supply one of'
355
' revision_id or --revision')
356
if revision_id is None and revision is None:
357
raise errors.BzrCommandError('You must supply either'
358
' --revision or a revision_id')
359
b = WorkingTree.open_containing(u'.')[0].branch
361
revisions = b.repository.revisions
362
if revisions is None:
363
raise errors.BzrCommandError('Repository %r does not support '
364
'access to raw revision texts')
366
b.repository.lock_read()
368
# TODO: jam 20060112 should cat-revision always output utf-8?
369
if revision_id is not None:
370
revision_id = osutils.safe_revision_id(revision_id, warn=False)
372
self.print_revision(revisions, revision_id)
373
except errors.NoSuchRevision:
374
msg = "The repository %s contains no revision %s." % (
375
b.repository.base, revision_id)
376
raise errors.BzrCommandError(msg)
377
elif revision is not None:
380
raise errors.BzrCommandError(
381
'You cannot specify a NULL revision.')
382
rev_id = rev.as_revision_id(b)
383
self.print_revision(revisions, rev_id)
385
b.repository.unlock()
388
class cmd_dump_btree(Command):
389
"""Dump the contents of a btree index file to stdout.
391
PATH is a btree index file, it can be any URL. This includes things like
392
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
394
By default, the tuples stored in the index file will be displayed. With
395
--raw, we will uncompress the pages, but otherwise display the raw bytes
399
# TODO: Do we want to dump the internal nodes as well?
400
# TODO: It would be nice to be able to dump the un-parsed information,
401
# rather than only going through iter_all_entries. However, this is
402
# good enough for a start
404
encoding_type = 'exact'
405
takes_args = ['path']
406
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
407
' rather than the parsed tuples.'),
410
def run(self, path, raw=False):
411
dirname, basename = osutils.split(path)
412
t = transport.get_transport(dirname)
414
self._dump_raw_bytes(t, basename)
416
self._dump_entries(t, basename)
418
def _get_index_and_bytes(self, trans, basename):
419
"""Create a BTreeGraphIndex and raw bytes."""
420
bt = btree_index.BTreeGraphIndex(trans, basename, None)
421
bytes = trans.get_bytes(basename)
422
bt._file = cStringIO.StringIO(bytes)
423
bt._size = len(bytes)
426
def _dump_raw_bytes(self, trans, basename):
429
# We need to parse at least the root node.
430
# This is because the first page of every row starts with an
431
# uncompressed header.
432
bt, bytes = self._get_index_and_bytes(trans, basename)
433
for page_idx, page_start in enumerate(xrange(0, len(bytes),
434
btree_index._PAGE_SIZE)):
435
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
436
page_bytes = bytes[page_start:page_end]
438
self.outf.write('Root node:\n')
439
header_end, data = bt._parse_header_from_bytes(page_bytes)
440
self.outf.write(page_bytes[:header_end])
442
self.outf.write('\nPage %d\n' % (page_idx,))
443
decomp_bytes = zlib.decompress(page_bytes)
444
self.outf.write(decomp_bytes)
445
self.outf.write('\n')
447
def _dump_entries(self, trans, basename):
449
st = trans.stat(basename)
450
except errors.TransportNotPossible:
451
# We can't stat, so we'll fake it because we have to do the 'get()'
453
bt, _ = self._get_index_and_bytes(trans, basename)
455
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
456
for node in bt.iter_all_entries():
457
# Node is made up of:
458
# (index, key, value, [references])
459
refs_as_tuples = static_tuple.as_tuples(node[3])
460
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
461
self.outf.write('%s\n' % (as_tuple,))
464
class cmd_remove_tree(Command):
465
"""Remove the working tree from a given branch/checkout.
467
Since a lightweight checkout is little more than a working tree
468
this will refuse to run against one.
470
To re-create the working tree, use "bzr checkout".
472
_see_also = ['checkout', 'working-trees']
473
takes_args = ['location*']
476
help='Remove the working tree even if it has '
477
'uncommitted changes.'),
480
def run(self, location_list, force=False):
481
if not location_list:
484
for location in location_list:
485
d = bzrdir.BzrDir.open(location)
488
working = d.open_workingtree()
489
except errors.NoWorkingTree:
490
raise errors.BzrCommandError("No working tree to remove")
491
except errors.NotLocalUrl:
492
raise errors.BzrCommandError("You cannot remove the working tree"
495
if (working.has_changes()):
496
raise errors.UncommittedChanges(working)
498
working_path = working.bzrdir.root_transport.base
499
branch_path = working.branch.bzrdir.root_transport.base
500
if working_path != branch_path:
501
raise errors.BzrCommandError("You cannot remove the working tree"
502
" from a lightweight checkout")
504
d.destroy_workingtree()
507
class cmd_revno(Command):
508
"""Show current revision number.
510
This is equal to the number of revisions on this branch.
514
takes_args = ['location?']
516
Option('tree', help='Show revno of working tree'),
520
def run(self, tree=False, location=u'.'):
523
wt = WorkingTree.open_containing(location)[0]
525
except (errors.NoWorkingTree, errors.NotLocalUrl):
526
raise errors.NoWorkingTree(location)
527
self.add_cleanup(wt.unlock)
528
revid = wt.last_revision()
530
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
531
except errors.NoSuchRevision:
533
revno = ".".join(str(n) for n in revno_t)
535
b = Branch.open_containing(location)[0]
537
self.add_cleanup(b.unlock)
540
self.outf.write(str(revno) + '\n')
543
class cmd_revision_info(Command):
544
"""Show revision number and revision id for a given revision identifier.
547
takes_args = ['revision_info*']
551
help='Branch to examine, '
552
'rather than the one containing the working directory.',
556
Option('tree', help='Show revno of working tree'),
560
def run(self, revision=None, directory=u'.', tree=False,
561
revision_info_list=[]):
564
wt = WorkingTree.open_containing(directory)[0]
567
self.add_cleanup(wt.unlock)
568
except (errors.NoWorkingTree, errors.NotLocalUrl):
570
b = Branch.open_containing(directory)[0]
572
self.add_cleanup(b.unlock)
574
if revision is not None:
575
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
576
if revision_info_list is not None:
577
for rev_str in revision_info_list:
578
rev_spec = RevisionSpec.from_string(rev_str)
579
revision_ids.append(rev_spec.as_revision_id(b))
580
# No arguments supplied, default to the last revision
581
if len(revision_ids) == 0:
584
raise errors.NoWorkingTree(directory)
585
revision_ids.append(wt.last_revision())
587
revision_ids.append(b.last_revision())
591
for revision_id in revision_ids:
593
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
594
revno = '.'.join(str(i) for i in dotted_revno)
595
except errors.NoSuchRevision:
597
maxlen = max(maxlen, len(revno))
598
revinfos.append([revno, revision_id])
602
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
605
class cmd_add(Command):
606
"""Add specified files or directories.
608
In non-recursive mode, all the named items are added, regardless
609
of whether they were previously ignored. A warning is given if
610
any of the named files are already versioned.
612
In recursive mode (the default), files are treated the same way
613
but the behaviour for directories is different. Directories that
614
are already versioned do not give a warning. All directories,
615
whether already versioned or not, are searched for files or
616
subdirectories that are neither versioned or ignored, and these
617
are added. This search proceeds recursively into versioned
618
directories. If no names are given '.' is assumed.
620
Therefore simply saying 'bzr add' will version all files that
621
are currently unknown.
623
Adding a file whose parent directory is not versioned will
624
implicitly add the parent, and so on up to the root. This means
625
you should never need to explicitly add a directory, they'll just
626
get added when you add a file in the directory.
628
--dry-run will show which files would be added, but not actually
631
--file-ids-from will try to use the file ids from the supplied path.
632
It looks up ids trying to find a matching parent directory with the
633
same filename, and then by pure path. This option is rarely needed
634
but can be useful when adding the same logical file into two
635
branches that will be merged later (without showing the two different
636
adds as a conflict). It is also useful when merging another project
637
into a subdirectory of this one.
639
Any files matching patterns in the ignore list will not be added
640
unless they are explicitly mentioned.
642
takes_args = ['file*']
645
help="Don't recursively add the contents of directories."),
647
help="Show what would be done, but don't actually do anything."),
649
Option('file-ids-from',
651
help='Lookup file ids from this tree.'),
653
encoding_type = 'replace'
654
_see_also = ['remove', 'ignore']
656
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
661
if file_ids_from is not None:
663
base_tree, base_path = WorkingTree.open_containing(
665
except errors.NoWorkingTree:
666
base_branch, base_path = Branch.open_containing(
668
base_tree = base_branch.basis_tree()
670
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
671
to_file=self.outf, should_print=(not is_quiet()))
673
action = bzrlib.add.AddAction(to_file=self.outf,
674
should_print=(not is_quiet()))
677
base_tree.lock_read()
678
self.add_cleanup(base_tree.unlock)
679
tree, file_list = tree_files_for_add(file_list)
680
added, ignored = tree.smart_add(file_list, not
681
no_recurse, action=action, save=not dry_run)
685
for glob in sorted(ignored.keys()):
686
for path in ignored[glob]:
687
self.outf.write("ignored %s matching \"%s\"\n"
691
class cmd_mkdir(Command):
692
"""Create a new versioned directory.
694
This is equivalent to creating the directory and then adding it.
697
takes_args = ['dir+']
698
encoding_type = 'replace'
700
def run(self, dir_list):
703
wt, dd = WorkingTree.open_containing(d)
705
self.outf.write('added %s\n' % d)
708
class cmd_relpath(Command):
709
"""Show path of a file relative to root"""
711
takes_args = ['filename']
715
def run(self, filename):
716
# TODO: jam 20050106 Can relpath return a munged path if
717
# sys.stdout encoding cannot represent it?
718
tree, relpath = WorkingTree.open_containing(filename)
719
self.outf.write(relpath)
720
self.outf.write('\n')
723
class cmd_inventory(Command):
724
"""Show inventory of the current working copy or a revision.
726
It is possible to limit the output to a particular entry
727
type using the --kind option. For example: --kind file.
729
It is also possible to restrict the list of files to a specific
730
set. For example: bzr inventory --show-ids this/file
739
help='List entries of a particular kind: file, directory, symlink.',
742
takes_args = ['file*']
745
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
746
if kind and kind not in ['file', 'directory', 'symlink']:
747
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
749
revision = _get_one_revision('inventory', revision)
750
work_tree, file_list = tree_files(file_list)
751
work_tree.lock_read()
752
self.add_cleanup(work_tree.unlock)
753
if revision is not None:
754
tree = revision.as_tree(work_tree.branch)
756
extra_trees = [work_tree]
758
self.add_cleanup(tree.unlock)
763
if file_list is not None:
764
file_ids = tree.paths2ids(file_list, trees=extra_trees,
765
require_versioned=True)
766
# find_ids_across_trees may include some paths that don't
768
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
769
for file_id in file_ids if file_id in tree)
771
entries = tree.inventory.entries()
774
for path, entry in entries:
775
if kind and kind != entry.kind:
778
self.outf.write('%-50s %s\n' % (path, entry.file_id))
780
self.outf.write(path)
781
self.outf.write('\n')
784
class cmd_mv(Command):
785
"""Move or rename a file.
788
bzr mv OLDNAME NEWNAME
790
bzr mv SOURCE... DESTINATION
792
If the last argument is a versioned directory, all the other names
793
are moved into it. Otherwise, there must be exactly two arguments
794
and the file is changed to a new name.
796
If OLDNAME does not exist on the filesystem but is versioned and
797
NEWNAME does exist on the filesystem but is not versioned, mv
798
assumes that the file has been manually moved and only updates
799
its internal inventory to reflect that change.
800
The same is valid when moving many SOURCE files to a DESTINATION.
802
Files cannot be moved between branches.
805
takes_args = ['names*']
806
takes_options = [Option("after", help="Move only the bzr identifier"
807
" of the file, because the file has already been moved."),
808
Option('auto', help='Automatically guess renames.'),
809
Option('dry-run', help='Avoid making changes when guessing renames.'),
811
aliases = ['move', 'rename']
812
encoding_type = 'replace'
814
def run(self, names_list, after=False, auto=False, dry_run=False):
816
return self.run_auto(names_list, after, dry_run)
818
raise errors.BzrCommandError('--dry-run requires --auto.')
819
if names_list is None:
821
if len(names_list) < 2:
822
raise errors.BzrCommandError("missing file argument")
823
tree, rel_names = tree_files(names_list, canonicalize=False)
824
tree.lock_tree_write()
825
self.add_cleanup(tree.unlock)
826
self._run(tree, names_list, rel_names, after)
828
def run_auto(self, names_list, after, dry_run):
829
if names_list is not None and len(names_list) > 1:
830
raise errors.BzrCommandError('Only one path may be specified to'
833
raise errors.BzrCommandError('--after cannot be specified with'
835
work_tree, file_list = tree_files(names_list, default_branch='.')
836
work_tree.lock_tree_write()
837
self.add_cleanup(work_tree.unlock)
838
rename_map.RenameMap.guess_renames(work_tree, dry_run)
840
def _run(self, tree, names_list, rel_names, after):
841
into_existing = osutils.isdir(names_list[-1])
842
if into_existing and len(names_list) == 2:
844
# a. case-insensitive filesystem and change case of dir
845
# b. move directory after the fact (if the source used to be
846
# a directory, but now doesn't exist in the working tree
847
# and the target is an existing directory, just rename it)
848
if (not tree.case_sensitive
849
and rel_names[0].lower() == rel_names[1].lower()):
850
into_existing = False
853
# 'fix' the case of a potential 'from'
854
from_id = tree.path2id(
855
tree.get_canonical_inventory_path(rel_names[0]))
856
if (not osutils.lexists(names_list[0]) and
857
from_id and inv.get_file_kind(from_id) == "directory"):
858
into_existing = False
861
# move into existing directory
862
# All entries reference existing inventory items, so fix them up
863
# for cicp file-systems.
864
rel_names = tree.get_canonical_inventory_paths(rel_names)
865
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
867
self.outf.write("%s => %s\n" % (src, dest))
869
if len(names_list) != 2:
870
raise errors.BzrCommandError('to mv multiple files the'
871
' destination must be a versioned'
874
# for cicp file-systems: the src references an existing inventory
876
src = tree.get_canonical_inventory_path(rel_names[0])
877
# Find the canonical version of the destination: In all cases, the
878
# parent of the target must be in the inventory, so we fetch the
879
# canonical version from there (we do not always *use* the
880
# canonicalized tail portion - we may be attempting to rename the
882
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
883
dest_parent = osutils.dirname(canon_dest)
884
spec_tail = osutils.basename(rel_names[1])
885
# For a CICP file-system, we need to avoid creating 2 inventory
886
# entries that differ only by case. So regardless of the case
887
# we *want* to use (ie, specified by the user or the file-system),
888
# we must always choose to use the case of any existing inventory
889
# items. The only exception to this is when we are attempting a
890
# case-only rename (ie, canonical versions of src and dest are
892
dest_id = tree.path2id(canon_dest)
893
if dest_id is None or tree.path2id(src) == dest_id:
894
# No existing item we care about, so work out what case we
895
# are actually going to use.
897
# If 'after' is specified, the tail must refer to a file on disk.
899
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
901
# pathjoin with an empty tail adds a slash, which breaks
903
dest_parent_fq = tree.basedir
905
dest_tail = osutils.canonical_relpath(
907
osutils.pathjoin(dest_parent_fq, spec_tail))
909
# not 'after', so case as specified is used
910
dest_tail = spec_tail
912
# Use the existing item so 'mv' fails with AlreadyVersioned.
913
dest_tail = os.path.basename(canon_dest)
914
dest = osutils.pathjoin(dest_parent, dest_tail)
915
mutter("attempting to move %s => %s", src, dest)
916
tree.rename_one(src, dest, after=after)
918
self.outf.write("%s => %s\n" % (src, dest))
921
class cmd_pull(Command):
922
"""Turn this branch into a mirror of another branch.
924
By default, this command only works on branches that have not diverged.
925
Branches are considered diverged if the destination branch's most recent
926
commit is one that has not been merged (directly or indirectly) into the
929
If branches have diverged, you can use 'bzr merge' to integrate the changes
930
from one into the other. Once one branch has merged, the other should
931
be able to pull it again.
933
If you want to replace your local changes and just want your branch to
934
match the remote one, use pull --overwrite. This will work even if the two
935
branches have diverged.
937
If there is no default location set, the first pull will set it. After
938
that, you can omit the location to use the default. To change the
939
default, use --remember. The value will only be saved if the remote
940
location can be accessed.
942
Note: The location can be specified either in the form of a branch,
943
or in the form of a path to a file containing a merge directive generated
947
_see_also = ['push', 'update', 'status-flags', 'send']
948
takes_options = ['remember', 'overwrite', 'revision',
949
custom_help('verbose',
950
help='Show logs of pulled revisions.'),
952
help='Branch to pull into, '
953
'rather than the one containing the working directory.',
958
help="Perform a local pull in a bound "
959
"branch. Local pulls are not applied to "
963
takes_args = ['location?']
964
encoding_type = 'replace'
966
def run(self, location=None, remember=False, overwrite=False,
967
revision=None, verbose=False,
968
directory=None, local=False):
969
# FIXME: too much stuff is in the command class
972
if directory is None:
975
tree_to = WorkingTree.open_containing(directory)[0]
976
branch_to = tree_to.branch
977
except errors.NoWorkingTree:
979
branch_to = Branch.open_containing(directory)[0]
981
if local and not branch_to.get_bound_location():
982
raise errors.LocalRequiresBoundBranch()
984
possible_transports = []
985
if location is not None:
987
mergeable = bundle.read_mergeable_from_url(location,
988
possible_transports=possible_transports)
989
except errors.NotABundle:
992
stored_loc = branch_to.get_parent()
994
if stored_loc is None:
995
raise errors.BzrCommandError("No pull location known or"
998
display_url = urlutils.unescape_for_display(stored_loc,
1001
self.outf.write("Using saved parent location: %s\n" % display_url)
1002
location = stored_loc
1004
revision = _get_one_revision('pull', revision)
1005
if mergeable is not None:
1006
if revision is not None:
1007
raise errors.BzrCommandError(
1008
'Cannot use -r with merge directives or bundles')
1009
mergeable.install_revisions(branch_to.repository)
1010
base_revision_id, revision_id, verified = \
1011
mergeable.get_merge_request(branch_to.repository)
1012
branch_from = branch_to
1014
branch_from = Branch.open(location,
1015
possible_transports=possible_transports)
1017
if branch_to.get_parent() is None or remember:
1018
branch_to.set_parent(branch_from.base)
1020
if branch_from is not branch_to:
1021
branch_from.lock_read()
1022
self.add_cleanup(branch_from.unlock)
1023
if revision is not None:
1024
revision_id = revision.as_revision_id(branch_from)
1026
branch_to.lock_write()
1027
self.add_cleanup(branch_to.unlock)
1028
if tree_to is not None:
1029
view_info = _get_view_info_for_change_reporter(tree_to)
1030
change_reporter = delta._ChangeReporter(
1031
unversioned_filter=tree_to.is_ignored,
1032
view_info=view_info)
1033
result = tree_to.pull(
1034
branch_from, overwrite, revision_id, change_reporter,
1035
possible_transports=possible_transports, local=local)
1037
result = branch_to.pull(
1038
branch_from, overwrite, revision_id, local=local)
1040
result.report(self.outf)
1041
if verbose and result.old_revid != result.new_revid:
1042
log.show_branch_change(
1043
branch_to, self.outf, result.old_revno,
1047
class cmd_push(Command):
1048
"""Update a mirror of this branch.
1050
The target branch will not have its working tree populated because this
1051
is both expensive, and is not supported on remote file systems.
1053
Some smart servers or protocols *may* put the working tree in place in
1056
This command only works on branches that have not diverged. Branches are
1057
considered diverged if the destination branch's most recent commit is one
1058
that has not been merged (directly or indirectly) by the source branch.
1060
If branches have diverged, you can use 'bzr push --overwrite' to replace
1061
the other branch completely, discarding its unmerged changes.
1063
If you want to ensure you have the different changes in the other branch,
1064
do a merge (see bzr help merge) from the other branch, and commit that.
1065
After that you will be able to do a push without '--overwrite'.
1067
If there is no default push location set, the first push will set it.
1068
After that, you can omit the location to use the default. To change the
1069
default, use --remember. The value will only be saved if the remote
1070
location can be accessed.
1073
_see_also = ['pull', 'update', 'working-trees']
1074
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1075
Option('create-prefix',
1076
help='Create the path leading up to the branch '
1077
'if it does not already exist.'),
1079
help='Branch to push from, '
1080
'rather than the one containing the working directory.',
1084
Option('use-existing-dir',
1085
help='By default push will fail if the target'
1086
' directory exists, but does not already'
1087
' have a control directory. This flag will'
1088
' allow push to proceed.'),
1090
help='Create a stacked branch that references the public location '
1091
'of the parent branch.'),
1092
Option('stacked-on',
1093
help='Create a stacked branch that refers to another branch '
1094
'for the commit history. Only the work not present in the '
1095
'referenced branch is included in the branch created.',
1098
help='Refuse to push if there are uncommitted changes in'
1099
' the working tree, --no-strict disables the check.'),
1101
takes_args = ['location?']
1102
encoding_type = 'replace'
1104
def run(self, location=None, remember=False, overwrite=False,
1105
create_prefix=False, verbose=False, revision=None,
1106
use_existing_dir=False, directory=None, stacked_on=None,
1107
stacked=False, strict=None):
1108
from bzrlib.push import _show_push_branch
1110
if directory is None:
1112
# Get the source branch
1114
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1116
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1117
if strict is None: strict = True # default value
1118
# Get the tip's revision_id
1119
revision = _get_one_revision('push', revision)
1120
if revision is not None:
1121
revision_id = revision.in_history(br_from).rev_id
1124
if strict and tree is not None and revision_id is None:
1125
if (tree.has_changes()):
1126
raise errors.UncommittedChanges(
1127
tree, more='Use --no-strict to force the push.')
1128
if tree.last_revision() != tree.branch.last_revision():
1129
# The tree has lost sync with its branch, there is little
1130
# chance that the user is aware of it but he can still force
1131
# the push with --no-strict
1132
raise errors.OutOfDateTree(
1133
tree, more='Use --no-strict to force the push.')
1135
# Get the stacked_on branch, if any
1136
if stacked_on is not None:
1137
stacked_on = urlutils.normalize_url(stacked_on)
1139
parent_url = br_from.get_parent()
1141
parent = Branch.open(parent_url)
1142
stacked_on = parent.get_public_branch()
1144
# I considered excluding non-http url's here, thus forcing
1145
# 'public' branches only, but that only works for some
1146
# users, so it's best to just depend on the user spotting an
1147
# error by the feedback given to them. RBC 20080227.
1148
stacked_on = parent_url
1150
raise errors.BzrCommandError(
1151
"Could not determine branch to refer to.")
1153
# Get the destination location
1154
if location is None:
1155
stored_loc = br_from.get_push_location()
1156
if stored_loc is None:
1157
raise errors.BzrCommandError(
1158
"No push location known or specified.")
1160
display_url = urlutils.unescape_for_display(stored_loc,
1162
self.outf.write("Using saved push location: %s\n" % display_url)
1163
location = stored_loc
1165
_show_push_branch(br_from, revision_id, location, self.outf,
1166
verbose=verbose, overwrite=overwrite, remember=remember,
1167
stacked_on=stacked_on, create_prefix=create_prefix,
1168
use_existing_dir=use_existing_dir)
1171
class cmd_branch(Command):
1172
"""Create a new branch that is a copy of an existing branch.
1174
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1175
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1176
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1177
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1178
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1181
To retrieve the branch as of a particular revision, supply the --revision
1182
parameter, as in "branch foo/bar -r 5".
1185
_see_also = ['checkout']
1186
takes_args = ['from_location', 'to_location?']
1187
takes_options = ['revision', Option('hardlink',
1188
help='Hard-link working tree files where possible.'),
1190
help="Create a branch without a working-tree."),
1192
help="Switch the checkout in the current directory "
1193
"to the new branch."),
1195
help='Create a stacked branch referring to the source branch. '
1196
'The new branch will depend on the availability of the source '
1197
'branch for all operations.'),
1198
Option('standalone',
1199
help='Do not use a shared repository, even if available.'),
1200
Option('use-existing-dir',
1201
help='By default branch will fail if the target'
1202
' directory exists, but does not already'
1203
' have a control directory. This flag will'
1204
' allow branch to proceed.'),
1206
help="Bind new branch to from location."),
1208
aliases = ['get', 'clone']
1210
def run(self, from_location, to_location=None, revision=None,
1211
hardlink=False, stacked=False, standalone=False, no_tree=False,
1212
use_existing_dir=False, switch=False, bind=False):
1213
from bzrlib import switch as _mod_switch
1214
from bzrlib.tag import _merge_tags_if_possible
1215
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1217
revision = _get_one_revision('branch', revision)
1219
self.add_cleanup(br_from.unlock)
1220
if revision is not None:
1221
revision_id = revision.as_revision_id(br_from)
1223
# FIXME - wt.last_revision, fallback to branch, fall back to
1224
# None or perhaps NULL_REVISION to mean copy nothing
1226
revision_id = br_from.last_revision()
1227
if to_location is None:
1228
to_location = urlutils.derive_to_location(from_location)
1229
to_transport = transport.get_transport(to_location)
1231
to_transport.mkdir('.')
1232
except errors.FileExists:
1233
if not use_existing_dir:
1234
raise errors.BzrCommandError('Target directory "%s" '
1235
'already exists.' % to_location)
1238
bzrdir.BzrDir.open_from_transport(to_transport)
1239
except errors.NotBranchError:
1242
raise errors.AlreadyBranchError(to_location)
1243
except errors.NoSuchFile:
1244
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1247
# preserve whatever source format we have.
1248
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1249
possible_transports=[to_transport],
1250
accelerator_tree=accelerator_tree,
1251
hardlink=hardlink, stacked=stacked,
1252
force_new_repo=standalone,
1253
create_tree_if_local=not no_tree,
1254
source_branch=br_from)
1255
branch = dir.open_branch()
1256
except errors.NoSuchRevision:
1257
to_transport.delete_tree('.')
1258
msg = "The branch %s has no revision %s." % (from_location,
1260
raise errors.BzrCommandError(msg)
1261
_merge_tags_if_possible(br_from, branch)
1262
# If the source branch is stacked, the new branch may
1263
# be stacked whether we asked for that explicitly or not.
1264
# We therefore need a try/except here and not just 'if stacked:'
1266
note('Created new stacked branch referring to %s.' %
1267
branch.get_stacked_on_url())
1268
except (errors.NotStacked, errors.UnstackableBranchFormat,
1269
errors.UnstackableRepositoryFormat), e:
1270
note('Branched %d revision(s).' % branch.revno())
1272
# Bind to the parent
1273
parent_branch = Branch.open(from_location)
1274
branch.bind(parent_branch)
1275
note('New branch bound to %s' % from_location)
1277
# Switch to the new branch
1278
wt, _ = WorkingTree.open_containing('.')
1279
_mod_switch.switch(wt.bzrdir, branch)
1280
note('Switched to branch: %s',
1281
urlutils.unescape_for_display(branch.base, 'utf-8'))
1284
class cmd_checkout(Command):
1285
"""Create a new checkout of an existing branch.
1287
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1288
the branch found in '.'. This is useful if you have removed the working tree
1289
or if it was never created - i.e. if you pushed the branch to its current
1290
location using SFTP.
1292
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1293
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1294
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1295
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1296
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1299
To retrieve the branch as of a particular revision, supply the --revision
1300
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1301
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1305
_see_also = ['checkouts', 'branch']
1306
takes_args = ['branch_location?', 'to_location?']
1307
takes_options = ['revision',
1308
Option('lightweight',
1309
help="Perform a lightweight checkout. Lightweight "
1310
"checkouts depend on access to the branch for "
1311
"every operation. Normal checkouts can perform "
1312
"common operations like diff and status without "
1313
"such access, and also support local commits."
1315
Option('files-from', type=str,
1316
help="Get file contents from this tree."),
1318
help='Hard-link working tree files where possible.'
1323
def run(self, branch_location=None, to_location=None, revision=None,
1324
lightweight=False, files_from=None, hardlink=False):
1325
if branch_location is None:
1326
branch_location = osutils.getcwd()
1327
to_location = branch_location
1328
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1330
revision = _get_one_revision('checkout', revision)
1331
if files_from is not None:
1332
accelerator_tree = WorkingTree.open(files_from)
1333
if revision is not None:
1334
revision_id = revision.as_revision_id(source)
1337
if to_location is None:
1338
to_location = urlutils.derive_to_location(branch_location)
1339
# if the source and to_location are the same,
1340
# and there is no working tree,
1341
# then reconstitute a branch
1342
if (osutils.abspath(to_location) ==
1343
osutils.abspath(branch_location)):
1345
source.bzrdir.open_workingtree()
1346
except errors.NoWorkingTree:
1347
source.bzrdir.create_workingtree(revision_id)
1349
source.create_checkout(to_location, revision_id, lightweight,
1350
accelerator_tree, hardlink)
1353
class cmd_renames(Command):
1354
"""Show list of renamed files.
1356
# TODO: Option to show renames between two historical versions.
1358
# TODO: Only show renames under dir, rather than in the whole branch.
1359
_see_also = ['status']
1360
takes_args = ['dir?']
1363
def run(self, dir=u'.'):
1364
tree = WorkingTree.open_containing(dir)[0]
1366
self.add_cleanup(tree.unlock)
1367
new_inv = tree.inventory
1368
old_tree = tree.basis_tree()
1369
old_tree.lock_read()
1370
self.add_cleanup(old_tree.unlock)
1371
old_inv = old_tree.inventory
1373
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1374
for f, paths, c, v, p, n, k, e in iterator:
1375
if paths[0] == paths[1]:
1379
renames.append(paths)
1381
for old_name, new_name in renames:
1382
self.outf.write("%s => %s\n" % (old_name, new_name))
1385
class cmd_update(Command):
1386
"""Update a tree to have the latest code committed to its branch.
1388
This will perform a merge into the working tree, and may generate
1389
conflicts. If you have any local changes, you will still
1390
need to commit them after the update for the update to be complete.
1392
If you want to discard your local changes, you can just do a
1393
'bzr revert' instead of 'bzr commit' after the update.
1395
If the tree's branch is bound to a master branch, it will also update
1396
the branch from the master.
1399
_see_also = ['pull', 'working-trees', 'status-flags']
1400
takes_args = ['dir?']
1401
takes_options = ['revision']
1404
def run(self, dir='.', revision=None):
1405
if revision is not None and len(revision) != 1:
1406
raise errors.BzrCommandError(
1407
"bzr update --revision takes exactly one revision")
1408
tree = WorkingTree.open_containing(dir)[0]
1409
branch = tree.branch
1410
possible_transports = []
1411
master = branch.get_master_branch(
1412
possible_transports=possible_transports)
1413
if master is not None:
1415
branch_location = master.base
1417
tree.lock_tree_write()
1418
branch_location = tree.branch.base
1419
self.add_cleanup(tree.unlock)
1420
# get rid of the final '/' and be ready for display
1421
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1423
existing_pending_merges = tree.get_parent_ids()[1:]
1427
# may need to fetch data into a heavyweight checkout
1428
# XXX: this may take some time, maybe we should display a
1430
old_tip = branch.update(possible_transports)
1431
if revision is not None:
1432
revision_id = revision[0].as_revision_id(branch)
1434
revision_id = branch.last_revision()
1435
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1436
revno = branch.revision_id_to_revno(revision_id)
1437
note("Tree is up to date at revision %d of branch %s" %
1438
(revno, branch_location))
1440
view_info = _get_view_info_for_change_reporter(tree)
1441
change_reporter = delta._ChangeReporter(
1442
unversioned_filter=tree.is_ignored,
1443
view_info=view_info)
1445
conflicts = tree.update(
1447
possible_transports=possible_transports,
1448
revision=revision_id,
1450
except errors.NoSuchRevision, e:
1451
raise errors.BzrCommandError(
1452
"branch has no revision %s\n"
1453
"bzr update --revision only works"
1454
" for a revision in the branch history"
1456
revno = tree.branch.revision_id_to_revno(
1457
_mod_revision.ensure_null(tree.last_revision()))
1458
note('Updated to revision %d of branch %s' %
1459
(revno, branch_location))
1460
if tree.get_parent_ids()[1:] != existing_pending_merges:
1461
note('Your local commits will now show as pending merges with '
1462
"'bzr status', and can be committed with 'bzr commit'.")
1469
class cmd_info(Command):
1470
"""Show information about a working tree, branch or repository.
1472
This command will show all known locations and formats associated to the
1473
tree, branch or repository.
1475
In verbose mode, statistical information is included with each report.
1476
To see extended statistic information, use a verbosity level of 2 or
1477
higher by specifying the verbose option multiple times, e.g. -vv.
1479
Branches and working trees will also report any missing revisions.
1483
Display information on the format and related locations:
1487
Display the above together with extended format information and
1488
basic statistics (like the number of files in the working tree and
1489
number of revisions in the branch and repository):
1493
Display the above together with number of committers to the branch:
1497
_see_also = ['revno', 'working-trees', 'repositories']
1498
takes_args = ['location?']
1499
takes_options = ['verbose']
1500
encoding_type = 'replace'
1503
def run(self, location=None, verbose=False):
1505
noise_level = get_verbosity_level()
1508
from bzrlib.info import show_bzrdir_info
1509
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1510
verbose=noise_level, outfile=self.outf)
1513
class cmd_remove(Command):
1514
"""Remove files or directories.
1516
This makes bzr stop tracking changes to the specified files. bzr will delete
1517
them if they can easily be recovered using revert. If no options or
1518
parameters are given bzr will scan for files that are being tracked by bzr
1519
but missing in your tree and stop tracking them for you.
1521
takes_args = ['file*']
1522
takes_options = ['verbose',
1523
Option('new', help='Only remove files that have never been committed.'),
1524
RegistryOption.from_kwargs('file-deletion-strategy',
1525
'The file deletion mode to be used.',
1526
title='Deletion Strategy', value_switches=True, enum_switch=False,
1527
safe='Only delete files if they can be'
1528
' safely recovered (default).',
1529
keep='Delete from bzr but leave the working copy.',
1530
force='Delete all the specified files, even if they can not be '
1531
'recovered and even if they are non-empty directories.')]
1532
aliases = ['rm', 'del']
1533
encoding_type = 'replace'
1535
def run(self, file_list, verbose=False, new=False,
1536
file_deletion_strategy='safe'):
1537
tree, file_list = tree_files(file_list)
1539
if file_list is not None:
1540
file_list = [f for f in file_list]
1543
self.add_cleanup(tree.unlock)
1544
# Heuristics should probably all move into tree.remove_smart or
1547
added = tree.changes_from(tree.basis_tree(),
1548
specific_files=file_list).added
1549
file_list = sorted([f[0] for f in added], reverse=True)
1550
if len(file_list) == 0:
1551
raise errors.BzrCommandError('No matching files.')
1552
elif file_list is None:
1553
# missing files show up in iter_changes(basis) as
1554
# versioned-with-no-kind.
1556
for change in tree.iter_changes(tree.basis_tree()):
1557
# Find paths in the working tree that have no kind:
1558
if change[1][1] is not None and change[6][1] is None:
1559
missing.append(change[1][1])
1560
file_list = sorted(missing, reverse=True)
1561
file_deletion_strategy = 'keep'
1562
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1563
keep_files=file_deletion_strategy=='keep',
1564
force=file_deletion_strategy=='force')
1567
class cmd_file_id(Command):
1568
"""Print file_id of a particular file or directory.
1570
The file_id is assigned when the file is first added and remains the
1571
same through all revisions where the file exists, even when it is
1576
_see_also = ['inventory', 'ls']
1577
takes_args = ['filename']
1580
def run(self, filename):
1581
tree, relpath = WorkingTree.open_containing(filename)
1582
i = tree.path2id(relpath)
1584
raise errors.NotVersionedError(filename)
1586
self.outf.write(i + '\n')
1589
class cmd_file_path(Command):
1590
"""Print path of file_ids to a file or directory.
1592
This prints one line for each directory down to the target,
1593
starting at the branch root.
1597
takes_args = ['filename']
1600
def run(self, filename):
1601
tree, relpath = WorkingTree.open_containing(filename)
1602
fid = tree.path2id(relpath)
1604
raise errors.NotVersionedError(filename)
1605
segments = osutils.splitpath(relpath)
1606
for pos in range(1, len(segments) + 1):
1607
path = osutils.joinpath(segments[:pos])
1608
self.outf.write("%s\n" % tree.path2id(path))
1611
class cmd_reconcile(Command):
1612
"""Reconcile bzr metadata in a branch.
1614
This can correct data mismatches that may have been caused by
1615
previous ghost operations or bzr upgrades. You should only
1616
need to run this command if 'bzr check' or a bzr developer
1617
advises you to run it.
1619
If a second branch is provided, cross-branch reconciliation is
1620
also attempted, which will check that data like the tree root
1621
id which was not present in very early bzr versions is represented
1622
correctly in both branches.
1624
At the same time it is run it may recompress data resulting in
1625
a potential saving in disk space or performance gain.
1627
The branch *MUST* be on a listable system such as local disk or sftp.
1630
_see_also = ['check']
1631
takes_args = ['branch?']
1633
def run(self, branch="."):
1634
from bzrlib.reconcile import reconcile
1635
dir = bzrdir.BzrDir.open(branch)
1639
class cmd_revision_history(Command):
1640
"""Display the list of revision ids on a branch."""
1643
takes_args = ['location?']
1648
def run(self, location="."):
1649
branch = Branch.open_containing(location)[0]
1650
for revid in branch.revision_history():
1651
self.outf.write(revid)
1652
self.outf.write('\n')
1655
class cmd_ancestry(Command):
1656
"""List all revisions merged into this branch."""
1658
_see_also = ['log', 'revision-history']
1659
takes_args = ['location?']
1664
def run(self, location="."):
1666
wt = WorkingTree.open_containing(location)[0]
1667
except errors.NoWorkingTree:
1668
b = Branch.open(location)
1669
last_revision = b.last_revision()
1672
last_revision = wt.last_revision()
1674
revision_ids = b.repository.get_ancestry(last_revision)
1676
for revision_id in revision_ids:
1677
self.outf.write(revision_id + '\n')
1680
class cmd_init(Command):
1681
"""Make a directory into a versioned branch.
1683
Use this to create an empty branch, or before importing an
1686
If there is a repository in a parent directory of the location, then
1687
the history of the branch will be stored in the repository. Otherwise
1688
init creates a standalone branch which carries its own history
1689
in the .bzr directory.
1691
If there is already a branch at the location but it has no working tree,
1692
the tree can be populated with 'bzr checkout'.
1694
Recipe for importing a tree of files::
1700
bzr commit -m "imported project"
1703
_see_also = ['init-repository', 'branch', 'checkout']
1704
takes_args = ['location?']
1706
Option('create-prefix',
1707
help='Create the path leading up to the branch '
1708
'if it does not already exist.'),
1709
RegistryOption('format',
1710
help='Specify a format for this branch. '
1711
'See "help formats".',
1712
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1713
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1714
value_switches=True,
1715
title="Branch format",
1717
Option('append-revisions-only',
1718
help='Never change revnos or the existing log.'
1719
' Append revisions to it only.')
1721
def run(self, location=None, format=None, append_revisions_only=False,
1722
create_prefix=False):
1724
format = bzrdir.format_registry.make_bzrdir('default')
1725
if location is None:
1728
to_transport = transport.get_transport(location)
1730
# The path has to exist to initialize a
1731
# branch inside of it.
1732
# Just using os.mkdir, since I don't
1733
# believe that we want to create a bunch of
1734
# locations if the user supplies an extended path
1736
to_transport.ensure_base()
1737
except errors.NoSuchFile:
1738
if not create_prefix:
1739
raise errors.BzrCommandError("Parent directory of %s"
1741
"\nYou may supply --create-prefix to create all"
1742
" leading parent directories."
1744
to_transport.create_prefix()
1747
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1748
except errors.NotBranchError:
1749
# really a NotBzrDir error...
1750
create_branch = bzrdir.BzrDir.create_branch_convenience
1751
branch = create_branch(to_transport.base, format=format,
1752
possible_transports=[to_transport])
1753
a_bzrdir = branch.bzrdir
1755
from bzrlib.transport.local import LocalTransport
1756
if a_bzrdir.has_branch():
1757
if (isinstance(to_transport, LocalTransport)
1758
and not a_bzrdir.has_workingtree()):
1759
raise errors.BranchExistsWithoutWorkingTree(location)
1760
raise errors.AlreadyBranchError(location)
1761
branch = a_bzrdir.create_branch()
1762
a_bzrdir.create_workingtree()
1763
if append_revisions_only:
1765
branch.set_append_revisions_only(True)
1766
except errors.UpgradeRequired:
1767
raise errors.BzrCommandError('This branch format cannot be set'
1768
' to append-revisions-only. Try --default.')
1770
from bzrlib.info import describe_layout, describe_format
1772
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1773
except (errors.NoWorkingTree, errors.NotLocalUrl):
1775
repository = branch.repository
1776
layout = describe_layout(repository, branch, tree).lower()
1777
format = describe_format(a_bzrdir, repository, branch, tree)
1778
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1779
if repository.is_shared():
1780
#XXX: maybe this can be refactored into transport.path_or_url()
1781
url = repository.bzrdir.root_transport.external_url()
1783
url = urlutils.local_path_from_url(url)
1784
except errors.InvalidURL:
1786
self.outf.write("Using shared repository: %s\n" % url)
1789
class cmd_init_repository(Command):
1790
"""Create a shared repository for branches to share storage space.
1792
New branches created under the repository directory will store their
1793
revisions in the repository, not in the branch directory. For branches
1794
with shared history, this reduces the amount of storage needed and
1795
speeds up the creation of new branches.
1797
If the --no-trees option is given then the branches in the repository
1798
will not have working trees by default. They will still exist as
1799
directories on disk, but they will not have separate copies of the
1800
files at a certain revision. This can be useful for repositories that
1801
store branches which are interacted with through checkouts or remote
1802
branches, such as on a server.
1805
Create a shared repository holding just branches::
1807
bzr init-repo --no-trees repo
1810
Make a lightweight checkout elsewhere::
1812
bzr checkout --lightweight repo/trunk trunk-checkout
1817
_see_also = ['init', 'branch', 'checkout', 'repositories']
1818
takes_args = ["location"]
1819
takes_options = [RegistryOption('format',
1820
help='Specify a format for this repository. See'
1821
' "bzr help formats" for details.',
1822
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1823
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1824
value_switches=True, title='Repository format'),
1826
help='Branches in the repository will default to'
1827
' not having a working tree.'),
1829
aliases = ["init-repo"]
1831
def run(self, location, format=None, no_trees=False):
1833
format = bzrdir.format_registry.make_bzrdir('default')
1835
if location is None:
1838
to_transport = transport.get_transport(location)
1839
to_transport.ensure_base()
1841
newdir = format.initialize_on_transport(to_transport)
1842
repo = newdir.create_repository(shared=True)
1843
repo.set_make_working_trees(not no_trees)
1845
from bzrlib.info import show_bzrdir_info
1846
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1849
class cmd_diff(Command):
1850
"""Show differences in the working tree, between revisions or branches.
1852
If no arguments are given, all changes for the current tree are listed.
1853
If files are given, only the changes in those files are listed.
1854
Remote and multiple branches can be compared by using the --old and
1855
--new options. If not provided, the default for both is derived from
1856
the first argument, if any, or the current tree if no arguments are
1859
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1860
produces patches suitable for "patch -p1".
1864
2 - unrepresentable changes
1869
Shows the difference in the working tree versus the last commit::
1873
Difference between the working tree and revision 1::
1877
Difference between revision 3 and revision 1::
1881
Difference between revision 3 and revision 1 for branch xxx::
1885
To see the changes introduced in revision X::
1889
Note that in the case of a merge, the -c option shows the changes
1890
compared to the left hand parent. To see the changes against
1891
another parent, use::
1893
bzr diff -r<chosen_parent>..X
1895
The changes introduced by revision 2 (equivalent to -r1..2)::
1899
Show just the differences for file NEWS::
1903
Show the differences in working tree xxx for file NEWS::
1907
Show the differences from branch xxx to this working tree:
1911
Show the differences between two branches for file NEWS::
1913
bzr diff --old xxx --new yyy NEWS
1915
Same as 'bzr diff' but prefix paths with old/ and new/::
1917
bzr diff --prefix old/:new/
1919
_see_also = ['status']
1920
takes_args = ['file*']
1922
Option('diff-options', type=str,
1923
help='Pass these options to the external diff program.'),
1924
Option('prefix', type=str,
1926
help='Set prefixes added to old and new filenames, as '
1927
'two values separated by a colon. (eg "old/:new/").'),
1929
help='Branch/tree to compare from.',
1933
help='Branch/tree to compare to.',
1939
help='Use this command to compare files.',
1943
aliases = ['di', 'dif']
1944
encoding_type = 'exact'
1947
def run(self, revision=None, file_list=None, diff_options=None,
1948
prefix=None, old=None, new=None, using=None):
1949
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1951
if (prefix is None) or (prefix == '0'):
1959
old_label, new_label = prefix.split(":")
1961
raise errors.BzrCommandError(
1962
'--prefix expects two values separated by a colon'
1963
' (eg "old/:new/")')
1965
if revision and len(revision) > 2:
1966
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1967
' one or two revision specifiers')
1969
(old_tree, new_tree,
1970
old_branch, new_branch,
1971
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1972
file_list, revision, old, new, apply_view=True)
1973
return show_diff_trees(old_tree, new_tree, sys.stdout,
1974
specific_files=specific_files,
1975
external_diff_options=diff_options,
1976
old_label=old_label, new_label=new_label,
1977
extra_trees=extra_trees, using=using)
1980
class cmd_deleted(Command):
1981
"""List files deleted in the working tree.
1983
# TODO: Show files deleted since a previous revision, or
1984
# between two revisions.
1985
# TODO: Much more efficient way to do this: read in new
1986
# directories with readdir, rather than stating each one. Same
1987
# level of effort but possibly much less IO. (Or possibly not,
1988
# if the directories are very large...)
1989
_see_also = ['status', 'ls']
1990
takes_options = ['show-ids']
1993
def run(self, show_ids=False):
1994
tree = WorkingTree.open_containing(u'.')[0]
1996
self.add_cleanup(tree.unlock)
1997
old = tree.basis_tree()
1999
self.add_cleanup(old.unlock)
2000
for path, ie in old.inventory.iter_entries():
2001
if not tree.has_id(ie.file_id):
2002
self.outf.write(path)
2004
self.outf.write(' ')
2005
self.outf.write(ie.file_id)
2006
self.outf.write('\n')
2009
class cmd_modified(Command):
2010
"""List files modified in working tree.
2014
_see_also = ['status', 'ls']
2017
help='Write an ascii NUL (\\0) separator '
2018
'between files rather than a newline.')
2022
def run(self, null=False):
2023
tree = WorkingTree.open_containing(u'.')[0]
2024
td = tree.changes_from(tree.basis_tree())
2025
for path, id, kind, text_modified, meta_modified in td.modified:
2027
self.outf.write(path + '\0')
2029
self.outf.write(osutils.quotefn(path) + '\n')
2032
class cmd_added(Command):
2033
"""List files added in working tree.
2037
_see_also = ['status', 'ls']
2040
help='Write an ascii NUL (\\0) separator '
2041
'between files rather than a newline.')
2045
def run(self, null=False):
2046
wt = WorkingTree.open_containing(u'.')[0]
2048
self.add_cleanup(wt.unlock)
2049
basis = wt.basis_tree()
2051
self.add_cleanup(basis.unlock)
2052
basis_inv = basis.inventory
2055
if file_id in basis_inv:
2057
if inv.is_root(file_id) and len(basis_inv) == 0:
2059
path = inv.id2path(file_id)
2060
if not os.access(osutils.abspath(path), os.F_OK):
2063
self.outf.write(path + '\0')
2065
self.outf.write(osutils.quotefn(path) + '\n')
2068
class cmd_root(Command):
2069
"""Show the tree root directory.
2071
The root is the nearest enclosing directory with a .bzr control
2074
takes_args = ['filename?']
2076
def run(self, filename=None):
2077
"""Print the branch root."""
2078
tree = WorkingTree.open_containing(filename)[0]
2079
self.outf.write(tree.basedir + '\n')
2082
def _parse_limit(limitstring):
2084
return int(limitstring)
2086
msg = "The limit argument must be an integer."
2087
raise errors.BzrCommandError(msg)
2090
def _parse_levels(s):
2094
msg = "The levels argument must be an integer."
2095
raise errors.BzrCommandError(msg)
2098
class cmd_log(Command):
2099
"""Show historical log for a branch or subset of a branch.
2101
log is bzr's default tool for exploring the history of a branch.
2102
The branch to use is taken from the first parameter. If no parameters
2103
are given, the branch containing the working directory is logged.
2104
Here are some simple examples::
2106
bzr log log the current branch
2107
bzr log foo.py log a file in its branch
2108
bzr log http://server/branch log a branch on a server
2110
The filtering, ordering and information shown for each revision can
2111
be controlled as explained below. By default, all revisions are
2112
shown sorted (topologically) so that newer revisions appear before
2113
older ones and descendants always appear before ancestors. If displayed,
2114
merged revisions are shown indented under the revision in which they
2119
The log format controls how information about each revision is
2120
displayed. The standard log formats are called ``long``, ``short``
2121
and ``line``. The default is long. See ``bzr help log-formats``
2122
for more details on log formats.
2124
The following options can be used to control what information is
2127
-l N display a maximum of N revisions
2128
-n N display N levels of revisions (0 for all, 1 for collapsed)
2129
-v display a status summary (delta) for each revision
2130
-p display a diff (patch) for each revision
2131
--show-ids display revision-ids (and file-ids), not just revnos
2133
Note that the default number of levels to display is a function of the
2134
log format. If the -n option is not used, the standard log formats show
2135
just the top level (mainline).
2137
Status summaries are shown using status flags like A, M, etc. To see
2138
the changes explained using words like ``added`` and ``modified``
2139
instead, use the -vv option.
2143
To display revisions from oldest to newest, use the --forward option.
2144
In most cases, using this option will have little impact on the total
2145
time taken to produce a log, though --forward does not incrementally
2146
display revisions like --reverse does when it can.
2148
:Revision filtering:
2150
The -r option can be used to specify what revision or range of revisions
2151
to filter against. The various forms are shown below::
2153
-rX display revision X
2154
-rX.. display revision X and later
2155
-r..Y display up to and including revision Y
2156
-rX..Y display from X to Y inclusive
2158
See ``bzr help revisionspec`` for details on how to specify X and Y.
2159
Some common examples are given below::
2161
-r-1 show just the tip
2162
-r-10.. show the last 10 mainline revisions
2163
-rsubmit:.. show what's new on this branch
2164
-rancestor:path.. show changes since the common ancestor of this
2165
branch and the one at location path
2166
-rdate:yesterday.. show changes since yesterday
2168
When logging a range of revisions using -rX..Y, log starts at
2169
revision Y and searches back in history through the primary
2170
("left-hand") parents until it finds X. When logging just the
2171
top level (using -n1), an error is reported if X is not found
2172
along the way. If multi-level logging is used (-n0), X may be
2173
a nested merge revision and the log will be truncated accordingly.
2177
If parameters are given and the first one is not a branch, the log
2178
will be filtered to show only those revisions that changed the
2179
nominated files or directories.
2181
Filenames are interpreted within their historical context. To log a
2182
deleted file, specify a revision range so that the file existed at
2183
the end or start of the range.
2185
Historical context is also important when interpreting pathnames of
2186
renamed files/directories. Consider the following example:
2188
* revision 1: add tutorial.txt
2189
* revision 2: modify tutorial.txt
2190
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2194
* ``bzr log guide.txt`` will log the file added in revision 1
2196
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2198
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2199
the original file in revision 2.
2201
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2202
was no file called guide.txt in revision 2.
2204
Renames are always followed by log. By design, there is no need to
2205
explicitly ask for this (and no way to stop logging a file back
2206
until it was last renamed).
2210
The --message option can be used for finding revisions that match a
2211
regular expression in a commit message.
2215
GUI tools and IDEs are often better at exploring history than command
2216
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2217
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2218
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2219
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2221
You may find it useful to add the aliases below to ``bazaar.conf``::
2225
top = log -l10 --line
2228
``bzr tip`` will then show the latest revision while ``bzr top``
2229
will show the last 10 mainline revisions. To see the details of a
2230
particular revision X, ``bzr show -rX``.
2232
If you are interested in looking deeper into a particular merge X,
2233
use ``bzr log -n0 -rX``.
2235
``bzr log -v`` on a branch with lots of history is currently
2236
very slow. A fix for this issue is currently under development.
2237
With or without that fix, it is recommended that a revision range
2238
be given when using the -v option.
2240
bzr has a generic full-text matching plugin, bzr-search, that can be
2241
used to find revisions matching user names, commit messages, etc.
2242
Among other features, this plugin can find all revisions containing
2243
a list of words but not others.
2245
When exploring non-mainline history on large projects with deep
2246
history, the performance of log can be greatly improved by installing
2247
the historycache plugin. This plugin buffers historical information
2248
trading disk space for faster speed.
2250
takes_args = ['file*']
2251
_see_also = ['log-formats', 'revisionspec']
2254
help='Show from oldest to newest.'),
2256
custom_help('verbose',
2257
help='Show files changed in each revision.'),
2261
type=bzrlib.option._parse_revision_str,
2263
help='Show just the specified revision.'
2264
' See also "help revisionspec".'),
2268
help='Number of levels to display - 0 for all, 1 for flat.',
2270
type=_parse_levels),
2273
help='Show revisions whose message matches this '
2274
'regular expression.',
2278
help='Limit the output to the first N revisions.',
2283
help='Show changes made in each revision as a patch.'),
2284
Option('include-merges',
2285
help='Show merged revisions like --levels 0 does.'),
2287
encoding_type = 'replace'
2290
def run(self, file_list=None, timezone='original',
2301
include_merges=False):
2302
from bzrlib.log import (
2304
make_log_request_dict,
2305
_get_info_for_log_files,
2307
direction = (forward and 'forward') or 'reverse'
2312
raise errors.BzrCommandError(
2313
'--levels and --include-merges are mutually exclusive')
2315
if change is not None:
2317
raise errors.RangeInChangeOption()
2318
if revision is not None:
2319
raise errors.BzrCommandError(
2320
'--revision and --change are mutually exclusive')
2325
filter_by_dir = False
2327
# find the file ids to log and check for directory filtering
2328
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2329
revision, file_list)
2330
self.add_cleanup(b.unlock)
2331
for relpath, file_id, kind in file_info_list:
2333
raise errors.BzrCommandError(
2334
"Path unknown at end or start of revision range: %s" %
2336
# If the relpath is the top of the tree, we log everything
2341
file_ids.append(file_id)
2342
filter_by_dir = filter_by_dir or (
2343
kind in ['directory', 'tree-reference'])
2346
# FIXME ? log the current subdir only RBC 20060203
2347
if revision is not None \
2348
and len(revision) > 0 and revision[0].get_branch():
2349
location = revision[0].get_branch()
2352
dir, relpath = bzrdir.BzrDir.open_containing(location)
2353
b = dir.open_branch()
2355
self.add_cleanup(b.unlock)
2356
rev1, rev2 = _get_revision_range(revision, b, self.name())
2358
# Decide on the type of delta & diff filtering to use
2359
# TODO: add an --all-files option to make this configurable & consistent
2367
diff_type = 'partial'
2371
# Build the log formatter
2372
if log_format is None:
2373
log_format = log.log_formatter_registry.get_default(b)
2374
# Make a non-encoding output to include the diffs - bug 328007
2375
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2376
lf = log_format(show_ids=show_ids, to_file=self.outf,
2377
to_exact_file=unencoded_output,
2378
show_timezone=timezone,
2379
delta_format=get_verbosity_level(),
2381
show_advice=levels is None)
2383
# Choose the algorithm for doing the logging. It's annoying
2384
# having multiple code paths like this but necessary until
2385
# the underlying repository format is faster at generating
2386
# deltas or can provide everything we need from the indices.
2387
# The default algorithm - match-using-deltas - works for
2388
# multiple files and directories and is faster for small
2389
# amounts of history (200 revisions say). However, it's too
2390
# slow for logging a single file in a repository with deep
2391
# history, i.e. > 10K revisions. In the spirit of "do no
2392
# evil when adding features", we continue to use the
2393
# original algorithm - per-file-graph - for the "single
2394
# file that isn't a directory without showing a delta" case.
2395
partial_history = revision and b.repository._format.supports_chks
2396
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2397
or delta_type or partial_history)
2399
# Build the LogRequest and execute it
2400
if len(file_ids) == 0:
2402
rqst = make_log_request_dict(
2403
direction=direction, specific_fileids=file_ids,
2404
start_revision=rev1, end_revision=rev2, limit=limit,
2405
message_search=message, delta_type=delta_type,
2406
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2407
Logger(b, rqst).show(lf)
2410
def _get_revision_range(revisionspec_list, branch, command_name):
2411
"""Take the input of a revision option and turn it into a revision range.
2413
It returns RevisionInfo objects which can be used to obtain the rev_id's
2414
of the desired revisions. It does some user input validations.
2416
if revisionspec_list is None:
2419
elif len(revisionspec_list) == 1:
2420
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2421
elif len(revisionspec_list) == 2:
2422
start_spec = revisionspec_list[0]
2423
end_spec = revisionspec_list[1]
2424
if end_spec.get_branch() != start_spec.get_branch():
2425
# b is taken from revision[0].get_branch(), and
2426
# show_log will use its revision_history. Having
2427
# different branches will lead to weird behaviors.
2428
raise errors.BzrCommandError(
2429
"bzr %s doesn't accept two revisions in different"
2430
" branches." % command_name)
2431
rev1 = start_spec.in_history(branch)
2432
# Avoid loading all of history when we know a missing
2433
# end of range means the last revision ...
2434
if end_spec.spec is None:
2435
last_revno, last_revision_id = branch.last_revision_info()
2436
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2438
rev2 = end_spec.in_history(branch)
2440
raise errors.BzrCommandError(
2441
'bzr %s --revision takes one or two values.' % command_name)
2445
def _revision_range_to_revid_range(revision_range):
2448
if revision_range[0] is not None:
2449
rev_id1 = revision_range[0].rev_id
2450
if revision_range[1] is not None:
2451
rev_id2 = revision_range[1].rev_id
2452
return rev_id1, rev_id2
2454
def get_log_format(long=False, short=False, line=False, default='long'):
2455
log_format = default
2459
log_format = 'short'
2465
class cmd_touching_revisions(Command):
2466
"""Return revision-ids which affected a particular file.
2468
A more user-friendly interface is "bzr log FILE".
2472
takes_args = ["filename"]
2475
def run(self, filename):
2476
tree, relpath = WorkingTree.open_containing(filename)
2477
file_id = tree.path2id(relpath)
2480
self.add_cleanup(b.unlock)
2481
touching_revs = log.find_touching_revisions(b, file_id)
2482
for revno, revision_id, what in touching_revs:
2483
self.outf.write("%6d %s\n" % (revno, what))
2486
class cmd_ls(Command):
2487
"""List files in a tree.
2490
_see_also = ['status', 'cat']
2491
takes_args = ['path?']
2495
Option('recursive', short_name='R',
2496
help='Recurse into subdirectories.'),
2498
help='Print paths relative to the root of the branch.'),
2499
Option('unknown', help='Print unknown files.'),
2500
Option('versioned', help='Print versioned files.',
2502
Option('ignored', help='Print ignored files.'),
2504
help='Write an ascii NUL (\\0) separator '
2505
'between files rather than a newline.'),
2507
help='List entries of a particular kind: file, directory, symlink.',
2512
def run(self, revision=None, verbose=False,
2513
recursive=False, from_root=False,
2514
unknown=False, versioned=False, ignored=False,
2515
null=False, kind=None, show_ids=False, path=None):
2517
if kind and kind not in ('file', 'directory', 'symlink'):
2518
raise errors.BzrCommandError('invalid kind specified')
2520
if verbose and null:
2521
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2522
all = not (unknown or versioned or ignored)
2524
selection = {'I':ignored, '?':unknown, 'V':versioned}
2530
raise errors.BzrCommandError('cannot specify both --from-root'
2533
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2536
# Calculate the prefix to use
2540
prefix = relpath + '/'
2541
elif fs_path != '.' and not fs_path.endswith('/'):
2542
prefix = fs_path + '/'
2544
if revision is not None or tree is None:
2545
tree = _get_one_revision_tree('ls', revision, branch=branch)
2548
if isinstance(tree, WorkingTree) and tree.supports_views():
2549
view_files = tree.views.lookup_view()
2552
view_str = views.view_display_str(view_files)
2553
note("Ignoring files outside view. View is %s" % view_str)
2556
self.add_cleanup(tree.unlock)
2557
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2558
from_dir=relpath, recursive=recursive):
2559
# Apply additional masking
2560
if not all and not selection[fc]:
2562
if kind is not None and fkind != kind:
2567
fullpath = osutils.pathjoin(relpath, fp)
2570
views.check_path_in_view(tree, fullpath)
2571
except errors.FileOutsideView:
2576
fp = osutils.pathjoin(prefix, fp)
2577
kindch = entry.kind_character()
2578
outstring = fp + kindch
2579
ui.ui_factory.clear_term()
2581
outstring = '%-8s %s' % (fc, outstring)
2582
if show_ids and fid is not None:
2583
outstring = "%-50s %s" % (outstring, fid)
2584
self.outf.write(outstring + '\n')
2586
self.outf.write(fp + '\0')
2589
self.outf.write(fid)
2590
self.outf.write('\0')
2598
self.outf.write('%-50s %s\n' % (outstring, my_id))
2600
self.outf.write(outstring + '\n')
2603
class cmd_unknowns(Command):
2604
"""List unknown files.
2612
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2613
self.outf.write(osutils.quotefn(f) + '\n')
2616
class cmd_ignore(Command):
2617
"""Ignore specified files or patterns.
2619
See ``bzr help patterns`` for details on the syntax of patterns.
2621
If a .bzrignore file does not exist, the ignore command
2622
will create one and add the specified files or patterns to the newly
2623
created file. The ignore command will also automatically add the
2624
.bzrignore file to be versioned. Creating a .bzrignore file without
2625
the use of the ignore command will require an explicit add command.
2627
To remove patterns from the ignore list, edit the .bzrignore file.
2628
After adding, editing or deleting that file either indirectly by
2629
using this command or directly by using an editor, be sure to commit
2632
Patterns prefixed with '!' are exceptions to ignore patterns and take
2633
precedence over regular ignores. Such exceptions are used to specify
2634
files that should be versioned which would otherwise be ignored.
2636
Patterns prefixed with '!!' act as regular ignore patterns, but have
2637
precedence over the '!' exception patterns.
2639
Note: ignore patterns containing shell wildcards must be quoted from
2643
Ignore the top level Makefile::
2645
bzr ignore ./Makefile
2647
Ignore .class files in all directories...::
2649
bzr ignore "*.class"
2651
...but do not ignore "special.class"::
2653
bzr ignore "!special.class"
2655
Ignore .o files under the lib directory::
2657
bzr ignore "lib/**/*.o"
2659
Ignore .o files under the lib directory::
2661
bzr ignore "RE:lib/.*\.o"
2663
Ignore everything but the "debian" toplevel directory::
2665
bzr ignore "RE:(?!debian/).*"
2667
Ignore everything except the "local" toplevel directory,
2668
but always ignore "*~" autosave files, even under local/::
2671
bzr ignore "!./local"
2675
_see_also = ['status', 'ignored', 'patterns']
2676
takes_args = ['name_pattern*']
2678
Option('old-default-rules',
2679
help='Write out the ignore rules bzr < 0.9 always used.')
2682
def run(self, name_pattern_list=None, old_default_rules=None):
2683
from bzrlib import ignores
2684
if old_default_rules is not None:
2685
# dump the rules and exit
2686
for pattern in ignores.OLD_DEFAULTS:
2687
self.outf.write("%s\n" % pattern)
2689
if not name_pattern_list:
2690
raise errors.BzrCommandError("ignore requires at least one "
2691
"NAME_PATTERN or --old-default-rules")
2692
name_pattern_list = [globbing.normalize_pattern(p)
2693
for p in name_pattern_list]
2694
for name_pattern in name_pattern_list:
2695
if (name_pattern[0] == '/' or
2696
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2697
raise errors.BzrCommandError(
2698
"NAME_PATTERN should not be an absolute path")
2699
tree, relpath = WorkingTree.open_containing(u'.')
2700
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2701
ignored = globbing.Globster(name_pattern_list)
2704
for entry in tree.list_files():
2708
if ignored.match(filename):
2709
matches.append(filename)
2711
if len(matches) > 0:
2712
self.outf.write("Warning: the following files are version controlled and"
2713
" match your ignore pattern:\n%s"
2714
"\nThese files will continue to be version controlled"
2715
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2718
class cmd_ignored(Command):
2719
"""List ignored files and the patterns that matched them.
2721
List all the ignored files and the ignore pattern that caused the file to
2724
Alternatively, to list just the files::
2729
encoding_type = 'replace'
2730
_see_also = ['ignore', 'ls']
2734
tree = WorkingTree.open_containing(u'.')[0]
2736
self.add_cleanup(tree.unlock)
2737
for path, file_class, kind, file_id, entry in tree.list_files():
2738
if file_class != 'I':
2740
## XXX: Slightly inefficient since this was already calculated
2741
pat = tree.is_ignored(path)
2742
self.outf.write('%-50s %s\n' % (path, pat))
2745
class cmd_lookup_revision(Command):
2746
"""Lookup the revision-id from a revision-number
2749
bzr lookup-revision 33
2752
takes_args = ['revno']
2755
def run(self, revno):
2759
raise errors.BzrCommandError("not a valid revision-number: %r"
2761
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2762
self.outf.write("%s\n" % revid)
2765
class cmd_export(Command):
2766
"""Export current or past revision to a destination directory or archive.
2768
If no revision is specified this exports the last committed revision.
2770
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2771
given, try to find the format with the extension. If no extension
2772
is found exports to a directory (equivalent to --format=dir).
2774
If root is supplied, it will be used as the root directory inside
2775
container formats (tar, zip, etc). If it is not supplied it will default
2776
to the exported filename. The root option has no effect for 'dir' format.
2778
If branch is omitted then the branch containing the current working
2779
directory will be used.
2781
Note: Export of tree with non-ASCII filenames to zip is not supported.
2783
================= =========================
2784
Supported formats Autodetected by extension
2785
================= =========================
2788
tbz2 .tar.bz2, .tbz2
2791
================= =========================
2793
takes_args = ['dest', 'branch_or_subdir?']
2796
help="Type of file to export to.",
2799
Option('filters', help='Apply content filters to export the '
2800
'convenient form.'),
2803
help="Name of the root directory inside the exported file."),
2805
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2806
root=None, filters=False):
2807
from bzrlib.export import export
2809
if branch_or_subdir is None:
2810
tree = WorkingTree.open_containing(u'.')[0]
2814
b, subdir = Branch.open_containing(branch_or_subdir)
2817
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2819
export(rev_tree, dest, format, root, subdir, filtered=filters)
2820
except errors.NoSuchExportFormat, e:
2821
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2824
class cmd_cat(Command):
2825
"""Write the contents of a file as of a given revision to standard output.
2827
If no revision is nominated, the last revision is used.
2829
Note: Take care to redirect standard output when using this command on a
2835
Option('name-from-revision', help='The path name in the old tree.'),
2836
Option('filters', help='Apply content filters to display the '
2837
'convenience form.'),
2840
takes_args = ['filename']
2841
encoding_type = 'exact'
2844
def run(self, filename, revision=None, name_from_revision=False,
2846
if revision is not None and len(revision) != 1:
2847
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2848
" one revision specifier")
2849
tree, branch, relpath = \
2850
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2852
self.add_cleanup(branch.unlock)
2853
return self._run(tree, branch, relpath, filename, revision,
2854
name_from_revision, filters)
2856
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2859
tree = b.basis_tree()
2860
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2861
rev_tree.lock_read()
2862
self.add_cleanup(rev_tree.unlock)
2864
old_file_id = rev_tree.path2id(relpath)
2866
if name_from_revision:
2867
# Try in revision if requested
2868
if old_file_id is None:
2869
raise errors.BzrCommandError(
2870
"%r is not present in revision %s" % (
2871
filename, rev_tree.get_revision_id()))
2873
content = rev_tree.get_file_text(old_file_id)
2875
cur_file_id = tree.path2id(relpath)
2877
if cur_file_id is not None:
2878
# Then try with the actual file id
2880
content = rev_tree.get_file_text(cur_file_id)
2882
except errors.NoSuchId:
2883
# The actual file id didn't exist at that time
2885
if not found and old_file_id is not None:
2886
# Finally try with the old file id
2887
content = rev_tree.get_file_text(old_file_id)
2890
# Can't be found anywhere
2891
raise errors.BzrCommandError(
2892
"%r is not present in revision %s" % (
2893
filename, rev_tree.get_revision_id()))
2895
from bzrlib.filters import (
2896
ContentFilterContext,
2897
filtered_output_bytes,
2899
filters = rev_tree._content_filter_stack(relpath)
2900
chunks = content.splitlines(True)
2901
content = filtered_output_bytes(chunks, filters,
2902
ContentFilterContext(relpath, rev_tree))
2904
self.outf.writelines(content)
2907
self.outf.write(content)
2910
class cmd_local_time_offset(Command):
2911
"""Show the offset in seconds from GMT to local time."""
2915
self.outf.write("%s\n" % osutils.local_time_offset())
2919
class cmd_commit(Command):
2920
"""Commit changes into a new revision.
2922
An explanatory message needs to be given for each commit. This is
2923
often done by using the --message option (getting the message from the
2924
command line) or by using the --file option (getting the message from
2925
a file). If neither of these options is given, an editor is opened for
2926
the user to enter the message. To see the changed files in the
2927
boilerplate text loaded into the editor, use the --show-diff option.
2929
By default, the entire tree is committed and the person doing the
2930
commit is assumed to be the author. These defaults can be overridden
2935
If selected files are specified, only changes to those files are
2936
committed. If a directory is specified then the directory and
2937
everything within it is committed.
2939
When excludes are given, they take precedence over selected files.
2940
For example, to commit only changes within foo, but not changes
2943
bzr commit foo -x foo/bar
2945
A selective commit after a merge is not yet supported.
2949
If the author of the change is not the same person as the committer,
2950
you can specify the author's name using the --author option. The
2951
name should be in the same format as a committer-id, e.g.
2952
"John Doe <jdoe@example.com>". If there is more than one author of
2953
the change you can specify the option multiple times, once for each
2958
A common mistake is to forget to add a new file or directory before
2959
running the commit command. The --strict option checks for unknown
2960
files and aborts the commit if any are found. More advanced pre-commit
2961
checks can be implemented by defining hooks. See ``bzr help hooks``
2966
If you accidentially commit the wrong changes or make a spelling
2967
mistake in the commit message say, you can use the uncommit command
2968
to undo it. See ``bzr help uncommit`` for details.
2970
Hooks can also be configured to run after a commit. This allows you
2971
to trigger updates to external systems like bug trackers. The --fixes
2972
option can be used to record the association between a revision and
2973
one or more bugs. See ``bzr help bugs`` for details.
2975
A selective commit may fail in some cases where the committed
2976
tree would be invalid. Consider::
2981
bzr commit foo -m "committing foo"
2982
bzr mv foo/bar foo/baz
2985
bzr commit foo/bar -m "committing bar but not baz"
2987
In the example above, the last commit will fail by design. This gives
2988
the user the opportunity to decide whether they want to commit the
2989
rename at the same time, separately first, or not at all. (As a general
2990
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2992
# TODO: Run hooks on tree to-be-committed, and after commit.
2994
# TODO: Strict commit that fails if there are deleted files.
2995
# (what does "deleted files" mean ??)
2997
# TODO: Give better message for -s, --summary, used by tla people
2999
# XXX: verbose currently does nothing
3001
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3002
takes_args = ['selected*']
3004
ListOption('exclude', type=str, short_name='x',
3005
help="Do not consider changes made to a given path."),
3006
Option('message', type=unicode,
3008
help="Description of the new revision."),
3011
help='Commit even if nothing has changed.'),
3012
Option('file', type=str,
3015
help='Take commit message from this file.'),
3017
help="Refuse to commit if there are unknown "
3018
"files in the working tree."),
3019
Option('commit-time', type=str,
3020
help="Manually set a commit time using commit date "
3021
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3022
ListOption('fixes', type=str,
3023
help="Mark a bug as being fixed by this revision "
3024
"(see \"bzr help bugs\")."),
3025
ListOption('author', type=unicode,
3026
help="Set the author's name, if it's different "
3027
"from the committer."),
3029
help="Perform a local commit in a bound "
3030
"branch. Local commits are not pushed to "
3031
"the master branch until a normal commit "
3035
help='When no message is supplied, show the diff along'
3036
' with the status summary in the message editor.'),
3038
aliases = ['ci', 'checkin']
3040
def _iter_bug_fix_urls(self, fixes, branch):
3041
# Configure the properties for bug fixing attributes.
3042
for fixed_bug in fixes:
3043
tokens = fixed_bug.split(':')
3044
if len(tokens) != 2:
3045
raise errors.BzrCommandError(
3046
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3047
"See \"bzr help bugs\" for more information on this "
3048
"feature.\nCommit refused." % fixed_bug)
3049
tag, bug_id = tokens
3051
yield bugtracker.get_bug_url(tag, branch, bug_id)
3052
except errors.UnknownBugTrackerAbbreviation:
3053
raise errors.BzrCommandError(
3054
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3055
except errors.MalformedBugIdentifier, e:
3056
raise errors.BzrCommandError(
3057
"%s\nCommit refused." % (str(e),))
3059
def run(self, message=None, file=None, verbose=False, selected_list=None,
3060
unchanged=False, strict=False, local=False, fixes=None,
3061
author=None, show_diff=False, exclude=None, commit_time=None):
3062
from bzrlib.errors import (
3067
from bzrlib.msgeditor import (
3068
edit_commit_message_encoded,
3069
generate_commit_message_template,
3070
make_commit_message_template_encoded
3073
commit_stamp = offset = None
3074
if commit_time is not None:
3076
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3077
except ValueError, e:
3078
raise errors.BzrCommandError(
3079
"Could not parse --commit-time: " + str(e))
3081
# TODO: Need a blackbox test for invoking the external editor; may be
3082
# slightly problematic to run this cross-platform.
3084
# TODO: do more checks that the commit will succeed before
3085
# spending the user's valuable time typing a commit message.
3089
tree, selected_list = tree_files(selected_list)
3090
if selected_list == ['']:
3091
# workaround - commit of root of tree should be exactly the same
3092
# as just default commit in that tree, and succeed even though
3093
# selected-file merge commit is not done yet
3098
bug_property = bugtracker.encode_fixes_bug_urls(
3099
self._iter_bug_fix_urls(fixes, tree.branch))
3101
properties['bugs'] = bug_property
3103
if local and not tree.branch.get_bound_location():
3104
raise errors.LocalRequiresBoundBranch()
3106
if message is not None:
3108
file_exists = osutils.lexists(message)
3109
except UnicodeError:
3110
# The commit message contains unicode characters that can't be
3111
# represented in the filesystem encoding, so that can't be a
3116
'The commit message is a file name: "%(f)s".\n'
3117
'(use --file "%(f)s" to take commit message from that file)'
3119
ui.ui_factory.show_warning(warning_msg)
3121
def get_message(commit_obj):
3122
"""Callback to get commit message"""
3123
my_message = message
3124
if my_message is not None and '\r' in my_message:
3125
my_message = my_message.replace('\r\n', '\n')
3126
my_message = my_message.replace('\r', '\n')
3127
if my_message is None and not file:
3128
t = make_commit_message_template_encoded(tree,
3129
selected_list, diff=show_diff,
3130
output_encoding=osutils.get_user_encoding())
3131
start_message = generate_commit_message_template(commit_obj)
3132
my_message = edit_commit_message_encoded(t,
3133
start_message=start_message)
3134
if my_message is None:
3135
raise errors.BzrCommandError("please specify a commit"
3136
" message with either --message or --file")
3137
elif my_message and file:
3138
raise errors.BzrCommandError(
3139
"please specify either --message or --file")
3141
my_message = codecs.open(file, 'rt',
3142
osutils.get_user_encoding()).read()
3143
if my_message == "":
3144
raise errors.BzrCommandError("empty commit message specified")
3147
# The API permits a commit with a filter of [] to mean 'select nothing'
3148
# but the command line should not do that.
3149
if not selected_list:
3150
selected_list = None
3152
tree.commit(message_callback=get_message,
3153
specific_files=selected_list,
3154
allow_pointless=unchanged, strict=strict, local=local,
3155
reporter=None, verbose=verbose, revprops=properties,
3156
authors=author, timestamp=commit_stamp,
3158
exclude=safe_relpath_files(tree, exclude))
3159
except PointlessCommit:
3160
# FIXME: This should really happen before the file is read in;
3161
# perhaps prepare the commit; get the message; then actually commit
3162
raise errors.BzrCommandError("No changes to commit."
3163
" Use --unchanged to commit anyhow.")
3164
except ConflictsInTree:
3165
raise errors.BzrCommandError('Conflicts detected in working '
3166
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3168
except StrictCommitFailed:
3169
raise errors.BzrCommandError("Commit refused because there are"
3170
" unknown files in the working tree.")
3171
except errors.BoundBranchOutOfDate, e:
3172
raise errors.BzrCommandError(str(e) + "\n"
3173
'To commit to master branch, run update and then commit.\n'
3174
'You can also pass --local to commit to continue working '
3178
class cmd_check(Command):
3179
"""Validate working tree structure, branch consistency and repository history.
3181
This command checks various invariants about branch and repository storage
3182
to detect data corruption or bzr bugs.
3184
The working tree and branch checks will only give output if a problem is
3185
detected. The output fields of the repository check are:
3188
This is just the number of revisions checked. It doesn't
3192
This is just the number of versionedfiles checked. It
3193
doesn't indicate a problem.
3195
unreferenced ancestors
3196
Texts that are ancestors of other texts, but
3197
are not properly referenced by the revision ancestry. This is a
3198
subtle problem that Bazaar can work around.
3201
This is the total number of unique file contents
3202
seen in the checked revisions. It does not indicate a problem.
3205
This is the total number of repeated texts seen
3206
in the checked revisions. Texts can be repeated when their file
3207
entries are modified, but the file contents are not. It does not
3210
If no restrictions are specified, all Bazaar data that is found at the given
3211
location will be checked.
3215
Check the tree and branch at 'foo'::
3217
bzr check --tree --branch foo
3219
Check only the repository at 'bar'::
3221
bzr check --repo bar
3223
Check everything at 'baz'::
3228
_see_also = ['reconcile']
3229
takes_args = ['path?']
3230
takes_options = ['verbose',
3231
Option('branch', help="Check the branch related to the"
3232
" current directory."),
3233
Option('repo', help="Check the repository related to the"
3234
" current directory."),
3235
Option('tree', help="Check the working tree related to"
3236
" the current directory.")]
3238
def run(self, path=None, verbose=False, branch=False, repo=False,
3240
from bzrlib.check import check_dwim
3243
if not branch and not repo and not tree:
3244
branch = repo = tree = True
3245
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3248
class cmd_upgrade(Command):
3249
"""Upgrade branch storage to current format.
3251
The check command or bzr developers may sometimes advise you to run
3252
this command. When the default format has changed you may also be warned
3253
during other operations to upgrade.
3256
_see_also = ['check']
3257
takes_args = ['url?']
3259
RegistryOption('format',
3260
help='Upgrade to a specific format. See "bzr help'
3261
' formats" for details.',
3262
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3263
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3264
value_switches=True, title='Branch format'),
3267
def run(self, url='.', format=None):
3268
from bzrlib.upgrade import upgrade
3269
upgrade(url, format)
3272
class cmd_whoami(Command):
3273
"""Show or set bzr user id.
3276
Show the email of the current user::
3280
Set the current user::
3282
bzr whoami "Frank Chu <fchu@example.com>"
3284
takes_options = [ Option('email',
3285
help='Display email address only.'),
3287
help='Set identity for the current branch instead of '
3290
takes_args = ['name?']
3291
encoding_type = 'replace'
3294
def run(self, email=False, branch=False, name=None):
3296
# use branch if we're inside one; otherwise global config
3298
c = Branch.open_containing('.')[0].get_config()
3299
except errors.NotBranchError:
3300
c = config.GlobalConfig()
3302
self.outf.write(c.user_email() + '\n')
3304
self.outf.write(c.username() + '\n')
3307
# display a warning if an email address isn't included in the given name.
3309
config.extract_email_address(name)
3310
except errors.NoEmailInUsername, e:
3311
warning('"%s" does not seem to contain an email address. '
3312
'This is allowed, but not recommended.', name)
3314
# use global config unless --branch given
3316
c = Branch.open_containing('.')[0].get_config()
3318
c = config.GlobalConfig()
3319
c.set_user_option('email', name)
3322
class cmd_nick(Command):
3323
"""Print or set the branch nickname.
3325
If unset, the tree root directory name is used as the nickname.
3326
To print the current nickname, execute with no argument.
3328
Bound branches use the nickname of its master branch unless it is set
3332
_see_also = ['info']
3333
takes_args = ['nickname?']
3334
def run(self, nickname=None):
3335
branch = Branch.open_containing(u'.')[0]
3336
if nickname is None:
3337
self.printme(branch)
3339
branch.nick = nickname
3342
def printme(self, branch):
3343
self.outf.write('%s\n' % branch.nick)
3346
class cmd_alias(Command):
3347
"""Set/unset and display aliases.
3350
Show the current aliases::
3354
Show the alias specified for 'll'::
3358
Set an alias for 'll'::
3360
bzr alias ll="log --line -r-10..-1"
3362
To remove an alias for 'll'::
3364
bzr alias --remove ll
3367
takes_args = ['name?']
3369
Option('remove', help='Remove the alias.'),
3372
def run(self, name=None, remove=False):
3374
self.remove_alias(name)
3376
self.print_aliases()
3378
equal_pos = name.find('=')
3380
self.print_alias(name)
3382
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3384
def remove_alias(self, alias_name):
3385
if alias_name is None:
3386
raise errors.BzrCommandError(
3387
'bzr alias --remove expects an alias to remove.')
3388
# If alias is not found, print something like:
3389
# unalias: foo: not found
3390
c = config.GlobalConfig()
3391
c.unset_alias(alias_name)
3394
def print_aliases(self):
3395
"""Print out the defined aliases in a similar format to bash."""
3396
aliases = config.GlobalConfig().get_aliases()
3397
for key, value in sorted(aliases.iteritems()):
3398
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3401
def print_alias(self, alias_name):
3402
from bzrlib.commands import get_alias
3403
alias = get_alias(alias_name)
3405
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3408
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3410
def set_alias(self, alias_name, alias_command):
3411
"""Save the alias in the global config."""
3412
c = config.GlobalConfig()
3413
c.set_alias(alias_name, alias_command)
3416
class cmd_selftest(Command):
3417
"""Run internal test suite.
3419
If arguments are given, they are regular expressions that say which tests
3420
should run. Tests matching any expression are run, and other tests are
3423
Alternatively if --first is given, matching tests are run first and then
3424
all other tests are run. This is useful if you have been working in a
3425
particular area, but want to make sure nothing else was broken.
3427
If --exclude is given, tests that match that regular expression are
3428
excluded, regardless of whether they match --first or not.
3430
To help catch accidential dependencies between tests, the --randomize
3431
option is useful. In most cases, the argument used is the word 'now'.
3432
Note that the seed used for the random number generator is displayed
3433
when this option is used. The seed can be explicitly passed as the
3434
argument to this option if required. This enables reproduction of the
3435
actual ordering used if and when an order sensitive problem is encountered.
3437
If --list-only is given, the tests that would be run are listed. This is
3438
useful when combined with --first, --exclude and/or --randomize to
3439
understand their impact. The test harness reports "Listed nn tests in ..."
3440
instead of "Ran nn tests in ..." when list mode is enabled.
3442
If the global option '--no-plugins' is given, plugins are not loaded
3443
before running the selftests. This has two effects: features provided or
3444
modified by plugins will not be tested, and tests provided by plugins will
3447
Tests that need working space on disk use a common temporary directory,
3448
typically inside $TMPDIR or /tmp.
3450
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3451
into a pdb postmortem session.
3454
Run only tests relating to 'ignore'::
3458
Disable plugins and list tests as they're run::
3460
bzr --no-plugins selftest -v
3462
# NB: this is used from the class without creating an instance, which is
3463
# why it does not have a self parameter.
3464
def get_transport_type(typestring):
3465
"""Parse and return a transport specifier."""
3466
if typestring == "sftp":
3467
from bzrlib.tests import stub_sftp
3468
return stub_sftp.SFTPAbsoluteServer
3469
if typestring == "memory":
3470
from bzrlib.tests import test_server
3471
return memory.MemoryServer
3472
if typestring == "fakenfs":
3473
from bzrlib.tests import test_server
3474
return test_server.FakeNFSServer
3475
msg = "No known transport type %s. Supported types are: sftp\n" %\
3477
raise errors.BzrCommandError(msg)
3480
takes_args = ['testspecs*']
3481
takes_options = ['verbose',
3483
help='Stop when one test fails.',
3487
help='Use a different transport by default '
3488
'throughout the test suite.',
3489
type=get_transport_type),
3491
help='Run the benchmarks rather than selftests.'),
3492
Option('lsprof-timed',
3493
help='Generate lsprof output for benchmarked'
3494
' sections of code.'),
3495
Option('lsprof-tests',
3496
help='Generate lsprof output for each test.'),
3497
Option('cache-dir', type=str,
3498
help='Cache intermediate benchmark output in this '
3501
help='Run all tests, but run specified tests first.',
3505
help='List the tests instead of running them.'),
3506
RegistryOption('parallel',
3507
help="Run the test suite in parallel.",
3508
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3509
value_switches=False,
3511
Option('randomize', type=str, argname="SEED",
3512
help='Randomize the order of tests using the given'
3513
' seed or "now" for the current time.'),
3514
Option('exclude', type=str, argname="PATTERN",
3516
help='Exclude tests that match this regular'
3519
help='Output test progress via subunit.'),
3520
Option('strict', help='Fail on missing dependencies or '
3522
Option('load-list', type=str, argname='TESTLISTFILE',
3523
help='Load a test id list from a text file.'),
3524
ListOption('debugflag', type=str, short_name='E',
3525
help='Turn on a selftest debug flag.'),
3526
ListOption('starting-with', type=str, argname='TESTID',
3527
param_name='starting_with', short_name='s',
3529
'Load only the tests starting with TESTID.'),
3531
encoding_type = 'replace'
3534
Command.__init__(self)
3535
self.additional_selftest_args = {}
3537
def run(self, testspecs_list=None, verbose=False, one=False,
3538
transport=None, benchmark=None,
3539
lsprof_timed=None, cache_dir=None,
3540
first=False, list_only=False,
3541
randomize=None, exclude=None, strict=False,
3542
load_list=None, debugflag=None, starting_with=None, subunit=False,
3543
parallel=None, lsprof_tests=False):
3544
from bzrlib.tests import selftest
3545
import bzrlib.benchmarks as benchmarks
3546
from bzrlib.benchmarks import tree_creator
3548
# Make deprecation warnings visible, unless -Werror is set
3549
symbol_versioning.activate_deprecation_warnings(override=False)
3551
if cache_dir is not None:
3552
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3553
if testspecs_list is not None:
3554
pattern = '|'.join(testspecs_list)
3559
from bzrlib.tests import SubUnitBzrRunner
3561
raise errors.BzrCommandError("subunit not available. subunit "
3562
"needs to be installed to use --subunit.")
3563
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3565
self.additional_selftest_args.setdefault(
3566
'suite_decorators', []).append(parallel)
3568
test_suite_factory = benchmarks.test_suite
3569
# Unless user explicitly asks for quiet, be verbose in benchmarks
3570
verbose = not is_quiet()
3571
# TODO: should possibly lock the history file...
3572
benchfile = open(".perf_history", "at", buffering=1)
3573
self.add_cleanup(benchfile.close)
3575
test_suite_factory = None
3577
selftest_kwargs = {"verbose": verbose,
3579
"stop_on_failure": one,
3580
"transport": transport,
3581
"test_suite_factory": test_suite_factory,
3582
"lsprof_timed": lsprof_timed,
3583
"lsprof_tests": lsprof_tests,
3584
"bench_history": benchfile,
3585
"matching_tests_first": first,
3586
"list_only": list_only,
3587
"random_seed": randomize,
3588
"exclude_pattern": exclude,
3590
"load_list": load_list,
3591
"debug_flags": debugflag,
3592
"starting_with": starting_with
3594
selftest_kwargs.update(self.additional_selftest_args)
3595
result = selftest(**selftest_kwargs)
3596
return int(not result)
3599
class cmd_version(Command):
3600
"""Show version of bzr."""
3602
encoding_type = 'replace'
3604
Option("short", help="Print just the version number."),
3608
def run(self, short=False):
3609
from bzrlib.version import show_version
3611
self.outf.write(bzrlib.version_string + '\n')
3613
show_version(to_file=self.outf)
3616
class cmd_rocks(Command):
3617
"""Statement of optimism."""
3623
self.outf.write("It sure does!\n")
3626
class cmd_find_merge_base(Command):
3627
"""Find and print a base revision for merging two branches."""
3628
# TODO: Options to specify revisions on either side, as if
3629
# merging only part of the history.
3630
takes_args = ['branch', 'other']
3634
def run(self, branch, other):
3635
from bzrlib.revision import ensure_null
3637
branch1 = Branch.open_containing(branch)[0]
3638
branch2 = Branch.open_containing(other)[0]
3640
self.add_cleanup(branch1.unlock)
3642
self.add_cleanup(branch2.unlock)
3643
last1 = ensure_null(branch1.last_revision())
3644
last2 = ensure_null(branch2.last_revision())
3646
graph = branch1.repository.get_graph(branch2.repository)
3647
base_rev_id = graph.find_unique_lca(last1, last2)
3649
self.outf.write('merge base is revision %s\n' % base_rev_id)
3652
class cmd_merge(Command):
3653
"""Perform a three-way merge.
3655
The source of the merge can be specified either in the form of a branch,
3656
or in the form of a path to a file containing a merge directive generated
3657
with bzr send. If neither is specified, the default is the upstream branch
3658
or the branch most recently merged using --remember.
3660
When merging a branch, by default the tip will be merged. To pick a different
3661
revision, pass --revision. If you specify two values, the first will be used as
3662
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3663
available revisions, like this is commonly referred to as "cherrypicking".
3665
Revision numbers are always relative to the branch being merged.
3667
By default, bzr will try to merge in all new work from the other
3668
branch, automatically determining an appropriate base. If this
3669
fails, you may need to give an explicit base.
3671
Merge will do its best to combine the changes in two branches, but there
3672
are some kinds of problems only a human can fix. When it encounters those,
3673
it will mark a conflict. A conflict means that you need to fix something,
3674
before you should commit.
3676
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3678
If there is no default branch set, the first merge will set it. After
3679
that, you can omit the branch to use the default. To change the
3680
default, use --remember. The value will only be saved if the remote
3681
location can be accessed.
3683
The results of the merge are placed into the destination working
3684
directory, where they can be reviewed (with bzr diff), tested, and then
3685
committed to record the result of the merge.
3687
merge refuses to run if there are any uncommitted changes, unless
3688
--force is given. The --force option can also be used to create a
3689
merge revision which has more than two parents.
3691
If one would like to merge changes from the working tree of the other
3692
branch without merging any committed revisions, the --uncommitted option
3695
To select only some changes to merge, use "merge -i", which will prompt
3696
you to apply each diff hunk and file change, similar to "shelve".
3699
To merge the latest revision from bzr.dev::
3701
bzr merge ../bzr.dev
3703
To merge changes up to and including revision 82 from bzr.dev::
3705
bzr merge -r 82 ../bzr.dev
3707
To merge the changes introduced by 82, without previous changes::
3709
bzr merge -r 81..82 ../bzr.dev
3711
To apply a merge directive contained in /tmp/merge::
3713
bzr merge /tmp/merge
3715
To create a merge revision with three parents from two branches
3716
feature1a and feature1b:
3718
bzr merge ../feature1a
3719
bzr merge ../feature1b --force
3720
bzr commit -m 'revision with three parents'
3723
encoding_type = 'exact'
3724
_see_also = ['update', 'remerge', 'status-flags', 'send']
3725
takes_args = ['location?']
3730
help='Merge even if the destination tree has uncommitted changes.'),
3734
Option('show-base', help="Show base revision text in "
3736
Option('uncommitted', help='Apply uncommitted changes'
3737
' from a working copy, instead of branch changes.'),
3738
Option('pull', help='If the destination is already'
3739
' completely merged into the source, pull from the'
3740
' source rather than merging. When this happens,'
3741
' you do not need to commit the result.'),
3743
help='Branch to merge into, '
3744
'rather than the one containing the working directory.',
3748
Option('preview', help='Instead of merging, show a diff of the'
3750
Option('interactive', help='Select changes interactively.',
3754
def run(self, location=None, revision=None, force=False,
3755
merge_type=None, show_base=False, reprocess=None, remember=False,
3756
uncommitted=False, pull=False,
3761
if merge_type is None:
3762
merge_type = _mod_merge.Merge3Merger
3764
if directory is None: directory = u'.'
3765
possible_transports = []
3767
allow_pending = True
3768
verified = 'inapplicable'
3769
tree = WorkingTree.open_containing(directory)[0]
3772
basis_tree = tree.revision_tree(tree.last_revision())
3773
except errors.NoSuchRevision:
3774
basis_tree = tree.basis_tree()
3776
# die as quickly as possible if there are uncommitted changes
3778
if tree.has_changes():
3779
raise errors.UncommittedChanges(tree)
3781
view_info = _get_view_info_for_change_reporter(tree)
3782
change_reporter = delta._ChangeReporter(
3783
unversioned_filter=tree.is_ignored, view_info=view_info)
3784
pb = ui.ui_factory.nested_progress_bar()
3785
self.add_cleanup(pb.finished)
3787
self.add_cleanup(tree.unlock)
3788
if location is not None:
3790
mergeable = bundle.read_mergeable_from_url(location,
3791
possible_transports=possible_transports)
3792
except errors.NotABundle:
3796
raise errors.BzrCommandError('Cannot use --uncommitted'
3797
' with bundles or merge directives.')
3799
if revision is not None:
3800
raise errors.BzrCommandError(
3801
'Cannot use -r with merge directives or bundles')
3802
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3805
if merger is None and uncommitted:
3806
if revision is not None and len(revision) > 0:
3807
raise errors.BzrCommandError('Cannot use --uncommitted and'
3808
' --revision at the same time.')
3809
merger = self.get_merger_from_uncommitted(tree, location, None)
3810
allow_pending = False
3813
merger, allow_pending = self._get_merger_from_branch(tree,
3814
location, revision, remember, possible_transports, None)
3816
merger.merge_type = merge_type
3817
merger.reprocess = reprocess
3818
merger.show_base = show_base
3819
self.sanity_check_merger(merger)
3820
if (merger.base_rev_id == merger.other_rev_id and
3821
merger.other_rev_id is not None):
3822
note('Nothing to do.')
3825
if merger.interesting_files is not None:
3826
raise errors.BzrCommandError('Cannot pull individual files')
3827
if (merger.base_rev_id == tree.last_revision()):
3828
result = tree.pull(merger.other_branch, False,
3829
merger.other_rev_id)
3830
result.report(self.outf)
3832
if merger.this_basis is None:
3833
raise errors.BzrCommandError(
3834
"This branch has no commits."
3835
" (perhaps you would prefer 'bzr pull')")
3837
return self._do_preview(merger)
3839
return self._do_interactive(merger)
3841
return self._do_merge(merger, change_reporter, allow_pending,
3844
def _get_preview(self, merger):
3845
tree_merger = merger.make_merger()
3846
tt = tree_merger.make_preview_transform()
3847
self.add_cleanup(tt.finalize)
3848
result_tree = tt.get_preview_tree()
3851
def _do_preview(self, merger):
3852
from bzrlib.diff import show_diff_trees
3853
result_tree = self._get_preview(merger)
3854
show_diff_trees(merger.this_tree, result_tree, self.outf,
3855
old_label='', new_label='')
3857
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3858
merger.change_reporter = change_reporter
3859
conflict_count = merger.do_merge()
3861
merger.set_pending()
3862
if verified == 'failed':
3863
warning('Preview patch does not match changes')
3864
if conflict_count != 0:
3869
def _do_interactive(self, merger):
3870
"""Perform an interactive merge.
3872
This works by generating a preview tree of the merge, then using
3873
Shelver to selectively remove the differences between the working tree
3874
and the preview tree.
3876
from bzrlib import shelf_ui
3877
result_tree = self._get_preview(merger)
3878
writer = bzrlib.option.diff_writer_registry.get()
3879
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3880
reporter=shelf_ui.ApplyReporter(),
3881
diff_writer=writer(sys.stdout))
3887
def sanity_check_merger(self, merger):
3888
if (merger.show_base and
3889
not merger.merge_type is _mod_merge.Merge3Merger):
3890
raise errors.BzrCommandError("Show-base is not supported for this"
3891
" merge type. %s" % merger.merge_type)
3892
if merger.reprocess is None:
3893
if merger.show_base:
3894
merger.reprocess = False
3896
# Use reprocess if the merger supports it
3897
merger.reprocess = merger.merge_type.supports_reprocess
3898
if merger.reprocess and not merger.merge_type.supports_reprocess:
3899
raise errors.BzrCommandError("Conflict reduction is not supported"
3900
" for merge type %s." %
3902
if merger.reprocess and merger.show_base:
3903
raise errors.BzrCommandError("Cannot do conflict reduction and"
3906
def _get_merger_from_branch(self, tree, location, revision, remember,
3907
possible_transports, pb):
3908
"""Produce a merger from a location, assuming it refers to a branch."""
3909
from bzrlib.tag import _merge_tags_if_possible
3910
# find the branch locations
3911
other_loc, user_location = self._select_branch_location(tree, location,
3913
if revision is not None and len(revision) == 2:
3914
base_loc, _unused = self._select_branch_location(tree,
3915
location, revision, 0)
3917
base_loc = other_loc
3919
other_branch, other_path = Branch.open_containing(other_loc,
3920
possible_transports)
3921
if base_loc == other_loc:
3922
base_branch = other_branch
3924
base_branch, base_path = Branch.open_containing(base_loc,
3925
possible_transports)
3926
# Find the revision ids
3927
other_revision_id = None
3928
base_revision_id = None
3929
if revision is not None:
3930
if len(revision) >= 1:
3931
other_revision_id = revision[-1].as_revision_id(other_branch)
3932
if len(revision) == 2:
3933
base_revision_id = revision[0].as_revision_id(base_branch)
3934
if other_revision_id is None:
3935
other_revision_id = _mod_revision.ensure_null(
3936
other_branch.last_revision())
3937
# Remember where we merge from
3938
if ((remember or tree.branch.get_submit_branch() is None) and
3939
user_location is not None):
3940
tree.branch.set_submit_branch(other_branch.base)
3941
_merge_tags_if_possible(other_branch, tree.branch)
3942
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3943
other_revision_id, base_revision_id, other_branch, base_branch)
3944
if other_path != '':
3945
allow_pending = False
3946
merger.interesting_files = [other_path]
3948
allow_pending = True
3949
return merger, allow_pending
3951
def get_merger_from_uncommitted(self, tree, location, pb):
3952
"""Get a merger for uncommitted changes.
3954
:param tree: The tree the merger should apply to.
3955
:param location: The location containing uncommitted changes.
3956
:param pb: The progress bar to use for showing progress.
3958
location = self._select_branch_location(tree, location)[0]
3959
other_tree, other_path = WorkingTree.open_containing(location)
3960
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3961
if other_path != '':
3962
merger.interesting_files = [other_path]
3965
def _select_branch_location(self, tree, user_location, revision=None,
3967
"""Select a branch location, according to possible inputs.
3969
If provided, branches from ``revision`` are preferred. (Both
3970
``revision`` and ``index`` must be supplied.)
3972
Otherwise, the ``location`` parameter is used. If it is None, then the
3973
``submit`` or ``parent`` location is used, and a note is printed.
3975
:param tree: The working tree to select a branch for merging into
3976
:param location: The location entered by the user
3977
:param revision: The revision parameter to the command
3978
:param index: The index to use for the revision parameter. Negative
3979
indices are permitted.
3980
:return: (selected_location, user_location). The default location
3981
will be the user-entered location.
3983
if (revision is not None and index is not None
3984
and revision[index] is not None):
3985
branch = revision[index].get_branch()
3986
if branch is not None:
3987
return branch, branch
3988
if user_location is None:
3989
location = self._get_remembered(tree, 'Merging from')
3991
location = user_location
3992
return location, user_location
3994
def _get_remembered(self, tree, verb_string):
3995
"""Use tree.branch's parent if none was supplied.
3997
Report if the remembered location was used.
3999
stored_location = tree.branch.get_submit_branch()
4000
stored_location_type = "submit"
4001
if stored_location is None:
4002
stored_location = tree.branch.get_parent()
4003
stored_location_type = "parent"
4004
mutter("%s", stored_location)
4005
if stored_location is None:
4006
raise errors.BzrCommandError("No location specified or remembered")
4007
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4008
note(u"%s remembered %s location %s", verb_string,
4009
stored_location_type, display_url)
4010
return stored_location
4013
class cmd_remerge(Command):
4016
Use this if you want to try a different merge technique while resolving
4017
conflicts. Some merge techniques are better than others, and remerge
4018
lets you try different ones on different files.
4020
The options for remerge have the same meaning and defaults as the ones for
4021
merge. The difference is that remerge can (only) be run when there is a
4022
pending merge, and it lets you specify particular files.
4025
Re-do the merge of all conflicted files, and show the base text in
4026
conflict regions, in addition to the usual THIS and OTHER texts::
4028
bzr remerge --show-base
4030
Re-do the merge of "foobar", using the weave merge algorithm, with
4031
additional processing to reduce the size of conflict regions::
4033
bzr remerge --merge-type weave --reprocess foobar
4035
takes_args = ['file*']
4040
help="Show base revision text in conflicts."),
4043
def run(self, file_list=None, merge_type=None, show_base=False,
4045
if merge_type is None:
4046
merge_type = _mod_merge.Merge3Merger
4047
tree, file_list = tree_files(file_list)
4049
self.add_cleanup(tree.unlock)
4050
parents = tree.get_parent_ids()
4051
if len(parents) != 2:
4052
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4053
" merges. Not cherrypicking or"
4055
repository = tree.branch.repository
4056
interesting_ids = None
4058
conflicts = tree.conflicts()
4059
if file_list is not None:
4060
interesting_ids = set()
4061
for filename in file_list:
4062
file_id = tree.path2id(filename)
4064
raise errors.NotVersionedError(filename)
4065
interesting_ids.add(file_id)
4066
if tree.kind(file_id) != "directory":
4069
for name, ie in tree.inventory.iter_entries(file_id):
4070
interesting_ids.add(ie.file_id)
4071
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4073
# Remerge only supports resolving contents conflicts
4074
allowed_conflicts = ('text conflict', 'contents conflict')
4075
restore_files = [c.path for c in conflicts
4076
if c.typestring in allowed_conflicts]
4077
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4078
tree.set_conflicts(ConflictList(new_conflicts))
4079
if file_list is not None:
4080
restore_files = file_list
4081
for filename in restore_files:
4083
restore(tree.abspath(filename))
4084
except errors.NotConflicted:
4086
# Disable pending merges, because the file texts we are remerging
4087
# have not had those merges performed. If we use the wrong parents
4088
# list, we imply that the working tree text has seen and rejected
4089
# all the changes from the other tree, when in fact those changes
4090
# have not yet been seen.
4091
tree.set_parent_ids(parents[:1])
4093
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4094
merger.interesting_ids = interesting_ids
4095
merger.merge_type = merge_type
4096
merger.show_base = show_base
4097
merger.reprocess = reprocess
4098
conflicts = merger.do_merge()
4100
tree.set_parent_ids(parents)
4107
class cmd_revert(Command):
4108
"""Revert files to a previous revision.
4110
Giving a list of files will revert only those files. Otherwise, all files
4111
will be reverted. If the revision is not specified with '--revision', the
4112
last committed revision is used.
4114
To remove only some changes, without reverting to a prior version, use
4115
merge instead. For example, "merge . --revision -2..-3" will remove the
4116
changes introduced by -2, without affecting the changes introduced by -1.
4117
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4119
By default, any files that have been manually changed will be backed up
4120
first. (Files changed only by merge are not backed up.) Backup files have
4121
'.~#~' appended to their name, where # is a number.
4123
When you provide files, you can use their current pathname or the pathname
4124
from the target revision. So you can use revert to "undelete" a file by
4125
name. If you name a directory, all the contents of that directory will be
4128
If you have newly added files since the target revision, they will be
4129
removed. If the files to be removed have been changed, backups will be
4130
created as above. Directories containing unknown files will not be
4133
The working tree contains a list of revisions that have been merged but
4134
not yet committed. These revisions will be included as additional parents
4135
of the next commit. Normally, using revert clears that list as well as
4136
reverting the files. If any files are specified, revert leaves the list
4137
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4138
.`` in the tree root to revert all files but keep the recorded merges,
4139
and ``bzr revert --forget-merges`` to clear the pending merge list without
4140
reverting any files.
4142
Using "bzr revert --forget-merges", it is possible to apply all of the
4143
changes from a branch in a single revision. To do this, perform the merge
4144
as desired. Then doing revert with the "--forget-merges" option will keep
4145
the content of the tree as it was, but it will clear the list of pending
4146
merges. The next commit will then contain all of the changes that are
4147
present in the other branch, but without any other parent revisions.
4148
Because this technique forgets where these changes originated, it may
4149
cause additional conflicts on later merges involving the same source and
4153
_see_also = ['cat', 'export']
4156
Option('no-backup', "Do not save backups of reverted files."),
4157
Option('forget-merges',
4158
'Remove pending merge marker, without changing any files.'),
4160
takes_args = ['file*']
4162
def run(self, revision=None, no_backup=False, file_list=None,
4163
forget_merges=None):
4164
tree, file_list = tree_files(file_list)
4166
self.add_cleanup(tree.unlock)
4168
tree.set_parent_ids(tree.get_parent_ids()[:1])
4170
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4173
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4174
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4175
tree.revert(file_list, rev_tree, not no_backup, None,
4176
report_changes=True)
4179
class cmd_assert_fail(Command):
4180
"""Test reporting of assertion failures"""
4181
# intended just for use in testing
4186
raise AssertionError("always fails")
4189
class cmd_help(Command):
4190
"""Show help on a command or other topic.
4193
_see_also = ['topics']
4195
Option('long', 'Show help on all commands.'),
4197
takes_args = ['topic?']
4198
aliases = ['?', '--help', '-?', '-h']
4201
def run(self, topic=None, long=False):
4203
if topic is None and long:
4205
bzrlib.help.help(topic)
4208
class cmd_shell_complete(Command):
4209
"""Show appropriate completions for context.
4211
For a list of all available commands, say 'bzr shell-complete'.
4213
takes_args = ['context?']
4218
def run(self, context=None):
4219
import shellcomplete
4220
shellcomplete.shellcomplete(context)
4223
class cmd_missing(Command):
4224
"""Show unmerged/unpulled revisions between two branches.
4226
OTHER_BRANCH may be local or remote.
4228
To filter on a range of revisions, you can use the command -r begin..end
4229
-r revision requests a specific revision, -r ..end or -r begin.. are
4233
1 - some missing revisions
4234
0 - no missing revisions
4238
Determine the missing revisions between this and the branch at the
4239
remembered pull location::
4243
Determine the missing revisions between this and another branch::
4245
bzr missing http://server/branch
4247
Determine the missing revisions up to a specific revision on the other
4250
bzr missing -r ..-10
4252
Determine the missing revisions up to a specific revision on this
4255
bzr missing --my-revision ..-10
4258
_see_also = ['merge', 'pull']
4259
takes_args = ['other_branch?']
4261
Option('reverse', 'Reverse the order of revisions.'),
4263
'Display changes in the local branch only.'),
4264
Option('this' , 'Same as --mine-only.'),
4265
Option('theirs-only',
4266
'Display changes in the remote branch only.'),
4267
Option('other', 'Same as --theirs-only.'),
4271
custom_help('revision',
4272
help='Filter on other branch revisions (inclusive). '
4273
'See "help revisionspec" for details.'),
4274
Option('my-revision',
4275
type=_parse_revision_str,
4276
help='Filter on local branch revisions (inclusive). '
4277
'See "help revisionspec" for details.'),
4278
Option('include-merges',
4279
'Show all revisions in addition to the mainline ones.'),
4281
encoding_type = 'replace'
4284
def run(self, other_branch=None, reverse=False, mine_only=False,
4286
log_format=None, long=False, short=False, line=False,
4287
show_ids=False, verbose=False, this=False, other=False,
4288
include_merges=False, revision=None, my_revision=None):
4289
from bzrlib.missing import find_unmerged, iter_log_revisions
4298
# TODO: We should probably check that we don't have mine-only and
4299
# theirs-only set, but it gets complicated because we also have
4300
# this and other which could be used.
4307
local_branch = Branch.open_containing(u".")[0]
4308
parent = local_branch.get_parent()
4309
if other_branch is None:
4310
other_branch = parent
4311
if other_branch is None:
4312
raise errors.BzrCommandError("No peer location known"
4314
display_url = urlutils.unescape_for_display(parent,
4316
message("Using saved parent location: "
4317
+ display_url + "\n")
4319
remote_branch = Branch.open(other_branch)
4320
if remote_branch.base == local_branch.base:
4321
remote_branch = local_branch
4323
local_branch.lock_read()
4324
self.add_cleanup(local_branch.unlock)
4325
local_revid_range = _revision_range_to_revid_range(
4326
_get_revision_range(my_revision, local_branch,
4329
remote_branch.lock_read()
4330
self.add_cleanup(remote_branch.unlock)
4331
remote_revid_range = _revision_range_to_revid_range(
4332
_get_revision_range(revision,
4333
remote_branch, self.name()))
4335
local_extra, remote_extra = find_unmerged(
4336
local_branch, remote_branch, restrict,
4337
backward=not reverse,
4338
include_merges=include_merges,
4339
local_revid_range=local_revid_range,
4340
remote_revid_range=remote_revid_range)
4342
if log_format is None:
4343
registry = log.log_formatter_registry
4344
log_format = registry.get_default(local_branch)
4345
lf = log_format(to_file=self.outf,
4347
show_timezone='original')
4350
if local_extra and not theirs_only:
4351
message("You have %d extra revision(s):\n" %
4353
for revision in iter_log_revisions(local_extra,
4354
local_branch.repository,
4356
lf.log_revision(revision)
4357
printed_local = True
4360
printed_local = False
4362
if remote_extra and not mine_only:
4363
if printed_local is True:
4365
message("You are missing %d revision(s):\n" %
4367
for revision in iter_log_revisions(remote_extra,
4368
remote_branch.repository,
4370
lf.log_revision(revision)
4373
if mine_only and not local_extra:
4374
# We checked local, and found nothing extra
4375
message('This branch is up to date.\n')
4376
elif theirs_only and not remote_extra:
4377
# We checked remote, and found nothing extra
4378
message('Other branch is up to date.\n')
4379
elif not (mine_only or theirs_only or local_extra or
4381
# We checked both branches, and neither one had extra
4383
message("Branches are up to date.\n")
4385
if not status_code and parent is None and other_branch is not None:
4386
local_branch.lock_write()
4387
self.add_cleanup(local_branch.unlock)
4388
# handle race conditions - a parent might be set while we run.
4389
if local_branch.get_parent() is None:
4390
local_branch.set_parent(remote_branch.base)
4394
class cmd_pack(Command):
4395
"""Compress the data within a repository."""
4397
_see_also = ['repositories']
4398
takes_args = ['branch_or_repo?']
4400
def run(self, branch_or_repo='.'):
4401
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4403
branch = dir.open_branch()
4404
repository = branch.repository
4405
except errors.NotBranchError:
4406
repository = dir.open_repository()
4410
class cmd_plugins(Command):
4411
"""List the installed plugins.
4413
This command displays the list of installed plugins including
4414
version of plugin and a short description of each.
4416
--verbose shows the path where each plugin is located.
4418
A plugin is an external component for Bazaar that extends the
4419
revision control system, by adding or replacing code in Bazaar.
4420
Plugins can do a variety of things, including overriding commands,
4421
adding new commands, providing additional network transports and
4422
customizing log output.
4424
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4425
for further information on plugins including where to find them and how to
4426
install them. Instructions are also provided there on how to write new
4427
plugins using the Python programming language.
4429
takes_options = ['verbose']
4432
def run(self, verbose=False):
4433
import bzrlib.plugin
4434
from inspect import getdoc
4436
for name, plugin in bzrlib.plugin.plugins().items():
4437
version = plugin.__version__
4438
if version == 'unknown':
4440
name_ver = '%s %s' % (name, version)
4441
d = getdoc(plugin.module)
4443
doc = d.split('\n')[0]
4445
doc = '(no description)'
4446
result.append((name_ver, doc, plugin.path()))
4447
for name_ver, doc, path in sorted(result):
4448
self.outf.write("%s\n" % name_ver)
4449
self.outf.write(" %s\n" % doc)
4451
self.outf.write(" %s\n" % path)
4452
self.outf.write("\n")
4455
class cmd_testament(Command):
4456
"""Show testament (signing-form) of a revision."""
4459
Option('long', help='Produce long-format testament.'),
4461
help='Produce a strict-format testament.')]
4462
takes_args = ['branch?']
4464
def run(self, branch=u'.', revision=None, long=False, strict=False):
4465
from bzrlib.testament import Testament, StrictTestament
4467
testament_class = StrictTestament
4469
testament_class = Testament
4471
b = Branch.open_containing(branch)[0]
4473
b = Branch.open(branch)
4475
self.add_cleanup(b.unlock)
4476
if revision is None:
4477
rev_id = b.last_revision()
4479
rev_id = revision[0].as_revision_id(b)
4480
t = testament_class.from_revision(b.repository, rev_id)
4482
sys.stdout.writelines(t.as_text_lines())
4484
sys.stdout.write(t.as_short_text())
4487
class cmd_annotate(Command):
4488
"""Show the origin of each line in a file.
4490
This prints out the given file with an annotation on the left side
4491
indicating which revision, author and date introduced the change.
4493
If the origin is the same for a run of consecutive lines, it is
4494
shown only at the top, unless the --all option is given.
4496
# TODO: annotate directories; showing when each file was last changed
4497
# TODO: if the working copy is modified, show annotations on that
4498
# with new uncommitted lines marked
4499
aliases = ['ann', 'blame', 'praise']
4500
takes_args = ['filename']
4501
takes_options = [Option('all', help='Show annotations on all lines.'),
4502
Option('long', help='Show commit date in annotations.'),
4506
encoding_type = 'exact'
4509
def run(self, filename, all=False, long=False, revision=None,
4511
from bzrlib.annotate import annotate_file, annotate_file_tree
4512
wt, branch, relpath = \
4513
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4516
self.add_cleanup(wt.unlock)
4519
self.add_cleanup(branch.unlock)
4520
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4522
self.add_cleanup(tree.unlock)
4524
file_id = wt.path2id(relpath)
4526
file_id = tree.path2id(relpath)
4528
raise errors.NotVersionedError(filename)
4529
file_version = tree.inventory[file_id].revision
4530
if wt is not None and revision is None:
4531
# If there is a tree and we're not annotating historical
4532
# versions, annotate the working tree's content.
4533
annotate_file_tree(wt, file_id, self.outf, long, all,
4536
annotate_file(branch, file_version, file_id, long, all, self.outf,
4540
class cmd_re_sign(Command):
4541
"""Create a digital signature for an existing revision."""
4542
# TODO be able to replace existing ones.
4544
hidden = True # is this right ?
4545
takes_args = ['revision_id*']
4546
takes_options = ['revision']
4548
def run(self, revision_id_list=None, revision=None):
4549
if revision_id_list is not None and revision is not None:
4550
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4551
if revision_id_list is None and revision is None:
4552
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4553
b = WorkingTree.open_containing(u'.')[0].branch
4555
self.add_cleanup(b.unlock)
4556
return self._run(b, revision_id_list, revision)
4558
def _run(self, b, revision_id_list, revision):
4559
import bzrlib.gpg as gpg
4560
gpg_strategy = gpg.GPGStrategy(b.get_config())
4561
if revision_id_list is not None:
4562
b.repository.start_write_group()
4564
for revision_id in revision_id_list:
4565
b.repository.sign_revision(revision_id, gpg_strategy)
4567
b.repository.abort_write_group()
4570
b.repository.commit_write_group()
4571
elif revision is not None:
4572
if len(revision) == 1:
4573
revno, rev_id = revision[0].in_history(b)
4574
b.repository.start_write_group()
4576
b.repository.sign_revision(rev_id, gpg_strategy)
4578
b.repository.abort_write_group()
4581
b.repository.commit_write_group()
4582
elif len(revision) == 2:
4583
# are they both on rh- if so we can walk between them
4584
# might be nice to have a range helper for arbitrary
4585
# revision paths. hmm.
4586
from_revno, from_revid = revision[0].in_history(b)
4587
to_revno, to_revid = revision[1].in_history(b)
4588
if to_revid is None:
4589
to_revno = b.revno()
4590
if from_revno is None or to_revno is None:
4591
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4592
b.repository.start_write_group()
4594
for revno in range(from_revno, to_revno + 1):
4595
b.repository.sign_revision(b.get_rev_id(revno),
4598
b.repository.abort_write_group()
4601
b.repository.commit_write_group()
4603
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4606
class cmd_bind(Command):
4607
"""Convert the current branch into a checkout of the supplied branch.
4609
Once converted into a checkout, commits must succeed on the master branch
4610
before they will be applied to the local branch.
4612
Bound branches use the nickname of its master branch unless it is set
4613
locally, in which case binding will update the local nickname to be
4617
_see_also = ['checkouts', 'unbind']
4618
takes_args = ['location?']
4621
def run(self, location=None):
4622
b, relpath = Branch.open_containing(u'.')
4623
if location is None:
4625
location = b.get_old_bound_location()
4626
except errors.UpgradeRequired:
4627
raise errors.BzrCommandError('No location supplied. '
4628
'This format does not remember old locations.')
4630
if location is None:
4631
if b.get_bound_location() is not None:
4632
raise errors.BzrCommandError('Branch is already bound')
4634
raise errors.BzrCommandError('No location supplied '
4635
'and no previous location known')
4636
b_other = Branch.open(location)
4639
except errors.DivergedBranches:
4640
raise errors.BzrCommandError('These branches have diverged.'
4641
' Try merging, and then bind again.')
4642
if b.get_config().has_explicit_nickname():
4643
b.nick = b_other.nick
4646
class cmd_unbind(Command):
4647
"""Convert the current checkout into a regular branch.
4649
After unbinding, the local branch is considered independent and subsequent
4650
commits will be local only.
4653
_see_also = ['checkouts', 'bind']
4658
b, relpath = Branch.open_containing(u'.')
4660
raise errors.BzrCommandError('Local branch is not bound')
4663
class cmd_uncommit(Command):
4664
"""Remove the last committed revision.
4666
--verbose will print out what is being removed.
4667
--dry-run will go through all the motions, but not actually
4670
If --revision is specified, uncommit revisions to leave the branch at the
4671
specified revision. For example, "bzr uncommit -r 15" will leave the
4672
branch at revision 15.
4674
Uncommit leaves the working tree ready for a new commit. The only change
4675
it may make is to restore any pending merges that were present before
4679
# TODO: jam 20060108 Add an option to allow uncommit to remove
4680
# unreferenced information in 'branch-as-repository' branches.
4681
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4682
# information in shared branches as well.
4683
_see_also = ['commit']
4684
takes_options = ['verbose', 'revision',
4685
Option('dry-run', help='Don\'t actually make changes.'),
4686
Option('force', help='Say yes to all questions.'),
4688
help="Only remove the commits from the local branch"
4689
" when in a checkout."
4692
takes_args = ['location?']
4694
encoding_type = 'replace'
4696
def run(self, location=None,
4697
dry_run=False, verbose=False,
4698
revision=None, force=False, local=False):
4699
if location is None:
4701
control, relpath = bzrdir.BzrDir.open_containing(location)
4703
tree = control.open_workingtree()
4705
except (errors.NoWorkingTree, errors.NotLocalUrl):
4707
b = control.open_branch()
4709
if tree is not None:
4711
self.add_cleanup(tree.unlock)
4714
self.add_cleanup(b.unlock)
4715
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4717
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4718
from bzrlib.log import log_formatter, show_log
4719
from bzrlib.uncommit import uncommit
4721
last_revno, last_rev_id = b.last_revision_info()
4724
if revision is None:
4726
rev_id = last_rev_id
4728
# 'bzr uncommit -r 10' actually means uncommit
4729
# so that the final tree is at revno 10.
4730
# but bzrlib.uncommit.uncommit() actually uncommits
4731
# the revisions that are supplied.
4732
# So we need to offset it by one
4733
revno = revision[0].in_history(b).revno + 1
4734
if revno <= last_revno:
4735
rev_id = b.get_rev_id(revno)
4737
if rev_id is None or _mod_revision.is_null(rev_id):
4738
self.outf.write('No revisions to uncommit.\n')
4741
lf = log_formatter('short',
4743
show_timezone='original')
4748
direction='forward',
4749
start_revision=revno,
4750
end_revision=last_revno)
4753
self.outf.write('Dry-run, pretending to remove'
4754
' the above revisions.\n')
4756
self.outf.write('The above revision(s) will be removed.\n')
4759
if not ui.ui_factory.get_boolean('Are you sure'):
4760
self.outf.write('Canceled')
4763
mutter('Uncommitting from {%s} to {%s}',
4764
last_rev_id, rev_id)
4765
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4766
revno=revno, local=local)
4767
self.outf.write('You can restore the old tip by running:\n'
4768
' bzr pull . -r revid:%s\n' % last_rev_id)
4771
class cmd_break_lock(Command):
4772
"""Break a dead lock on a repository, branch or working directory.
4774
CAUTION: Locks should only be broken when you are sure that the process
4775
holding the lock has been stopped.
4777
You can get information on what locks are open via the 'bzr info
4778
[location]' command.
4782
bzr break-lock bzr+ssh://example.com/bzr/foo
4784
takes_args = ['location?']
4786
def run(self, location=None, show=False):
4787
if location is None:
4789
control, relpath = bzrdir.BzrDir.open_containing(location)
4791
control.break_lock()
4792
except NotImplementedError:
4796
class cmd_wait_until_signalled(Command):
4797
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4799
This just prints a line to signal when it is ready, then blocks on stdin.
4805
sys.stdout.write("running\n")
4807
sys.stdin.readline()
4810
class cmd_serve(Command):
4811
"""Run the bzr server."""
4813
aliases = ['server']
4817
help='Serve on stdin/out for use from inetd or sshd.'),
4818
RegistryOption('protocol',
4819
help="Protocol to serve.",
4820
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4821
value_switches=True),
4823
help='Listen for connections on nominated port of the form '
4824
'[hostname:]portnumber. Passing 0 as the port number will '
4825
'result in a dynamically allocated port. The default port '
4826
'depends on the protocol.',
4829
help='Serve contents of this directory.',
4831
Option('allow-writes',
4832
help='By default the server is a readonly server. Supplying '
4833
'--allow-writes enables write access to the contents of '
4834
'the served directory and below. Note that ``bzr serve`` '
4835
'does not perform authentication, so unless some form of '
4836
'external authentication is arranged supplying this '
4837
'option leads to global uncontrolled write access to your '
4842
def get_host_and_port(self, port):
4843
"""Return the host and port to run the smart server on.
4845
If 'port' is None, None will be returned for the host and port.
4847
If 'port' has a colon in it, the string before the colon will be
4848
interpreted as the host.
4850
:param port: A string of the port to run the server on.
4851
:return: A tuple of (host, port), where 'host' is a host name or IP,
4852
and port is an integer TCP/IP port.
4855
if port is not None:
4857
host, port = port.split(':')
4861
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4863
from bzrlib.transport import get_transport, transport_server_registry
4864
if directory is None:
4865
directory = os.getcwd()
4866
if protocol is None:
4867
protocol = transport_server_registry.get()
4868
host, port = self.get_host_and_port(port)
4869
url = urlutils.local_path_to_url(directory)
4870
if not allow_writes:
4871
url = 'readonly+' + url
4872
transport = get_transport(url)
4873
protocol(transport, host, port, inet)
4876
class cmd_join(Command):
4877
"""Combine a tree into its containing tree.
4879
This command requires the target tree to be in a rich-root format.
4881
The TREE argument should be an independent tree, inside another tree, but
4882
not part of it. (Such trees can be produced by "bzr split", but also by
4883
running "bzr branch" with the target inside a tree.)
4885
The result is a combined tree, with the subtree no longer an independant
4886
part. This is marked as a merge of the subtree into the containing tree,
4887
and all history is preserved.
4890
_see_also = ['split']
4891
takes_args = ['tree']
4893
Option('reference', help='Join by reference.', hidden=True),
4896
def run(self, tree, reference=False):
4897
sub_tree = WorkingTree.open(tree)
4898
parent_dir = osutils.dirname(sub_tree.basedir)
4899
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4900
repo = containing_tree.branch.repository
4901
if not repo.supports_rich_root():
4902
raise errors.BzrCommandError(
4903
"Can't join trees because %s doesn't support rich root data.\n"
4904
"You can use bzr upgrade on the repository."
4908
containing_tree.add_reference(sub_tree)
4909
except errors.BadReferenceTarget, e:
4910
# XXX: Would be better to just raise a nicely printable
4911
# exception from the real origin. Also below. mbp 20070306
4912
raise errors.BzrCommandError("Cannot join %s. %s" %
4916
containing_tree.subsume(sub_tree)
4917
except errors.BadSubsumeSource, e:
4918
raise errors.BzrCommandError("Cannot join %s. %s" %
4922
class cmd_split(Command):
4923
"""Split a subdirectory of a tree into a separate tree.
4925
This command will produce a target tree in a format that supports
4926
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4927
converted into earlier formats like 'dirstate-tags'.
4929
The TREE argument should be a subdirectory of a working tree. That
4930
subdirectory will be converted into an independent tree, with its own
4931
branch. Commits in the top-level tree will not apply to the new subtree.
4934
_see_also = ['join']
4935
takes_args = ['tree']
4937
def run(self, tree):
4938
containing_tree, subdir = WorkingTree.open_containing(tree)
4939
sub_id = containing_tree.path2id(subdir)
4941
raise errors.NotVersionedError(subdir)
4943
containing_tree.extract(sub_id)
4944
except errors.RootNotRich:
4945
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4948
class cmd_merge_directive(Command):
4949
"""Generate a merge directive for auto-merge tools.
4951
A directive requests a merge to be performed, and also provides all the
4952
information necessary to do so. This means it must either include a
4953
revision bundle, or the location of a branch containing the desired
4956
A submit branch (the location to merge into) must be supplied the first
4957
time the command is issued. After it has been supplied once, it will
4958
be remembered as the default.
4960
A public branch is optional if a revision bundle is supplied, but required
4961
if --diff or --plain is specified. It will be remembered as the default
4962
after the first use.
4965
takes_args = ['submit_branch?', 'public_branch?']
4969
_see_also = ['send']
4972
RegistryOption.from_kwargs('patch-type',
4973
'The type of patch to include in the directive.',
4975
value_switches=True,
4977
bundle='Bazaar revision bundle (default).',
4978
diff='Normal unified diff.',
4979
plain='No patch, just directive.'),
4980
Option('sign', help='GPG-sign the directive.'), 'revision',
4981
Option('mail-to', type=str,
4982
help='Instead of printing the directive, email to this address.'),
4983
Option('message', type=str, short_name='m',
4984
help='Message to use when committing this merge.')
4987
encoding_type = 'exact'
4989
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4990
sign=False, revision=None, mail_to=None, message=None):
4991
from bzrlib.revision import ensure_null, NULL_REVISION
4992
include_patch, include_bundle = {
4993
'plain': (False, False),
4994
'diff': (True, False),
4995
'bundle': (True, True),
4997
branch = Branch.open('.')
4998
stored_submit_branch = branch.get_submit_branch()
4999
if submit_branch is None:
5000
submit_branch = stored_submit_branch
5002
if stored_submit_branch is None:
5003
branch.set_submit_branch(submit_branch)
5004
if submit_branch is None:
5005
submit_branch = branch.get_parent()
5006
if submit_branch is None:
5007
raise errors.BzrCommandError('No submit branch specified or known')
5009
stored_public_branch = branch.get_public_branch()
5010
if public_branch is None:
5011
public_branch = stored_public_branch
5012
elif stored_public_branch is None:
5013
branch.set_public_branch(public_branch)
5014
if not include_bundle and public_branch is None:
5015
raise errors.BzrCommandError('No public branch specified or'
5017
base_revision_id = None
5018
if revision is not None:
5019
if len(revision) > 2:
5020
raise errors.BzrCommandError('bzr merge-directive takes '
5021
'at most two one revision identifiers')
5022
revision_id = revision[-1].as_revision_id(branch)
5023
if len(revision) == 2:
5024
base_revision_id = revision[0].as_revision_id(branch)
5026
revision_id = branch.last_revision()
5027
revision_id = ensure_null(revision_id)
5028
if revision_id == NULL_REVISION:
5029
raise errors.BzrCommandError('No revisions to bundle.')
5030
directive = merge_directive.MergeDirective2.from_objects(
5031
branch.repository, revision_id, time.time(),
5032
osutils.local_time_offset(), submit_branch,
5033
public_branch=public_branch, include_patch=include_patch,
5034
include_bundle=include_bundle, message=message,
5035
base_revision_id=base_revision_id)
5038
self.outf.write(directive.to_signed(branch))
5040
self.outf.writelines(directive.to_lines())
5042
message = directive.to_email(mail_to, branch, sign)
5043
s = SMTPConnection(branch.get_config())
5044
s.send_email(message)
5047
class cmd_send(Command):
5048
"""Mail or create a merge-directive for submitting changes.
5050
A merge directive provides many things needed for requesting merges:
5052
* A machine-readable description of the merge to perform
5054
* An optional patch that is a preview of the changes requested
5056
* An optional bundle of revision data, so that the changes can be applied
5057
directly from the merge directive, without retrieving data from a
5060
`bzr send` creates a compact data set that, when applied using bzr
5061
merge, has the same effect as merging from the source branch.
5063
By default the merge directive is self-contained and can be applied to any
5064
branch containing submit_branch in its ancestory without needing access to
5067
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5068
revisions, but only a structured request to merge from the
5069
public_location. In that case the public_branch is needed and it must be
5070
up-to-date and accessible to the recipient. The public_branch is always
5071
included if known, so that people can check it later.
5073
The submit branch defaults to the parent of the source branch, but can be
5074
overridden. Both submit branch and public branch will be remembered in
5075
branch.conf the first time they are used for a particular branch. The
5076
source branch defaults to that containing the working directory, but can
5077
be changed using --from.
5079
In order to calculate those changes, bzr must analyse the submit branch.
5080
Therefore it is most efficient for the submit branch to be a local mirror.
5081
If a public location is known for the submit_branch, that location is used
5082
in the merge directive.
5084
The default behaviour is to send the merge directive by mail, unless -o is
5085
given, in which case it is sent to a file.
5087
Mail is sent using your preferred mail program. This should be transparent
5088
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5089
If the preferred client can't be found (or used), your editor will be used.
5091
To use a specific mail program, set the mail_client configuration option.
5092
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5093
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5094
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5095
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5098
If mail is being sent, a to address is required. This can be supplied
5099
either on the commandline, by setting the submit_to configuration
5100
option in the branch itself or the child_submit_to configuration option
5101
in the submit branch.
5103
Two formats are currently supported: "4" uses revision bundle format 4 and
5104
merge directive format 2. It is significantly faster and smaller than
5105
older formats. It is compatible with Bazaar 0.19 and later. It is the
5106
default. "0.9" uses revision bundle format 0.9 and merge directive
5107
format 1. It is compatible with Bazaar 0.12 - 0.18.
5109
The merge directives created by bzr send may be applied using bzr merge or
5110
bzr pull by specifying a file containing a merge directive as the location.
5112
bzr send makes extensive use of public locations to map local locations into
5113
URLs that can be used by other people. See `bzr help configuration` to
5114
set them, and use `bzr info` to display them.
5117
encoding_type = 'exact'
5119
_see_also = ['merge', 'pull']
5121
takes_args = ['submit_branch?', 'public_branch?']
5125
help='Do not include a bundle in the merge directive.'),
5126
Option('no-patch', help='Do not include a preview patch in the merge'
5129
help='Remember submit and public branch.'),
5131
help='Branch to generate the submission from, '
5132
'rather than the one containing the working directory.',
5135
Option('output', short_name='o',
5136
help='Write merge directive to this file; '
5137
'use - for stdout.',
5140
help='Refuse to send if there are uncommitted changes in'
5141
' the working tree, --no-strict disables the check.'),
5142
Option('mail-to', help='Mail the request to this address.',
5146
Option('body', help='Body for the email.', type=unicode),
5147
RegistryOption('format',
5148
help='Use the specified output format.',
5149
lazy_registry=('bzrlib.send', 'format_registry')),
5152
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5153
no_patch=False, revision=None, remember=False, output=None,
5154
format=None, mail_to=None, message=None, body=None,
5155
strict=None, **kwargs):
5156
from bzrlib.send import send
5157
return send(submit_branch, revision, public_branch, remember,
5158
format, no_bundle, no_patch, output,
5159
kwargs.get('from', '.'), mail_to, message, body,
5164
class cmd_bundle_revisions(cmd_send):
5165
"""Create a merge-directive for submitting changes.
5167
A merge directive provides many things needed for requesting merges:
5169
* A machine-readable description of the merge to perform
5171
* An optional patch that is a preview of the changes requested
5173
* An optional bundle of revision data, so that the changes can be applied
5174
directly from the merge directive, without retrieving data from a
5177
If --no-bundle is specified, then public_branch is needed (and must be
5178
up-to-date), so that the receiver can perform the merge using the
5179
public_branch. The public_branch is always included if known, so that
5180
people can check it later.
5182
The submit branch defaults to the parent, but can be overridden. Both
5183
submit branch and public branch will be remembered if supplied.
5185
If a public_branch is known for the submit_branch, that public submit
5186
branch is used in the merge instructions. This means that a local mirror
5187
can be used as your actual submit branch, once you have set public_branch
5190
Two formats are currently supported: "4" uses revision bundle format 4 and
5191
merge directive format 2. It is significantly faster and smaller than
5192
older formats. It is compatible with Bazaar 0.19 and later. It is the
5193
default. "0.9" uses revision bundle format 0.9 and merge directive
5194
format 1. It is compatible with Bazaar 0.12 - 0.18.
5199
help='Do not include a bundle in the merge directive.'),
5200
Option('no-patch', help='Do not include a preview patch in the merge'
5203
help='Remember submit and public branch.'),
5205
help='Branch to generate the submission from, '
5206
'rather than the one containing the working directory.',
5209
Option('output', short_name='o', help='Write directive to this file.',
5212
help='Refuse to bundle revisions if there are uncommitted'
5213
' changes in the working tree, --no-strict disables the check.'),
5215
RegistryOption('format',
5216
help='Use the specified output format.',
5217
lazy_registry=('bzrlib.send', 'format_registry')),
5219
aliases = ['bundle']
5221
_see_also = ['send', 'merge']
5225
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5226
no_patch=False, revision=None, remember=False, output=None,
5227
format=None, strict=None, **kwargs):
5230
from bzrlib.send import send
5231
return send(submit_branch, revision, public_branch, remember,
5232
format, no_bundle, no_patch, output,
5233
kwargs.get('from', '.'), None, None, None,
5234
self.outf, strict=strict)
5237
class cmd_tag(Command):
5238
"""Create, remove or modify a tag naming a revision.
5240
Tags give human-meaningful names to revisions. Commands that take a -r
5241
(--revision) option can be given -rtag:X, where X is any previously
5244
Tags are stored in the branch. Tags are copied from one branch to another
5245
along when you branch, push, pull or merge.
5247
It is an error to give a tag name that already exists unless you pass
5248
--force, in which case the tag is moved to point to the new revision.
5250
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5251
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5254
_see_also = ['commit', 'tags']
5255
takes_args = ['tag_name']
5258
help='Delete this tag rather than placing it.',
5261
help='Branch in which to place the tag.',
5266
help='Replace existing tags.',
5271
def run(self, tag_name,
5277
branch, relpath = Branch.open_containing(directory)
5279
self.add_cleanup(branch.unlock)
5281
branch.tags.delete_tag(tag_name)
5282
self.outf.write('Deleted tag %s.\n' % tag_name)
5285
if len(revision) != 1:
5286
raise errors.BzrCommandError(
5287
"Tags can only be placed on a single revision, "
5289
revision_id = revision[0].as_revision_id(branch)
5291
revision_id = branch.last_revision()
5292
if (not force) and branch.tags.has_tag(tag_name):
5293
raise errors.TagAlreadyExists(tag_name)
5294
branch.tags.set_tag(tag_name, revision_id)
5295
self.outf.write('Created tag %s.\n' % tag_name)
5298
class cmd_tags(Command):
5301
This command shows a table of tag names and the revisions they reference.
5307
help='Branch whose tags should be displayed.',
5311
RegistryOption.from_kwargs('sort',
5312
'Sort tags by different criteria.', title='Sorting',
5313
alpha='Sort tags lexicographically (default).',
5314
time='Sort tags chronologically.',
5327
branch, relpath = Branch.open_containing(directory)
5329
tags = branch.tags.get_tag_dict().items()
5334
self.add_cleanup(branch.unlock)
5336
graph = branch.repository.get_graph()
5337
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5338
revid1, revid2 = rev1.rev_id, rev2.rev_id
5339
# only show revisions between revid1 and revid2 (inclusive)
5340
tags = [(tag, revid) for tag, revid in tags if
5341
graph.is_between(revid, revid1, revid2)]
5344
elif sort == 'time':
5346
for tag, revid in tags:
5348
revobj = branch.repository.get_revision(revid)
5349
except errors.NoSuchRevision:
5350
timestamp = sys.maxint # place them at the end
5352
timestamp = revobj.timestamp
5353
timestamps[revid] = timestamp
5354
tags.sort(key=lambda x: timestamps[x[1]])
5356
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5357
for index, (tag, revid) in enumerate(tags):
5359
revno = branch.revision_id_to_dotted_revno(revid)
5360
if isinstance(revno, tuple):
5361
revno = '.'.join(map(str, revno))
5362
except errors.NoSuchRevision:
5363
# Bad tag data/merges can lead to tagged revisions
5364
# which are not in this branch. Fail gracefully ...
5366
tags[index] = (tag, revno)
5368
for tag, revspec in tags:
5369
self.outf.write('%-20s %s\n' % (tag, revspec))
5372
class cmd_reconfigure(Command):
5373
"""Reconfigure the type of a bzr directory.
5375
A target configuration must be specified.
5377
For checkouts, the bind-to location will be auto-detected if not specified.
5378
The order of preference is
5379
1. For a lightweight checkout, the current bound location.
5380
2. For branches that used to be checkouts, the previously-bound location.
5381
3. The push location.
5382
4. The parent location.
5383
If none of these is available, --bind-to must be specified.
5386
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5387
takes_args = ['location?']
5389
RegistryOption.from_kwargs(
5391
title='Target type',
5392
help='The type to reconfigure the directory to.',
5393
value_switches=True, enum_switch=False,
5394
branch='Reconfigure to be an unbound branch with no working tree.',
5395
tree='Reconfigure to be an unbound branch with a working tree.',
5396
checkout='Reconfigure to be a bound branch with a working tree.',
5397
lightweight_checkout='Reconfigure to be a lightweight'
5398
' checkout (with no local history).',
5399
standalone='Reconfigure to be a standalone branch '
5400
'(i.e. stop using shared repository).',
5401
use_shared='Reconfigure to use a shared repository.',
5402
with_trees='Reconfigure repository to create '
5403
'working trees on branches by default.',
5404
with_no_trees='Reconfigure repository to not create '
5405
'working trees on branches by default.'
5407
Option('bind-to', help='Branch to bind checkout to.', type=str),
5409
help='Perform reconfiguration even if local changes'
5411
Option('stacked-on',
5412
help='Reconfigure a branch to be stacked on another branch.',
5416
help='Reconfigure a branch to be unstacked. This '
5417
'may require copying substantial data into it.',
5421
def run(self, location=None, target_type=None, bind_to=None, force=False,
5424
directory = bzrdir.BzrDir.open(location)
5425
if stacked_on and unstacked:
5426
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5427
elif stacked_on is not None:
5428
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5430
reconfigure.ReconfigureUnstacked().apply(directory)
5431
# At the moment you can use --stacked-on and a different
5432
# reconfiguration shape at the same time; there seems no good reason
5434
if target_type is None:
5435
if stacked_on or unstacked:
5438
raise errors.BzrCommandError('No target configuration '
5440
elif target_type == 'branch':
5441
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5442
elif target_type == 'tree':
5443
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5444
elif target_type == 'checkout':
5445
reconfiguration = reconfigure.Reconfigure.to_checkout(
5447
elif target_type == 'lightweight-checkout':
5448
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5450
elif target_type == 'use-shared':
5451
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5452
elif target_type == 'standalone':
5453
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5454
elif target_type == 'with-trees':
5455
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5457
elif target_type == 'with-no-trees':
5458
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5460
reconfiguration.apply(force)
5463
class cmd_switch(Command):
5464
"""Set the branch of a checkout and update.
5466
For lightweight checkouts, this changes the branch being referenced.
5467
For heavyweight checkouts, this checks that there are no local commits
5468
versus the current bound branch, then it makes the local branch a mirror
5469
of the new location and binds to it.
5471
In both cases, the working tree is updated and uncommitted changes
5472
are merged. The user can commit or revert these as they desire.
5474
Pending merges need to be committed or reverted before using switch.
5476
The path to the branch to switch to can be specified relative to the parent
5477
directory of the current branch. For example, if you are currently in a
5478
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5481
Bound branches use the nickname of its master branch unless it is set
5482
locally, in which case switching will update the local nickname to be
5486
takes_args = ['to_location?']
5487
takes_options = [Option('force',
5488
help='Switch even if local commits will be lost.'),
5490
Option('create-branch', short_name='b',
5491
help='Create the target branch from this one before'
5492
' switching to it.'),
5495
def run(self, to_location=None, force=False, create_branch=False,
5497
from bzrlib import switch
5499
revision = _get_one_revision('switch', revision)
5500
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5501
if to_location is None:
5502
if revision is None:
5503
raise errors.BzrCommandError('You must supply either a'
5504
' revision or a location')
5507
branch = control_dir.open_branch()
5508
had_explicit_nick = branch.get_config().has_explicit_nickname()
5509
except errors.NotBranchError:
5511
had_explicit_nick = False
5514
raise errors.BzrCommandError('cannot create branch without'
5516
to_location = directory_service.directories.dereference(
5518
if '/' not in to_location and '\\' not in to_location:
5519
# This path is meant to be relative to the existing branch
5520
this_url = self._get_branch_location(control_dir)
5521
to_location = urlutils.join(this_url, '..', to_location)
5522
to_branch = branch.bzrdir.sprout(to_location,
5523
possible_transports=[branch.bzrdir.root_transport],
5524
source_branch=branch).open_branch()
5527
to_branch = Branch.open(to_location)
5528
except errors.NotBranchError:
5529
this_url = self._get_branch_location(control_dir)
5530
to_branch = Branch.open(
5531
urlutils.join(this_url, '..', to_location))
5532
if revision is not None:
5533
revision = revision.as_revision_id(to_branch)
5534
switch.switch(control_dir, to_branch, force, revision_id=revision)
5535
if had_explicit_nick:
5536
branch = control_dir.open_branch() #get the new branch!
5537
branch.nick = to_branch.nick
5538
note('Switched to branch: %s',
5539
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5541
def _get_branch_location(self, control_dir):
5542
"""Return location of branch for this control dir."""
5544
this_branch = control_dir.open_branch()
5545
# This may be a heavy checkout, where we want the master branch
5546
master_location = this_branch.get_bound_location()
5547
if master_location is not None:
5548
return master_location
5549
# If not, use a local sibling
5550
return this_branch.base
5551
except errors.NotBranchError:
5552
format = control_dir.find_branch_format()
5553
if getattr(format, 'get_reference', None) is not None:
5554
return format.get_reference(control_dir)
5556
return control_dir.root_transport.base
5559
class cmd_view(Command):
5560
"""Manage filtered views.
5562
Views provide a mask over the tree so that users can focus on
5563
a subset of a tree when doing their work. After creating a view,
5564
commands that support a list of files - status, diff, commit, etc -
5565
effectively have that list of files implicitly given each time.
5566
An explicit list of files can still be given but those files
5567
must be within the current view.
5569
In most cases, a view has a short life-span: it is created to make
5570
a selected change and is deleted once that change is committed.
5571
At other times, you may wish to create one or more named views
5572
and switch between them.
5574
To disable the current view without deleting it, you can switch to
5575
the pseudo view called ``off``. This can be useful when you need
5576
to see the whole tree for an operation or two (e.g. merge) but
5577
want to switch back to your view after that.
5580
To define the current view::
5582
bzr view file1 dir1 ...
5584
To list the current view::
5588
To delete the current view::
5592
To disable the current view without deleting it::
5594
bzr view --switch off
5596
To define a named view and switch to it::
5598
bzr view --name view-name file1 dir1 ...
5600
To list a named view::
5602
bzr view --name view-name
5604
To delete a named view::
5606
bzr view --name view-name --delete
5608
To switch to a named view::
5610
bzr view --switch view-name
5612
To list all views defined::
5616
To delete all views::
5618
bzr view --delete --all
5622
takes_args = ['file*']
5625
help='Apply list or delete action to all views.',
5628
help='Delete the view.',
5631
help='Name of the view to define, list or delete.',
5635
help='Name of the view to switch to.',
5640
def run(self, file_list,
5646
tree, file_list = tree_files(file_list, apply_view=False)
5647
current_view, view_dict = tree.views.get_view_info()
5652
raise errors.BzrCommandError(
5653
"Both --delete and a file list specified")
5655
raise errors.BzrCommandError(
5656
"Both --delete and --switch specified")
5658
tree.views.set_view_info(None, {})
5659
self.outf.write("Deleted all views.\n")
5661
raise errors.BzrCommandError("No current view to delete")
5663
tree.views.delete_view(name)
5664
self.outf.write("Deleted '%s' view.\n" % name)
5667
raise errors.BzrCommandError(
5668
"Both --switch and a file list specified")
5670
raise errors.BzrCommandError(
5671
"Both --switch and --all specified")
5672
elif switch == 'off':
5673
if current_view is None:
5674
raise errors.BzrCommandError("No current view to disable")
5675
tree.views.set_view_info(None, view_dict)
5676
self.outf.write("Disabled '%s' view.\n" % (current_view))
5678
tree.views.set_view_info(switch, view_dict)
5679
view_str = views.view_display_str(tree.views.lookup_view())
5680
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5683
self.outf.write('Views defined:\n')
5684
for view in sorted(view_dict):
5685
if view == current_view:
5689
view_str = views.view_display_str(view_dict[view])
5690
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5692
self.outf.write('No views defined.\n')
5695
# No name given and no current view set
5698
raise errors.BzrCommandError(
5699
"Cannot change the 'off' pseudo view")
5700
tree.views.set_view(name, sorted(file_list))
5701
view_str = views.view_display_str(tree.views.lookup_view())
5702
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5706
# No name given and no current view set
5707
self.outf.write('No current view.\n')
5709
view_str = views.view_display_str(tree.views.lookup_view(name))
5710
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5713
class cmd_hooks(Command):
5719
for hook_key in sorted(hooks.known_hooks.keys()):
5720
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5721
self.outf.write("%s:\n" % type(some_hooks).__name__)
5722
for hook_name, hook_point in sorted(some_hooks.items()):
5723
self.outf.write(" %s:\n" % (hook_name,))
5724
found_hooks = list(hook_point)
5726
for hook in found_hooks:
5727
self.outf.write(" %s\n" %
5728
(some_hooks.get_hook_name(hook),))
5730
self.outf.write(" <no hooks installed>\n")
5733
class cmd_shelve(Command):
5734
"""Temporarily set aside some changes from the current tree.
5736
Shelve allows you to temporarily put changes you've made "on the shelf",
5737
ie. out of the way, until a later time when you can bring them back from
5738
the shelf with the 'unshelve' command. The changes are stored alongside
5739
your working tree, and so they aren't propagated along with your branch nor
5740
will they survive its deletion.
5742
If shelve --list is specified, previously-shelved changes are listed.
5744
Shelve is intended to help separate several sets of changes that have
5745
been inappropriately mingled. If you just want to get rid of all changes
5746
and you don't need to restore them later, use revert. If you want to
5747
shelve all text changes at once, use shelve --all.
5749
If filenames are specified, only the changes to those files will be
5750
shelved. Other files will be left untouched.
5752
If a revision is specified, changes since that revision will be shelved.
5754
You can put multiple items on the shelf, and by default, 'unshelve' will
5755
restore the most recently shelved changes.
5758
takes_args = ['file*']
5762
Option('all', help='Shelve all changes.'),
5764
RegistryOption('writer', 'Method to use for writing diffs.',
5765
bzrlib.option.diff_writer_registry,
5766
value_switches=True, enum_switch=False),
5768
Option('list', help='List shelved changes.'),
5770
help='Destroy removed changes instead of shelving them.'),
5772
_see_also = ['unshelve']
5774
def run(self, revision=None, all=False, file_list=None, message=None,
5775
writer=None, list=False, destroy=False):
5777
return self.run_for_list()
5778
from bzrlib.shelf_ui import Shelver
5780
writer = bzrlib.option.diff_writer_registry.get()
5782
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5783
file_list, message, destroy=destroy)
5788
except errors.UserAbort:
5791
def run_for_list(self):
5792
tree = WorkingTree.open_containing('.')[0]
5794
self.add_cleanup(tree.unlock)
5795
manager = tree.get_shelf_manager()
5796
shelves = manager.active_shelves()
5797
if len(shelves) == 0:
5798
note('No shelved changes.')
5800
for shelf_id in reversed(shelves):
5801
message = manager.get_metadata(shelf_id).get('message')
5803
message = '<no message>'
5804
self.outf.write('%3d: %s\n' % (shelf_id, message))
5808
class cmd_unshelve(Command):
5809
"""Restore shelved changes.
5811
By default, the most recently shelved changes are restored. However if you
5812
specify a shelf by id those changes will be restored instead. This works
5813
best when the changes don't depend on each other.
5816
takes_args = ['shelf_id?']
5818
RegistryOption.from_kwargs(
5819
'action', help="The action to perform.",
5820
enum_switch=False, value_switches=True,
5821
apply="Apply changes and remove from the shelf.",
5822
dry_run="Show changes, but do not apply or remove them.",
5823
preview="Instead of unshelving the changes, show the diff that "
5824
"would result from unshelving.",
5825
delete_only="Delete changes without applying them.",
5826
keep="Apply changes but don't delete them.",
5829
_see_also = ['shelve']
5831
def run(self, shelf_id=None, action='apply'):
5832
from bzrlib.shelf_ui import Unshelver
5833
unshelver = Unshelver.from_args(shelf_id, action)
5837
unshelver.tree.unlock()
5840
class cmd_clean_tree(Command):
5841
"""Remove unwanted files from working tree.
5843
By default, only unknown files, not ignored files, are deleted. Versioned
5844
files are never deleted.
5846
Another class is 'detritus', which includes files emitted by bzr during
5847
normal operations and selftests. (The value of these files decreases with
5850
If no options are specified, unknown files are deleted. Otherwise, option
5851
flags are respected, and may be combined.
5853
To check what clean-tree will do, use --dry-run.
5855
takes_options = [Option('ignored', help='Delete all ignored files.'),
5856
Option('detritus', help='Delete conflict files, merge'
5857
' backups, and failed selftest dirs.'),
5859
help='Delete files unknown to bzr (default).'),
5860
Option('dry-run', help='Show files to delete instead of'
5862
Option('force', help='Do not prompt before deleting.')]
5863
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5865
from bzrlib.clean_tree import clean_tree
5866
if not (unknown or ignored or detritus):
5870
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5871
dry_run=dry_run, no_prompt=force)
5874
class cmd_reference(Command):
5875
"""list, view and set branch locations for nested trees.
5877
If no arguments are provided, lists the branch locations for nested trees.
5878
If one argument is provided, display the branch location for that tree.
5879
If two arguments are provided, set the branch location for that tree.
5884
takes_args = ['path?', 'location?']
5886
def run(self, path=None, location=None):
5888
if path is not None:
5890
tree, branch, relpath =(
5891
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5892
if path is not None:
5895
tree = branch.basis_tree()
5897
info = branch._get_all_reference_info().iteritems()
5898
self._display_reference_info(tree, branch, info)
5900
file_id = tree.path2id(path)
5902
raise errors.NotVersionedError(path)
5903
if location is None:
5904
info = [(file_id, branch.get_reference_info(file_id))]
5905
self._display_reference_info(tree, branch, info)
5907
branch.set_reference_info(file_id, path, location)
5909
def _display_reference_info(self, tree, branch, info):
5911
for file_id, (path, location) in info:
5913
path = tree.id2path(file_id)
5914
except errors.NoSuchId:
5916
ref_list.append((path, location))
5917
for path, location in sorted(ref_list):
5918
self.outf.write('%s %s\n' % (path, location))
5921
# these get imported and then picked up by the scan for cmd_*
5922
# TODO: Some more consistent way to split command definitions across files;
5923
# we do need to load at least some information about them to know of
5924
# aliases. ideally we would avoid loading the implementation until the
5925
# details were needed.
5926
from bzrlib.cmd_version_info import cmd_version_info
5927
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5928
from bzrlib.bundle.commands import (
5931
from bzrlib.foreign import cmd_dpush
5932
from bzrlib.sign_my_commits import cmd_sign_my_commits
added
removed
bzrlib/builtins.py
