1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import (
71
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
74
def tree_files(file_list, default_branch=u'.', canonicalize=True,
77
return internal_tree_files(file_list, default_branch, canonicalize,
79
except errors.FileInWrongBranch, e:
80
raise errors.BzrCommandError("%s is not in the same branch as %s" %
81
(e.path, file_list[0]))
84
def tree_files_for_add(file_list):
86
Return a tree and list of absolute paths from a file list.
88
Similar to tree_files, but add handles files a bit differently, so it a
89
custom implementation. In particular, MutableTreeTree.smart_add expects
90
absolute paths, which it immediately converts to relative paths.
92
# FIXME Would be nice to just return the relative paths like
93
# internal_tree_files does, but there are a large number of unit tests
94
# that assume the current interface to mutabletree.smart_add
96
tree, relpath = WorkingTree.open_containing(file_list[0])
97
if tree.supports_views():
98
view_files = tree.views.lookup_view()
100
for filename in file_list:
101
if not osutils.is_inside_any(view_files, filename):
102
raise errors.FileOutsideView(filename, view_files)
103
file_list = file_list[:]
104
file_list[0] = tree.abspath(relpath)
106
tree = WorkingTree.open_containing(u'.')[0]
107
if tree.supports_views():
108
view_files = tree.views.lookup_view()
110
file_list = view_files
111
view_str = views.view_display_str(view_files)
112
note("Ignoring files outside view. View is %s" % view_str)
113
return tree, file_list
116
def _get_one_revision(command_name, revisions):
117
if revisions is None:
119
if len(revisions) != 1:
120
raise errors.BzrCommandError(
121
'bzr %s --revision takes exactly one revision identifier' % (
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
127
"""Get a revision tree. Not suitable for commands that change the tree.
129
Specifically, the basis tree in dirstate trees is coupled to the dirstate
130
and doing a commit/uncommit/pull will at best fail due to changing the
133
If tree is passed in, it should be already locked, for lifetime management
134
of the trees internal cached state.
138
if revisions is None:
140
rev_tree = tree.basis_tree()
142
rev_tree = branch.basis_tree()
144
revision = _get_one_revision(command_name, revisions)
145
rev_tree = revision.as_tree(branch)
149
# XXX: Bad function name; should possibly also be a class method of
150
# WorkingTree rather than a function.
151
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
"""Convert command-line paths to a WorkingTree and relative paths.
155
This is typically used for command-line processors that take one or
156
more filenames, and infer the workingtree that contains them.
158
The filenames given are not required to exist.
160
:param file_list: Filenames to convert.
162
:param default_branch: Fallback tree path to use if file_list is empty or
165
:param apply_view: if True and a view is set, apply it or check that
166
specified files are within it
168
:return: workingtree, [relative_paths]
170
if file_list is None or len(file_list) == 0:
171
tree = WorkingTree.open_containing(default_branch)[0]
172
if tree.supports_views() and apply_view:
173
view_files = tree.views.lookup_view()
175
file_list = view_files
176
view_str = views.view_display_str(view_files)
177
note("Ignoring files outside view. View is %s" % view_str)
178
return tree, file_list
179
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
180
return tree, safe_relpath_files(tree, file_list, canonicalize,
181
apply_view=apply_view)
184
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
185
"""Convert file_list into a list of relpaths in tree.
187
:param tree: A tree to operate on.
188
:param file_list: A list of user provided paths or None.
189
:param apply_view: if True and a view is set, apply it or check that
190
specified files are within it
191
:return: A list of relative paths.
192
:raises errors.PathNotChild: When a provided path is in a different tree
195
if file_list is None:
197
if tree.supports_views() and apply_view:
198
view_files = tree.views.lookup_view()
202
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
203
# doesn't - fix that up here before we enter the loop.
205
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
208
for filename in file_list:
210
relpath = fixer(osutils.dereference_path(filename))
211
if view_files and not osutils.is_inside_any(view_files, relpath):
212
raise errors.FileOutsideView(filename, view_files)
213
new_list.append(relpath)
214
except errors.PathNotChild:
215
raise errors.FileInWrongBranch(tree.branch, filename)
219
def _get_view_info_for_change_reporter(tree):
220
"""Get the view information from a tree for change reporting."""
223
current_view = tree.views.get_view_info()[0]
224
if current_view is not None:
225
view_info = (current_view, tree.views.lookup_view())
226
except errors.ViewsNotSupported:
231
# TODO: Make sure no commands unconditionally use the working directory as a
232
# branch. If a filename argument is used, the first of them should be used to
233
# specify the branch. (Perhaps this can be factored out into some kind of
234
# Argument class, representing a file in a branch, where the first occurrence
237
class cmd_status(Command):
238
"""Display status summary.
240
This reports on versioned and unknown files, reporting them
241
grouped by state. Possible states are:
244
Versioned in the working copy but not in the previous revision.
247
Versioned in the previous revision but removed or deleted
251
Path of this file changed from the previous revision;
252
the text may also have changed. This includes files whose
253
parent directory was renamed.
256
Text has changed since the previous revision.
259
File kind has been changed (e.g. from file to directory).
262
Not versioned and not matching an ignore pattern.
264
Additionally for directories, symlinks and files with an executable
265
bit, Bazaar indicates their type using a trailing character: '/', '@'
268
To see ignored files use 'bzr ignored'. For details on the
269
changes to file texts, use 'bzr diff'.
271
Note that --short or -S gives status flags for each item, similar
272
to Subversion's status command. To get output similar to svn -q,
275
If no arguments are specified, the status of the entire working
276
directory is shown. Otherwise, only the status of the specified
277
files or directories is reported. If a directory is given, status
278
is reported for everything inside that directory.
280
Before merges are committed, the pending merge tip revisions are
281
shown. To see all pending merge revisions, use the -v option.
282
To skip the display of pending merge information altogether, use
283
the no-pending option or specify a file/directory.
285
If a revision argument is given, the status is calculated against
286
that revision, or between two revisions if two are provided.
289
# TODO: --no-recurse, --recurse options
291
takes_args = ['file*']
292
takes_options = ['show-ids', 'revision', 'change', 'verbose',
293
Option('short', help='Use short status indicators.',
295
Option('versioned', help='Only show versioned files.',
297
Option('no-pending', help='Don\'t show pending merges.',
300
aliases = ['st', 'stat']
302
encoding_type = 'replace'
303
_see_also = ['diff', 'revert', 'status-flags']
306
def run(self, show_ids=False, file_list=None, revision=None, short=False,
307
versioned=False, no_pending=False, verbose=False):
308
from bzrlib.status import show_tree_status
310
if revision and len(revision) > 2:
311
raise errors.BzrCommandError('bzr status --revision takes exactly'
312
' one or two revision specifiers')
314
tree, relfile_list = tree_files(file_list)
315
# Avoid asking for specific files when that is not needed.
316
if relfile_list == ['']:
318
# Don't disable pending merges for full trees other than '.'.
319
if file_list == ['.']:
321
# A specific path within a tree was given.
322
elif relfile_list is not None:
324
show_tree_status(tree, show_ids=show_ids,
325
specific_files=relfile_list, revision=revision,
326
to_file=self.outf, short=short, versioned=versioned,
327
show_pending=(not no_pending), verbose=verbose)
330
class cmd_cat_revision(Command):
331
"""Write out metadata for a revision.
333
The revision to print can either be specified by a specific
334
revision identifier, or you can use --revision.
338
takes_args = ['revision_id?']
339
takes_options = ['revision']
340
# cat-revision is more for frontends so should be exact
343
def print_revision(self, revisions, revid):
344
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
345
record = stream.next()
346
if record.storage_kind == 'absent':
347
raise errors.NoSuchRevision(revisions, revid)
348
revtext = record.get_bytes_as('fulltext')
349
self.outf.write(revtext.decode('utf-8'))
352
def run(self, revision_id=None, revision=None):
353
if revision_id is not None and revision is not None:
354
raise errors.BzrCommandError('You can only supply one of'
355
' revision_id or --revision')
356
if revision_id is None and revision is None:
357
raise errors.BzrCommandError('You must supply either'
358
' --revision or a revision_id')
359
b = WorkingTree.open_containing(u'.')[0].branch
361
revisions = b.repository.revisions
362
if revisions is None:
363
raise errors.BzrCommandError('Repository %r does not support '
364
'access to raw revision texts')
366
b.repository.lock_read()
368
# TODO: jam 20060112 should cat-revision always output utf-8?
369
if revision_id is not None:
370
revision_id = osutils.safe_revision_id(revision_id, warn=False)
372
self.print_revision(revisions, revision_id)
373
except errors.NoSuchRevision:
374
msg = "The repository %s contains no revision %s." % (
375
b.repository.base, revision_id)
376
raise errors.BzrCommandError(msg)
377
elif revision is not None:
380
raise errors.BzrCommandError(
381
'You cannot specify a NULL revision.')
382
rev_id = rev.as_revision_id(b)
383
self.print_revision(revisions, rev_id)
385
b.repository.unlock()
388
class cmd_dump_btree(Command):
389
"""Dump the contents of a btree index file to stdout.
391
PATH is a btree index file, it can be any URL. This includes things like
392
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
394
By default, the tuples stored in the index file will be displayed. With
395
--raw, we will uncompress the pages, but otherwise display the raw bytes
399
# TODO: Do we want to dump the internal nodes as well?
400
# TODO: It would be nice to be able to dump the un-parsed information,
401
# rather than only going through iter_all_entries. However, this is
402
# good enough for a start
404
encoding_type = 'exact'
405
takes_args = ['path']
406
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
407
' rather than the parsed tuples.'),
410
def run(self, path, raw=False):
411
dirname, basename = osutils.split(path)
412
t = transport.get_transport(dirname)
414
self._dump_raw_bytes(t, basename)
416
self._dump_entries(t, basename)
418
def _get_index_and_bytes(self, trans, basename):
419
"""Create a BTreeGraphIndex and raw bytes."""
420
bt = btree_index.BTreeGraphIndex(trans, basename, None)
421
bytes = trans.get_bytes(basename)
422
bt._file = cStringIO.StringIO(bytes)
423
bt._size = len(bytes)
426
def _dump_raw_bytes(self, trans, basename):
429
# We need to parse at least the root node.
430
# This is because the first page of every row starts with an
431
# uncompressed header.
432
bt, bytes = self._get_index_and_bytes(trans, basename)
433
for page_idx, page_start in enumerate(xrange(0, len(bytes),
434
btree_index._PAGE_SIZE)):
435
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
436
page_bytes = bytes[page_start:page_end]
438
self.outf.write('Root node:\n')
439
header_end, data = bt._parse_header_from_bytes(page_bytes)
440
self.outf.write(page_bytes[:header_end])
442
self.outf.write('\nPage %d\n' % (page_idx,))
443
decomp_bytes = zlib.decompress(page_bytes)
444
self.outf.write(decomp_bytes)
445
self.outf.write('\n')
447
def _dump_entries(self, trans, basename):
449
st = trans.stat(basename)
450
except errors.TransportNotPossible:
451
# We can't stat, so we'll fake it because we have to do the 'get()'
453
bt, _ = self._get_index_and_bytes(trans, basename)
455
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
456
for node in bt.iter_all_entries():
457
# Node is made up of:
458
# (index, key, value, [references])
459
refs_as_tuples = static_tuple.as_tuples(node[3])
460
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
461
self.outf.write('%s\n' % (as_tuple,))
464
class cmd_remove_tree(Command):
465
"""Remove the working tree from a given branch/checkout.
467
Since a lightweight checkout is little more than a working tree
468
this will refuse to run against one.
470
To re-create the working tree, use "bzr checkout".
472
_see_also = ['checkout', 'working-trees']
473
takes_args = ['location*']
476
help='Remove the working tree even if it has '
477
'uncommitted changes.'),
480
def run(self, location_list, force=False):
481
if not location_list:
484
for location in location_list:
485
d = bzrdir.BzrDir.open(location)
488
working = d.open_workingtree()
489
except errors.NoWorkingTree:
490
raise errors.BzrCommandError("No working tree to remove")
491
except errors.NotLocalUrl:
492
raise errors.BzrCommandError("You cannot remove the working tree"
495
if (working.has_changes()):
496
raise errors.UncommittedChanges(working)
498
working_path = working.bzrdir.root_transport.base
499
branch_path = working.branch.bzrdir.root_transport.base
500
if working_path != branch_path:
501
raise errors.BzrCommandError("You cannot remove the working tree"
502
" from a lightweight checkout")
504
d.destroy_workingtree()
507
class cmd_revno(Command):
508
"""Show current revision number.
510
This is equal to the number of revisions on this branch.
514
takes_args = ['location?']
516
Option('tree', help='Show revno of working tree'),
520
def run(self, tree=False, location=u'.'):
523
wt = WorkingTree.open_containing(location)[0]
525
except (errors.NoWorkingTree, errors.NotLocalUrl):
526
raise errors.NoWorkingTree(location)
527
self.add_cleanup(wt.unlock)
528
revid = wt.last_revision()
530
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
531
except errors.NoSuchRevision:
533
revno = ".".join(str(n) for n in revno_t)
535
b = Branch.open_containing(location)[0]
537
self.add_cleanup(b.unlock)
540
self.outf.write(str(revno) + '\n')
543
class cmd_revision_info(Command):
544
"""Show revision number and revision id for a given revision identifier.
547
takes_args = ['revision_info*']
551
help='Branch to examine, '
552
'rather than the one containing the working directory.',
556
Option('tree', help='Show revno of working tree'),
560
def run(self, revision=None, directory=u'.', tree=False,
561
revision_info_list=[]):
564
wt = WorkingTree.open_containing(directory)[0]
567
self.add_cleanup(wt.unlock)
568
except (errors.NoWorkingTree, errors.NotLocalUrl):
570
b = Branch.open_containing(directory)[0]
572
self.add_cleanup(b.unlock)
574
if revision is not None:
575
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
576
if revision_info_list is not None:
577
for rev_str in revision_info_list:
578
rev_spec = RevisionSpec.from_string(rev_str)
579
revision_ids.append(rev_spec.as_revision_id(b))
580
# No arguments supplied, default to the last revision
581
if len(revision_ids) == 0:
584
raise errors.NoWorkingTree(directory)
585
revision_ids.append(wt.last_revision())
587
revision_ids.append(b.last_revision())
591
for revision_id in revision_ids:
593
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
594
revno = '.'.join(str(i) for i in dotted_revno)
595
except errors.NoSuchRevision:
597
maxlen = max(maxlen, len(revno))
598
revinfos.append([revno, revision_id])
602
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
605
class cmd_add(Command):
606
"""Add specified files or directories.
608
In non-recursive mode, all the named items are added, regardless
609
of whether they were previously ignored. A warning is given if
610
any of the named files are already versioned.
612
In recursive mode (the default), files are treated the same way
613
but the behaviour for directories is different. Directories that
614
are already versioned do not give a warning. All directories,
615
whether already versioned or not, are searched for files or
616
subdirectories that are neither versioned or ignored, and these
617
are added. This search proceeds recursively into versioned
618
directories. If no names are given '.' is assumed.
620
Therefore simply saying 'bzr add' will version all files that
621
are currently unknown.
623
Adding a file whose parent directory is not versioned will
624
implicitly add the parent, and so on up to the root. This means
625
you should never need to explicitly add a directory, they'll just
626
get added when you add a file in the directory.
628
--dry-run will show which files would be added, but not actually
631
--file-ids-from will try to use the file ids from the supplied path.
632
It looks up ids trying to find a matching parent directory with the
633
same filename, and then by pure path. This option is rarely needed
634
but can be useful when adding the same logical file into two
635
branches that will be merged later (without showing the two different
636
adds as a conflict). It is also useful when merging another project
637
into a subdirectory of this one.
639
Any files matching patterns in the ignore list will not be added
640
unless they are explicitly mentioned.
642
takes_args = ['file*']
645
help="Don't recursively add the contents of directories."),
647
help="Show what would be done, but don't actually do anything."),
649
Option('file-ids-from',
651
help='Lookup file ids from this tree.'),
653
encoding_type = 'replace'
654
_see_also = ['remove', 'ignore']
656
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
661
if file_ids_from is not None:
663
base_tree, base_path = WorkingTree.open_containing(
665
except errors.NoWorkingTree:
666
base_branch, base_path = Branch.open_containing(
668
base_tree = base_branch.basis_tree()
670
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
671
to_file=self.outf, should_print=(not is_quiet()))
673
action = bzrlib.add.AddAction(to_file=self.outf,
674
should_print=(not is_quiet()))
677
base_tree.lock_read()
678
self.add_cleanup(base_tree.unlock)
679
tree, file_list = tree_files_for_add(file_list)
680
added, ignored = tree.smart_add(file_list, not
681
no_recurse, action=action, save=not dry_run)
685
for glob in sorted(ignored.keys()):
686
for path in ignored[glob]:
687
self.outf.write("ignored %s matching \"%s\"\n"
691
class cmd_mkdir(Command):
692
"""Create a new versioned directory.
694
This is equivalent to creating the directory and then adding it.
697
takes_args = ['dir+']
698
encoding_type = 'replace'
700
def run(self, dir_list):
702
wt, dd = WorkingTree.open_containing(d)
703
base = os.path.dirname(dd)
704
id = wt.path2id(base)
708
self.outf.write('added %s\n' % d)
710
raise errors.NotVersionedError(path=base)
713
class cmd_relpath(Command):
714
"""Show path of a file relative to root"""
716
takes_args = ['filename']
720
def run(self, filename):
721
# TODO: jam 20050106 Can relpath return a munged path if
722
# sys.stdout encoding cannot represent it?
723
tree, relpath = WorkingTree.open_containing(filename)
724
self.outf.write(relpath)
725
self.outf.write('\n')
728
class cmd_inventory(Command):
729
"""Show inventory of the current working copy or a revision.
731
It is possible to limit the output to a particular entry
732
type using the --kind option. For example: --kind file.
734
It is also possible to restrict the list of files to a specific
735
set. For example: bzr inventory --show-ids this/file
744
help='List entries of a particular kind: file, directory, symlink.',
747
takes_args = ['file*']
750
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
751
if kind and kind not in ['file', 'directory', 'symlink']:
752
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
754
revision = _get_one_revision('inventory', revision)
755
work_tree, file_list = tree_files(file_list)
756
work_tree.lock_read()
757
self.add_cleanup(work_tree.unlock)
758
if revision is not None:
759
tree = revision.as_tree(work_tree.branch)
761
extra_trees = [work_tree]
763
self.add_cleanup(tree.unlock)
768
if file_list is not None:
769
file_ids = tree.paths2ids(file_list, trees=extra_trees,
770
require_versioned=True)
771
# find_ids_across_trees may include some paths that don't
773
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
774
for file_id in file_ids if file_id in tree)
776
entries = tree.inventory.entries()
779
for path, entry in entries:
780
if kind and kind != entry.kind:
783
self.outf.write('%-50s %s\n' % (path, entry.file_id))
785
self.outf.write(path)
786
self.outf.write('\n')
789
class cmd_mv(Command):
790
"""Move or rename a file.
793
bzr mv OLDNAME NEWNAME
795
bzr mv SOURCE... DESTINATION
797
If the last argument is a versioned directory, all the other names
798
are moved into it. Otherwise, there must be exactly two arguments
799
and the file is changed to a new name.
801
If OLDNAME does not exist on the filesystem but is versioned and
802
NEWNAME does exist on the filesystem but is not versioned, mv
803
assumes that the file has been manually moved and only updates
804
its internal inventory to reflect that change.
805
The same is valid when moving many SOURCE files to a DESTINATION.
807
Files cannot be moved between branches.
810
takes_args = ['names*']
811
takes_options = [Option("after", help="Move only the bzr identifier"
812
" of the file, because the file has already been moved."),
813
Option('auto', help='Automatically guess renames.'),
814
Option('dry-run', help='Avoid making changes when guessing renames.'),
816
aliases = ['move', 'rename']
817
encoding_type = 'replace'
819
def run(self, names_list, after=False, auto=False, dry_run=False):
821
return self.run_auto(names_list, after, dry_run)
823
raise errors.BzrCommandError('--dry-run requires --auto.')
824
if names_list is None:
826
if len(names_list) < 2:
827
raise errors.BzrCommandError("missing file argument")
828
tree, rel_names = tree_files(names_list, canonicalize=False)
829
tree.lock_tree_write()
830
self.add_cleanup(tree.unlock)
831
self._run(tree, names_list, rel_names, after)
833
def run_auto(self, names_list, after, dry_run):
834
if names_list is not None and len(names_list) > 1:
835
raise errors.BzrCommandError('Only one path may be specified to'
838
raise errors.BzrCommandError('--after cannot be specified with'
840
work_tree, file_list = tree_files(names_list, default_branch='.')
841
work_tree.lock_tree_write()
842
self.add_cleanup(work_tree.unlock)
843
rename_map.RenameMap.guess_renames(work_tree, dry_run)
845
def _run(self, tree, names_list, rel_names, after):
846
into_existing = osutils.isdir(names_list[-1])
847
if into_existing and len(names_list) == 2:
849
# a. case-insensitive filesystem and change case of dir
850
# b. move directory after the fact (if the source used to be
851
# a directory, but now doesn't exist in the working tree
852
# and the target is an existing directory, just rename it)
853
if (not tree.case_sensitive
854
and rel_names[0].lower() == rel_names[1].lower()):
855
into_existing = False
858
# 'fix' the case of a potential 'from'
859
from_id = tree.path2id(
860
tree.get_canonical_inventory_path(rel_names[0]))
861
if (not osutils.lexists(names_list[0]) and
862
from_id and inv.get_file_kind(from_id) == "directory"):
863
into_existing = False
866
# move into existing directory
867
# All entries reference existing inventory items, so fix them up
868
# for cicp file-systems.
869
rel_names = tree.get_canonical_inventory_paths(rel_names)
870
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
872
self.outf.write("%s => %s\n" % (src, dest))
874
if len(names_list) != 2:
875
raise errors.BzrCommandError('to mv multiple files the'
876
' destination must be a versioned'
879
# for cicp file-systems: the src references an existing inventory
881
src = tree.get_canonical_inventory_path(rel_names[0])
882
# Find the canonical version of the destination: In all cases, the
883
# parent of the target must be in the inventory, so we fetch the
884
# canonical version from there (we do not always *use* the
885
# canonicalized tail portion - we may be attempting to rename the
887
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
888
dest_parent = osutils.dirname(canon_dest)
889
spec_tail = osutils.basename(rel_names[1])
890
# For a CICP file-system, we need to avoid creating 2 inventory
891
# entries that differ only by case. So regardless of the case
892
# we *want* to use (ie, specified by the user or the file-system),
893
# we must always choose to use the case of any existing inventory
894
# items. The only exception to this is when we are attempting a
895
# case-only rename (ie, canonical versions of src and dest are
897
dest_id = tree.path2id(canon_dest)
898
if dest_id is None or tree.path2id(src) == dest_id:
899
# No existing item we care about, so work out what case we
900
# are actually going to use.
902
# If 'after' is specified, the tail must refer to a file on disk.
904
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
906
# pathjoin with an empty tail adds a slash, which breaks
908
dest_parent_fq = tree.basedir
910
dest_tail = osutils.canonical_relpath(
912
osutils.pathjoin(dest_parent_fq, spec_tail))
914
# not 'after', so case as specified is used
915
dest_tail = spec_tail
917
# Use the existing item so 'mv' fails with AlreadyVersioned.
918
dest_tail = os.path.basename(canon_dest)
919
dest = osutils.pathjoin(dest_parent, dest_tail)
920
mutter("attempting to move %s => %s", src, dest)
921
tree.rename_one(src, dest, after=after)
923
self.outf.write("%s => %s\n" % (src, dest))
926
class cmd_pull(Command):
927
"""Turn this branch into a mirror of another branch.
929
By default, this command only works on branches that have not diverged.
930
Branches are considered diverged if the destination branch's most recent
931
commit is one that has not been merged (directly or indirectly) into the
934
If branches have diverged, you can use 'bzr merge' to integrate the changes
935
from one into the other. Once one branch has merged, the other should
936
be able to pull it again.
938
If you want to replace your local changes and just want your branch to
939
match the remote one, use pull --overwrite. This will work even if the two
940
branches have diverged.
942
If there is no default location set, the first pull will set it. After
943
that, you can omit the location to use the default. To change the
944
default, use --remember. The value will only be saved if the remote
945
location can be accessed.
947
Note: The location can be specified either in the form of a branch,
948
or in the form of a path to a file containing a merge directive generated
952
_see_also = ['push', 'update', 'status-flags', 'send']
953
takes_options = ['remember', 'overwrite', 'revision',
954
custom_help('verbose',
955
help='Show logs of pulled revisions.'),
957
help='Branch to pull into, '
958
'rather than the one containing the working directory.',
963
help="Perform a local pull in a bound "
964
"branch. Local pulls are not applied to "
968
takes_args = ['location?']
969
encoding_type = 'replace'
971
def run(self, location=None, remember=False, overwrite=False,
972
revision=None, verbose=False,
973
directory=None, local=False):
974
# FIXME: too much stuff is in the command class
977
if directory is None:
980
tree_to = WorkingTree.open_containing(directory)[0]
981
branch_to = tree_to.branch
982
except errors.NoWorkingTree:
984
branch_to = Branch.open_containing(directory)[0]
986
if local and not branch_to.get_bound_location():
987
raise errors.LocalRequiresBoundBranch()
989
possible_transports = []
990
if location is not None:
992
mergeable = bundle.read_mergeable_from_url(location,
993
possible_transports=possible_transports)
994
except errors.NotABundle:
997
stored_loc = branch_to.get_parent()
999
if stored_loc is None:
1000
raise errors.BzrCommandError("No pull location known or"
1003
display_url = urlutils.unescape_for_display(stored_loc,
1006
self.outf.write("Using saved parent location: %s\n" % display_url)
1007
location = stored_loc
1009
revision = _get_one_revision('pull', revision)
1010
if mergeable is not None:
1011
if revision is not None:
1012
raise errors.BzrCommandError(
1013
'Cannot use -r with merge directives or bundles')
1014
mergeable.install_revisions(branch_to.repository)
1015
base_revision_id, revision_id, verified = \
1016
mergeable.get_merge_request(branch_to.repository)
1017
branch_from = branch_to
1019
branch_from = Branch.open(location,
1020
possible_transports=possible_transports)
1022
if branch_to.get_parent() is None or remember:
1023
branch_to.set_parent(branch_from.base)
1025
if branch_from is not branch_to:
1026
branch_from.lock_read()
1027
self.add_cleanup(branch_from.unlock)
1028
if revision is not None:
1029
revision_id = revision.as_revision_id(branch_from)
1031
branch_to.lock_write()
1032
self.add_cleanup(branch_to.unlock)
1033
if tree_to is not None:
1034
view_info = _get_view_info_for_change_reporter(tree_to)
1035
change_reporter = delta._ChangeReporter(
1036
unversioned_filter=tree_to.is_ignored,
1037
view_info=view_info)
1038
result = tree_to.pull(
1039
branch_from, overwrite, revision_id, change_reporter,
1040
possible_transports=possible_transports, local=local)
1042
result = branch_to.pull(
1043
branch_from, overwrite, revision_id, local=local)
1045
result.report(self.outf)
1046
if verbose and result.old_revid != result.new_revid:
1047
log.show_branch_change(
1048
branch_to, self.outf, result.old_revno,
1052
class cmd_push(Command):
1053
"""Update a mirror of this branch.
1055
The target branch will not have its working tree populated because this
1056
is both expensive, and is not supported on remote file systems.
1058
Some smart servers or protocols *may* put the working tree in place in
1061
This command only works on branches that have not diverged. Branches are
1062
considered diverged if the destination branch's most recent commit is one
1063
that has not been merged (directly or indirectly) by the source branch.
1065
If branches have diverged, you can use 'bzr push --overwrite' to replace
1066
the other branch completely, discarding its unmerged changes.
1068
If you want to ensure you have the different changes in the other branch,
1069
do a merge (see bzr help merge) from the other branch, and commit that.
1070
After that you will be able to do a push without '--overwrite'.
1072
If there is no default push location set, the first push will set it.
1073
After that, you can omit the location to use the default. To change the
1074
default, use --remember. The value will only be saved if the remote
1075
location can be accessed.
1078
_see_also = ['pull', 'update', 'working-trees']
1079
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1080
Option('create-prefix',
1081
help='Create the path leading up to the branch '
1082
'if it does not already exist.'),
1084
help='Branch to push from, '
1085
'rather than the one containing the working directory.',
1089
Option('use-existing-dir',
1090
help='By default push will fail if the target'
1091
' directory exists, but does not already'
1092
' have a control directory. This flag will'
1093
' allow push to proceed.'),
1095
help='Create a stacked branch that references the public location '
1096
'of the parent branch.'),
1097
Option('stacked-on',
1098
help='Create a stacked branch that refers to another branch '
1099
'for the commit history. Only the work not present in the '
1100
'referenced branch is included in the branch created.',
1103
help='Refuse to push if there are uncommitted changes in'
1104
' the working tree, --no-strict disables the check.'),
1106
takes_args = ['location?']
1107
encoding_type = 'replace'
1109
def run(self, location=None, remember=False, overwrite=False,
1110
create_prefix=False, verbose=False, revision=None,
1111
use_existing_dir=False, directory=None, stacked_on=None,
1112
stacked=False, strict=None):
1113
from bzrlib.push import _show_push_branch
1115
if directory is None:
1117
# Get the source branch
1119
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1121
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1122
if strict is None: strict = True # default value
1123
# Get the tip's revision_id
1124
revision = _get_one_revision('push', revision)
1125
if revision is not None:
1126
revision_id = revision.in_history(br_from).rev_id
1129
if strict and tree is not None and revision_id is None:
1130
if (tree.has_changes()):
1131
raise errors.UncommittedChanges(
1132
tree, more='Use --no-strict to force the push.')
1133
if tree.last_revision() != tree.branch.last_revision():
1134
# The tree has lost sync with its branch, there is little
1135
# chance that the user is aware of it but he can still force
1136
# the push with --no-strict
1137
raise errors.OutOfDateTree(
1138
tree, more='Use --no-strict to force the push.')
1140
# Get the stacked_on branch, if any
1141
if stacked_on is not None:
1142
stacked_on = urlutils.normalize_url(stacked_on)
1144
parent_url = br_from.get_parent()
1146
parent = Branch.open(parent_url)
1147
stacked_on = parent.get_public_branch()
1149
# I considered excluding non-http url's here, thus forcing
1150
# 'public' branches only, but that only works for some
1151
# users, so it's best to just depend on the user spotting an
1152
# error by the feedback given to them. RBC 20080227.
1153
stacked_on = parent_url
1155
raise errors.BzrCommandError(
1156
"Could not determine branch to refer to.")
1158
# Get the destination location
1159
if location is None:
1160
stored_loc = br_from.get_push_location()
1161
if stored_loc is None:
1162
raise errors.BzrCommandError(
1163
"No push location known or specified.")
1165
display_url = urlutils.unescape_for_display(stored_loc,
1167
self.outf.write("Using saved push location: %s\n" % display_url)
1168
location = stored_loc
1170
_show_push_branch(br_from, revision_id, location, self.outf,
1171
verbose=verbose, overwrite=overwrite, remember=remember,
1172
stacked_on=stacked_on, create_prefix=create_prefix,
1173
use_existing_dir=use_existing_dir)
1176
class cmd_branch(Command):
1177
"""Create a new branch that is a copy of an existing branch.
1179
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1180
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1181
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1182
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1183
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1186
To retrieve the branch as of a particular revision, supply the --revision
1187
parameter, as in "branch foo/bar -r 5".
1190
_see_also = ['checkout']
1191
takes_args = ['from_location', 'to_location?']
1192
takes_options = ['revision', Option('hardlink',
1193
help='Hard-link working tree files where possible.'),
1195
help="Create a branch without a working-tree."),
1197
help="Switch the checkout in the current directory "
1198
"to the new branch."),
1200
help='Create a stacked branch referring to the source branch. '
1201
'The new branch will depend on the availability of the source '
1202
'branch for all operations.'),
1203
Option('standalone',
1204
help='Do not use a shared repository, even if available.'),
1205
Option('use-existing-dir',
1206
help='By default branch will fail if the target'
1207
' directory exists, but does not already'
1208
' have a control directory. This flag will'
1209
' allow branch to proceed.'),
1211
help="Bind new branch to from location."),
1213
aliases = ['get', 'clone']
1215
def run(self, from_location, to_location=None, revision=None,
1216
hardlink=False, stacked=False, standalone=False, no_tree=False,
1217
use_existing_dir=False, switch=False, bind=False):
1218
from bzrlib import switch as _mod_switch
1219
from bzrlib.tag import _merge_tags_if_possible
1220
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1222
revision = _get_one_revision('branch', revision)
1224
self.add_cleanup(br_from.unlock)
1225
if revision is not None:
1226
revision_id = revision.as_revision_id(br_from)
1228
# FIXME - wt.last_revision, fallback to branch, fall back to
1229
# None or perhaps NULL_REVISION to mean copy nothing
1231
revision_id = br_from.last_revision()
1232
if to_location is None:
1233
to_location = urlutils.derive_to_location(from_location)
1234
to_transport = transport.get_transport(to_location)
1236
to_transport.mkdir('.')
1237
except errors.FileExists:
1238
if not use_existing_dir:
1239
raise errors.BzrCommandError('Target directory "%s" '
1240
'already exists.' % to_location)
1243
bzrdir.BzrDir.open_from_transport(to_transport)
1244
except errors.NotBranchError:
1247
raise errors.AlreadyBranchError(to_location)
1248
except errors.NoSuchFile:
1249
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1252
# preserve whatever source format we have.
1253
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1254
possible_transports=[to_transport],
1255
accelerator_tree=accelerator_tree,
1256
hardlink=hardlink, stacked=stacked,
1257
force_new_repo=standalone,
1258
create_tree_if_local=not no_tree,
1259
source_branch=br_from)
1260
branch = dir.open_branch()
1261
except errors.NoSuchRevision:
1262
to_transport.delete_tree('.')
1263
msg = "The branch %s has no revision %s." % (from_location,
1265
raise errors.BzrCommandError(msg)
1266
_merge_tags_if_possible(br_from, branch)
1267
# If the source branch is stacked, the new branch may
1268
# be stacked whether we asked for that explicitly or not.
1269
# We therefore need a try/except here and not just 'if stacked:'
1271
note('Created new stacked branch referring to %s.' %
1272
branch.get_stacked_on_url())
1273
except (errors.NotStacked, errors.UnstackableBranchFormat,
1274
errors.UnstackableRepositoryFormat), e:
1275
note('Branched %d revision(s).' % branch.revno())
1277
# Bind to the parent
1278
parent_branch = Branch.open(from_location)
1279
branch.bind(parent_branch)
1280
note('New branch bound to %s' % from_location)
1282
# Switch to the new branch
1283
wt, _ = WorkingTree.open_containing('.')
1284
_mod_switch.switch(wt.bzrdir, branch)
1285
note('Switched to branch: %s',
1286
urlutils.unescape_for_display(branch.base, 'utf-8'))
1289
class cmd_checkout(Command):
1290
"""Create a new checkout of an existing branch.
1292
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1293
the branch found in '.'. This is useful if you have removed the working tree
1294
or if it was never created - i.e. if you pushed the branch to its current
1295
location using SFTP.
1297
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1298
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1299
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1300
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1301
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1304
To retrieve the branch as of a particular revision, supply the --revision
1305
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1306
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1310
_see_also = ['checkouts', 'branch']
1311
takes_args = ['branch_location?', 'to_location?']
1312
takes_options = ['revision',
1313
Option('lightweight',
1314
help="Perform a lightweight checkout. Lightweight "
1315
"checkouts depend on access to the branch for "
1316
"every operation. Normal checkouts can perform "
1317
"common operations like diff and status without "
1318
"such access, and also support local commits."
1320
Option('files-from', type=str,
1321
help="Get file contents from this tree."),
1323
help='Hard-link working tree files where possible.'
1328
def run(self, branch_location=None, to_location=None, revision=None,
1329
lightweight=False, files_from=None, hardlink=False):
1330
if branch_location is None:
1331
branch_location = osutils.getcwd()
1332
to_location = branch_location
1333
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1335
revision = _get_one_revision('checkout', revision)
1336
if files_from is not None:
1337
accelerator_tree = WorkingTree.open(files_from)
1338
if revision is not None:
1339
revision_id = revision.as_revision_id(source)
1342
if to_location is None:
1343
to_location = urlutils.derive_to_location(branch_location)
1344
# if the source and to_location are the same,
1345
# and there is no working tree,
1346
# then reconstitute a branch
1347
if (osutils.abspath(to_location) ==
1348
osutils.abspath(branch_location)):
1350
source.bzrdir.open_workingtree()
1351
except errors.NoWorkingTree:
1352
source.bzrdir.create_workingtree(revision_id)
1354
source.create_checkout(to_location, revision_id, lightweight,
1355
accelerator_tree, hardlink)
1358
class cmd_renames(Command):
1359
"""Show list of renamed files.
1361
# TODO: Option to show renames between two historical versions.
1363
# TODO: Only show renames under dir, rather than in the whole branch.
1364
_see_also = ['status']
1365
takes_args = ['dir?']
1368
def run(self, dir=u'.'):
1369
tree = WorkingTree.open_containing(dir)[0]
1371
self.add_cleanup(tree.unlock)
1372
new_inv = tree.inventory
1373
old_tree = tree.basis_tree()
1374
old_tree.lock_read()
1375
self.add_cleanup(old_tree.unlock)
1376
old_inv = old_tree.inventory
1378
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1379
for f, paths, c, v, p, n, k, e in iterator:
1380
if paths[0] == paths[1]:
1384
renames.append(paths)
1386
for old_name, new_name in renames:
1387
self.outf.write("%s => %s\n" % (old_name, new_name))
1390
class cmd_update(Command):
1391
"""Update a tree to have the latest code committed to its branch.
1393
This will perform a merge into the working tree, and may generate
1394
conflicts. If you have any local changes, you will still
1395
need to commit them after the update for the update to be complete.
1397
If you want to discard your local changes, you can just do a
1398
'bzr revert' instead of 'bzr commit' after the update.
1400
If the tree's branch is bound to a master branch, it will also update
1401
the branch from the master.
1404
_see_also = ['pull', 'working-trees', 'status-flags']
1405
takes_args = ['dir?']
1406
takes_options = ['revision']
1409
def run(self, dir='.', revision=None):
1410
if revision is not None and len(revision) != 1:
1411
raise errors.BzrCommandError(
1412
"bzr update --revision takes exactly one revision")
1413
tree = WorkingTree.open_containing(dir)[0]
1414
branch = tree.branch
1415
possible_transports = []
1416
master = branch.get_master_branch(
1417
possible_transports=possible_transports)
1418
if master is not None:
1420
branch_location = master.base
1422
tree.lock_tree_write()
1423
branch_location = tree.branch.base
1424
self.add_cleanup(tree.unlock)
1425
# get rid of the final '/' and be ready for display
1426
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1428
existing_pending_merges = tree.get_parent_ids()[1:]
1432
# may need to fetch data into a heavyweight checkout
1433
# XXX: this may take some time, maybe we should display a
1435
old_tip = branch.update(possible_transports)
1436
if revision is not None:
1437
revision_id = revision[0].as_revision_id(branch)
1439
revision_id = branch.last_revision()
1440
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
revno = branch.revision_id_to_revno(revision_id)
1442
note("Tree is up to date at revision %d of branch %s" %
1443
(revno, branch_location))
1445
view_info = _get_view_info_for_change_reporter(tree)
1446
change_reporter = delta._ChangeReporter(
1447
unversioned_filter=tree.is_ignored,
1448
view_info=view_info)
1450
conflicts = tree.update(
1452
possible_transports=possible_transports,
1453
revision=revision_id,
1455
except errors.NoSuchRevision, e:
1456
raise errors.BzrCommandError(
1457
"branch has no revision %s\n"
1458
"bzr update --revision only works"
1459
" for a revision in the branch history"
1461
revno = tree.branch.revision_id_to_revno(
1462
_mod_revision.ensure_null(tree.last_revision()))
1463
note('Updated to revision %d of branch %s' %
1464
(revno, branch_location))
1465
if tree.get_parent_ids()[1:] != existing_pending_merges:
1466
note('Your local commits will now show as pending merges with '
1467
"'bzr status', and can be committed with 'bzr commit'.")
1474
class cmd_info(Command):
1475
"""Show information about a working tree, branch or repository.
1477
This command will show all known locations and formats associated to the
1478
tree, branch or repository.
1480
In verbose mode, statistical information is included with each report.
1481
To see extended statistic information, use a verbosity level of 2 or
1482
higher by specifying the verbose option multiple times, e.g. -vv.
1484
Branches and working trees will also report any missing revisions.
1488
Display information on the format and related locations:
1492
Display the above together with extended format information and
1493
basic statistics (like the number of files in the working tree and
1494
number of revisions in the branch and repository):
1498
Display the above together with number of committers to the branch:
1502
_see_also = ['revno', 'working-trees', 'repositories']
1503
takes_args = ['location?']
1504
takes_options = ['verbose']
1505
encoding_type = 'replace'
1508
def run(self, location=None, verbose=False):
1510
noise_level = get_verbosity_level()
1513
from bzrlib.info import show_bzrdir_info
1514
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1515
verbose=noise_level, outfile=self.outf)
1518
class cmd_remove(Command):
1519
"""Remove files or directories.
1521
This makes bzr stop tracking changes to the specified files. bzr will delete
1522
them if they can easily be recovered using revert. If no options or
1523
parameters are given bzr will scan for files that are being tracked by bzr
1524
but missing in your tree and stop tracking them for you.
1526
takes_args = ['file*']
1527
takes_options = ['verbose',
1528
Option('new', help='Only remove files that have never been committed.'),
1529
RegistryOption.from_kwargs('file-deletion-strategy',
1530
'The file deletion mode to be used.',
1531
title='Deletion Strategy', value_switches=True, enum_switch=False,
1532
safe='Only delete files if they can be'
1533
' safely recovered (default).',
1534
keep='Delete from bzr but leave the working copy.',
1535
force='Delete all the specified files, even if they can not be '
1536
'recovered and even if they are non-empty directories.')]
1537
aliases = ['rm', 'del']
1538
encoding_type = 'replace'
1540
def run(self, file_list, verbose=False, new=False,
1541
file_deletion_strategy='safe'):
1542
tree, file_list = tree_files(file_list)
1544
if file_list is not None:
1545
file_list = [f for f in file_list]
1548
self.add_cleanup(tree.unlock)
1549
# Heuristics should probably all move into tree.remove_smart or
1552
added = tree.changes_from(tree.basis_tree(),
1553
specific_files=file_list).added
1554
file_list = sorted([f[0] for f in added], reverse=True)
1555
if len(file_list) == 0:
1556
raise errors.BzrCommandError('No matching files.')
1557
elif file_list is None:
1558
# missing files show up in iter_changes(basis) as
1559
# versioned-with-no-kind.
1561
for change in tree.iter_changes(tree.basis_tree()):
1562
# Find paths in the working tree that have no kind:
1563
if change[1][1] is not None and change[6][1] is None:
1564
missing.append(change[1][1])
1565
file_list = sorted(missing, reverse=True)
1566
file_deletion_strategy = 'keep'
1567
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1568
keep_files=file_deletion_strategy=='keep',
1569
force=file_deletion_strategy=='force')
1572
class cmd_file_id(Command):
1573
"""Print file_id of a particular file or directory.
1575
The file_id is assigned when the file is first added and remains the
1576
same through all revisions where the file exists, even when it is
1581
_see_also = ['inventory', 'ls']
1582
takes_args = ['filename']
1585
def run(self, filename):
1586
tree, relpath = WorkingTree.open_containing(filename)
1587
i = tree.path2id(relpath)
1589
raise errors.NotVersionedError(filename)
1591
self.outf.write(i + '\n')
1594
class cmd_file_path(Command):
1595
"""Print path of file_ids to a file or directory.
1597
This prints one line for each directory down to the target,
1598
starting at the branch root.
1602
takes_args = ['filename']
1605
def run(self, filename):
1606
tree, relpath = WorkingTree.open_containing(filename)
1607
fid = tree.path2id(relpath)
1609
raise errors.NotVersionedError(filename)
1610
segments = osutils.splitpath(relpath)
1611
for pos in range(1, len(segments) + 1):
1612
path = osutils.joinpath(segments[:pos])
1613
self.outf.write("%s\n" % tree.path2id(path))
1616
class cmd_reconcile(Command):
1617
"""Reconcile bzr metadata in a branch.
1619
This can correct data mismatches that may have been caused by
1620
previous ghost operations or bzr upgrades. You should only
1621
need to run this command if 'bzr check' or a bzr developer
1622
advises you to run it.
1624
If a second branch is provided, cross-branch reconciliation is
1625
also attempted, which will check that data like the tree root
1626
id which was not present in very early bzr versions is represented
1627
correctly in both branches.
1629
At the same time it is run it may recompress data resulting in
1630
a potential saving in disk space or performance gain.
1632
The branch *MUST* be on a listable system such as local disk or sftp.
1635
_see_also = ['check']
1636
takes_args = ['branch?']
1638
def run(self, branch="."):
1639
from bzrlib.reconcile import reconcile
1640
dir = bzrdir.BzrDir.open(branch)
1644
class cmd_revision_history(Command):
1645
"""Display the list of revision ids on a branch."""
1648
takes_args = ['location?']
1653
def run(self, location="."):
1654
branch = Branch.open_containing(location)[0]
1655
for revid in branch.revision_history():
1656
self.outf.write(revid)
1657
self.outf.write('\n')
1660
class cmd_ancestry(Command):
1661
"""List all revisions merged into this branch."""
1663
_see_also = ['log', 'revision-history']
1664
takes_args = ['location?']
1669
def run(self, location="."):
1671
wt = WorkingTree.open_containing(location)[0]
1672
except errors.NoWorkingTree:
1673
b = Branch.open(location)
1674
last_revision = b.last_revision()
1677
last_revision = wt.last_revision()
1679
revision_ids = b.repository.get_ancestry(last_revision)
1681
for revision_id in revision_ids:
1682
self.outf.write(revision_id + '\n')
1685
class cmd_init(Command):
1686
"""Make a directory into a versioned branch.
1688
Use this to create an empty branch, or before importing an
1691
If there is a repository in a parent directory of the location, then
1692
the history of the branch will be stored in the repository. Otherwise
1693
init creates a standalone branch which carries its own history
1694
in the .bzr directory.
1696
If there is already a branch at the location but it has no working tree,
1697
the tree can be populated with 'bzr checkout'.
1699
Recipe for importing a tree of files::
1705
bzr commit -m "imported project"
1708
_see_also = ['init-repository', 'branch', 'checkout']
1709
takes_args = ['location?']
1711
Option('create-prefix',
1712
help='Create the path leading up to the branch '
1713
'if it does not already exist.'),
1714
RegistryOption('format',
1715
help='Specify a format for this branch. '
1716
'See "help formats".',
1717
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1718
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1719
value_switches=True,
1720
title="Branch format",
1722
Option('append-revisions-only',
1723
help='Never change revnos or the existing log.'
1724
' Append revisions to it only.')
1726
def run(self, location=None, format=None, append_revisions_only=False,
1727
create_prefix=False):
1729
format = bzrdir.format_registry.make_bzrdir('default')
1730
if location is None:
1733
to_transport = transport.get_transport(location)
1735
# The path has to exist to initialize a
1736
# branch inside of it.
1737
# Just using os.mkdir, since I don't
1738
# believe that we want to create a bunch of
1739
# locations if the user supplies an extended path
1741
to_transport.ensure_base()
1742
except errors.NoSuchFile:
1743
if not create_prefix:
1744
raise errors.BzrCommandError("Parent directory of %s"
1746
"\nYou may supply --create-prefix to create all"
1747
" leading parent directories."
1749
to_transport.create_prefix()
1752
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1753
except errors.NotBranchError:
1754
# really a NotBzrDir error...
1755
create_branch = bzrdir.BzrDir.create_branch_convenience
1756
branch = create_branch(to_transport.base, format=format,
1757
possible_transports=[to_transport])
1758
a_bzrdir = branch.bzrdir
1760
from bzrlib.transport.local import LocalTransport
1761
if a_bzrdir.has_branch():
1762
if (isinstance(to_transport, LocalTransport)
1763
and not a_bzrdir.has_workingtree()):
1764
raise errors.BranchExistsWithoutWorkingTree(location)
1765
raise errors.AlreadyBranchError(location)
1766
branch = a_bzrdir.create_branch()
1767
a_bzrdir.create_workingtree()
1768
if append_revisions_only:
1770
branch.set_append_revisions_only(True)
1771
except errors.UpgradeRequired:
1772
raise errors.BzrCommandError('This branch format cannot be set'
1773
' to append-revisions-only. Try --default.')
1775
from bzrlib.info import describe_layout, describe_format
1777
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1778
except (errors.NoWorkingTree, errors.NotLocalUrl):
1780
repository = branch.repository
1781
layout = describe_layout(repository, branch, tree).lower()
1782
format = describe_format(a_bzrdir, repository, branch, tree)
1783
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1784
if repository.is_shared():
1785
#XXX: maybe this can be refactored into transport.path_or_url()
1786
url = repository.bzrdir.root_transport.external_url()
1788
url = urlutils.local_path_from_url(url)
1789
except errors.InvalidURL:
1791
self.outf.write("Using shared repository: %s\n" % url)
1794
class cmd_init_repository(Command):
1795
"""Create a shared repository for branches to share storage space.
1797
New branches created under the repository directory will store their
1798
revisions in the repository, not in the branch directory. For branches
1799
with shared history, this reduces the amount of storage needed and
1800
speeds up the creation of new branches.
1802
If the --no-trees option is given then the branches in the repository
1803
will not have working trees by default. They will still exist as
1804
directories on disk, but they will not have separate copies of the
1805
files at a certain revision. This can be useful for repositories that
1806
store branches which are interacted with through checkouts or remote
1807
branches, such as on a server.
1810
Create a shared repository holding just branches::
1812
bzr init-repo --no-trees repo
1815
Make a lightweight checkout elsewhere::
1817
bzr checkout --lightweight repo/trunk trunk-checkout
1822
_see_also = ['init', 'branch', 'checkout', 'repositories']
1823
takes_args = ["location"]
1824
takes_options = [RegistryOption('format',
1825
help='Specify a format for this repository. See'
1826
' "bzr help formats" for details.',
1827
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1828
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1829
value_switches=True, title='Repository format'),
1831
help='Branches in the repository will default to'
1832
' not having a working tree.'),
1834
aliases = ["init-repo"]
1836
def run(self, location, format=None, no_trees=False):
1838
format = bzrdir.format_registry.make_bzrdir('default')
1840
if location is None:
1843
to_transport = transport.get_transport(location)
1844
to_transport.ensure_base()
1846
newdir = format.initialize_on_transport(to_transport)
1847
repo = newdir.create_repository(shared=True)
1848
repo.set_make_working_trees(not no_trees)
1850
from bzrlib.info import show_bzrdir_info
1851
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1854
class cmd_diff(Command):
1855
"""Show differences in the working tree, between revisions or branches.
1857
If no arguments are given, all changes for the current tree are listed.
1858
If files are given, only the changes in those files are listed.
1859
Remote and multiple branches can be compared by using the --old and
1860
--new options. If not provided, the default for both is derived from
1861
the first argument, if any, or the current tree if no arguments are
1864
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1865
produces patches suitable for "patch -p1".
1869
2 - unrepresentable changes
1874
Shows the difference in the working tree versus the last commit::
1878
Difference between the working tree and revision 1::
1882
Difference between revision 3 and revision 1::
1886
Difference between revision 3 and revision 1 for branch xxx::
1890
To see the changes introduced in revision X::
1894
Note that in the case of a merge, the -c option shows the changes
1895
compared to the left hand parent. To see the changes against
1896
another parent, use::
1898
bzr diff -r<chosen_parent>..X
1900
The changes introduced by revision 2 (equivalent to -r1..2)::
1904
Show just the differences for file NEWS::
1908
Show the differences in working tree xxx for file NEWS::
1912
Show the differences from branch xxx to this working tree:
1916
Show the differences between two branches for file NEWS::
1918
bzr diff --old xxx --new yyy NEWS
1920
Same as 'bzr diff' but prefix paths with old/ and new/::
1922
bzr diff --prefix old/:new/
1924
_see_also = ['status']
1925
takes_args = ['file*']
1927
Option('diff-options', type=str,
1928
help='Pass these options to the external diff program.'),
1929
Option('prefix', type=str,
1931
help='Set prefixes added to old and new filenames, as '
1932
'two values separated by a colon. (eg "old/:new/").'),
1934
help='Branch/tree to compare from.',
1938
help='Branch/tree to compare to.',
1944
help='Use this command to compare files.',
1948
aliases = ['di', 'dif']
1949
encoding_type = 'exact'
1952
def run(self, revision=None, file_list=None, diff_options=None,
1953
prefix=None, old=None, new=None, using=None):
1954
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1956
if (prefix is None) or (prefix == '0'):
1964
old_label, new_label = prefix.split(":")
1966
raise errors.BzrCommandError(
1967
'--prefix expects two values separated by a colon'
1968
' (eg "old/:new/")')
1970
if revision and len(revision) > 2:
1971
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1972
' one or two revision specifiers')
1974
(old_tree, new_tree,
1975
old_branch, new_branch,
1976
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1977
file_list, revision, old, new, apply_view=True)
1978
return show_diff_trees(old_tree, new_tree, sys.stdout,
1979
specific_files=specific_files,
1980
external_diff_options=diff_options,
1981
old_label=old_label, new_label=new_label,
1982
extra_trees=extra_trees, using=using)
1985
class cmd_deleted(Command):
1986
"""List files deleted in the working tree.
1988
# TODO: Show files deleted since a previous revision, or
1989
# between two revisions.
1990
# TODO: Much more efficient way to do this: read in new
1991
# directories with readdir, rather than stating each one. Same
1992
# level of effort but possibly much less IO. (Or possibly not,
1993
# if the directories are very large...)
1994
_see_also = ['status', 'ls']
1995
takes_options = ['show-ids']
1998
def run(self, show_ids=False):
1999
tree = WorkingTree.open_containing(u'.')[0]
2001
self.add_cleanup(tree.unlock)
2002
old = tree.basis_tree()
2004
self.add_cleanup(old.unlock)
2005
for path, ie in old.inventory.iter_entries():
2006
if not tree.has_id(ie.file_id):
2007
self.outf.write(path)
2009
self.outf.write(' ')
2010
self.outf.write(ie.file_id)
2011
self.outf.write('\n')
2014
class cmd_modified(Command):
2015
"""List files modified in working tree.
2019
_see_also = ['status', 'ls']
2022
help='Write an ascii NUL (\\0) separator '
2023
'between files rather than a newline.')
2027
def run(self, null=False):
2028
tree = WorkingTree.open_containing(u'.')[0]
2029
td = tree.changes_from(tree.basis_tree())
2030
for path, id, kind, text_modified, meta_modified in td.modified:
2032
self.outf.write(path + '\0')
2034
self.outf.write(osutils.quotefn(path) + '\n')
2037
class cmd_added(Command):
2038
"""List files added in working tree.
2042
_see_also = ['status', 'ls']
2045
help='Write an ascii NUL (\\0) separator '
2046
'between files rather than a newline.')
2050
def run(self, null=False):
2051
wt = WorkingTree.open_containing(u'.')[0]
2053
self.add_cleanup(wt.unlock)
2054
basis = wt.basis_tree()
2056
self.add_cleanup(basis.unlock)
2057
basis_inv = basis.inventory
2060
if file_id in basis_inv:
2062
if inv.is_root(file_id) and len(basis_inv) == 0:
2064
path = inv.id2path(file_id)
2065
if not os.access(osutils.abspath(path), os.F_OK):
2068
self.outf.write(path + '\0')
2070
self.outf.write(osutils.quotefn(path) + '\n')
2073
class cmd_root(Command):
2074
"""Show the tree root directory.
2076
The root is the nearest enclosing directory with a .bzr control
2079
takes_args = ['filename?']
2081
def run(self, filename=None):
2082
"""Print the branch root."""
2083
tree = WorkingTree.open_containing(filename)[0]
2084
self.outf.write(tree.basedir + '\n')
2087
def _parse_limit(limitstring):
2089
return int(limitstring)
2091
msg = "The limit argument must be an integer."
2092
raise errors.BzrCommandError(msg)
2095
def _parse_levels(s):
2099
msg = "The levels argument must be an integer."
2100
raise errors.BzrCommandError(msg)
2103
class cmd_log(Command):
2104
"""Show historical log for a branch or subset of a branch.
2106
log is bzr's default tool for exploring the history of a branch.
2107
The branch to use is taken from the first parameter. If no parameters
2108
are given, the branch containing the working directory is logged.
2109
Here are some simple examples::
2111
bzr log log the current branch
2112
bzr log foo.py log a file in its branch
2113
bzr log http://server/branch log a branch on a server
2115
The filtering, ordering and information shown for each revision can
2116
be controlled as explained below. By default, all revisions are
2117
shown sorted (topologically) so that newer revisions appear before
2118
older ones and descendants always appear before ancestors. If displayed,
2119
merged revisions are shown indented under the revision in which they
2124
The log format controls how information about each revision is
2125
displayed. The standard log formats are called ``long``, ``short``
2126
and ``line``. The default is long. See ``bzr help log-formats``
2127
for more details on log formats.
2129
The following options can be used to control what information is
2132
-l N display a maximum of N revisions
2133
-n N display N levels of revisions (0 for all, 1 for collapsed)
2134
-v display a status summary (delta) for each revision
2135
-p display a diff (patch) for each revision
2136
--show-ids display revision-ids (and file-ids), not just revnos
2138
Note that the default number of levels to display is a function of the
2139
log format. If the -n option is not used, the standard log formats show
2140
just the top level (mainline).
2142
Status summaries are shown using status flags like A, M, etc. To see
2143
the changes explained using words like ``added`` and ``modified``
2144
instead, use the -vv option.
2148
To display revisions from oldest to newest, use the --forward option.
2149
In most cases, using this option will have little impact on the total
2150
time taken to produce a log, though --forward does not incrementally
2151
display revisions like --reverse does when it can.
2153
:Revision filtering:
2155
The -r option can be used to specify what revision or range of revisions
2156
to filter against. The various forms are shown below::
2158
-rX display revision X
2159
-rX.. display revision X and later
2160
-r..Y display up to and including revision Y
2161
-rX..Y display from X to Y inclusive
2163
See ``bzr help revisionspec`` for details on how to specify X and Y.
2164
Some common examples are given below::
2166
-r-1 show just the tip
2167
-r-10.. show the last 10 mainline revisions
2168
-rsubmit:.. show what's new on this branch
2169
-rancestor:path.. show changes since the common ancestor of this
2170
branch and the one at location path
2171
-rdate:yesterday.. show changes since yesterday
2173
When logging a range of revisions using -rX..Y, log starts at
2174
revision Y and searches back in history through the primary
2175
("left-hand") parents until it finds X. When logging just the
2176
top level (using -n1), an error is reported if X is not found
2177
along the way. If multi-level logging is used (-n0), X may be
2178
a nested merge revision and the log will be truncated accordingly.
2182
If parameters are given and the first one is not a branch, the log
2183
will be filtered to show only those revisions that changed the
2184
nominated files or directories.
2186
Filenames are interpreted within their historical context. To log a
2187
deleted file, specify a revision range so that the file existed at
2188
the end or start of the range.
2190
Historical context is also important when interpreting pathnames of
2191
renamed files/directories. Consider the following example:
2193
* revision 1: add tutorial.txt
2194
* revision 2: modify tutorial.txt
2195
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2199
* ``bzr log guide.txt`` will log the file added in revision 1
2201
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2203
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2204
the original file in revision 2.
2206
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2207
was no file called guide.txt in revision 2.
2209
Renames are always followed by log. By design, there is no need to
2210
explicitly ask for this (and no way to stop logging a file back
2211
until it was last renamed).
2215
The --message option can be used for finding revisions that match a
2216
regular expression in a commit message.
2220
GUI tools and IDEs are often better at exploring history than command
2221
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2222
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2223
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2224
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2226
You may find it useful to add the aliases below to ``bazaar.conf``::
2230
top = log -l10 --line
2233
``bzr tip`` will then show the latest revision while ``bzr top``
2234
will show the last 10 mainline revisions. To see the details of a
2235
particular revision X, ``bzr show -rX``.
2237
If you are interested in looking deeper into a particular merge X,
2238
use ``bzr log -n0 -rX``.
2240
``bzr log -v`` on a branch with lots of history is currently
2241
very slow. A fix for this issue is currently under development.
2242
With or without that fix, it is recommended that a revision range
2243
be given when using the -v option.
2245
bzr has a generic full-text matching plugin, bzr-search, that can be
2246
used to find revisions matching user names, commit messages, etc.
2247
Among other features, this plugin can find all revisions containing
2248
a list of words but not others.
2250
When exploring non-mainline history on large projects with deep
2251
history, the performance of log can be greatly improved by installing
2252
the historycache plugin. This plugin buffers historical information
2253
trading disk space for faster speed.
2255
takes_args = ['file*']
2256
_see_also = ['log-formats', 'revisionspec']
2259
help='Show from oldest to newest.'),
2261
custom_help('verbose',
2262
help='Show files changed in each revision.'),
2266
type=bzrlib.option._parse_revision_str,
2268
help='Show just the specified revision.'
2269
' See also "help revisionspec".'),
2273
help='Number of levels to display - 0 for all, 1 for flat.',
2275
type=_parse_levels),
2278
help='Show revisions whose message matches this '
2279
'regular expression.',
2283
help='Limit the output to the first N revisions.',
2288
help='Show changes made in each revision as a patch.'),
2289
Option('include-merges',
2290
help='Show merged revisions like --levels 0 does.'),
2292
encoding_type = 'replace'
2295
def run(self, file_list=None, timezone='original',
2306
include_merges=False):
2307
from bzrlib.log import (
2309
make_log_request_dict,
2310
_get_info_for_log_files,
2312
direction = (forward and 'forward') or 'reverse'
2317
raise errors.BzrCommandError(
2318
'--levels and --include-merges are mutually exclusive')
2320
if change is not None:
2322
raise errors.RangeInChangeOption()
2323
if revision is not None:
2324
raise errors.BzrCommandError(
2325
'--revision and --change are mutually exclusive')
2330
filter_by_dir = False
2332
# find the file ids to log and check for directory filtering
2333
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2334
revision, file_list)
2335
self.add_cleanup(b.unlock)
2336
for relpath, file_id, kind in file_info_list:
2338
raise errors.BzrCommandError(
2339
"Path unknown at end or start of revision range: %s" %
2341
# If the relpath is the top of the tree, we log everything
2346
file_ids.append(file_id)
2347
filter_by_dir = filter_by_dir or (
2348
kind in ['directory', 'tree-reference'])
2351
# FIXME ? log the current subdir only RBC 20060203
2352
if revision is not None \
2353
and len(revision) > 0 and revision[0].get_branch():
2354
location = revision[0].get_branch()
2357
dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
b = dir.open_branch()
2360
self.add_cleanup(b.unlock)
2361
rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
# Decide on the type of delta & diff filtering to use
2364
# TODO: add an --all-files option to make this configurable & consistent
2372
diff_type = 'partial'
2376
# Build the log formatter
2377
if log_format is None:
2378
log_format = log.log_formatter_registry.get_default(b)
2379
# Make a non-encoding output to include the diffs - bug 328007
2380
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2381
lf = log_format(show_ids=show_ids, to_file=self.outf,
2382
to_exact_file=unencoded_output,
2383
show_timezone=timezone,
2384
delta_format=get_verbosity_level(),
2386
show_advice=levels is None)
2388
# Choose the algorithm for doing the logging. It's annoying
2389
# having multiple code paths like this but necessary until
2390
# the underlying repository format is faster at generating
2391
# deltas or can provide everything we need from the indices.
2392
# The default algorithm - match-using-deltas - works for
2393
# multiple files and directories and is faster for small
2394
# amounts of history (200 revisions say). However, it's too
2395
# slow for logging a single file in a repository with deep
2396
# history, i.e. > 10K revisions. In the spirit of "do no
2397
# evil when adding features", we continue to use the
2398
# original algorithm - per-file-graph - for the "single
2399
# file that isn't a directory without showing a delta" case.
2400
partial_history = revision and b.repository._format.supports_chks
2401
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2402
or delta_type or partial_history)
2404
# Build the LogRequest and execute it
2405
if len(file_ids) == 0:
2407
rqst = make_log_request_dict(
2408
direction=direction, specific_fileids=file_ids,
2409
start_revision=rev1, end_revision=rev2, limit=limit,
2410
message_search=message, delta_type=delta_type,
2411
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2412
Logger(b, rqst).show(lf)
2415
def _get_revision_range(revisionspec_list, branch, command_name):
2416
"""Take the input of a revision option and turn it into a revision range.
2418
It returns RevisionInfo objects which can be used to obtain the rev_id's
2419
of the desired revisions. It does some user input validations.
2421
if revisionspec_list is None:
2424
elif len(revisionspec_list) == 1:
2425
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2426
elif len(revisionspec_list) == 2:
2427
start_spec = revisionspec_list[0]
2428
end_spec = revisionspec_list[1]
2429
if end_spec.get_branch() != start_spec.get_branch():
2430
# b is taken from revision[0].get_branch(), and
2431
# show_log will use its revision_history. Having
2432
# different branches will lead to weird behaviors.
2433
raise errors.BzrCommandError(
2434
"bzr %s doesn't accept two revisions in different"
2435
" branches." % command_name)
2436
rev1 = start_spec.in_history(branch)
2437
# Avoid loading all of history when we know a missing
2438
# end of range means the last revision ...
2439
if end_spec.spec is None:
2440
last_revno, last_revision_id = branch.last_revision_info()
2441
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2443
rev2 = end_spec.in_history(branch)
2445
raise errors.BzrCommandError(
2446
'bzr %s --revision takes one or two values.' % command_name)
2450
def _revision_range_to_revid_range(revision_range):
2453
if revision_range[0] is not None:
2454
rev_id1 = revision_range[0].rev_id
2455
if revision_range[1] is not None:
2456
rev_id2 = revision_range[1].rev_id
2457
return rev_id1, rev_id2
2459
def get_log_format(long=False, short=False, line=False, default='long'):
2460
log_format = default
2464
log_format = 'short'
2470
class cmd_touching_revisions(Command):
2471
"""Return revision-ids which affected a particular file.
2473
A more user-friendly interface is "bzr log FILE".
2477
takes_args = ["filename"]
2480
def run(self, filename):
2481
tree, relpath = WorkingTree.open_containing(filename)
2482
file_id = tree.path2id(relpath)
2485
self.add_cleanup(b.unlock)
2486
touching_revs = log.find_touching_revisions(b, file_id)
2487
for revno, revision_id, what in touching_revs:
2488
self.outf.write("%6d %s\n" % (revno, what))
2491
class cmd_ls(Command):
2492
"""List files in a tree.
2495
_see_also = ['status', 'cat']
2496
takes_args = ['path?']
2500
Option('recursive', short_name='R',
2501
help='Recurse into subdirectories.'),
2503
help='Print paths relative to the root of the branch.'),
2504
Option('unknown', help='Print unknown files.'),
2505
Option('versioned', help='Print versioned files.',
2507
Option('ignored', help='Print ignored files.'),
2509
help='Write an ascii NUL (\\0) separator '
2510
'between files rather than a newline.'),
2512
help='List entries of a particular kind: file, directory, symlink.',
2517
def run(self, revision=None, verbose=False,
2518
recursive=False, from_root=False,
2519
unknown=False, versioned=False, ignored=False,
2520
null=False, kind=None, show_ids=False, path=None):
2522
if kind and kind not in ('file', 'directory', 'symlink'):
2523
raise errors.BzrCommandError('invalid kind specified')
2525
if verbose and null:
2526
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2527
all = not (unknown or versioned or ignored)
2529
selection = {'I':ignored, '?':unknown, 'V':versioned}
2535
raise errors.BzrCommandError('cannot specify both --from-root'
2538
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2541
# Calculate the prefix to use
2545
prefix = relpath + '/'
2546
elif fs_path != '.' and not fs_path.endswith('/'):
2547
prefix = fs_path + '/'
2549
if revision is not None or tree is None:
2550
tree = _get_one_revision_tree('ls', revision, branch=branch)
2553
if isinstance(tree, WorkingTree) and tree.supports_views():
2554
view_files = tree.views.lookup_view()
2557
view_str = views.view_display_str(view_files)
2558
note("Ignoring files outside view. View is %s" % view_str)
2561
self.add_cleanup(tree.unlock)
2562
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2563
from_dir=relpath, recursive=recursive):
2564
# Apply additional masking
2565
if not all and not selection[fc]:
2567
if kind is not None and fkind != kind:
2572
fullpath = osutils.pathjoin(relpath, fp)
2575
views.check_path_in_view(tree, fullpath)
2576
except errors.FileOutsideView:
2581
fp = osutils.pathjoin(prefix, fp)
2582
kindch = entry.kind_character()
2583
outstring = fp + kindch
2584
ui.ui_factory.clear_term()
2586
outstring = '%-8s %s' % (fc, outstring)
2587
if show_ids and fid is not None:
2588
outstring = "%-50s %s" % (outstring, fid)
2589
self.outf.write(outstring + '\n')
2591
self.outf.write(fp + '\0')
2594
self.outf.write(fid)
2595
self.outf.write('\0')
2603
self.outf.write('%-50s %s\n' % (outstring, my_id))
2605
self.outf.write(outstring + '\n')
2608
class cmd_unknowns(Command):
2609
"""List unknown files.
2617
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2618
self.outf.write(osutils.quotefn(f) + '\n')
2621
class cmd_ignore(Command):
2622
"""Ignore specified files or patterns.
2624
See ``bzr help patterns`` for details on the syntax of patterns.
2626
If a .bzrignore file does not exist, the ignore command
2627
will create one and add the specified files or patterns to the newly
2628
created file. The ignore command will also automatically add the
2629
.bzrignore file to be versioned. Creating a .bzrignore file without
2630
the use of the ignore command will require an explicit add command.
2632
To remove patterns from the ignore list, edit the .bzrignore file.
2633
After adding, editing or deleting that file either indirectly by
2634
using this command or directly by using an editor, be sure to commit
2637
Patterns prefixed with '!' are exceptions to ignore patterns and take
2638
precedence over regular ignores. Such exceptions are used to specify
2639
files that should be versioned which would otherwise be ignored.
2641
Patterns prefixed with '!!' act as regular ignore patterns, but have
2642
precedence over the '!' exception patterns.
2644
Note: ignore patterns containing shell wildcards must be quoted from
2648
Ignore the top level Makefile::
2650
bzr ignore ./Makefile
2652
Ignore .class files in all directories...::
2654
bzr ignore "*.class"
2656
...but do not ignore "special.class"::
2658
bzr ignore "!special.class"
2660
Ignore .o files under the lib directory::
2662
bzr ignore "lib/**/*.o"
2664
Ignore .o files under the lib directory::
2666
bzr ignore "RE:lib/.*\.o"
2668
Ignore everything but the "debian" toplevel directory::
2670
bzr ignore "RE:(?!debian/).*"
2672
Ignore everything except the "local" toplevel directory,
2673
but always ignore "*~" autosave files, even under local/::
2676
bzr ignore "!./local"
2680
_see_also = ['status', 'ignored', 'patterns']
2681
takes_args = ['name_pattern*']
2683
Option('old-default-rules',
2684
help='Write out the ignore rules bzr < 0.9 always used.')
2687
def run(self, name_pattern_list=None, old_default_rules=None):
2688
from bzrlib import ignores
2689
if old_default_rules is not None:
2690
# dump the rules and exit
2691
for pattern in ignores.OLD_DEFAULTS:
2692
self.outf.write("%s\n" % pattern)
2694
if not name_pattern_list:
2695
raise errors.BzrCommandError("ignore requires at least one "
2696
"NAME_PATTERN or --old-default-rules")
2697
name_pattern_list = [globbing.normalize_pattern(p)
2698
for p in name_pattern_list]
2699
for name_pattern in name_pattern_list:
2700
if (name_pattern[0] == '/' or
2701
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2702
raise errors.BzrCommandError(
2703
"NAME_PATTERN should not be an absolute path")
2704
tree, relpath = WorkingTree.open_containing(u'.')
2705
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2706
ignored = globbing.Globster(name_pattern_list)
2709
for entry in tree.list_files():
2713
if ignored.match(filename):
2714
matches.append(filename)
2716
if len(matches) > 0:
2717
self.outf.write("Warning: the following files are version controlled and"
2718
" match your ignore pattern:\n%s"
2719
"\nThese files will continue to be version controlled"
2720
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2723
class cmd_ignored(Command):
2724
"""List ignored files and the patterns that matched them.
2726
List all the ignored files and the ignore pattern that caused the file to
2729
Alternatively, to list just the files::
2734
encoding_type = 'replace'
2735
_see_also = ['ignore', 'ls']
2739
tree = WorkingTree.open_containing(u'.')[0]
2741
self.add_cleanup(tree.unlock)
2742
for path, file_class, kind, file_id, entry in tree.list_files():
2743
if file_class != 'I':
2745
## XXX: Slightly inefficient since this was already calculated
2746
pat = tree.is_ignored(path)
2747
self.outf.write('%-50s %s\n' % (path, pat))
2750
class cmd_lookup_revision(Command):
2751
"""Lookup the revision-id from a revision-number
2754
bzr lookup-revision 33
2757
takes_args = ['revno']
2760
def run(self, revno):
2764
raise errors.BzrCommandError("not a valid revision-number: %r"
2766
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2767
self.outf.write("%s\n" % revid)
2770
class cmd_export(Command):
2771
"""Export current or past revision to a destination directory or archive.
2773
If no revision is specified this exports the last committed revision.
2775
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2776
given, try to find the format with the extension. If no extension
2777
is found exports to a directory (equivalent to --format=dir).
2779
If root is supplied, it will be used as the root directory inside
2780
container formats (tar, zip, etc). If it is not supplied it will default
2781
to the exported filename. The root option has no effect for 'dir' format.
2783
If branch is omitted then the branch containing the current working
2784
directory will be used.
2786
Note: Export of tree with non-ASCII filenames to zip is not supported.
2788
================= =========================
2789
Supported formats Autodetected by extension
2790
================= =========================
2793
tbz2 .tar.bz2, .tbz2
2796
================= =========================
2798
takes_args = ['dest', 'branch_or_subdir?']
2801
help="Type of file to export to.",
2804
Option('filters', help='Apply content filters to export the '
2805
'convenient form.'),
2808
help="Name of the root directory inside the exported file."),
2809
Option('per-file-timestamps',
2810
help='Set modification time of files to that of the last '
2811
'revision in which it was changed.'),
2813
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2814
root=None, filters=False, per_file_timestamps=False):
2815
from bzrlib.export import export
2817
if branch_or_subdir is None:
2818
tree = WorkingTree.open_containing(u'.')[0]
2822
b, subdir = Branch.open_containing(branch_or_subdir)
2825
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2827
export(rev_tree, dest, format, root, subdir, filtered=filters,
2828
per_file_timestamps=per_file_timestamps)
2829
except errors.NoSuchExportFormat, e:
2830
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2833
class cmd_cat(Command):
2834
"""Write the contents of a file as of a given revision to standard output.
2836
If no revision is nominated, the last revision is used.
2838
Note: Take care to redirect standard output when using this command on a
2844
Option('name-from-revision', help='The path name in the old tree.'),
2845
Option('filters', help='Apply content filters to display the '
2846
'convenience form.'),
2849
takes_args = ['filename']
2850
encoding_type = 'exact'
2853
def run(self, filename, revision=None, name_from_revision=False,
2855
if revision is not None and len(revision) != 1:
2856
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2857
" one revision specifier")
2858
tree, branch, relpath = \
2859
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2861
self.add_cleanup(branch.unlock)
2862
return self._run(tree, branch, relpath, filename, revision,
2863
name_from_revision, filters)
2865
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2868
tree = b.basis_tree()
2869
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2870
rev_tree.lock_read()
2871
self.add_cleanup(rev_tree.unlock)
2873
old_file_id = rev_tree.path2id(relpath)
2875
if name_from_revision:
2876
# Try in revision if requested
2877
if old_file_id is None:
2878
raise errors.BzrCommandError(
2879
"%r is not present in revision %s" % (
2880
filename, rev_tree.get_revision_id()))
2882
content = rev_tree.get_file_text(old_file_id)
2884
cur_file_id = tree.path2id(relpath)
2886
if cur_file_id is not None:
2887
# Then try with the actual file id
2889
content = rev_tree.get_file_text(cur_file_id)
2891
except errors.NoSuchId:
2892
# The actual file id didn't exist at that time
2894
if not found and old_file_id is not None:
2895
# Finally try with the old file id
2896
content = rev_tree.get_file_text(old_file_id)
2899
# Can't be found anywhere
2900
raise errors.BzrCommandError(
2901
"%r is not present in revision %s" % (
2902
filename, rev_tree.get_revision_id()))
2904
from bzrlib.filters import (
2905
ContentFilterContext,
2906
filtered_output_bytes,
2908
filters = rev_tree._content_filter_stack(relpath)
2909
chunks = content.splitlines(True)
2910
content = filtered_output_bytes(chunks, filters,
2911
ContentFilterContext(relpath, rev_tree))
2913
self.outf.writelines(content)
2916
self.outf.write(content)
2919
class cmd_local_time_offset(Command):
2920
"""Show the offset in seconds from GMT to local time."""
2924
self.outf.write("%s\n" % osutils.local_time_offset())
2928
class cmd_commit(Command):
2929
"""Commit changes into a new revision.
2931
An explanatory message needs to be given for each commit. This is
2932
often done by using the --message option (getting the message from the
2933
command line) or by using the --file option (getting the message from
2934
a file). If neither of these options is given, an editor is opened for
2935
the user to enter the message. To see the changed files in the
2936
boilerplate text loaded into the editor, use the --show-diff option.
2938
By default, the entire tree is committed and the person doing the
2939
commit is assumed to be the author. These defaults can be overridden
2944
If selected files are specified, only changes to those files are
2945
committed. If a directory is specified then the directory and
2946
everything within it is committed.
2948
When excludes are given, they take precedence over selected files.
2949
For example, to commit only changes within foo, but not changes
2952
bzr commit foo -x foo/bar
2954
A selective commit after a merge is not yet supported.
2958
If the author of the change is not the same person as the committer,
2959
you can specify the author's name using the --author option. The
2960
name should be in the same format as a committer-id, e.g.
2961
"John Doe <jdoe@example.com>". If there is more than one author of
2962
the change you can specify the option multiple times, once for each
2967
A common mistake is to forget to add a new file or directory before
2968
running the commit command. The --strict option checks for unknown
2969
files and aborts the commit if any are found. More advanced pre-commit
2970
checks can be implemented by defining hooks. See ``bzr help hooks``
2975
If you accidentially commit the wrong changes or make a spelling
2976
mistake in the commit message say, you can use the uncommit command
2977
to undo it. See ``bzr help uncommit`` for details.
2979
Hooks can also be configured to run after a commit. This allows you
2980
to trigger updates to external systems like bug trackers. The --fixes
2981
option can be used to record the association between a revision and
2982
one or more bugs. See ``bzr help bugs`` for details.
2984
A selective commit may fail in some cases where the committed
2985
tree would be invalid. Consider::
2990
bzr commit foo -m "committing foo"
2991
bzr mv foo/bar foo/baz
2994
bzr commit foo/bar -m "committing bar but not baz"
2996
In the example above, the last commit will fail by design. This gives
2997
the user the opportunity to decide whether they want to commit the
2998
rename at the same time, separately first, or not at all. (As a general
2999
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3001
# TODO: Run hooks on tree to-be-committed, and after commit.
3003
# TODO: Strict commit that fails if there are deleted files.
3004
# (what does "deleted files" mean ??)
3006
# TODO: Give better message for -s, --summary, used by tla people
3008
# XXX: verbose currently does nothing
3010
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3011
takes_args = ['selected*']
3013
ListOption('exclude', type=str, short_name='x',
3014
help="Do not consider changes made to a given path."),
3015
Option('message', type=unicode,
3017
help="Description of the new revision."),
3020
help='Commit even if nothing has changed.'),
3021
Option('file', type=str,
3024
help='Take commit message from this file.'),
3026
help="Refuse to commit if there are unknown "
3027
"files in the working tree."),
3028
Option('commit-time', type=str,
3029
help="Manually set a commit time using commit date "
3030
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3031
ListOption('fixes', type=str,
3032
help="Mark a bug as being fixed by this revision "
3033
"(see \"bzr help bugs\")."),
3034
ListOption('author', type=unicode,
3035
help="Set the author's name, if it's different "
3036
"from the committer."),
3038
help="Perform a local commit in a bound "
3039
"branch. Local commits are not pushed to "
3040
"the master branch until a normal commit "
3044
help='When no message is supplied, show the diff along'
3045
' with the status summary in the message editor.'),
3047
aliases = ['ci', 'checkin']
3049
def _iter_bug_fix_urls(self, fixes, branch):
3050
# Configure the properties for bug fixing attributes.
3051
for fixed_bug in fixes:
3052
tokens = fixed_bug.split(':')
3053
if len(tokens) != 2:
3054
raise errors.BzrCommandError(
3055
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3056
"See \"bzr help bugs\" for more information on this "
3057
"feature.\nCommit refused." % fixed_bug)
3058
tag, bug_id = tokens
3060
yield bugtracker.get_bug_url(tag, branch, bug_id)
3061
except errors.UnknownBugTrackerAbbreviation:
3062
raise errors.BzrCommandError(
3063
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3064
except errors.MalformedBugIdentifier, e:
3065
raise errors.BzrCommandError(
3066
"%s\nCommit refused." % (str(e),))
3068
def run(self, message=None, file=None, verbose=False, selected_list=None,
3069
unchanged=False, strict=False, local=False, fixes=None,
3070
author=None, show_diff=False, exclude=None, commit_time=None):
3071
from bzrlib.errors import (
3076
from bzrlib.msgeditor import (
3077
edit_commit_message_encoded,
3078
generate_commit_message_template,
3079
make_commit_message_template_encoded
3082
commit_stamp = offset = None
3083
if commit_time is not None:
3085
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3086
except ValueError, e:
3087
raise errors.BzrCommandError(
3088
"Could not parse --commit-time: " + str(e))
3090
# TODO: Need a blackbox test for invoking the external editor; may be
3091
# slightly problematic to run this cross-platform.
3093
# TODO: do more checks that the commit will succeed before
3094
# spending the user's valuable time typing a commit message.
3098
tree, selected_list = tree_files(selected_list)
3099
if selected_list == ['']:
3100
# workaround - commit of root of tree should be exactly the same
3101
# as just default commit in that tree, and succeed even though
3102
# selected-file merge commit is not done yet
3107
bug_property = bugtracker.encode_fixes_bug_urls(
3108
self._iter_bug_fix_urls(fixes, tree.branch))
3110
properties['bugs'] = bug_property
3112
if local and not tree.branch.get_bound_location():
3113
raise errors.LocalRequiresBoundBranch()
3115
if message is not None:
3117
file_exists = osutils.lexists(message)
3118
except UnicodeError:
3119
# The commit message contains unicode characters that can't be
3120
# represented in the filesystem encoding, so that can't be a
3125
'The commit message is a file name: "%(f)s".\n'
3126
'(use --file "%(f)s" to take commit message from that file)'
3128
ui.ui_factory.show_warning(warning_msg)
3130
def get_message(commit_obj):
3131
"""Callback to get commit message"""
3132
my_message = message
3133
if my_message is not None and '\r' in my_message:
3134
my_message = my_message.replace('\r\n', '\n')
3135
my_message = my_message.replace('\r', '\n')
3136
if my_message is None and not file:
3137
# t is the status of the tree
3138
t = make_commit_message_template_encoded(tree,
3139
selected_list, diff=show_diff,
3140
output_encoding=osutils.get_user_encoding())
3141
# start_message is the template generated from hooks
3142
start_message = generate_commit_message_template(commit_obj)
3143
my_message = edit_commit_message_encoded(t,
3144
start_message=start_message)
3145
if my_message is None:
3146
raise errors.BzrCommandError("please specify a commit"
3147
" message with either --message or --file")
3148
elif my_message and file:
3149
raise errors.BzrCommandError(
3150
"please specify either --message or --file")
3152
my_message = codecs.open(file, 'rt',
3153
osutils.get_user_encoding()).read()
3154
if my_message == "":
3155
raise errors.BzrCommandError("empty commit message specified")
3158
# The API permits a commit with a filter of [] to mean 'select nothing'
3159
# but the command line should not do that.
3160
if not selected_list:
3161
selected_list = None
3163
tree.commit(message_callback=get_message,
3164
specific_files=selected_list,
3165
allow_pointless=unchanged, strict=strict, local=local,
3166
reporter=None, verbose=verbose, revprops=properties,
3167
authors=author, timestamp=commit_stamp,
3169
exclude=safe_relpath_files(tree, exclude))
3170
except PointlessCommit:
3171
# FIXME: This should really happen before the file is read in;
3172
# perhaps prepare the commit; get the message; then actually commit
3173
raise errors.BzrCommandError("No changes to commit."
3174
" Use --unchanged to commit anyhow.")
3175
except ConflictsInTree:
3176
raise errors.BzrCommandError('Conflicts detected in working '
3177
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3179
except StrictCommitFailed:
3180
raise errors.BzrCommandError("Commit refused because there are"
3181
" unknown files in the working tree.")
3182
except errors.BoundBranchOutOfDate, e:
3183
e.extra_help = ("\n"
3184
'To commit to master branch, run update and then commit.\n'
3185
'You can also pass --local to commit to continue working '
3190
class cmd_check(Command):
3191
"""Validate working tree structure, branch consistency and repository history.
3193
This command checks various invariants about branch and repository storage
3194
to detect data corruption or bzr bugs.
3196
The working tree and branch checks will only give output if a problem is
3197
detected. The output fields of the repository check are:
3200
This is just the number of revisions checked. It doesn't
3204
This is just the number of versionedfiles checked. It
3205
doesn't indicate a problem.
3207
unreferenced ancestors
3208
Texts that are ancestors of other texts, but
3209
are not properly referenced by the revision ancestry. This is a
3210
subtle problem that Bazaar can work around.
3213
This is the total number of unique file contents
3214
seen in the checked revisions. It does not indicate a problem.
3217
This is the total number of repeated texts seen
3218
in the checked revisions. Texts can be repeated when their file
3219
entries are modified, but the file contents are not. It does not
3222
If no restrictions are specified, all Bazaar data that is found at the given
3223
location will be checked.
3227
Check the tree and branch at 'foo'::
3229
bzr check --tree --branch foo
3231
Check only the repository at 'bar'::
3233
bzr check --repo bar
3235
Check everything at 'baz'::
3240
_see_also = ['reconcile']
3241
takes_args = ['path?']
3242
takes_options = ['verbose',
3243
Option('branch', help="Check the branch related to the"
3244
" current directory."),
3245
Option('repo', help="Check the repository related to the"
3246
" current directory."),
3247
Option('tree', help="Check the working tree related to"
3248
" the current directory.")]
3250
def run(self, path=None, verbose=False, branch=False, repo=False,
3252
from bzrlib.check import check_dwim
3255
if not branch and not repo and not tree:
3256
branch = repo = tree = True
3257
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3260
class cmd_upgrade(Command):
3261
"""Upgrade branch storage to current format.
3263
The check command or bzr developers may sometimes advise you to run
3264
this command. When the default format has changed you may also be warned
3265
during other operations to upgrade.
3268
_see_also = ['check']
3269
takes_args = ['url?']
3271
RegistryOption('format',
3272
help='Upgrade to a specific format. See "bzr help'
3273
' formats" for details.',
3274
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3275
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3276
value_switches=True, title='Branch format'),
3279
def run(self, url='.', format=None):
3280
from bzrlib.upgrade import upgrade
3281
upgrade(url, format)
3284
class cmd_whoami(Command):
3285
"""Show or set bzr user id.
3288
Show the email of the current user::
3292
Set the current user::
3294
bzr whoami "Frank Chu <fchu@example.com>"
3296
takes_options = [ Option('email',
3297
help='Display email address only.'),
3299
help='Set identity for the current branch instead of '
3302
takes_args = ['name?']
3303
encoding_type = 'replace'
3306
def run(self, email=False, branch=False, name=None):
3308
# use branch if we're inside one; otherwise global config
3310
c = Branch.open_containing('.')[0].get_config()
3311
except errors.NotBranchError:
3312
c = config.GlobalConfig()
3314
self.outf.write(c.user_email() + '\n')
3316
self.outf.write(c.username() + '\n')
3319
# display a warning if an email address isn't included in the given name.
3321
config.extract_email_address(name)
3322
except errors.NoEmailInUsername, e:
3323
warning('"%s" does not seem to contain an email address. '
3324
'This is allowed, but not recommended.', name)
3326
# use global config unless --branch given
3328
c = Branch.open_containing('.')[0].get_config()
3330
c = config.GlobalConfig()
3331
c.set_user_option('email', name)
3334
class cmd_nick(Command):
3335
"""Print or set the branch nickname.
3337
If unset, the tree root directory name is used as the nickname.
3338
To print the current nickname, execute with no argument.
3340
Bound branches use the nickname of its master branch unless it is set
3344
_see_also = ['info']
3345
takes_args = ['nickname?']
3346
def run(self, nickname=None):
3347
branch = Branch.open_containing(u'.')[0]
3348
if nickname is None:
3349
self.printme(branch)
3351
branch.nick = nickname
3354
def printme(self, branch):
3355
self.outf.write('%s\n' % branch.nick)
3358
class cmd_alias(Command):
3359
"""Set/unset and display aliases.
3362
Show the current aliases::
3366
Show the alias specified for 'll'::
3370
Set an alias for 'll'::
3372
bzr alias ll="log --line -r-10..-1"
3374
To remove an alias for 'll'::
3376
bzr alias --remove ll
3379
takes_args = ['name?']
3381
Option('remove', help='Remove the alias.'),
3384
def run(self, name=None, remove=False):
3386
self.remove_alias(name)
3388
self.print_aliases()
3390
equal_pos = name.find('=')
3392
self.print_alias(name)
3394
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3396
def remove_alias(self, alias_name):
3397
if alias_name is None:
3398
raise errors.BzrCommandError(
3399
'bzr alias --remove expects an alias to remove.')
3400
# If alias is not found, print something like:
3401
# unalias: foo: not found
3402
c = config.GlobalConfig()
3403
c.unset_alias(alias_name)
3406
def print_aliases(self):
3407
"""Print out the defined aliases in a similar format to bash."""
3408
aliases = config.GlobalConfig().get_aliases()
3409
for key, value in sorted(aliases.iteritems()):
3410
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3413
def print_alias(self, alias_name):
3414
from bzrlib.commands import get_alias
3415
alias = get_alias(alias_name)
3417
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3420
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3422
def set_alias(self, alias_name, alias_command):
3423
"""Save the alias in the global config."""
3424
c = config.GlobalConfig()
3425
c.set_alias(alias_name, alias_command)
3428
class cmd_selftest(Command):
3429
"""Run internal test suite.
3431
If arguments are given, they are regular expressions that say which tests
3432
should run. Tests matching any expression are run, and other tests are
3435
Alternatively if --first is given, matching tests are run first and then
3436
all other tests are run. This is useful if you have been working in a
3437
particular area, but want to make sure nothing else was broken.
3439
If --exclude is given, tests that match that regular expression are
3440
excluded, regardless of whether they match --first or not.
3442
To help catch accidential dependencies between tests, the --randomize
3443
option is useful. In most cases, the argument used is the word 'now'.
3444
Note that the seed used for the random number generator is displayed
3445
when this option is used. The seed can be explicitly passed as the
3446
argument to this option if required. This enables reproduction of the
3447
actual ordering used if and when an order sensitive problem is encountered.
3449
If --list-only is given, the tests that would be run are listed. This is
3450
useful when combined with --first, --exclude and/or --randomize to
3451
understand their impact. The test harness reports "Listed nn tests in ..."
3452
instead of "Ran nn tests in ..." when list mode is enabled.
3454
If the global option '--no-plugins' is given, plugins are not loaded
3455
before running the selftests. This has two effects: features provided or
3456
modified by plugins will not be tested, and tests provided by plugins will
3459
Tests that need working space on disk use a common temporary directory,
3460
typically inside $TMPDIR or /tmp.
3462
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3463
into a pdb postmortem session.
3466
Run only tests relating to 'ignore'::
3470
Disable plugins and list tests as they're run::
3472
bzr --no-plugins selftest -v
3474
# NB: this is used from the class without creating an instance, which is
3475
# why it does not have a self parameter.
3476
def get_transport_type(typestring):
3477
"""Parse and return a transport specifier."""
3478
if typestring == "sftp":
3479
from bzrlib.tests import stub_sftp
3480
return stub_sftp.SFTPAbsoluteServer
3481
if typestring == "memory":
3482
from bzrlib.tests import test_server
3483
return memory.MemoryServer
3484
if typestring == "fakenfs":
3485
from bzrlib.tests import test_server
3486
return test_server.FakeNFSServer
3487
msg = "No known transport type %s. Supported types are: sftp\n" %\
3489
raise errors.BzrCommandError(msg)
3492
takes_args = ['testspecs*']
3493
takes_options = ['verbose',
3495
help='Stop when one test fails.',
3499
help='Use a different transport by default '
3500
'throughout the test suite.',
3501
type=get_transport_type),
3503
help='Run the benchmarks rather than selftests.'),
3504
Option('lsprof-timed',
3505
help='Generate lsprof output for benchmarked'
3506
' sections of code.'),
3507
Option('lsprof-tests',
3508
help='Generate lsprof output for each test.'),
3509
Option('cache-dir', type=str,
3510
help='Cache intermediate benchmark output in this '
3513
help='Run all tests, but run specified tests first.',
3517
help='List the tests instead of running them.'),
3518
RegistryOption('parallel',
3519
help="Run the test suite in parallel.",
3520
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3521
value_switches=False,
3523
Option('randomize', type=str, argname="SEED",
3524
help='Randomize the order of tests using the given'
3525
' seed or "now" for the current time.'),
3526
Option('exclude', type=str, argname="PATTERN",
3528
help='Exclude tests that match this regular'
3531
help='Output test progress via subunit.'),
3532
Option('strict', help='Fail on missing dependencies or '
3534
Option('load-list', type=str, argname='TESTLISTFILE',
3535
help='Load a test id list from a text file.'),
3536
ListOption('debugflag', type=str, short_name='E',
3537
help='Turn on a selftest debug flag.'),
3538
ListOption('starting-with', type=str, argname='TESTID',
3539
param_name='starting_with', short_name='s',
3541
'Load only the tests starting with TESTID.'),
3543
encoding_type = 'replace'
3546
Command.__init__(self)
3547
self.additional_selftest_args = {}
3549
def run(self, testspecs_list=None, verbose=False, one=False,
3550
transport=None, benchmark=None,
3551
lsprof_timed=None, cache_dir=None,
3552
first=False, list_only=False,
3553
randomize=None, exclude=None, strict=False,
3554
load_list=None, debugflag=None, starting_with=None, subunit=False,
3555
parallel=None, lsprof_tests=False):
3556
from bzrlib.tests import selftest
3557
import bzrlib.benchmarks as benchmarks
3558
from bzrlib.benchmarks import tree_creator
3560
# Make deprecation warnings visible, unless -Werror is set
3561
symbol_versioning.activate_deprecation_warnings(override=False)
3563
if cache_dir is not None:
3564
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3565
if testspecs_list is not None:
3566
pattern = '|'.join(testspecs_list)
3571
from bzrlib.tests import SubUnitBzrRunner
3573
raise errors.BzrCommandError("subunit not available. subunit "
3574
"needs to be installed to use --subunit.")
3575
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3577
self.additional_selftest_args.setdefault(
3578
'suite_decorators', []).append(parallel)
3580
test_suite_factory = benchmarks.test_suite
3581
# Unless user explicitly asks for quiet, be verbose in benchmarks
3582
verbose = not is_quiet()
3583
# TODO: should possibly lock the history file...
3584
benchfile = open(".perf_history", "at", buffering=1)
3585
self.add_cleanup(benchfile.close)
3587
test_suite_factory = None
3589
selftest_kwargs = {"verbose": verbose,
3591
"stop_on_failure": one,
3592
"transport": transport,
3593
"test_suite_factory": test_suite_factory,
3594
"lsprof_timed": lsprof_timed,
3595
"lsprof_tests": lsprof_tests,
3596
"bench_history": benchfile,
3597
"matching_tests_first": first,
3598
"list_only": list_only,
3599
"random_seed": randomize,
3600
"exclude_pattern": exclude,
3602
"load_list": load_list,
3603
"debug_flags": debugflag,
3604
"starting_with": starting_with
3606
selftest_kwargs.update(self.additional_selftest_args)
3607
result = selftest(**selftest_kwargs)
3608
return int(not result)
3611
class cmd_version(Command):
3612
"""Show version of bzr."""
3614
encoding_type = 'replace'
3616
Option("short", help="Print just the version number."),
3620
def run(self, short=False):
3621
from bzrlib.version import show_version
3623
self.outf.write(bzrlib.version_string + '\n')
3625
show_version(to_file=self.outf)
3628
class cmd_rocks(Command):
3629
"""Statement of optimism."""
3635
self.outf.write("It sure does!\n")
3638
class cmd_find_merge_base(Command):
3639
"""Find and print a base revision for merging two branches."""
3640
# TODO: Options to specify revisions on either side, as if
3641
# merging only part of the history.
3642
takes_args = ['branch', 'other']
3646
def run(self, branch, other):
3647
from bzrlib.revision import ensure_null
3649
branch1 = Branch.open_containing(branch)[0]
3650
branch2 = Branch.open_containing(other)[0]
3652
self.add_cleanup(branch1.unlock)
3654
self.add_cleanup(branch2.unlock)
3655
last1 = ensure_null(branch1.last_revision())
3656
last2 = ensure_null(branch2.last_revision())
3658
graph = branch1.repository.get_graph(branch2.repository)
3659
base_rev_id = graph.find_unique_lca(last1, last2)
3661
self.outf.write('merge base is revision %s\n' % base_rev_id)
3664
class cmd_merge(Command):
3665
"""Perform a three-way merge.
3667
The source of the merge can be specified either in the form of a branch,
3668
or in the form of a path to a file containing a merge directive generated
3669
with bzr send. If neither is specified, the default is the upstream branch
3670
or the branch most recently merged using --remember.
3672
When merging a branch, by default the tip will be merged. To pick a different
3673
revision, pass --revision. If you specify two values, the first will be used as
3674
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3675
available revisions, like this is commonly referred to as "cherrypicking".
3677
Revision numbers are always relative to the branch being merged.
3679
By default, bzr will try to merge in all new work from the other
3680
branch, automatically determining an appropriate base. If this
3681
fails, you may need to give an explicit base.
3683
Merge will do its best to combine the changes in two branches, but there
3684
are some kinds of problems only a human can fix. When it encounters those,
3685
it will mark a conflict. A conflict means that you need to fix something,
3686
before you should commit.
3688
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3690
If there is no default branch set, the first merge will set it. After
3691
that, you can omit the branch to use the default. To change the
3692
default, use --remember. The value will only be saved if the remote
3693
location can be accessed.
3695
The results of the merge are placed into the destination working
3696
directory, where they can be reviewed (with bzr diff), tested, and then
3697
committed to record the result of the merge.
3699
merge refuses to run if there are any uncommitted changes, unless
3700
--force is given. The --force option can also be used to create a
3701
merge revision which has more than two parents.
3703
If one would like to merge changes from the working tree of the other
3704
branch without merging any committed revisions, the --uncommitted option
3707
To select only some changes to merge, use "merge -i", which will prompt
3708
you to apply each diff hunk and file change, similar to "shelve".
3711
To merge the latest revision from bzr.dev::
3713
bzr merge ../bzr.dev
3715
To merge changes up to and including revision 82 from bzr.dev::
3717
bzr merge -r 82 ../bzr.dev
3719
To merge the changes introduced by 82, without previous changes::
3721
bzr merge -r 81..82 ../bzr.dev
3723
To apply a merge directive contained in /tmp/merge::
3725
bzr merge /tmp/merge
3727
To create a merge revision with three parents from two branches
3728
feature1a and feature1b:
3730
bzr merge ../feature1a
3731
bzr merge ../feature1b --force
3732
bzr commit -m 'revision with three parents'
3735
encoding_type = 'exact'
3736
_see_also = ['update', 'remerge', 'status-flags', 'send']
3737
takes_args = ['location?']
3742
help='Merge even if the destination tree has uncommitted changes.'),
3746
Option('show-base', help="Show base revision text in "
3748
Option('uncommitted', help='Apply uncommitted changes'
3749
' from a working copy, instead of branch changes.'),
3750
Option('pull', help='If the destination is already'
3751
' completely merged into the source, pull from the'
3752
' source rather than merging. When this happens,'
3753
' you do not need to commit the result.'),
3755
help='Branch to merge into, '
3756
'rather than the one containing the working directory.',
3760
Option('preview', help='Instead of merging, show a diff of the'
3762
Option('interactive', help='Select changes interactively.',
3766
def run(self, location=None, revision=None, force=False,
3767
merge_type=None, show_base=False, reprocess=None, remember=False,
3768
uncommitted=False, pull=False,
3773
if merge_type is None:
3774
merge_type = _mod_merge.Merge3Merger
3776
if directory is None: directory = u'.'
3777
possible_transports = []
3779
allow_pending = True
3780
verified = 'inapplicable'
3781
tree = WorkingTree.open_containing(directory)[0]
3784
basis_tree = tree.revision_tree(tree.last_revision())
3785
except errors.NoSuchRevision:
3786
basis_tree = tree.basis_tree()
3788
# die as quickly as possible if there are uncommitted changes
3790
if tree.has_changes():
3791
raise errors.UncommittedChanges(tree)
3793
view_info = _get_view_info_for_change_reporter(tree)
3794
change_reporter = delta._ChangeReporter(
3795
unversioned_filter=tree.is_ignored, view_info=view_info)
3796
pb = ui.ui_factory.nested_progress_bar()
3797
self.add_cleanup(pb.finished)
3799
self.add_cleanup(tree.unlock)
3800
if location is not None:
3802
mergeable = bundle.read_mergeable_from_url(location,
3803
possible_transports=possible_transports)
3804
except errors.NotABundle:
3808
raise errors.BzrCommandError('Cannot use --uncommitted'
3809
' with bundles or merge directives.')
3811
if revision is not None:
3812
raise errors.BzrCommandError(
3813
'Cannot use -r with merge directives or bundles')
3814
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3817
if merger is None and uncommitted:
3818
if revision is not None and len(revision) > 0:
3819
raise errors.BzrCommandError('Cannot use --uncommitted and'
3820
' --revision at the same time.')
3821
merger = self.get_merger_from_uncommitted(tree, location, None)
3822
allow_pending = False
3825
merger, allow_pending = self._get_merger_from_branch(tree,
3826
location, revision, remember, possible_transports, None)
3828
merger.merge_type = merge_type
3829
merger.reprocess = reprocess
3830
merger.show_base = show_base
3831
self.sanity_check_merger(merger)
3832
if (merger.base_rev_id == merger.other_rev_id and
3833
merger.other_rev_id is not None):
3834
note('Nothing to do.')
3837
if merger.interesting_files is not None:
3838
raise errors.BzrCommandError('Cannot pull individual files')
3839
if (merger.base_rev_id == tree.last_revision()):
3840
result = tree.pull(merger.other_branch, False,
3841
merger.other_rev_id)
3842
result.report(self.outf)
3844
if merger.this_basis is None:
3845
raise errors.BzrCommandError(
3846
"This branch has no commits."
3847
" (perhaps you would prefer 'bzr pull')")
3849
return self._do_preview(merger)
3851
return self._do_interactive(merger)
3853
return self._do_merge(merger, change_reporter, allow_pending,
3856
def _get_preview(self, merger):
3857
tree_merger = merger.make_merger()
3858
tt = tree_merger.make_preview_transform()
3859
self.add_cleanup(tt.finalize)
3860
result_tree = tt.get_preview_tree()
3863
def _do_preview(self, merger):
3864
from bzrlib.diff import show_diff_trees
3865
result_tree = self._get_preview(merger)
3866
show_diff_trees(merger.this_tree, result_tree, self.outf,
3867
old_label='', new_label='')
3869
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3870
merger.change_reporter = change_reporter
3871
conflict_count = merger.do_merge()
3873
merger.set_pending()
3874
if verified == 'failed':
3875
warning('Preview patch does not match changes')
3876
if conflict_count != 0:
3881
def _do_interactive(self, merger):
3882
"""Perform an interactive merge.
3884
This works by generating a preview tree of the merge, then using
3885
Shelver to selectively remove the differences between the working tree
3886
and the preview tree.
3888
from bzrlib import shelf_ui
3889
result_tree = self._get_preview(merger)
3890
writer = bzrlib.option.diff_writer_registry.get()
3891
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3892
reporter=shelf_ui.ApplyReporter(),
3893
diff_writer=writer(sys.stdout))
3899
def sanity_check_merger(self, merger):
3900
if (merger.show_base and
3901
not merger.merge_type is _mod_merge.Merge3Merger):
3902
raise errors.BzrCommandError("Show-base is not supported for this"
3903
" merge type. %s" % merger.merge_type)
3904
if merger.reprocess is None:
3905
if merger.show_base:
3906
merger.reprocess = False
3908
# Use reprocess if the merger supports it
3909
merger.reprocess = merger.merge_type.supports_reprocess
3910
if merger.reprocess and not merger.merge_type.supports_reprocess:
3911
raise errors.BzrCommandError("Conflict reduction is not supported"
3912
" for merge type %s." %
3914
if merger.reprocess and merger.show_base:
3915
raise errors.BzrCommandError("Cannot do conflict reduction and"
3918
def _get_merger_from_branch(self, tree, location, revision, remember,
3919
possible_transports, pb):
3920
"""Produce a merger from a location, assuming it refers to a branch."""
3921
from bzrlib.tag import _merge_tags_if_possible
3922
# find the branch locations
3923
other_loc, user_location = self._select_branch_location(tree, location,
3925
if revision is not None and len(revision) == 2:
3926
base_loc, _unused = self._select_branch_location(tree,
3927
location, revision, 0)
3929
base_loc = other_loc
3931
other_branch, other_path = Branch.open_containing(other_loc,
3932
possible_transports)
3933
if base_loc == other_loc:
3934
base_branch = other_branch
3936
base_branch, base_path = Branch.open_containing(base_loc,
3937
possible_transports)
3938
# Find the revision ids
3939
other_revision_id = None
3940
base_revision_id = None
3941
if revision is not None:
3942
if len(revision) >= 1:
3943
other_revision_id = revision[-1].as_revision_id(other_branch)
3944
if len(revision) == 2:
3945
base_revision_id = revision[0].as_revision_id(base_branch)
3946
if other_revision_id is None:
3947
other_revision_id = _mod_revision.ensure_null(
3948
other_branch.last_revision())
3949
# Remember where we merge from
3950
if ((remember or tree.branch.get_submit_branch() is None) and
3951
user_location is not None):
3952
tree.branch.set_submit_branch(other_branch.base)
3953
_merge_tags_if_possible(other_branch, tree.branch)
3954
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3955
other_revision_id, base_revision_id, other_branch, base_branch)
3956
if other_path != '':
3957
allow_pending = False
3958
merger.interesting_files = [other_path]
3960
allow_pending = True
3961
return merger, allow_pending
3963
def get_merger_from_uncommitted(self, tree, location, pb):
3964
"""Get a merger for uncommitted changes.
3966
:param tree: The tree the merger should apply to.
3967
:param location: The location containing uncommitted changes.
3968
:param pb: The progress bar to use for showing progress.
3970
location = self._select_branch_location(tree, location)[0]
3971
other_tree, other_path = WorkingTree.open_containing(location)
3972
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3973
if other_path != '':
3974
merger.interesting_files = [other_path]
3977
def _select_branch_location(self, tree, user_location, revision=None,
3979
"""Select a branch location, according to possible inputs.
3981
If provided, branches from ``revision`` are preferred. (Both
3982
``revision`` and ``index`` must be supplied.)
3984
Otherwise, the ``location`` parameter is used. If it is None, then the
3985
``submit`` or ``parent`` location is used, and a note is printed.
3987
:param tree: The working tree to select a branch for merging into
3988
:param location: The location entered by the user
3989
:param revision: The revision parameter to the command
3990
:param index: The index to use for the revision parameter. Negative
3991
indices are permitted.
3992
:return: (selected_location, user_location). The default location
3993
will be the user-entered location.
3995
if (revision is not None and index is not None
3996
and revision[index] is not None):
3997
branch = revision[index].get_branch()
3998
if branch is not None:
3999
return branch, branch
4000
if user_location is None:
4001
location = self._get_remembered(tree, 'Merging from')
4003
location = user_location
4004
return location, user_location
4006
def _get_remembered(self, tree, verb_string):
4007
"""Use tree.branch's parent if none was supplied.
4009
Report if the remembered location was used.
4011
stored_location = tree.branch.get_submit_branch()
4012
stored_location_type = "submit"
4013
if stored_location is None:
4014
stored_location = tree.branch.get_parent()
4015
stored_location_type = "parent"
4016
mutter("%s", stored_location)
4017
if stored_location is None:
4018
raise errors.BzrCommandError("No location specified or remembered")
4019
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4020
note(u"%s remembered %s location %s", verb_string,
4021
stored_location_type, display_url)
4022
return stored_location
4025
class cmd_remerge(Command):
4028
Use this if you want to try a different merge technique while resolving
4029
conflicts. Some merge techniques are better than others, and remerge
4030
lets you try different ones on different files.
4032
The options for remerge have the same meaning and defaults as the ones for
4033
merge. The difference is that remerge can (only) be run when there is a
4034
pending merge, and it lets you specify particular files.
4037
Re-do the merge of all conflicted files, and show the base text in
4038
conflict regions, in addition to the usual THIS and OTHER texts::
4040
bzr remerge --show-base
4042
Re-do the merge of "foobar", using the weave merge algorithm, with
4043
additional processing to reduce the size of conflict regions::
4045
bzr remerge --merge-type weave --reprocess foobar
4047
takes_args = ['file*']
4052
help="Show base revision text in conflicts."),
4055
def run(self, file_list=None, merge_type=None, show_base=False,
4057
if merge_type is None:
4058
merge_type = _mod_merge.Merge3Merger
4059
tree, file_list = tree_files(file_list)
4061
self.add_cleanup(tree.unlock)
4062
parents = tree.get_parent_ids()
4063
if len(parents) != 2:
4064
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4065
" merges. Not cherrypicking or"
4067
repository = tree.branch.repository
4068
interesting_ids = None
4070
conflicts = tree.conflicts()
4071
if file_list is not None:
4072
interesting_ids = set()
4073
for filename in file_list:
4074
file_id = tree.path2id(filename)
4076
raise errors.NotVersionedError(filename)
4077
interesting_ids.add(file_id)
4078
if tree.kind(file_id) != "directory":
4081
for name, ie in tree.inventory.iter_entries(file_id):
4082
interesting_ids.add(ie.file_id)
4083
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4085
# Remerge only supports resolving contents conflicts
4086
allowed_conflicts = ('text conflict', 'contents conflict')
4087
restore_files = [c.path for c in conflicts
4088
if c.typestring in allowed_conflicts]
4089
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4090
tree.set_conflicts(ConflictList(new_conflicts))
4091
if file_list is not None:
4092
restore_files = file_list
4093
for filename in restore_files:
4095
restore(tree.abspath(filename))
4096
except errors.NotConflicted:
4098
# Disable pending merges, because the file texts we are remerging
4099
# have not had those merges performed. If we use the wrong parents
4100
# list, we imply that the working tree text has seen and rejected
4101
# all the changes from the other tree, when in fact those changes
4102
# have not yet been seen.
4103
tree.set_parent_ids(parents[:1])
4105
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4106
merger.interesting_ids = interesting_ids
4107
merger.merge_type = merge_type
4108
merger.show_base = show_base
4109
merger.reprocess = reprocess
4110
conflicts = merger.do_merge()
4112
tree.set_parent_ids(parents)
4119
class cmd_revert(Command):
4120
"""Revert files to a previous revision.
4122
Giving a list of files will revert only those files. Otherwise, all files
4123
will be reverted. If the revision is not specified with '--revision', the
4124
last committed revision is used.
4126
To remove only some changes, without reverting to a prior version, use
4127
merge instead. For example, "merge . --revision -2..-3" will remove the
4128
changes introduced by -2, without affecting the changes introduced by -1.
4129
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4131
By default, any files that have been manually changed will be backed up
4132
first. (Files changed only by merge are not backed up.) Backup files have
4133
'.~#~' appended to their name, where # is a number.
4135
When you provide files, you can use their current pathname or the pathname
4136
from the target revision. So you can use revert to "undelete" a file by
4137
name. If you name a directory, all the contents of that directory will be
4140
If you have newly added files since the target revision, they will be
4141
removed. If the files to be removed have been changed, backups will be
4142
created as above. Directories containing unknown files will not be
4145
The working tree contains a list of revisions that have been merged but
4146
not yet committed. These revisions will be included as additional parents
4147
of the next commit. Normally, using revert clears that list as well as
4148
reverting the files. If any files are specified, revert leaves the list
4149
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4150
.`` in the tree root to revert all files but keep the recorded merges,
4151
and ``bzr revert --forget-merges`` to clear the pending merge list without
4152
reverting any files.
4154
Using "bzr revert --forget-merges", it is possible to apply all of the
4155
changes from a branch in a single revision. To do this, perform the merge
4156
as desired. Then doing revert with the "--forget-merges" option will keep
4157
the content of the tree as it was, but it will clear the list of pending
4158
merges. The next commit will then contain all of the changes that are
4159
present in the other branch, but without any other parent revisions.
4160
Because this technique forgets where these changes originated, it may
4161
cause additional conflicts on later merges involving the same source and
4165
_see_also = ['cat', 'export']
4168
Option('no-backup', "Do not save backups of reverted files."),
4169
Option('forget-merges',
4170
'Remove pending merge marker, without changing any files.'),
4172
takes_args = ['file*']
4174
def run(self, revision=None, no_backup=False, file_list=None,
4175
forget_merges=None):
4176
tree, file_list = tree_files(file_list)
4178
self.add_cleanup(tree.unlock)
4180
tree.set_parent_ids(tree.get_parent_ids()[:1])
4182
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4185
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4186
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4187
tree.revert(file_list, rev_tree, not no_backup, None,
4188
report_changes=True)
4191
class cmd_assert_fail(Command):
4192
"""Test reporting of assertion failures"""
4193
# intended just for use in testing
4198
raise AssertionError("always fails")
4201
class cmd_help(Command):
4202
"""Show help on a command or other topic.
4205
_see_also = ['topics']
4207
Option('long', 'Show help on all commands.'),
4209
takes_args = ['topic?']
4210
aliases = ['?', '--help', '-?', '-h']
4213
def run(self, topic=None, long=False):
4215
if topic is None and long:
4217
bzrlib.help.help(topic)
4220
class cmd_shell_complete(Command):
4221
"""Show appropriate completions for context.
4223
For a list of all available commands, say 'bzr shell-complete'.
4225
takes_args = ['context?']
4230
def run(self, context=None):
4231
import shellcomplete
4232
shellcomplete.shellcomplete(context)
4235
class cmd_missing(Command):
4236
"""Show unmerged/unpulled revisions between two branches.
4238
OTHER_BRANCH may be local or remote.
4240
To filter on a range of revisions, you can use the command -r begin..end
4241
-r revision requests a specific revision, -r ..end or -r begin.. are
4245
1 - some missing revisions
4246
0 - no missing revisions
4250
Determine the missing revisions between this and the branch at the
4251
remembered pull location::
4255
Determine the missing revisions between this and another branch::
4257
bzr missing http://server/branch
4259
Determine the missing revisions up to a specific revision on the other
4262
bzr missing -r ..-10
4264
Determine the missing revisions up to a specific revision on this
4267
bzr missing --my-revision ..-10
4270
_see_also = ['merge', 'pull']
4271
takes_args = ['other_branch?']
4273
Option('reverse', 'Reverse the order of revisions.'),
4275
'Display changes in the local branch only.'),
4276
Option('this' , 'Same as --mine-only.'),
4277
Option('theirs-only',
4278
'Display changes in the remote branch only.'),
4279
Option('other', 'Same as --theirs-only.'),
4283
custom_help('revision',
4284
help='Filter on other branch revisions (inclusive). '
4285
'See "help revisionspec" for details.'),
4286
Option('my-revision',
4287
type=_parse_revision_str,
4288
help='Filter on local branch revisions (inclusive). '
4289
'See "help revisionspec" for details.'),
4290
Option('include-merges',
4291
'Show all revisions in addition to the mainline ones.'),
4293
encoding_type = 'replace'
4296
def run(self, other_branch=None, reverse=False, mine_only=False,
4298
log_format=None, long=False, short=False, line=False,
4299
show_ids=False, verbose=False, this=False, other=False,
4300
include_merges=False, revision=None, my_revision=None):
4301
from bzrlib.missing import find_unmerged, iter_log_revisions
4310
# TODO: We should probably check that we don't have mine-only and
4311
# theirs-only set, but it gets complicated because we also have
4312
# this and other which could be used.
4319
local_branch = Branch.open_containing(u".")[0]
4320
parent = local_branch.get_parent()
4321
if other_branch is None:
4322
other_branch = parent
4323
if other_branch is None:
4324
raise errors.BzrCommandError("No peer location known"
4326
display_url = urlutils.unescape_for_display(parent,
4328
message("Using saved parent location: "
4329
+ display_url + "\n")
4331
remote_branch = Branch.open(other_branch)
4332
if remote_branch.base == local_branch.base:
4333
remote_branch = local_branch
4335
local_branch.lock_read()
4336
self.add_cleanup(local_branch.unlock)
4337
local_revid_range = _revision_range_to_revid_range(
4338
_get_revision_range(my_revision, local_branch,
4341
remote_branch.lock_read()
4342
self.add_cleanup(remote_branch.unlock)
4343
remote_revid_range = _revision_range_to_revid_range(
4344
_get_revision_range(revision,
4345
remote_branch, self.name()))
4347
local_extra, remote_extra = find_unmerged(
4348
local_branch, remote_branch, restrict,
4349
backward=not reverse,
4350
include_merges=include_merges,
4351
local_revid_range=local_revid_range,
4352
remote_revid_range=remote_revid_range)
4354
if log_format is None:
4355
registry = log.log_formatter_registry
4356
log_format = registry.get_default(local_branch)
4357
lf = log_format(to_file=self.outf,
4359
show_timezone='original')
4362
if local_extra and not theirs_only:
4363
message("You have %d extra revision(s):\n" %
4365
for revision in iter_log_revisions(local_extra,
4366
local_branch.repository,
4368
lf.log_revision(revision)
4369
printed_local = True
4372
printed_local = False
4374
if remote_extra and not mine_only:
4375
if printed_local is True:
4377
message("You are missing %d revision(s):\n" %
4379
for revision in iter_log_revisions(remote_extra,
4380
remote_branch.repository,
4382
lf.log_revision(revision)
4385
if mine_only and not local_extra:
4386
# We checked local, and found nothing extra
4387
message('This branch is up to date.\n')
4388
elif theirs_only and not remote_extra:
4389
# We checked remote, and found nothing extra
4390
message('Other branch is up to date.\n')
4391
elif not (mine_only or theirs_only or local_extra or
4393
# We checked both branches, and neither one had extra
4395
message("Branches are up to date.\n")
4397
if not status_code and parent is None and other_branch is not None:
4398
local_branch.lock_write()
4399
self.add_cleanup(local_branch.unlock)
4400
# handle race conditions - a parent might be set while we run.
4401
if local_branch.get_parent() is None:
4402
local_branch.set_parent(remote_branch.base)
4406
class cmd_pack(Command):
4407
"""Compress the data within a repository."""
4409
_see_also = ['repositories']
4410
takes_args = ['branch_or_repo?']
4412
def run(self, branch_or_repo='.'):
4413
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4415
branch = dir.open_branch()
4416
repository = branch.repository
4417
except errors.NotBranchError:
4418
repository = dir.open_repository()
4422
class cmd_plugins(Command):
4423
"""List the installed plugins.
4425
This command displays the list of installed plugins including
4426
version of plugin and a short description of each.
4428
--verbose shows the path where each plugin is located.
4430
A plugin is an external component for Bazaar that extends the
4431
revision control system, by adding or replacing code in Bazaar.
4432
Plugins can do a variety of things, including overriding commands,
4433
adding new commands, providing additional network transports and
4434
customizing log output.
4436
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4437
for further information on plugins including where to find them and how to
4438
install them. Instructions are also provided there on how to write new
4439
plugins using the Python programming language.
4441
takes_options = ['verbose']
4444
def run(self, verbose=False):
4445
import bzrlib.plugin
4446
from inspect import getdoc
4448
for name, plugin in bzrlib.plugin.plugins().items():
4449
version = plugin.__version__
4450
if version == 'unknown':
4452
name_ver = '%s %s' % (name, version)
4453
d = getdoc(plugin.module)
4455
doc = d.split('\n')[0]
4457
doc = '(no description)'
4458
result.append((name_ver, doc, plugin.path()))
4459
for name_ver, doc, path in sorted(result):
4460
self.outf.write("%s\n" % name_ver)
4461
self.outf.write(" %s\n" % doc)
4463
self.outf.write(" %s\n" % path)
4464
self.outf.write("\n")
4467
class cmd_testament(Command):
4468
"""Show testament (signing-form) of a revision."""
4471
Option('long', help='Produce long-format testament.'),
4473
help='Produce a strict-format testament.')]
4474
takes_args = ['branch?']
4476
def run(self, branch=u'.', revision=None, long=False, strict=False):
4477
from bzrlib.testament import Testament, StrictTestament
4479
testament_class = StrictTestament
4481
testament_class = Testament
4483
b = Branch.open_containing(branch)[0]
4485
b = Branch.open(branch)
4487
self.add_cleanup(b.unlock)
4488
if revision is None:
4489
rev_id = b.last_revision()
4491
rev_id = revision[0].as_revision_id(b)
4492
t = testament_class.from_revision(b.repository, rev_id)
4494
sys.stdout.writelines(t.as_text_lines())
4496
sys.stdout.write(t.as_short_text())
4499
class cmd_annotate(Command):
4500
"""Show the origin of each line in a file.
4502
This prints out the given file with an annotation on the left side
4503
indicating which revision, author and date introduced the change.
4505
If the origin is the same for a run of consecutive lines, it is
4506
shown only at the top, unless the --all option is given.
4508
# TODO: annotate directories; showing when each file was last changed
4509
# TODO: if the working copy is modified, show annotations on that
4510
# with new uncommitted lines marked
4511
aliases = ['ann', 'blame', 'praise']
4512
takes_args = ['filename']
4513
takes_options = [Option('all', help='Show annotations on all lines.'),
4514
Option('long', help='Show commit date in annotations.'),
4518
encoding_type = 'exact'
4521
def run(self, filename, all=False, long=False, revision=None,
4523
from bzrlib.annotate import annotate_file, annotate_file_tree
4524
wt, branch, relpath = \
4525
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4528
self.add_cleanup(wt.unlock)
4531
self.add_cleanup(branch.unlock)
4532
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4534
self.add_cleanup(tree.unlock)
4536
file_id = wt.path2id(relpath)
4538
file_id = tree.path2id(relpath)
4540
raise errors.NotVersionedError(filename)
4541
file_version = tree.inventory[file_id].revision
4542
if wt is not None and revision is None:
4543
# If there is a tree and we're not annotating historical
4544
# versions, annotate the working tree's content.
4545
annotate_file_tree(wt, file_id, self.outf, long, all,
4548
annotate_file(branch, file_version, file_id, long, all, self.outf,
4552
class cmd_re_sign(Command):
4553
"""Create a digital signature for an existing revision."""
4554
# TODO be able to replace existing ones.
4556
hidden = True # is this right ?
4557
takes_args = ['revision_id*']
4558
takes_options = ['revision']
4560
def run(self, revision_id_list=None, revision=None):
4561
if revision_id_list is not None and revision is not None:
4562
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4563
if revision_id_list is None and revision is None:
4564
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4565
b = WorkingTree.open_containing(u'.')[0].branch
4567
self.add_cleanup(b.unlock)
4568
return self._run(b, revision_id_list, revision)
4570
def _run(self, b, revision_id_list, revision):
4571
import bzrlib.gpg as gpg
4572
gpg_strategy = gpg.GPGStrategy(b.get_config())
4573
if revision_id_list is not None:
4574
b.repository.start_write_group()
4576
for revision_id in revision_id_list:
4577
b.repository.sign_revision(revision_id, gpg_strategy)
4579
b.repository.abort_write_group()
4582
b.repository.commit_write_group()
4583
elif revision is not None:
4584
if len(revision) == 1:
4585
revno, rev_id = revision[0].in_history(b)
4586
b.repository.start_write_group()
4588
b.repository.sign_revision(rev_id, gpg_strategy)
4590
b.repository.abort_write_group()
4593
b.repository.commit_write_group()
4594
elif len(revision) == 2:
4595
# are they both on rh- if so we can walk between them
4596
# might be nice to have a range helper for arbitrary
4597
# revision paths. hmm.
4598
from_revno, from_revid = revision[0].in_history(b)
4599
to_revno, to_revid = revision[1].in_history(b)
4600
if to_revid is None:
4601
to_revno = b.revno()
4602
if from_revno is None or to_revno is None:
4603
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4604
b.repository.start_write_group()
4606
for revno in range(from_revno, to_revno + 1):
4607
b.repository.sign_revision(b.get_rev_id(revno),
4610
b.repository.abort_write_group()
4613
b.repository.commit_write_group()
4615
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4618
class cmd_bind(Command):
4619
"""Convert the current branch into a checkout of the supplied branch.
4621
Once converted into a checkout, commits must succeed on the master branch
4622
before they will be applied to the local branch.
4624
Bound branches use the nickname of its master branch unless it is set
4625
locally, in which case binding will update the local nickname to be
4629
_see_also = ['checkouts', 'unbind']
4630
takes_args = ['location?']
4633
def run(self, location=None):
4634
b, relpath = Branch.open_containing(u'.')
4635
if location is None:
4637
location = b.get_old_bound_location()
4638
except errors.UpgradeRequired:
4639
raise errors.BzrCommandError('No location supplied. '
4640
'This format does not remember old locations.')
4642
if location is None:
4643
if b.get_bound_location() is not None:
4644
raise errors.BzrCommandError('Branch is already bound')
4646
raise errors.BzrCommandError('No location supplied '
4647
'and no previous location known')
4648
b_other = Branch.open(location)
4651
except errors.DivergedBranches:
4652
raise errors.BzrCommandError('These branches have diverged.'
4653
' Try merging, and then bind again.')
4654
if b.get_config().has_explicit_nickname():
4655
b.nick = b_other.nick
4658
class cmd_unbind(Command):
4659
"""Convert the current checkout into a regular branch.
4661
After unbinding, the local branch is considered independent and subsequent
4662
commits will be local only.
4665
_see_also = ['checkouts', 'bind']
4670
b, relpath = Branch.open_containing(u'.')
4672
raise errors.BzrCommandError('Local branch is not bound')
4675
class cmd_uncommit(Command):
4676
"""Remove the last committed revision.
4678
--verbose will print out what is being removed.
4679
--dry-run will go through all the motions, but not actually
4682
If --revision is specified, uncommit revisions to leave the branch at the
4683
specified revision. For example, "bzr uncommit -r 15" will leave the
4684
branch at revision 15.
4686
Uncommit leaves the working tree ready for a new commit. The only change
4687
it may make is to restore any pending merges that were present before
4691
# TODO: jam 20060108 Add an option to allow uncommit to remove
4692
# unreferenced information in 'branch-as-repository' branches.
4693
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4694
# information in shared branches as well.
4695
_see_also = ['commit']
4696
takes_options = ['verbose', 'revision',
4697
Option('dry-run', help='Don\'t actually make changes.'),
4698
Option('force', help='Say yes to all questions.'),
4700
help="Only remove the commits from the local branch"
4701
" when in a checkout."
4704
takes_args = ['location?']
4706
encoding_type = 'replace'
4708
def run(self, location=None,
4709
dry_run=False, verbose=False,
4710
revision=None, force=False, local=False):
4711
if location is None:
4713
control, relpath = bzrdir.BzrDir.open_containing(location)
4715
tree = control.open_workingtree()
4717
except (errors.NoWorkingTree, errors.NotLocalUrl):
4719
b = control.open_branch()
4721
if tree is not None:
4723
self.add_cleanup(tree.unlock)
4726
self.add_cleanup(b.unlock)
4727
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4729
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4730
from bzrlib.log import log_formatter, show_log
4731
from bzrlib.uncommit import uncommit
4733
last_revno, last_rev_id = b.last_revision_info()
4736
if revision is None:
4738
rev_id = last_rev_id
4740
# 'bzr uncommit -r 10' actually means uncommit
4741
# so that the final tree is at revno 10.
4742
# but bzrlib.uncommit.uncommit() actually uncommits
4743
# the revisions that are supplied.
4744
# So we need to offset it by one
4745
revno = revision[0].in_history(b).revno + 1
4746
if revno <= last_revno:
4747
rev_id = b.get_rev_id(revno)
4749
if rev_id is None or _mod_revision.is_null(rev_id):
4750
self.outf.write('No revisions to uncommit.\n')
4753
lf = log_formatter('short',
4755
show_timezone='original')
4760
direction='forward',
4761
start_revision=revno,
4762
end_revision=last_revno)
4765
self.outf.write('Dry-run, pretending to remove'
4766
' the above revisions.\n')
4768
self.outf.write('The above revision(s) will be removed.\n')
4771
if not ui.ui_factory.get_boolean('Are you sure'):
4772
self.outf.write('Canceled')
4775
mutter('Uncommitting from {%s} to {%s}',
4776
last_rev_id, rev_id)
4777
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4778
revno=revno, local=local)
4779
self.outf.write('You can restore the old tip by running:\n'
4780
' bzr pull . -r revid:%s\n' % last_rev_id)
4783
class cmd_break_lock(Command):
4784
"""Break a dead lock on a repository, branch or working directory.
4786
CAUTION: Locks should only be broken when you are sure that the process
4787
holding the lock has been stopped.
4789
You can get information on what locks are open via the 'bzr info
4790
[location]' command.
4794
bzr break-lock bzr+ssh://example.com/bzr/foo
4796
takes_args = ['location?']
4798
def run(self, location=None, show=False):
4799
if location is None:
4801
control, relpath = bzrdir.BzrDir.open_containing(location)
4803
control.break_lock()
4804
except NotImplementedError:
4808
class cmd_wait_until_signalled(Command):
4809
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4811
This just prints a line to signal when it is ready, then blocks on stdin.
4817
sys.stdout.write("running\n")
4819
sys.stdin.readline()
4822
class cmd_serve(Command):
4823
"""Run the bzr server."""
4825
aliases = ['server']
4829
help='Serve on stdin/out for use from inetd or sshd.'),
4830
RegistryOption('protocol',
4831
help="Protocol to serve.",
4832
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4833
value_switches=True),
4835
help='Listen for connections on nominated port of the form '
4836
'[hostname:]portnumber. Passing 0 as the port number will '
4837
'result in a dynamically allocated port. The default port '
4838
'depends on the protocol.',
4841
help='Serve contents of this directory.',
4843
Option('allow-writes',
4844
help='By default the server is a readonly server. Supplying '
4845
'--allow-writes enables write access to the contents of '
4846
'the served directory and below. Note that ``bzr serve`` '
4847
'does not perform authentication, so unless some form of '
4848
'external authentication is arranged supplying this '
4849
'option leads to global uncontrolled write access to your '
4854
def get_host_and_port(self, port):
4855
"""Return the host and port to run the smart server on.
4857
If 'port' is None, None will be returned for the host and port.
4859
If 'port' has a colon in it, the string before the colon will be
4860
interpreted as the host.
4862
:param port: A string of the port to run the server on.
4863
:return: A tuple of (host, port), where 'host' is a host name or IP,
4864
and port is an integer TCP/IP port.
4867
if port is not None:
4869
host, port = port.split(':')
4873
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4875
from bzrlib.transport import get_transport, transport_server_registry
4876
if directory is None:
4877
directory = os.getcwd()
4878
if protocol is None:
4879
protocol = transport_server_registry.get()
4880
host, port = self.get_host_and_port(port)
4881
url = urlutils.local_path_to_url(directory)
4882
if not allow_writes:
4883
url = 'readonly+' + url
4884
transport = get_transport(url)
4885
protocol(transport, host, port, inet)
4888
class cmd_join(Command):
4889
"""Combine a tree into its containing tree.
4891
This command requires the target tree to be in a rich-root format.
4893
The TREE argument should be an independent tree, inside another tree, but
4894
not part of it. (Such trees can be produced by "bzr split", but also by
4895
running "bzr branch" with the target inside a tree.)
4897
The result is a combined tree, with the subtree no longer an independant
4898
part. This is marked as a merge of the subtree into the containing tree,
4899
and all history is preserved.
4902
_see_also = ['split']
4903
takes_args = ['tree']
4905
Option('reference', help='Join by reference.', hidden=True),
4908
def run(self, tree, reference=False):
4909
sub_tree = WorkingTree.open(tree)
4910
parent_dir = osutils.dirname(sub_tree.basedir)
4911
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4912
repo = containing_tree.branch.repository
4913
if not repo.supports_rich_root():
4914
raise errors.BzrCommandError(
4915
"Can't join trees because %s doesn't support rich root data.\n"
4916
"You can use bzr upgrade on the repository."
4920
containing_tree.add_reference(sub_tree)
4921
except errors.BadReferenceTarget, e:
4922
# XXX: Would be better to just raise a nicely printable
4923
# exception from the real origin. Also below. mbp 20070306
4924
raise errors.BzrCommandError("Cannot join %s. %s" %
4928
containing_tree.subsume(sub_tree)
4929
except errors.BadSubsumeSource, e:
4930
raise errors.BzrCommandError("Cannot join %s. %s" %
4934
class cmd_split(Command):
4935
"""Split a subdirectory of a tree into a separate tree.
4937
This command will produce a target tree in a format that supports
4938
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4939
converted into earlier formats like 'dirstate-tags'.
4941
The TREE argument should be a subdirectory of a working tree. That
4942
subdirectory will be converted into an independent tree, with its own
4943
branch. Commits in the top-level tree will not apply to the new subtree.
4946
_see_also = ['join']
4947
takes_args = ['tree']
4949
def run(self, tree):
4950
containing_tree, subdir = WorkingTree.open_containing(tree)
4951
sub_id = containing_tree.path2id(subdir)
4953
raise errors.NotVersionedError(subdir)
4955
containing_tree.extract(sub_id)
4956
except errors.RootNotRich:
4957
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4960
class cmd_merge_directive(Command):
4961
"""Generate a merge directive for auto-merge tools.
4963
A directive requests a merge to be performed, and also provides all the
4964
information necessary to do so. This means it must either include a
4965
revision bundle, or the location of a branch containing the desired
4968
A submit branch (the location to merge into) must be supplied the first
4969
time the command is issued. After it has been supplied once, it will
4970
be remembered as the default.
4972
A public branch is optional if a revision bundle is supplied, but required
4973
if --diff or --plain is specified. It will be remembered as the default
4974
after the first use.
4977
takes_args = ['submit_branch?', 'public_branch?']
4981
_see_also = ['send']
4984
RegistryOption.from_kwargs('patch-type',
4985
'The type of patch to include in the directive.',
4987
value_switches=True,
4989
bundle='Bazaar revision bundle (default).',
4990
diff='Normal unified diff.',
4991
plain='No patch, just directive.'),
4992
Option('sign', help='GPG-sign the directive.'), 'revision',
4993
Option('mail-to', type=str,
4994
help='Instead of printing the directive, email to this address.'),
4995
Option('message', type=str, short_name='m',
4996
help='Message to use when committing this merge.')
4999
encoding_type = 'exact'
5001
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5002
sign=False, revision=None, mail_to=None, message=None):
5003
from bzrlib.revision import ensure_null, NULL_REVISION
5004
include_patch, include_bundle = {
5005
'plain': (False, False),
5006
'diff': (True, False),
5007
'bundle': (True, True),
5009
branch = Branch.open('.')
5010
stored_submit_branch = branch.get_submit_branch()
5011
if submit_branch is None:
5012
submit_branch = stored_submit_branch
5014
if stored_submit_branch is None:
5015
branch.set_submit_branch(submit_branch)
5016
if submit_branch is None:
5017
submit_branch = branch.get_parent()
5018
if submit_branch is None:
5019
raise errors.BzrCommandError('No submit branch specified or known')
5021
stored_public_branch = branch.get_public_branch()
5022
if public_branch is None:
5023
public_branch = stored_public_branch
5024
elif stored_public_branch is None:
5025
branch.set_public_branch(public_branch)
5026
if not include_bundle and public_branch is None:
5027
raise errors.BzrCommandError('No public branch specified or'
5029
base_revision_id = None
5030
if revision is not None:
5031
if len(revision) > 2:
5032
raise errors.BzrCommandError('bzr merge-directive takes '
5033
'at most two one revision identifiers')
5034
revision_id = revision[-1].as_revision_id(branch)
5035
if len(revision) == 2:
5036
base_revision_id = revision[0].as_revision_id(branch)
5038
revision_id = branch.last_revision()
5039
revision_id = ensure_null(revision_id)
5040
if revision_id == NULL_REVISION:
5041
raise errors.BzrCommandError('No revisions to bundle.')
5042
directive = merge_directive.MergeDirective2.from_objects(
5043
branch.repository, revision_id, time.time(),
5044
osutils.local_time_offset(), submit_branch,
5045
public_branch=public_branch, include_patch=include_patch,
5046
include_bundle=include_bundle, message=message,
5047
base_revision_id=base_revision_id)
5050
self.outf.write(directive.to_signed(branch))
5052
self.outf.writelines(directive.to_lines())
5054
message = directive.to_email(mail_to, branch, sign)
5055
s = SMTPConnection(branch.get_config())
5056
s.send_email(message)
5059
class cmd_send(Command):
5060
"""Mail or create a merge-directive for submitting changes.
5062
A merge directive provides many things needed for requesting merges:
5064
* A machine-readable description of the merge to perform
5066
* An optional patch that is a preview of the changes requested
5068
* An optional bundle of revision data, so that the changes can be applied
5069
directly from the merge directive, without retrieving data from a
5072
`bzr send` creates a compact data set that, when applied using bzr
5073
merge, has the same effect as merging from the source branch.
5075
By default the merge directive is self-contained and can be applied to any
5076
branch containing submit_branch in its ancestory without needing access to
5079
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5080
revisions, but only a structured request to merge from the
5081
public_location. In that case the public_branch is needed and it must be
5082
up-to-date and accessible to the recipient. The public_branch is always
5083
included if known, so that people can check it later.
5085
The submit branch defaults to the parent of the source branch, but can be
5086
overridden. Both submit branch and public branch will be remembered in
5087
branch.conf the first time they are used for a particular branch. The
5088
source branch defaults to that containing the working directory, but can
5089
be changed using --from.
5091
In order to calculate those changes, bzr must analyse the submit branch.
5092
Therefore it is most efficient for the submit branch to be a local mirror.
5093
If a public location is known for the submit_branch, that location is used
5094
in the merge directive.
5096
The default behaviour is to send the merge directive by mail, unless -o is
5097
given, in which case it is sent to a file.
5099
Mail is sent using your preferred mail program. This should be transparent
5100
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5101
If the preferred client can't be found (or used), your editor will be used.
5103
To use a specific mail program, set the mail_client configuration option.
5104
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5105
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5106
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5107
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5110
If mail is being sent, a to address is required. This can be supplied
5111
either on the commandline, by setting the submit_to configuration
5112
option in the branch itself or the child_submit_to configuration option
5113
in the submit branch.
5115
Two formats are currently supported: "4" uses revision bundle format 4 and
5116
merge directive format 2. It is significantly faster and smaller than
5117
older formats. It is compatible with Bazaar 0.19 and later. It is the
5118
default. "0.9" uses revision bundle format 0.9 and merge directive
5119
format 1. It is compatible with Bazaar 0.12 - 0.18.
5121
The merge directives created by bzr send may be applied using bzr merge or
5122
bzr pull by specifying a file containing a merge directive as the location.
5124
bzr send makes extensive use of public locations to map local locations into
5125
URLs that can be used by other people. See `bzr help configuration` to
5126
set them, and use `bzr info` to display them.
5129
encoding_type = 'exact'
5131
_see_also = ['merge', 'pull']
5133
takes_args = ['submit_branch?', 'public_branch?']
5137
help='Do not include a bundle in the merge directive.'),
5138
Option('no-patch', help='Do not include a preview patch in the merge'
5141
help='Remember submit and public branch.'),
5143
help='Branch to generate the submission from, '
5144
'rather than the one containing the working directory.',
5147
Option('output', short_name='o',
5148
help='Write merge directive to this file; '
5149
'use - for stdout.',
5152
help='Refuse to send if there are uncommitted changes in'
5153
' the working tree, --no-strict disables the check.'),
5154
Option('mail-to', help='Mail the request to this address.',
5158
Option('body', help='Body for the email.', type=unicode),
5159
RegistryOption('format',
5160
help='Use the specified output format.',
5161
lazy_registry=('bzrlib.send', 'format_registry')),
5164
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5165
no_patch=False, revision=None, remember=False, output=None,
5166
format=None, mail_to=None, message=None, body=None,
5167
strict=None, **kwargs):
5168
from bzrlib.send import send
5169
return send(submit_branch, revision, public_branch, remember,
5170
format, no_bundle, no_patch, output,
5171
kwargs.get('from', '.'), mail_to, message, body,
5176
class cmd_bundle_revisions(cmd_send):
5177
"""Create a merge-directive for submitting changes.
5179
A merge directive provides many things needed for requesting merges:
5181
* A machine-readable description of the merge to perform
5183
* An optional patch that is a preview of the changes requested
5185
* An optional bundle of revision data, so that the changes can be applied
5186
directly from the merge directive, without retrieving data from a
5189
If --no-bundle is specified, then public_branch is needed (and must be
5190
up-to-date), so that the receiver can perform the merge using the
5191
public_branch. The public_branch is always included if known, so that
5192
people can check it later.
5194
The submit branch defaults to the parent, but can be overridden. Both
5195
submit branch and public branch will be remembered if supplied.
5197
If a public_branch is known for the submit_branch, that public submit
5198
branch is used in the merge instructions. This means that a local mirror
5199
can be used as your actual submit branch, once you have set public_branch
5202
Two formats are currently supported: "4" uses revision bundle format 4 and
5203
merge directive format 2. It is significantly faster and smaller than
5204
older formats. It is compatible with Bazaar 0.19 and later. It is the
5205
default. "0.9" uses revision bundle format 0.9 and merge directive
5206
format 1. It is compatible with Bazaar 0.12 - 0.18.
5211
help='Do not include a bundle in the merge directive.'),
5212
Option('no-patch', help='Do not include a preview patch in the merge'
5215
help='Remember submit and public branch.'),
5217
help='Branch to generate the submission from, '
5218
'rather than the one containing the working directory.',
5221
Option('output', short_name='o', help='Write directive to this file.',
5224
help='Refuse to bundle revisions if there are uncommitted'
5225
' changes in the working tree, --no-strict disables the check.'),
5227
RegistryOption('format',
5228
help='Use the specified output format.',
5229
lazy_registry=('bzrlib.send', 'format_registry')),
5231
aliases = ['bundle']
5233
_see_also = ['send', 'merge']
5237
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5238
no_patch=False, revision=None, remember=False, output=None,
5239
format=None, strict=None, **kwargs):
5242
from bzrlib.send import send
5243
return send(submit_branch, revision, public_branch, remember,
5244
format, no_bundle, no_patch, output,
5245
kwargs.get('from', '.'), None, None, None,
5246
self.outf, strict=strict)
5249
class cmd_tag(Command):
5250
"""Create, remove or modify a tag naming a revision.
5252
Tags give human-meaningful names to revisions. Commands that take a -r
5253
(--revision) option can be given -rtag:X, where X is any previously
5256
Tags are stored in the branch. Tags are copied from one branch to another
5257
along when you branch, push, pull or merge.
5259
It is an error to give a tag name that already exists unless you pass
5260
--force, in which case the tag is moved to point to the new revision.
5262
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5263
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5266
_see_also = ['commit', 'tags']
5267
takes_args = ['tag_name']
5270
help='Delete this tag rather than placing it.',
5273
help='Branch in which to place the tag.',
5278
help='Replace existing tags.',
5283
def run(self, tag_name,
5289
branch, relpath = Branch.open_containing(directory)
5291
self.add_cleanup(branch.unlock)
5293
branch.tags.delete_tag(tag_name)
5294
self.outf.write('Deleted tag %s.\n' % tag_name)
5297
if len(revision) != 1:
5298
raise errors.BzrCommandError(
5299
"Tags can only be placed on a single revision, "
5301
revision_id = revision[0].as_revision_id(branch)
5303
revision_id = branch.last_revision()
5304
if (not force) and branch.tags.has_tag(tag_name):
5305
raise errors.TagAlreadyExists(tag_name)
5306
branch.tags.set_tag(tag_name, revision_id)
5307
self.outf.write('Created tag %s.\n' % tag_name)
5310
class cmd_tags(Command):
5313
This command shows a table of tag names and the revisions they reference.
5319
help='Branch whose tags should be displayed.',
5323
RegistryOption.from_kwargs('sort',
5324
'Sort tags by different criteria.', title='Sorting',
5325
alpha='Sort tags lexicographically (default).',
5326
time='Sort tags chronologically.',
5339
branch, relpath = Branch.open_containing(directory)
5341
tags = branch.tags.get_tag_dict().items()
5346
self.add_cleanup(branch.unlock)
5348
graph = branch.repository.get_graph()
5349
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5350
revid1, revid2 = rev1.rev_id, rev2.rev_id
5351
# only show revisions between revid1 and revid2 (inclusive)
5352
tags = [(tag, revid) for tag, revid in tags if
5353
graph.is_between(revid, revid1, revid2)]
5356
elif sort == 'time':
5358
for tag, revid in tags:
5360
revobj = branch.repository.get_revision(revid)
5361
except errors.NoSuchRevision:
5362
timestamp = sys.maxint # place them at the end
5364
timestamp = revobj.timestamp
5365
timestamps[revid] = timestamp
5366
tags.sort(key=lambda x: timestamps[x[1]])
5368
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5369
for index, (tag, revid) in enumerate(tags):
5371
revno = branch.revision_id_to_dotted_revno(revid)
5372
if isinstance(revno, tuple):
5373
revno = '.'.join(map(str, revno))
5374
except errors.NoSuchRevision:
5375
# Bad tag data/merges can lead to tagged revisions
5376
# which are not in this branch. Fail gracefully ...
5378
tags[index] = (tag, revno)
5380
for tag, revspec in tags:
5381
self.outf.write('%-20s %s\n' % (tag, revspec))
5384
class cmd_reconfigure(Command):
5385
"""Reconfigure the type of a bzr directory.
5387
A target configuration must be specified.
5389
For checkouts, the bind-to location will be auto-detected if not specified.
5390
The order of preference is
5391
1. For a lightweight checkout, the current bound location.
5392
2. For branches that used to be checkouts, the previously-bound location.
5393
3. The push location.
5394
4. The parent location.
5395
If none of these is available, --bind-to must be specified.
5398
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5399
takes_args = ['location?']
5401
RegistryOption.from_kwargs(
5403
title='Target type',
5404
help='The type to reconfigure the directory to.',
5405
value_switches=True, enum_switch=False,
5406
branch='Reconfigure to be an unbound branch with no working tree.',
5407
tree='Reconfigure to be an unbound branch with a working tree.',
5408
checkout='Reconfigure to be a bound branch with a working tree.',
5409
lightweight_checkout='Reconfigure to be a lightweight'
5410
' checkout (with no local history).',
5411
standalone='Reconfigure to be a standalone branch '
5412
'(i.e. stop using shared repository).',
5413
use_shared='Reconfigure to use a shared repository.',
5414
with_trees='Reconfigure repository to create '
5415
'working trees on branches by default.',
5416
with_no_trees='Reconfigure repository to not create '
5417
'working trees on branches by default.'
5419
Option('bind-to', help='Branch to bind checkout to.', type=str),
5421
help='Perform reconfiguration even if local changes'
5423
Option('stacked-on',
5424
help='Reconfigure a branch to be stacked on another branch.',
5428
help='Reconfigure a branch to be unstacked. This '
5429
'may require copying substantial data into it.',
5433
def run(self, location=None, target_type=None, bind_to=None, force=False,
5436
directory = bzrdir.BzrDir.open(location)
5437
if stacked_on and unstacked:
5438
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5439
elif stacked_on is not None:
5440
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5442
reconfigure.ReconfigureUnstacked().apply(directory)
5443
# At the moment you can use --stacked-on and a different
5444
# reconfiguration shape at the same time; there seems no good reason
5446
if target_type is None:
5447
if stacked_on or unstacked:
5450
raise errors.BzrCommandError('No target configuration '
5452
elif target_type == 'branch':
5453
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5454
elif target_type == 'tree':
5455
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5456
elif target_type == 'checkout':
5457
reconfiguration = reconfigure.Reconfigure.to_checkout(
5459
elif target_type == 'lightweight-checkout':
5460
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5462
elif target_type == 'use-shared':
5463
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5464
elif target_type == 'standalone':
5465
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5466
elif target_type == 'with-trees':
5467
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5469
elif target_type == 'with-no-trees':
5470
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5472
reconfiguration.apply(force)
5475
class cmd_switch(Command):
5476
"""Set the branch of a checkout and update.
5478
For lightweight checkouts, this changes the branch being referenced.
5479
For heavyweight checkouts, this checks that there are no local commits
5480
versus the current bound branch, then it makes the local branch a mirror
5481
of the new location and binds to it.
5483
In both cases, the working tree is updated and uncommitted changes
5484
are merged. The user can commit or revert these as they desire.
5486
Pending merges need to be committed or reverted before using switch.
5488
The path to the branch to switch to can be specified relative to the parent
5489
directory of the current branch. For example, if you are currently in a
5490
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5493
Bound branches use the nickname of its master branch unless it is set
5494
locally, in which case switching will update the local nickname to be
5498
takes_args = ['to_location?']
5499
takes_options = [Option('force',
5500
help='Switch even if local commits will be lost.'),
5502
Option('create-branch', short_name='b',
5503
help='Create the target branch from this one before'
5504
' switching to it.'),
5507
def run(self, to_location=None, force=False, create_branch=False,
5509
from bzrlib import switch
5511
revision = _get_one_revision('switch', revision)
5512
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5513
if to_location is None:
5514
if revision is None:
5515
raise errors.BzrCommandError('You must supply either a'
5516
' revision or a location')
5519
branch = control_dir.open_branch()
5520
had_explicit_nick = branch.get_config().has_explicit_nickname()
5521
except errors.NotBranchError:
5523
had_explicit_nick = False
5526
raise errors.BzrCommandError('cannot create branch without'
5528
to_location = directory_service.directories.dereference(
5530
if '/' not in to_location and '\\' not in to_location:
5531
# This path is meant to be relative to the existing branch
5532
this_url = self._get_branch_location(control_dir)
5533
to_location = urlutils.join(this_url, '..', to_location)
5534
to_branch = branch.bzrdir.sprout(to_location,
5535
possible_transports=[branch.bzrdir.root_transport],
5536
source_branch=branch).open_branch()
5539
to_branch = Branch.open(to_location)
5540
except errors.NotBranchError:
5541
this_url = self._get_branch_location(control_dir)
5542
to_branch = Branch.open(
5543
urlutils.join(this_url, '..', to_location))
5544
if revision is not None:
5545
revision = revision.as_revision_id(to_branch)
5546
switch.switch(control_dir, to_branch, force, revision_id=revision)
5547
if had_explicit_nick:
5548
branch = control_dir.open_branch() #get the new branch!
5549
branch.nick = to_branch.nick
5550
note('Switched to branch: %s',
5551
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5553
def _get_branch_location(self, control_dir):
5554
"""Return location of branch for this control dir."""
5556
this_branch = control_dir.open_branch()
5557
# This may be a heavy checkout, where we want the master branch
5558
master_location = this_branch.get_bound_location()
5559
if master_location is not None:
5560
return master_location
5561
# If not, use a local sibling
5562
return this_branch.base
5563
except errors.NotBranchError:
5564
format = control_dir.find_branch_format()
5565
if getattr(format, 'get_reference', None) is not None:
5566
return format.get_reference(control_dir)
5568
return control_dir.root_transport.base
5571
class cmd_view(Command):
5572
"""Manage filtered views.
5574
Views provide a mask over the tree so that users can focus on
5575
a subset of a tree when doing their work. After creating a view,
5576
commands that support a list of files - status, diff, commit, etc -
5577
effectively have that list of files implicitly given each time.
5578
An explicit list of files can still be given but those files
5579
must be within the current view.
5581
In most cases, a view has a short life-span: it is created to make
5582
a selected change and is deleted once that change is committed.
5583
At other times, you may wish to create one or more named views
5584
and switch between them.
5586
To disable the current view without deleting it, you can switch to
5587
the pseudo view called ``off``. This can be useful when you need
5588
to see the whole tree for an operation or two (e.g. merge) but
5589
want to switch back to your view after that.
5592
To define the current view::
5594
bzr view file1 dir1 ...
5596
To list the current view::
5600
To delete the current view::
5604
To disable the current view without deleting it::
5606
bzr view --switch off
5608
To define a named view and switch to it::
5610
bzr view --name view-name file1 dir1 ...
5612
To list a named view::
5614
bzr view --name view-name
5616
To delete a named view::
5618
bzr view --name view-name --delete
5620
To switch to a named view::
5622
bzr view --switch view-name
5624
To list all views defined::
5628
To delete all views::
5630
bzr view --delete --all
5634
takes_args = ['file*']
5637
help='Apply list or delete action to all views.',
5640
help='Delete the view.',
5643
help='Name of the view to define, list or delete.',
5647
help='Name of the view to switch to.',
5652
def run(self, file_list,
5658
tree, file_list = tree_files(file_list, apply_view=False)
5659
current_view, view_dict = tree.views.get_view_info()
5664
raise errors.BzrCommandError(
5665
"Both --delete and a file list specified")
5667
raise errors.BzrCommandError(
5668
"Both --delete and --switch specified")
5670
tree.views.set_view_info(None, {})
5671
self.outf.write("Deleted all views.\n")
5673
raise errors.BzrCommandError("No current view to delete")
5675
tree.views.delete_view(name)
5676
self.outf.write("Deleted '%s' view.\n" % name)
5679
raise errors.BzrCommandError(
5680
"Both --switch and a file list specified")
5682
raise errors.BzrCommandError(
5683
"Both --switch and --all specified")
5684
elif switch == 'off':
5685
if current_view is None:
5686
raise errors.BzrCommandError("No current view to disable")
5687
tree.views.set_view_info(None, view_dict)
5688
self.outf.write("Disabled '%s' view.\n" % (current_view))
5690
tree.views.set_view_info(switch, view_dict)
5691
view_str = views.view_display_str(tree.views.lookup_view())
5692
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5695
self.outf.write('Views defined:\n')
5696
for view in sorted(view_dict):
5697
if view == current_view:
5701
view_str = views.view_display_str(view_dict[view])
5702
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5704
self.outf.write('No views defined.\n')
5707
# No name given and no current view set
5710
raise errors.BzrCommandError(
5711
"Cannot change the 'off' pseudo view")
5712
tree.views.set_view(name, sorted(file_list))
5713
view_str = views.view_display_str(tree.views.lookup_view())
5714
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5718
# No name given and no current view set
5719
self.outf.write('No current view.\n')
5721
view_str = views.view_display_str(tree.views.lookup_view(name))
5722
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5725
class cmd_hooks(Command):
5731
for hook_key in sorted(hooks.known_hooks.keys()):
5732
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5733
self.outf.write("%s:\n" % type(some_hooks).__name__)
5734
for hook_name, hook_point in sorted(some_hooks.items()):
5735
self.outf.write(" %s:\n" % (hook_name,))
5736
found_hooks = list(hook_point)
5738
for hook in found_hooks:
5739
self.outf.write(" %s\n" %
5740
(some_hooks.get_hook_name(hook),))
5742
self.outf.write(" <no hooks installed>\n")
5745
class cmd_shelve(Command):
5746
"""Temporarily set aside some changes from the current tree.
5748
Shelve allows you to temporarily put changes you've made "on the shelf",
5749
ie. out of the way, until a later time when you can bring them back from
5750
the shelf with the 'unshelve' command. The changes are stored alongside
5751
your working tree, and so they aren't propagated along with your branch nor
5752
will they survive its deletion.
5754
If shelve --list is specified, previously-shelved changes are listed.
5756
Shelve is intended to help separate several sets of changes that have
5757
been inappropriately mingled. If you just want to get rid of all changes
5758
and you don't need to restore them later, use revert. If you want to
5759
shelve all text changes at once, use shelve --all.
5761
If filenames are specified, only the changes to those files will be
5762
shelved. Other files will be left untouched.
5764
If a revision is specified, changes since that revision will be shelved.
5766
You can put multiple items on the shelf, and by default, 'unshelve' will
5767
restore the most recently shelved changes.
5770
takes_args = ['file*']
5774
Option('all', help='Shelve all changes.'),
5776
RegistryOption('writer', 'Method to use for writing diffs.',
5777
bzrlib.option.diff_writer_registry,
5778
value_switches=True, enum_switch=False),
5780
Option('list', help='List shelved changes.'),
5782
help='Destroy removed changes instead of shelving them.'),
5784
_see_also = ['unshelve']
5786
def run(self, revision=None, all=False, file_list=None, message=None,
5787
writer=None, list=False, destroy=False):
5789
return self.run_for_list()
5790
from bzrlib.shelf_ui import Shelver
5792
writer = bzrlib.option.diff_writer_registry.get()
5794
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5795
file_list, message, destroy=destroy)
5800
except errors.UserAbort:
5803
def run_for_list(self):
5804
tree = WorkingTree.open_containing('.')[0]
5806
self.add_cleanup(tree.unlock)
5807
manager = tree.get_shelf_manager()
5808
shelves = manager.active_shelves()
5809
if len(shelves) == 0:
5810
note('No shelved changes.')
5812
for shelf_id in reversed(shelves):
5813
message = manager.get_metadata(shelf_id).get('message')
5815
message = '<no message>'
5816
self.outf.write('%3d: %s\n' % (shelf_id, message))
5820
class cmd_unshelve(Command):
5821
"""Restore shelved changes.
5823
By default, the most recently shelved changes are restored. However if you
5824
specify a shelf by id those changes will be restored instead. This works
5825
best when the changes don't depend on each other.
5828
takes_args = ['shelf_id?']
5830
RegistryOption.from_kwargs(
5831
'action', help="The action to perform.",
5832
enum_switch=False, value_switches=True,
5833
apply="Apply changes and remove from the shelf.",
5834
dry_run="Show changes, but do not apply or remove them.",
5835
preview="Instead of unshelving the changes, show the diff that "
5836
"would result from unshelving.",
5837
delete_only="Delete changes without applying them.",
5838
keep="Apply changes but don't delete them.",
5841
_see_also = ['shelve']
5843
def run(self, shelf_id=None, action='apply'):
5844
from bzrlib.shelf_ui import Unshelver
5845
unshelver = Unshelver.from_args(shelf_id, action)
5849
unshelver.tree.unlock()
5852
class cmd_clean_tree(Command):
5853
"""Remove unwanted files from working tree.
5855
By default, only unknown files, not ignored files, are deleted. Versioned
5856
files are never deleted.
5858
Another class is 'detritus', which includes files emitted by bzr during
5859
normal operations and selftests. (The value of these files decreases with
5862
If no options are specified, unknown files are deleted. Otherwise, option
5863
flags are respected, and may be combined.
5865
To check what clean-tree will do, use --dry-run.
5867
takes_options = [Option('ignored', help='Delete all ignored files.'),
5868
Option('detritus', help='Delete conflict files, merge'
5869
' backups, and failed selftest dirs.'),
5871
help='Delete files unknown to bzr (default).'),
5872
Option('dry-run', help='Show files to delete instead of'
5874
Option('force', help='Do not prompt before deleting.')]
5875
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5877
from bzrlib.clean_tree import clean_tree
5878
if not (unknown or ignored or detritus):
5882
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5883
dry_run=dry_run, no_prompt=force)
5886
class cmd_reference(Command):
5887
"""list, view and set branch locations for nested trees.
5889
If no arguments are provided, lists the branch locations for nested trees.
5890
If one argument is provided, display the branch location for that tree.
5891
If two arguments are provided, set the branch location for that tree.
5896
takes_args = ['path?', 'location?']
5898
def run(self, path=None, location=None):
5900
if path is not None:
5902
tree, branch, relpath =(
5903
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5904
if path is not None:
5907
tree = branch.basis_tree()
5909
info = branch._get_all_reference_info().iteritems()
5910
self._display_reference_info(tree, branch, info)
5912
file_id = tree.path2id(path)
5914
raise errors.NotVersionedError(path)
5915
if location is None:
5916
info = [(file_id, branch.get_reference_info(file_id))]
5917
self._display_reference_info(tree, branch, info)
5919
branch.set_reference_info(file_id, path, location)
5921
def _display_reference_info(self, tree, branch, info):
5923
for file_id, (path, location) in info:
5925
path = tree.id2path(file_id)
5926
except errors.NoSuchId:
5928
ref_list.append((path, location))
5929
for path, location in sorted(ref_list):
5930
self.outf.write('%s %s\n' % (path, location))
5933
# these get imported and then picked up by the scan for cmd_*
5934
# TODO: Some more consistent way to split command definitions across files;
5935
# we do need to load at least some information about them to know of
5936
# aliases. ideally we would avoid loading the implementation until the
5937
# details were needed.
5938
from bzrlib.cmd_version_info import cmd_version_info
5939
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5940
from bzrlib.bundle.commands import (
5943
from bzrlib.foreign import cmd_dpush
5944
from bzrlib.sign_my_commits import cmd_sign_my_commits
added
removed
bzrlib/builtins.py
