1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import (
65
builtin_command_registry,
68
from bzrlib.option import (
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
81
return internal_tree_files(file_list, default_branch, canonicalize,
83
except errors.FileInWrongBranch, e:
84
raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
(e.path, file_list[0]))
88
def tree_files_for_add(file_list):
90
Return a tree and list of absolute paths from a file list.
92
Similar to tree_files, but add handles files a bit differently, so it a
93
custom implementation. In particular, MutableTreeTree.smart_add expects
94
absolute paths, which it immediately converts to relative paths.
96
# FIXME Would be nice to just return the relative paths like
97
# internal_tree_files does, but there are a large number of unit tests
98
# that assume the current interface to mutabletree.smart_add
100
tree, relpath = WorkingTree.open_containing(file_list[0])
101
if tree.supports_views():
102
view_files = tree.views.lookup_view()
104
for filename in file_list:
105
if not osutils.is_inside_any(view_files, filename):
106
raise errors.FileOutsideView(filename, view_files)
107
file_list = file_list[:]
108
file_list[0] = tree.abspath(relpath)
110
tree = WorkingTree.open_containing(u'.')[0]
111
if tree.supports_views():
112
view_files = tree.views.lookup_view()
114
file_list = view_files
115
view_str = views.view_display_str(view_files)
116
note("Ignoring files outside view. View is %s" % view_str)
117
return tree, file_list
120
def _get_one_revision(command_name, revisions):
121
if revisions is None:
123
if len(revisions) != 1:
124
raise errors.BzrCommandError(
125
'bzr %s --revision takes exactly one revision identifier' % (
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
"""Get a revision tree. Not suitable for commands that change the tree.
133
Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
and doing a commit/uncommit/pull will at best fail due to changing the
137
If tree is passed in, it should be already locked, for lifetime management
138
of the trees internal cached state.
142
if revisions is None:
144
rev_tree = tree.basis_tree()
146
rev_tree = branch.basis_tree()
148
revision = _get_one_revision(command_name, revisions)
149
rev_tree = revision.as_tree(branch)
153
# XXX: Bad function name; should possibly also be a class method of
154
# WorkingTree rather than a function.
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
157
"""Convert command-line paths to a WorkingTree and relative paths.
159
This is typically used for command-line processors that take one or
160
more filenames, and infer the workingtree that contains them.
162
The filenames given are not required to exist.
164
:param file_list: Filenames to convert.
166
:param default_branch: Fallback tree path to use if file_list is empty or
169
:param apply_view: if True and a view is set, apply it or check that
170
specified files are within it
172
:return: workingtree, [relative_paths]
174
if file_list is None or len(file_list) == 0:
175
tree = WorkingTree.open_containing(default_branch)[0]
176
if tree.supports_views() and apply_view:
177
view_files = tree.views.lookup_view()
179
file_list = view_files
180
view_str = views.view_display_str(view_files)
181
note("Ignoring files outside view. View is %s" % view_str)
182
return tree, file_list
183
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
return tree, safe_relpath_files(tree, file_list, canonicalize,
185
apply_view=apply_view)
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
"""Convert file_list into a list of relpaths in tree.
191
:param tree: A tree to operate on.
192
:param file_list: A list of user provided paths or None.
193
:param apply_view: if True and a view is set, apply it or check that
194
specified files are within it
195
:return: A list of relative paths.
196
:raises errors.PathNotChild: When a provided path is in a different tree
199
if file_list is None:
201
if tree.supports_views() and apply_view:
202
view_files = tree.views.lookup_view()
206
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
# doesn't - fix that up here before we enter the loop.
209
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
212
for filename in file_list:
214
relpath = fixer(osutils.dereference_path(filename))
215
if view_files and not osutils.is_inside_any(view_files, relpath):
216
raise errors.FileOutsideView(filename, view_files)
217
new_list.append(relpath)
218
except errors.PathNotChild:
219
raise errors.FileInWrongBranch(tree.branch, filename)
223
def _get_view_info_for_change_reporter(tree):
224
"""Get the view information from a tree for change reporting."""
227
current_view = tree.views.get_view_info()[0]
228
if current_view is not None:
229
view_info = (current_view, tree.views.lookup_view())
230
except errors.ViewsNotSupported:
235
# TODO: Make sure no commands unconditionally use the working directory as a
236
# branch. If a filename argument is used, the first of them should be used to
237
# specify the branch. (Perhaps this can be factored out into some kind of
238
# Argument class, representing a file in a branch, where the first occurrence
241
class cmd_status(Command):
242
"""Display status summary.
244
This reports on versioned and unknown files, reporting them
245
grouped by state. Possible states are:
248
Versioned in the working copy but not in the previous revision.
251
Versioned in the previous revision but removed or deleted
255
Path of this file changed from the previous revision;
256
the text may also have changed. This includes files whose
257
parent directory was renamed.
260
Text has changed since the previous revision.
263
File kind has been changed (e.g. from file to directory).
266
Not versioned and not matching an ignore pattern.
268
Additionally for directories, symlinks and files with an executable
269
bit, Bazaar indicates their type using a trailing character: '/', '@'
272
To see ignored files use 'bzr ignored'. For details on the
273
changes to file texts, use 'bzr diff'.
275
Note that --short or -S gives status flags for each item, similar
276
to Subversion's status command. To get output similar to svn -q,
279
If no arguments are specified, the status of the entire working
280
directory is shown. Otherwise, only the status of the specified
281
files or directories is reported. If a directory is given, status
282
is reported for everything inside that directory.
284
Before merges are committed, the pending merge tip revisions are
285
shown. To see all pending merge revisions, use the -v option.
286
To skip the display of pending merge information altogether, use
287
the no-pending option or specify a file/directory.
289
If a revision argument is given, the status is calculated against
290
that revision, or between two revisions if two are provided.
293
# TODO: --no-recurse, --recurse options
295
takes_args = ['file*']
296
takes_options = ['show-ids', 'revision', 'change', 'verbose',
297
Option('short', help='Use short status indicators.',
299
Option('versioned', help='Only show versioned files.',
301
Option('no-pending', help='Don\'t show pending merges.',
304
aliases = ['st', 'stat']
306
encoding_type = 'replace'
307
_see_also = ['diff', 'revert', 'status-flags']
310
def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
versioned=False, no_pending=False, verbose=False):
312
from bzrlib.status import show_tree_status
314
if revision and len(revision) > 2:
315
raise errors.BzrCommandError('bzr status --revision takes exactly'
316
' one or two revision specifiers')
318
tree, relfile_list = tree_files(file_list)
319
# Avoid asking for specific files when that is not needed.
320
if relfile_list == ['']:
322
# Don't disable pending merges for full trees other than '.'.
323
if file_list == ['.']:
325
# A specific path within a tree was given.
326
elif relfile_list is not None:
328
show_tree_status(tree, show_ids=show_ids,
329
specific_files=relfile_list, revision=revision,
330
to_file=self.outf, short=short, versioned=versioned,
331
show_pending=(not no_pending), verbose=verbose)
334
class cmd_cat_revision(Command):
335
"""Write out metadata for a revision.
337
The revision to print can either be specified by a specific
338
revision identifier, or you can use --revision.
342
takes_args = ['revision_id?']
343
takes_options = ['revision']
344
# cat-revision is more for frontends so should be exact
347
def print_revision(self, revisions, revid):
348
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
record = stream.next()
350
if record.storage_kind == 'absent':
351
raise errors.NoSuchRevision(revisions, revid)
352
revtext = record.get_bytes_as('fulltext')
353
self.outf.write(revtext.decode('utf-8'))
356
def run(self, revision_id=None, revision=None):
357
if revision_id is not None and revision is not None:
358
raise errors.BzrCommandError('You can only supply one of'
359
' revision_id or --revision')
360
if revision_id is None and revision is None:
361
raise errors.BzrCommandError('You must supply either'
362
' --revision or a revision_id')
363
b = WorkingTree.open_containing(u'.')[0].branch
365
revisions = b.repository.revisions
366
if revisions is None:
367
raise errors.BzrCommandError('Repository %r does not support '
368
'access to raw revision texts')
370
b.repository.lock_read()
372
# TODO: jam 20060112 should cat-revision always output utf-8?
373
if revision_id is not None:
374
revision_id = osutils.safe_revision_id(revision_id, warn=False)
376
self.print_revision(revisions, revision_id)
377
except errors.NoSuchRevision:
378
msg = "The repository %s contains no revision %s." % (
379
b.repository.base, revision_id)
380
raise errors.BzrCommandError(msg)
381
elif revision is not None:
384
raise errors.BzrCommandError(
385
'You cannot specify a NULL revision.')
386
rev_id = rev.as_revision_id(b)
387
self.print_revision(revisions, rev_id)
389
b.repository.unlock()
392
class cmd_dump_btree(Command):
393
"""Dump the contents of a btree index file to stdout.
395
PATH is a btree index file, it can be any URL. This includes things like
396
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
398
By default, the tuples stored in the index file will be displayed. With
399
--raw, we will uncompress the pages, but otherwise display the raw bytes
403
# TODO: Do we want to dump the internal nodes as well?
404
# TODO: It would be nice to be able to dump the un-parsed information,
405
# rather than only going through iter_all_entries. However, this is
406
# good enough for a start
408
encoding_type = 'exact'
409
takes_args = ['path']
410
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
411
' rather than the parsed tuples.'),
414
def run(self, path, raw=False):
415
dirname, basename = osutils.split(path)
416
t = transport.get_transport(dirname)
418
self._dump_raw_bytes(t, basename)
420
self._dump_entries(t, basename)
422
def _get_index_and_bytes(self, trans, basename):
423
"""Create a BTreeGraphIndex and raw bytes."""
424
bt = btree_index.BTreeGraphIndex(trans, basename, None)
425
bytes = trans.get_bytes(basename)
426
bt._file = cStringIO.StringIO(bytes)
427
bt._size = len(bytes)
430
def _dump_raw_bytes(self, trans, basename):
433
# We need to parse at least the root node.
434
# This is because the first page of every row starts with an
435
# uncompressed header.
436
bt, bytes = self._get_index_and_bytes(trans, basename)
437
for page_idx, page_start in enumerate(xrange(0, len(bytes),
438
btree_index._PAGE_SIZE)):
439
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
440
page_bytes = bytes[page_start:page_end]
442
self.outf.write('Root node:\n')
443
header_end, data = bt._parse_header_from_bytes(page_bytes)
444
self.outf.write(page_bytes[:header_end])
446
self.outf.write('\nPage %d\n' % (page_idx,))
447
decomp_bytes = zlib.decompress(page_bytes)
448
self.outf.write(decomp_bytes)
449
self.outf.write('\n')
451
def _dump_entries(self, trans, basename):
453
st = trans.stat(basename)
454
except errors.TransportNotPossible:
455
# We can't stat, so we'll fake it because we have to do the 'get()'
457
bt, _ = self._get_index_and_bytes(trans, basename)
459
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
460
for node in bt.iter_all_entries():
461
# Node is made up of:
462
# (index, key, value, [references])
466
refs_as_tuples = None
468
refs_as_tuples = static_tuple.as_tuples(refs)
469
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
self.outf.write('%s\n' % (as_tuple,))
473
class cmd_remove_tree(Command):
474
"""Remove the working tree from a given branch/checkout.
476
Since a lightweight checkout is little more than a working tree
477
this will refuse to run against one.
479
To re-create the working tree, use "bzr checkout".
481
_see_also = ['checkout', 'working-trees']
482
takes_args = ['location*']
485
help='Remove the working tree even if it has '
486
'uncommitted changes.'),
489
def run(self, location_list, force=False):
490
if not location_list:
493
for location in location_list:
494
d = bzrdir.BzrDir.open(location)
497
working = d.open_workingtree()
498
except errors.NoWorkingTree:
499
raise errors.BzrCommandError("No working tree to remove")
500
except errors.NotLocalUrl:
501
raise errors.BzrCommandError("You cannot remove the working tree"
504
if (working.has_changes()):
505
raise errors.UncommittedChanges(working)
507
working_path = working.bzrdir.root_transport.base
508
branch_path = working.branch.bzrdir.root_transport.base
509
if working_path != branch_path:
510
raise errors.BzrCommandError("You cannot remove the working tree"
511
" from a lightweight checkout")
513
d.destroy_workingtree()
516
class cmd_revno(Command):
517
"""Show current revision number.
519
This is equal to the number of revisions on this branch.
523
takes_args = ['location?']
525
Option('tree', help='Show revno of working tree'),
529
def run(self, tree=False, location=u'.'):
532
wt = WorkingTree.open_containing(location)[0]
534
except (errors.NoWorkingTree, errors.NotLocalUrl):
535
raise errors.NoWorkingTree(location)
536
self.add_cleanup(wt.unlock)
537
revid = wt.last_revision()
539
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
540
except errors.NoSuchRevision:
542
revno = ".".join(str(n) for n in revno_t)
544
b = Branch.open_containing(location)[0]
546
self.add_cleanup(b.unlock)
549
self.outf.write(str(revno) + '\n')
552
class cmd_revision_info(Command):
553
"""Show revision number and revision id for a given revision identifier.
556
takes_args = ['revision_info*']
560
help='Branch to examine, '
561
'rather than the one containing the working directory.',
565
Option('tree', help='Show revno of working tree'),
569
def run(self, revision=None, directory=u'.', tree=False,
570
revision_info_list=[]):
573
wt = WorkingTree.open_containing(directory)[0]
576
self.add_cleanup(wt.unlock)
577
except (errors.NoWorkingTree, errors.NotLocalUrl):
579
b = Branch.open_containing(directory)[0]
581
self.add_cleanup(b.unlock)
583
if revision is not None:
584
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
585
if revision_info_list is not None:
586
for rev_str in revision_info_list:
587
rev_spec = RevisionSpec.from_string(rev_str)
588
revision_ids.append(rev_spec.as_revision_id(b))
589
# No arguments supplied, default to the last revision
590
if len(revision_ids) == 0:
593
raise errors.NoWorkingTree(directory)
594
revision_ids.append(wt.last_revision())
596
revision_ids.append(b.last_revision())
600
for revision_id in revision_ids:
602
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
603
revno = '.'.join(str(i) for i in dotted_revno)
604
except errors.NoSuchRevision:
606
maxlen = max(maxlen, len(revno))
607
revinfos.append([revno, revision_id])
611
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
614
class cmd_add(Command):
615
"""Add specified files or directories.
617
In non-recursive mode, all the named items are added, regardless
618
of whether they were previously ignored. A warning is given if
619
any of the named files are already versioned.
621
In recursive mode (the default), files are treated the same way
622
but the behaviour for directories is different. Directories that
623
are already versioned do not give a warning. All directories,
624
whether already versioned or not, are searched for files or
625
subdirectories that are neither versioned or ignored, and these
626
are added. This search proceeds recursively into versioned
627
directories. If no names are given '.' is assumed.
629
Therefore simply saying 'bzr add' will version all files that
630
are currently unknown.
632
Adding a file whose parent directory is not versioned will
633
implicitly add the parent, and so on up to the root. This means
634
you should never need to explicitly add a directory, they'll just
635
get added when you add a file in the directory.
637
--dry-run will show which files would be added, but not actually
640
--file-ids-from will try to use the file ids from the supplied path.
641
It looks up ids trying to find a matching parent directory with the
642
same filename, and then by pure path. This option is rarely needed
643
but can be useful when adding the same logical file into two
644
branches that will be merged later (without showing the two different
645
adds as a conflict). It is also useful when merging another project
646
into a subdirectory of this one.
648
Any files matching patterns in the ignore list will not be added
649
unless they are explicitly mentioned.
651
takes_args = ['file*']
654
help="Don't recursively add the contents of directories."),
656
help="Show what would be done, but don't actually do anything."),
658
Option('file-ids-from',
660
help='Lookup file ids from this tree.'),
662
encoding_type = 'replace'
663
_see_also = ['remove', 'ignore']
665
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
670
if file_ids_from is not None:
672
base_tree, base_path = WorkingTree.open_containing(
674
except errors.NoWorkingTree:
675
base_branch, base_path = Branch.open_containing(
677
base_tree = base_branch.basis_tree()
679
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
680
to_file=self.outf, should_print=(not is_quiet()))
682
action = bzrlib.add.AddAction(to_file=self.outf,
683
should_print=(not is_quiet()))
686
base_tree.lock_read()
687
self.add_cleanup(base_tree.unlock)
688
tree, file_list = tree_files_for_add(file_list)
689
added, ignored = tree.smart_add(file_list, not
690
no_recurse, action=action, save=not dry_run)
694
for glob in sorted(ignored.keys()):
695
for path in ignored[glob]:
696
self.outf.write("ignored %s matching \"%s\"\n"
700
class cmd_mkdir(Command):
701
"""Create a new versioned directory.
703
This is equivalent to creating the directory and then adding it.
706
takes_args = ['dir+']
707
encoding_type = 'replace'
709
def run(self, dir_list):
711
wt, dd = WorkingTree.open_containing(d)
712
base = os.path.dirname(dd)
713
id = wt.path2id(base)
717
self.outf.write('added %s\n' % d)
719
raise errors.NotVersionedError(path=base)
722
class cmd_relpath(Command):
723
"""Show path of a file relative to root"""
725
takes_args = ['filename']
729
def run(self, filename):
730
# TODO: jam 20050106 Can relpath return a munged path if
731
# sys.stdout encoding cannot represent it?
732
tree, relpath = WorkingTree.open_containing(filename)
733
self.outf.write(relpath)
734
self.outf.write('\n')
737
class cmd_inventory(Command):
738
"""Show inventory of the current working copy or a revision.
740
It is possible to limit the output to a particular entry
741
type using the --kind option. For example: --kind file.
743
It is also possible to restrict the list of files to a specific
744
set. For example: bzr inventory --show-ids this/file
753
help='List entries of a particular kind: file, directory, symlink.',
756
takes_args = ['file*']
759
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
760
if kind and kind not in ['file', 'directory', 'symlink']:
761
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
763
revision = _get_one_revision('inventory', revision)
764
work_tree, file_list = tree_files(file_list)
765
work_tree.lock_read()
766
self.add_cleanup(work_tree.unlock)
767
if revision is not None:
768
tree = revision.as_tree(work_tree.branch)
770
extra_trees = [work_tree]
772
self.add_cleanup(tree.unlock)
777
if file_list is not None:
778
file_ids = tree.paths2ids(file_list, trees=extra_trees,
779
require_versioned=True)
780
# find_ids_across_trees may include some paths that don't
782
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
783
for file_id in file_ids if file_id in tree)
785
entries = tree.inventory.entries()
788
for path, entry in entries:
789
if kind and kind != entry.kind:
792
self.outf.write('%-50s %s\n' % (path, entry.file_id))
794
self.outf.write(path)
795
self.outf.write('\n')
798
class cmd_mv(Command):
799
"""Move or rename a file.
802
bzr mv OLDNAME NEWNAME
804
bzr mv SOURCE... DESTINATION
806
If the last argument is a versioned directory, all the other names
807
are moved into it. Otherwise, there must be exactly two arguments
808
and the file is changed to a new name.
810
If OLDNAME does not exist on the filesystem but is versioned and
811
NEWNAME does exist on the filesystem but is not versioned, mv
812
assumes that the file has been manually moved and only updates
813
its internal inventory to reflect that change.
814
The same is valid when moving many SOURCE files to a DESTINATION.
816
Files cannot be moved between branches.
819
takes_args = ['names*']
820
takes_options = [Option("after", help="Move only the bzr identifier"
821
" of the file, because the file has already been moved."),
822
Option('auto', help='Automatically guess renames.'),
823
Option('dry-run', help='Avoid making changes when guessing renames.'),
825
aliases = ['move', 'rename']
826
encoding_type = 'replace'
828
def run(self, names_list, after=False, auto=False, dry_run=False):
830
return self.run_auto(names_list, after, dry_run)
832
raise errors.BzrCommandError('--dry-run requires --auto.')
833
if names_list is None:
835
if len(names_list) < 2:
836
raise errors.BzrCommandError("missing file argument")
837
tree, rel_names = tree_files(names_list, canonicalize=False)
838
tree.lock_tree_write()
839
self.add_cleanup(tree.unlock)
840
self._run(tree, names_list, rel_names, after)
842
def run_auto(self, names_list, after, dry_run):
843
if names_list is not None and len(names_list) > 1:
844
raise errors.BzrCommandError('Only one path may be specified to'
847
raise errors.BzrCommandError('--after cannot be specified with'
849
work_tree, file_list = tree_files(names_list, default_branch='.')
850
work_tree.lock_tree_write()
851
self.add_cleanup(work_tree.unlock)
852
rename_map.RenameMap.guess_renames(work_tree, dry_run)
854
def _run(self, tree, names_list, rel_names, after):
855
into_existing = osutils.isdir(names_list[-1])
856
if into_existing and len(names_list) == 2:
858
# a. case-insensitive filesystem and change case of dir
859
# b. move directory after the fact (if the source used to be
860
# a directory, but now doesn't exist in the working tree
861
# and the target is an existing directory, just rename it)
862
if (not tree.case_sensitive
863
and rel_names[0].lower() == rel_names[1].lower()):
864
into_existing = False
867
# 'fix' the case of a potential 'from'
868
from_id = tree.path2id(
869
tree.get_canonical_inventory_path(rel_names[0]))
870
if (not osutils.lexists(names_list[0]) and
871
from_id and inv.get_file_kind(from_id) == "directory"):
872
into_existing = False
875
# move into existing directory
876
# All entries reference existing inventory items, so fix them up
877
# for cicp file-systems.
878
rel_names = tree.get_canonical_inventory_paths(rel_names)
879
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
881
self.outf.write("%s => %s\n" % (src, dest))
883
if len(names_list) != 2:
884
raise errors.BzrCommandError('to mv multiple files the'
885
' destination must be a versioned'
888
# for cicp file-systems: the src references an existing inventory
890
src = tree.get_canonical_inventory_path(rel_names[0])
891
# Find the canonical version of the destination: In all cases, the
892
# parent of the target must be in the inventory, so we fetch the
893
# canonical version from there (we do not always *use* the
894
# canonicalized tail portion - we may be attempting to rename the
896
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
897
dest_parent = osutils.dirname(canon_dest)
898
spec_tail = osutils.basename(rel_names[1])
899
# For a CICP file-system, we need to avoid creating 2 inventory
900
# entries that differ only by case. So regardless of the case
901
# we *want* to use (ie, specified by the user or the file-system),
902
# we must always choose to use the case of any existing inventory
903
# items. The only exception to this is when we are attempting a
904
# case-only rename (ie, canonical versions of src and dest are
906
dest_id = tree.path2id(canon_dest)
907
if dest_id is None or tree.path2id(src) == dest_id:
908
# No existing item we care about, so work out what case we
909
# are actually going to use.
911
# If 'after' is specified, the tail must refer to a file on disk.
913
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
915
# pathjoin with an empty tail adds a slash, which breaks
917
dest_parent_fq = tree.basedir
919
dest_tail = osutils.canonical_relpath(
921
osutils.pathjoin(dest_parent_fq, spec_tail))
923
# not 'after', so case as specified is used
924
dest_tail = spec_tail
926
# Use the existing item so 'mv' fails with AlreadyVersioned.
927
dest_tail = os.path.basename(canon_dest)
928
dest = osutils.pathjoin(dest_parent, dest_tail)
929
mutter("attempting to move %s => %s", src, dest)
930
tree.rename_one(src, dest, after=after)
932
self.outf.write("%s => %s\n" % (src, dest))
935
class cmd_pull(Command):
936
"""Turn this branch into a mirror of another branch.
938
By default, this command only works on branches that have not diverged.
939
Branches are considered diverged if the destination branch's most recent
940
commit is one that has not been merged (directly or indirectly) into the
943
If branches have diverged, you can use 'bzr merge' to integrate the changes
944
from one into the other. Once one branch has merged, the other should
945
be able to pull it again.
947
If you want to replace your local changes and just want your branch to
948
match the remote one, use pull --overwrite. This will work even if the two
949
branches have diverged.
951
If there is no default location set, the first pull will set it. After
952
that, you can omit the location to use the default. To change the
953
default, use --remember. The value will only be saved if the remote
954
location can be accessed.
956
Note: The location can be specified either in the form of a branch,
957
or in the form of a path to a file containing a merge directive generated
961
_see_also = ['push', 'update', 'status-flags', 'send']
962
takes_options = ['remember', 'overwrite', 'revision',
963
custom_help('verbose',
964
help='Show logs of pulled revisions.'),
966
help='Branch to pull into, '
967
'rather than the one containing the working directory.',
972
help="Perform a local pull in a bound "
973
"branch. Local pulls are not applied to "
977
takes_args = ['location?']
978
encoding_type = 'replace'
980
def run(self, location=None, remember=False, overwrite=False,
981
revision=None, verbose=False,
982
directory=None, local=False):
983
# FIXME: too much stuff is in the command class
986
if directory is None:
989
tree_to = WorkingTree.open_containing(directory)[0]
990
branch_to = tree_to.branch
992
self.add_cleanup(tree_to.unlock)
993
except errors.NoWorkingTree:
995
branch_to = Branch.open_containing(directory)[0]
996
branch_to.lock_write()
997
self.add_cleanup(branch_to.unlock)
999
if local and not branch_to.get_bound_location():
1000
raise errors.LocalRequiresBoundBranch()
1002
possible_transports = []
1003
if location is not None:
1005
mergeable = bundle.read_mergeable_from_url(location,
1006
possible_transports=possible_transports)
1007
except errors.NotABundle:
1010
stored_loc = branch_to.get_parent()
1011
if location is None:
1012
if stored_loc is None:
1013
raise errors.BzrCommandError("No pull location known or"
1016
display_url = urlutils.unescape_for_display(stored_loc,
1019
self.outf.write("Using saved parent location: %s\n" % display_url)
1020
location = stored_loc
1022
revision = _get_one_revision('pull', revision)
1023
if mergeable is not None:
1024
if revision is not None:
1025
raise errors.BzrCommandError(
1026
'Cannot use -r with merge directives or bundles')
1027
mergeable.install_revisions(branch_to.repository)
1028
base_revision_id, revision_id, verified = \
1029
mergeable.get_merge_request(branch_to.repository)
1030
branch_from = branch_to
1032
branch_from = Branch.open(location,
1033
possible_transports=possible_transports)
1034
branch_from.lock_read()
1035
self.add_cleanup(branch_from.unlock)
1037
if branch_to.get_parent() is None or remember:
1038
branch_to.set_parent(branch_from.base)
1040
if revision is not None:
1041
revision_id = revision.as_revision_id(branch_from)
1043
if tree_to is not None:
1044
view_info = _get_view_info_for_change_reporter(tree_to)
1045
change_reporter = delta._ChangeReporter(
1046
unversioned_filter=tree_to.is_ignored,
1047
view_info=view_info)
1048
result = tree_to.pull(
1049
branch_from, overwrite, revision_id, change_reporter,
1050
possible_transports=possible_transports, local=local)
1052
result = branch_to.pull(
1053
branch_from, overwrite, revision_id, local=local)
1055
result.report(self.outf)
1056
if verbose and result.old_revid != result.new_revid:
1057
log.show_branch_change(
1058
branch_to, self.outf, result.old_revno,
1062
class cmd_push(Command):
1063
"""Update a mirror of this branch.
1065
The target branch will not have its working tree populated because this
1066
is both expensive, and is not supported on remote file systems.
1068
Some smart servers or protocols *may* put the working tree in place in
1071
This command only works on branches that have not diverged. Branches are
1072
considered diverged if the destination branch's most recent commit is one
1073
that has not been merged (directly or indirectly) by the source branch.
1075
If branches have diverged, you can use 'bzr push --overwrite' to replace
1076
the other branch completely, discarding its unmerged changes.
1078
If you want to ensure you have the different changes in the other branch,
1079
do a merge (see bzr help merge) from the other branch, and commit that.
1080
After that you will be able to do a push without '--overwrite'.
1082
If there is no default push location set, the first push will set it.
1083
After that, you can omit the location to use the default. To change the
1084
default, use --remember. The value will only be saved if the remote
1085
location can be accessed.
1088
_see_also = ['pull', 'update', 'working-trees']
1089
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1090
Option('create-prefix',
1091
help='Create the path leading up to the branch '
1092
'if it does not already exist.'),
1094
help='Branch to push from, '
1095
'rather than the one containing the working directory.',
1099
Option('use-existing-dir',
1100
help='By default push will fail if the target'
1101
' directory exists, but does not already'
1102
' have a control directory. This flag will'
1103
' allow push to proceed.'),
1105
help='Create a stacked branch that references the public location '
1106
'of the parent branch.'),
1107
Option('stacked-on',
1108
help='Create a stacked branch that refers to another branch '
1109
'for the commit history. Only the work not present in the '
1110
'referenced branch is included in the branch created.',
1113
help='Refuse to push if there are uncommitted changes in'
1114
' the working tree, --no-strict disables the check.'),
1116
takes_args = ['location?']
1117
encoding_type = 'replace'
1119
def run(self, location=None, remember=False, overwrite=False,
1120
create_prefix=False, verbose=False, revision=None,
1121
use_existing_dir=False, directory=None, stacked_on=None,
1122
stacked=False, strict=None):
1123
from bzrlib.push import _show_push_branch
1125
if directory is None:
1127
# Get the source branch
1129
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1130
# Get the tip's revision_id
1131
revision = _get_one_revision('push', revision)
1132
if revision is not None:
1133
revision_id = revision.in_history(br_from).rev_id
1136
if tree is not None and revision_id is None:
1137
tree.warn_if_changed_or_out_of_date(
1138
strict, 'push_strict', 'Use --no-strict to force the push.')
1139
# Get the stacked_on branch, if any
1140
if stacked_on is not None:
1141
stacked_on = urlutils.normalize_url(stacked_on)
1143
parent_url = br_from.get_parent()
1145
parent = Branch.open(parent_url)
1146
stacked_on = parent.get_public_branch()
1148
# I considered excluding non-http url's here, thus forcing
1149
# 'public' branches only, but that only works for some
1150
# users, so it's best to just depend on the user spotting an
1151
# error by the feedback given to them. RBC 20080227.
1152
stacked_on = parent_url
1154
raise errors.BzrCommandError(
1155
"Could not determine branch to refer to.")
1157
# Get the destination location
1158
if location is None:
1159
stored_loc = br_from.get_push_location()
1160
if stored_loc is None:
1161
raise errors.BzrCommandError(
1162
"No push location known or specified.")
1164
display_url = urlutils.unescape_for_display(stored_loc,
1166
self.outf.write("Using saved push location: %s\n" % display_url)
1167
location = stored_loc
1169
_show_push_branch(br_from, revision_id, location, self.outf,
1170
verbose=verbose, overwrite=overwrite, remember=remember,
1171
stacked_on=stacked_on, create_prefix=create_prefix,
1172
use_existing_dir=use_existing_dir)
1175
class cmd_branch(Command):
1176
"""Create a new branch that is a copy of an existing branch.
1178
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1180
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1181
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1182
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1185
To retrieve the branch as of a particular revision, supply the --revision
1186
parameter, as in "branch foo/bar -r 5".
1189
_see_also = ['checkout']
1190
takes_args = ['from_location', 'to_location?']
1191
takes_options = ['revision', Option('hardlink',
1192
help='Hard-link working tree files where possible.'),
1194
help="Create a branch without a working-tree."),
1196
help="Switch the checkout in the current directory "
1197
"to the new branch."),
1199
help='Create a stacked branch referring to the source branch. '
1200
'The new branch will depend on the availability of the source '
1201
'branch for all operations.'),
1202
Option('standalone',
1203
help='Do not use a shared repository, even if available.'),
1204
Option('use-existing-dir',
1205
help='By default branch will fail if the target'
1206
' directory exists, but does not already'
1207
' have a control directory. This flag will'
1208
' allow branch to proceed.'),
1210
help="Bind new branch to from location."),
1212
aliases = ['get', 'clone']
1214
def run(self, from_location, to_location=None, revision=None,
1215
hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
use_existing_dir=False, switch=False, bind=False):
1217
from bzrlib import switch as _mod_switch
1218
from bzrlib.tag import _merge_tags_if_possible
1219
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1221
revision = _get_one_revision('branch', revision)
1223
self.add_cleanup(br_from.unlock)
1224
if revision is not None:
1225
revision_id = revision.as_revision_id(br_from)
1227
# FIXME - wt.last_revision, fallback to branch, fall back to
1228
# None or perhaps NULL_REVISION to mean copy nothing
1230
revision_id = br_from.last_revision()
1231
if to_location is None:
1232
to_location = urlutils.derive_to_location(from_location)
1233
to_transport = transport.get_transport(to_location)
1235
to_transport.mkdir('.')
1236
except errors.FileExists:
1237
if not use_existing_dir:
1238
raise errors.BzrCommandError('Target directory "%s" '
1239
'already exists.' % to_location)
1242
bzrdir.BzrDir.open_from_transport(to_transport)
1243
except errors.NotBranchError:
1246
raise errors.AlreadyBranchError(to_location)
1247
except errors.NoSuchFile:
1248
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1251
# preserve whatever source format we have.
1252
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1253
possible_transports=[to_transport],
1254
accelerator_tree=accelerator_tree,
1255
hardlink=hardlink, stacked=stacked,
1256
force_new_repo=standalone,
1257
create_tree_if_local=not no_tree,
1258
source_branch=br_from)
1259
branch = dir.open_branch()
1260
except errors.NoSuchRevision:
1261
to_transport.delete_tree('.')
1262
msg = "The branch %s has no revision %s." % (from_location,
1264
raise errors.BzrCommandError(msg)
1265
_merge_tags_if_possible(br_from, branch)
1266
# If the source branch is stacked, the new branch may
1267
# be stacked whether we asked for that explicitly or not.
1268
# We therefore need a try/except here and not just 'if stacked:'
1270
note('Created new stacked branch referring to %s.' %
1271
branch.get_stacked_on_url())
1272
except (errors.NotStacked, errors.UnstackableBranchFormat,
1273
errors.UnstackableRepositoryFormat), e:
1274
note('Branched %d revision(s).' % branch.revno())
1276
# Bind to the parent
1277
parent_branch = Branch.open(from_location)
1278
branch.bind(parent_branch)
1279
note('New branch bound to %s' % from_location)
1281
# Switch to the new branch
1282
wt, _ = WorkingTree.open_containing('.')
1283
_mod_switch.switch(wt.bzrdir, branch)
1284
note('Switched to branch: %s',
1285
urlutils.unescape_for_display(branch.base, 'utf-8'))
1288
class cmd_checkout(Command):
1289
"""Create a new checkout of an existing branch.
1291
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
the branch found in '.'. This is useful if you have removed the working tree
1293
or if it was never created - i.e. if you pushed the branch to its current
1294
location using SFTP.
1296
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1297
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1298
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1299
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1300
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1303
To retrieve the branch as of a particular revision, supply the --revision
1304
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1305
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1309
_see_also = ['checkouts', 'branch']
1310
takes_args = ['branch_location?', 'to_location?']
1311
takes_options = ['revision',
1312
Option('lightweight',
1313
help="Perform a lightweight checkout. Lightweight "
1314
"checkouts depend on access to the branch for "
1315
"every operation. Normal checkouts can perform "
1316
"common operations like diff and status without "
1317
"such access, and also support local commits."
1319
Option('files-from', type=str,
1320
help="Get file contents from this tree."),
1322
help='Hard-link working tree files where possible.'
1327
def run(self, branch_location=None, to_location=None, revision=None,
1328
lightweight=False, files_from=None, hardlink=False):
1329
if branch_location is None:
1330
branch_location = osutils.getcwd()
1331
to_location = branch_location
1332
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1334
revision = _get_one_revision('checkout', revision)
1335
if files_from is not None:
1336
accelerator_tree = WorkingTree.open(files_from)
1337
if revision is not None:
1338
revision_id = revision.as_revision_id(source)
1341
if to_location is None:
1342
to_location = urlutils.derive_to_location(branch_location)
1343
# if the source and to_location are the same,
1344
# and there is no working tree,
1345
# then reconstitute a branch
1346
if (osutils.abspath(to_location) ==
1347
osutils.abspath(branch_location)):
1349
source.bzrdir.open_workingtree()
1350
except errors.NoWorkingTree:
1351
source.bzrdir.create_workingtree(revision_id)
1353
source.create_checkout(to_location, revision_id, lightweight,
1354
accelerator_tree, hardlink)
1357
class cmd_renames(Command):
1358
"""Show list of renamed files.
1360
# TODO: Option to show renames between two historical versions.
1362
# TODO: Only show renames under dir, rather than in the whole branch.
1363
_see_also = ['status']
1364
takes_args = ['dir?']
1367
def run(self, dir=u'.'):
1368
tree = WorkingTree.open_containing(dir)[0]
1370
self.add_cleanup(tree.unlock)
1371
new_inv = tree.inventory
1372
old_tree = tree.basis_tree()
1373
old_tree.lock_read()
1374
self.add_cleanup(old_tree.unlock)
1375
old_inv = old_tree.inventory
1377
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1378
for f, paths, c, v, p, n, k, e in iterator:
1379
if paths[0] == paths[1]:
1383
renames.append(paths)
1385
for old_name, new_name in renames:
1386
self.outf.write("%s => %s\n" % (old_name, new_name))
1389
class cmd_update(Command):
1390
"""Update a tree to have the latest code committed to its branch.
1392
This will perform a merge into the working tree, and may generate
1393
conflicts. If you have any local changes, you will still
1394
need to commit them after the update for the update to be complete.
1396
If you want to discard your local changes, you can just do a
1397
'bzr revert' instead of 'bzr commit' after the update.
1399
If the tree's branch is bound to a master branch, it will also update
1400
the branch from the master.
1403
_see_also = ['pull', 'working-trees', 'status-flags']
1404
takes_args = ['dir?']
1405
takes_options = ['revision']
1408
def run(self, dir='.', revision=None):
1409
if revision is not None and len(revision) != 1:
1410
raise errors.BzrCommandError(
1411
"bzr update --revision takes exactly one revision")
1412
tree = WorkingTree.open_containing(dir)[0]
1413
branch = tree.branch
1414
possible_transports = []
1415
master = branch.get_master_branch(
1416
possible_transports=possible_transports)
1417
if master is not None:
1419
branch_location = master.base
1421
tree.lock_tree_write()
1422
branch_location = tree.branch.base
1423
self.add_cleanup(tree.unlock)
1424
# get rid of the final '/' and be ready for display
1425
branch_location = urlutils.unescape_for_display(
1426
branch_location.rstrip('/'),
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_dotted_revno(revision_id)
1442
note("Tree is up to date at revision %s of branch %s" %
1443
('.'.join(map(str, 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_dotted_revno(
1462
_mod_revision.ensure_null(tree.last_revision()))
1463
note('Updated to revision %s of branch %s' %
1464
('.'.join(map(str, 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.',
1947
RegistryOption('format',
1948
help='Diff format to use.',
1949
lazy_registry=('bzrlib.diff', 'format_registry'),
1950
value_switches=False, title='Diff format'),
1952
aliases = ['di', 'dif']
1953
encoding_type = 'exact'
1956
def run(self, revision=None, file_list=None, diff_options=None,
1957
prefix=None, old=None, new=None, using=None, format=None):
1958
from bzrlib.diff import (get_trees_and_branches_to_diff,
1961
if (prefix is None) or (prefix == '0'):
1969
old_label, new_label = prefix.split(":")
1971
raise errors.BzrCommandError(
1972
'--prefix expects two values separated by a colon'
1973
' (eg "old/:new/")')
1975
if revision and len(revision) > 2:
1976
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1977
' one or two revision specifiers')
1979
if using is not None and format is not None:
1980
raise errors.BzrCommandError('--using and --format are mutually '
1983
(old_tree, new_tree,
1984
old_branch, new_branch,
1985
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1986
file_list, revision, old, new, apply_view=True)
1987
return show_diff_trees(old_tree, new_tree, sys.stdout,
1988
specific_files=specific_files,
1989
external_diff_options=diff_options,
1990
old_label=old_label, new_label=new_label,
1991
extra_trees=extra_trees, using=using,
1995
class cmd_deleted(Command):
1996
"""List files deleted in the working tree.
1998
# TODO: Show files deleted since a previous revision, or
1999
# between two revisions.
2000
# TODO: Much more efficient way to do this: read in new
2001
# directories with readdir, rather than stating each one. Same
2002
# level of effort but possibly much less IO. (Or possibly not,
2003
# if the directories are very large...)
2004
_see_also = ['status', 'ls']
2005
takes_options = ['show-ids']
2008
def run(self, show_ids=False):
2009
tree = WorkingTree.open_containing(u'.')[0]
2011
self.add_cleanup(tree.unlock)
2012
old = tree.basis_tree()
2014
self.add_cleanup(old.unlock)
2015
for path, ie in old.inventory.iter_entries():
2016
if not tree.has_id(ie.file_id):
2017
self.outf.write(path)
2019
self.outf.write(' ')
2020
self.outf.write(ie.file_id)
2021
self.outf.write('\n')
2024
class cmd_modified(Command):
2025
"""List files modified in working tree.
2029
_see_also = ['status', 'ls']
2032
help='Write an ascii NUL (\\0) separator '
2033
'between files rather than a newline.')
2037
def run(self, null=False):
2038
tree = WorkingTree.open_containing(u'.')[0]
2039
td = tree.changes_from(tree.basis_tree())
2040
for path, id, kind, text_modified, meta_modified in td.modified:
2042
self.outf.write(path + '\0')
2044
self.outf.write(osutils.quotefn(path) + '\n')
2047
class cmd_added(Command):
2048
"""List files added in working tree.
2052
_see_also = ['status', 'ls']
2055
help='Write an ascii NUL (\\0) separator '
2056
'between files rather than a newline.')
2060
def run(self, null=False):
2061
wt = WorkingTree.open_containing(u'.')[0]
2063
self.add_cleanup(wt.unlock)
2064
basis = wt.basis_tree()
2066
self.add_cleanup(basis.unlock)
2067
basis_inv = basis.inventory
2070
if file_id in basis_inv:
2072
if inv.is_root(file_id) and len(basis_inv) == 0:
2074
path = inv.id2path(file_id)
2075
if not os.access(osutils.abspath(path), os.F_OK):
2078
self.outf.write(path + '\0')
2080
self.outf.write(osutils.quotefn(path) + '\n')
2083
class cmd_root(Command):
2084
"""Show the tree root directory.
2086
The root is the nearest enclosing directory with a .bzr control
2089
takes_args = ['filename?']
2091
def run(self, filename=None):
2092
"""Print the branch root."""
2093
tree = WorkingTree.open_containing(filename)[0]
2094
self.outf.write(tree.basedir + '\n')
2097
def _parse_limit(limitstring):
2099
return int(limitstring)
2101
msg = "The limit argument must be an integer."
2102
raise errors.BzrCommandError(msg)
2105
def _parse_levels(s):
2109
msg = "The levels argument must be an integer."
2110
raise errors.BzrCommandError(msg)
2113
class cmd_log(Command):
2114
"""Show historical log for a branch or subset of a branch.
2116
log is bzr's default tool for exploring the history of a branch.
2117
The branch to use is taken from the first parameter. If no parameters
2118
are given, the branch containing the working directory is logged.
2119
Here are some simple examples::
2121
bzr log log the current branch
2122
bzr log foo.py log a file in its branch
2123
bzr log http://server/branch log a branch on a server
2125
The filtering, ordering and information shown for each revision can
2126
be controlled as explained below. By default, all revisions are
2127
shown sorted (topologically) so that newer revisions appear before
2128
older ones and descendants always appear before ancestors. If displayed,
2129
merged revisions are shown indented under the revision in which they
2134
The log format controls how information about each revision is
2135
displayed. The standard log formats are called ``long``, ``short``
2136
and ``line``. The default is long. See ``bzr help log-formats``
2137
for more details on log formats.
2139
The following options can be used to control what information is
2142
-l N display a maximum of N revisions
2143
-n N display N levels of revisions (0 for all, 1 for collapsed)
2144
-v display a status summary (delta) for each revision
2145
-p display a diff (patch) for each revision
2146
--show-ids display revision-ids (and file-ids), not just revnos
2148
Note that the default number of levels to display is a function of the
2149
log format. If the -n option is not used, the standard log formats show
2150
just the top level (mainline).
2152
Status summaries are shown using status flags like A, M, etc. To see
2153
the changes explained using words like ``added`` and ``modified``
2154
instead, use the -vv option.
2158
To display revisions from oldest to newest, use the --forward option.
2159
In most cases, using this option will have little impact on the total
2160
time taken to produce a log, though --forward does not incrementally
2161
display revisions like --reverse does when it can.
2163
:Revision filtering:
2165
The -r option can be used to specify what revision or range of revisions
2166
to filter against. The various forms are shown below::
2168
-rX display revision X
2169
-rX.. display revision X and later
2170
-r..Y display up to and including revision Y
2171
-rX..Y display from X to Y inclusive
2173
See ``bzr help revisionspec`` for details on how to specify X and Y.
2174
Some common examples are given below::
2176
-r-1 show just the tip
2177
-r-10.. show the last 10 mainline revisions
2178
-rsubmit:.. show what's new on this branch
2179
-rancestor:path.. show changes since the common ancestor of this
2180
branch and the one at location path
2181
-rdate:yesterday.. show changes since yesterday
2183
When logging a range of revisions using -rX..Y, log starts at
2184
revision Y and searches back in history through the primary
2185
("left-hand") parents until it finds X. When logging just the
2186
top level (using -n1), an error is reported if X is not found
2187
along the way. If multi-level logging is used (-n0), X may be
2188
a nested merge revision and the log will be truncated accordingly.
2192
If parameters are given and the first one is not a branch, the log
2193
will be filtered to show only those revisions that changed the
2194
nominated files or directories.
2196
Filenames are interpreted within their historical context. To log a
2197
deleted file, specify a revision range so that the file existed at
2198
the end or start of the range.
2200
Historical context is also important when interpreting pathnames of
2201
renamed files/directories. Consider the following example:
2203
* revision 1: add tutorial.txt
2204
* revision 2: modify tutorial.txt
2205
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2209
* ``bzr log guide.txt`` will log the file added in revision 1
2211
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2213
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2214
the original file in revision 2.
2216
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2217
was no file called guide.txt in revision 2.
2219
Renames are always followed by log. By design, there is no need to
2220
explicitly ask for this (and no way to stop logging a file back
2221
until it was last renamed).
2225
The --message option can be used for finding revisions that match a
2226
regular expression in a commit message.
2230
GUI tools and IDEs are often better at exploring history than command
2231
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2232
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2233
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2234
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2236
You may find it useful to add the aliases below to ``bazaar.conf``::
2240
top = log -l10 --line
2243
``bzr tip`` will then show the latest revision while ``bzr top``
2244
will show the last 10 mainline revisions. To see the details of a
2245
particular revision X, ``bzr show -rX``.
2247
If you are interested in looking deeper into a particular merge X,
2248
use ``bzr log -n0 -rX``.
2250
``bzr log -v`` on a branch with lots of history is currently
2251
very slow. A fix for this issue is currently under development.
2252
With or without that fix, it is recommended that a revision range
2253
be given when using the -v option.
2255
bzr has a generic full-text matching plugin, bzr-search, that can be
2256
used to find revisions matching user names, commit messages, etc.
2257
Among other features, this plugin can find all revisions containing
2258
a list of words but not others.
2260
When exploring non-mainline history on large projects with deep
2261
history, the performance of log can be greatly improved by installing
2262
the historycache plugin. This plugin buffers historical information
2263
trading disk space for faster speed.
2265
takes_args = ['file*']
2266
_see_also = ['log-formats', 'revisionspec']
2269
help='Show from oldest to newest.'),
2271
custom_help('verbose',
2272
help='Show files changed in each revision.'),
2276
type=bzrlib.option._parse_revision_str,
2278
help='Show just the specified revision.'
2279
' See also "help revisionspec".'),
2283
help='Number of levels to display - 0 for all, 1 for flat.',
2285
type=_parse_levels),
2288
help='Show revisions whose message matches this '
2289
'regular expression.',
2293
help='Limit the output to the first N revisions.',
2298
help='Show changes made in each revision as a patch.'),
2299
Option('include-merges',
2300
help='Show merged revisions like --levels 0 does.'),
2302
encoding_type = 'replace'
2305
def run(self, file_list=None, timezone='original',
2316
include_merges=False):
2317
from bzrlib.log import (
2319
make_log_request_dict,
2320
_get_info_for_log_files,
2322
direction = (forward and 'forward') or 'reverse'
2327
raise errors.BzrCommandError(
2328
'--levels and --include-merges are mutually exclusive')
2330
if change is not None:
2332
raise errors.RangeInChangeOption()
2333
if revision is not None:
2334
raise errors.BzrCommandError(
2335
'--revision and --change are mutually exclusive')
2340
filter_by_dir = False
2342
# find the file ids to log and check for directory filtering
2343
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2344
revision, file_list)
2345
self.add_cleanup(b.unlock)
2346
for relpath, file_id, kind in file_info_list:
2348
raise errors.BzrCommandError(
2349
"Path unknown at end or start of revision range: %s" %
2351
# If the relpath is the top of the tree, we log everything
2356
file_ids.append(file_id)
2357
filter_by_dir = filter_by_dir or (
2358
kind in ['directory', 'tree-reference'])
2361
# FIXME ? log the current subdir only RBC 20060203
2362
if revision is not None \
2363
and len(revision) > 0 and revision[0].get_branch():
2364
location = revision[0].get_branch()
2367
dir, relpath = bzrdir.BzrDir.open_containing(location)
2368
b = dir.open_branch()
2370
self.add_cleanup(b.unlock)
2371
rev1, rev2 = _get_revision_range(revision, b, self.name())
2373
# Decide on the type of delta & diff filtering to use
2374
# TODO: add an --all-files option to make this configurable & consistent
2382
diff_type = 'partial'
2386
# Build the log formatter
2387
if log_format is None:
2388
log_format = log.log_formatter_registry.get_default(b)
2389
# Make a non-encoding output to include the diffs - bug 328007
2390
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2391
lf = log_format(show_ids=show_ids, to_file=self.outf,
2392
to_exact_file=unencoded_output,
2393
show_timezone=timezone,
2394
delta_format=get_verbosity_level(),
2396
show_advice=levels is None)
2398
# Choose the algorithm for doing the logging. It's annoying
2399
# having multiple code paths like this but necessary until
2400
# the underlying repository format is faster at generating
2401
# deltas or can provide everything we need from the indices.
2402
# The default algorithm - match-using-deltas - works for
2403
# multiple files and directories and is faster for small
2404
# amounts of history (200 revisions say). However, it's too
2405
# slow for logging a single file in a repository with deep
2406
# history, i.e. > 10K revisions. In the spirit of "do no
2407
# evil when adding features", we continue to use the
2408
# original algorithm - per-file-graph - for the "single
2409
# file that isn't a directory without showing a delta" case.
2410
partial_history = revision and b.repository._format.supports_chks
2411
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2412
or delta_type or partial_history)
2414
# Build the LogRequest and execute it
2415
if len(file_ids) == 0:
2417
rqst = make_log_request_dict(
2418
direction=direction, specific_fileids=file_ids,
2419
start_revision=rev1, end_revision=rev2, limit=limit,
2420
message_search=message, delta_type=delta_type,
2421
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2422
Logger(b, rqst).show(lf)
2425
def _get_revision_range(revisionspec_list, branch, command_name):
2426
"""Take the input of a revision option and turn it into a revision range.
2428
It returns RevisionInfo objects which can be used to obtain the rev_id's
2429
of the desired revisions. It does some user input validations.
2431
if revisionspec_list is None:
2434
elif len(revisionspec_list) == 1:
2435
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2436
elif len(revisionspec_list) == 2:
2437
start_spec = revisionspec_list[0]
2438
end_spec = revisionspec_list[1]
2439
if end_spec.get_branch() != start_spec.get_branch():
2440
# b is taken from revision[0].get_branch(), and
2441
# show_log will use its revision_history. Having
2442
# different branches will lead to weird behaviors.
2443
raise errors.BzrCommandError(
2444
"bzr %s doesn't accept two revisions in different"
2445
" branches." % command_name)
2446
if start_spec.spec is None:
2447
# Avoid loading all the history.
2448
rev1 = RevisionInfo(branch, None, None)
2450
rev1 = start_spec.in_history(branch)
2451
# Avoid loading all of history when we know a missing
2452
# end of range means the last revision ...
2453
if end_spec.spec is None:
2454
last_revno, last_revision_id = branch.last_revision_info()
2455
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2457
rev2 = end_spec.in_history(branch)
2459
raise errors.BzrCommandError(
2460
'bzr %s --revision takes one or two values.' % command_name)
2464
def _revision_range_to_revid_range(revision_range):
2467
if revision_range[0] is not None:
2468
rev_id1 = revision_range[0].rev_id
2469
if revision_range[1] is not None:
2470
rev_id2 = revision_range[1].rev_id
2471
return rev_id1, rev_id2
2473
def get_log_format(long=False, short=False, line=False, default='long'):
2474
log_format = default
2478
log_format = 'short'
2484
class cmd_touching_revisions(Command):
2485
"""Return revision-ids which affected a particular file.
2487
A more user-friendly interface is "bzr log FILE".
2491
takes_args = ["filename"]
2494
def run(self, filename):
2495
tree, relpath = WorkingTree.open_containing(filename)
2496
file_id = tree.path2id(relpath)
2499
self.add_cleanup(b.unlock)
2500
touching_revs = log.find_touching_revisions(b, file_id)
2501
for revno, revision_id, what in touching_revs:
2502
self.outf.write("%6d %s\n" % (revno, what))
2505
class cmd_ls(Command):
2506
"""List files in a tree.
2509
_see_also = ['status', 'cat']
2510
takes_args = ['path?']
2514
Option('recursive', short_name='R',
2515
help='Recurse into subdirectories.'),
2517
help='Print paths relative to the root of the branch.'),
2518
Option('unknown', help='Print unknown files.'),
2519
Option('versioned', help='Print versioned files.',
2521
Option('ignored', help='Print ignored files.'),
2523
help='Write an ascii NUL (\\0) separator '
2524
'between files rather than a newline.'),
2526
help='List entries of a particular kind: file, directory, symlink.',
2531
def run(self, revision=None, verbose=False,
2532
recursive=False, from_root=False,
2533
unknown=False, versioned=False, ignored=False,
2534
null=False, kind=None, show_ids=False, path=None):
2536
if kind and kind not in ('file', 'directory', 'symlink'):
2537
raise errors.BzrCommandError('invalid kind specified')
2539
if verbose and null:
2540
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2541
all = not (unknown or versioned or ignored)
2543
selection = {'I':ignored, '?':unknown, 'V':versioned}
2549
raise errors.BzrCommandError('cannot specify both --from-root'
2552
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2555
# Calculate the prefix to use
2559
prefix = relpath + '/'
2560
elif fs_path != '.' and not fs_path.endswith('/'):
2561
prefix = fs_path + '/'
2563
if revision is not None or tree is None:
2564
tree = _get_one_revision_tree('ls', revision, branch=branch)
2567
if isinstance(tree, WorkingTree) and tree.supports_views():
2568
view_files = tree.views.lookup_view()
2571
view_str = views.view_display_str(view_files)
2572
note("Ignoring files outside view. View is %s" % view_str)
2575
self.add_cleanup(tree.unlock)
2576
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2577
from_dir=relpath, recursive=recursive):
2578
# Apply additional masking
2579
if not all and not selection[fc]:
2581
if kind is not None and fkind != kind:
2586
fullpath = osutils.pathjoin(relpath, fp)
2589
views.check_path_in_view(tree, fullpath)
2590
except errors.FileOutsideView:
2595
fp = osutils.pathjoin(prefix, fp)
2596
kindch = entry.kind_character()
2597
outstring = fp + kindch
2598
ui.ui_factory.clear_term()
2600
outstring = '%-8s %s' % (fc, outstring)
2601
if show_ids and fid is not None:
2602
outstring = "%-50s %s" % (outstring, fid)
2603
self.outf.write(outstring + '\n')
2605
self.outf.write(fp + '\0')
2608
self.outf.write(fid)
2609
self.outf.write('\0')
2617
self.outf.write('%-50s %s\n' % (outstring, my_id))
2619
self.outf.write(outstring + '\n')
2622
class cmd_unknowns(Command):
2623
"""List unknown files.
2631
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2632
self.outf.write(osutils.quotefn(f) + '\n')
2635
class cmd_ignore(Command):
2636
"""Ignore specified files or patterns.
2638
See ``bzr help patterns`` for details on the syntax of patterns.
2640
If a .bzrignore file does not exist, the ignore command
2641
will create one and add the specified files or patterns to the newly
2642
created file. The ignore command will also automatically add the
2643
.bzrignore file to be versioned. Creating a .bzrignore file without
2644
the use of the ignore command will require an explicit add command.
2646
To remove patterns from the ignore list, edit the .bzrignore file.
2647
After adding, editing or deleting that file either indirectly by
2648
using this command or directly by using an editor, be sure to commit
2651
Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
precedence over regular ignores. Such exceptions are used to specify
2653
files that should be versioned which would otherwise be ignored.
2655
Patterns prefixed with '!!' act as regular ignore patterns, but have
2656
precedence over the '!' exception patterns.
2658
Note: ignore patterns containing shell wildcards must be quoted from
2662
Ignore the top level Makefile::
2664
bzr ignore ./Makefile
2666
Ignore .class files in all directories...::
2668
bzr ignore "*.class"
2670
...but do not ignore "special.class"::
2672
bzr ignore "!special.class"
2674
Ignore .o files under the lib directory::
2676
bzr ignore "lib/**/*.o"
2678
Ignore .o files under the lib directory::
2680
bzr ignore "RE:lib/.*\.o"
2682
Ignore everything but the "debian" toplevel directory::
2684
bzr ignore "RE:(?!debian/).*"
2686
Ignore everything except the "local" toplevel directory,
2687
but always ignore "*~" autosave files, even under local/::
2690
bzr ignore "!./local"
2694
_see_also = ['status', 'ignored', 'patterns']
2695
takes_args = ['name_pattern*']
2697
Option('old-default-rules',
2698
help='Write out the ignore rules bzr < 0.9 always used.')
2701
def run(self, name_pattern_list=None, old_default_rules=None):
2702
from bzrlib import ignores
2703
if old_default_rules is not None:
2704
# dump the rules and exit
2705
for pattern in ignores.OLD_DEFAULTS:
2706
self.outf.write("%s\n" % pattern)
2708
if not name_pattern_list:
2709
raise errors.BzrCommandError("ignore requires at least one "
2710
"NAME_PATTERN or --old-default-rules")
2711
name_pattern_list = [globbing.normalize_pattern(p)
2712
for p in name_pattern_list]
2713
for name_pattern in name_pattern_list:
2714
if (name_pattern[0] == '/' or
2715
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2716
raise errors.BzrCommandError(
2717
"NAME_PATTERN should not be an absolute path")
2718
tree, relpath = WorkingTree.open_containing(u'.')
2719
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2720
ignored = globbing.Globster(name_pattern_list)
2723
for entry in tree.list_files():
2727
if ignored.match(filename):
2728
matches.append(filename)
2730
if len(matches) > 0:
2731
self.outf.write("Warning: the following files are version controlled and"
2732
" match your ignore pattern:\n%s"
2733
"\nThese files will continue to be version controlled"
2734
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2737
class cmd_ignored(Command):
2738
"""List ignored files and the patterns that matched them.
2740
List all the ignored files and the ignore pattern that caused the file to
2743
Alternatively, to list just the files::
2748
encoding_type = 'replace'
2749
_see_also = ['ignore', 'ls']
2753
tree = WorkingTree.open_containing(u'.')[0]
2755
self.add_cleanup(tree.unlock)
2756
for path, file_class, kind, file_id, entry in tree.list_files():
2757
if file_class != 'I':
2759
## XXX: Slightly inefficient since this was already calculated
2760
pat = tree.is_ignored(path)
2761
self.outf.write('%-50s %s\n' % (path, pat))
2764
class cmd_lookup_revision(Command):
2765
"""Lookup the revision-id from a revision-number
2768
bzr lookup-revision 33
2771
takes_args = ['revno']
2774
def run(self, revno):
2778
raise errors.BzrCommandError("not a valid revision-number: %r"
2780
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2781
self.outf.write("%s\n" % revid)
2784
class cmd_export(Command):
2785
"""Export current or past revision to a destination directory or archive.
2787
If no revision is specified this exports the last committed revision.
2789
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2790
given, try to find the format with the extension. If no extension
2791
is found exports to a directory (equivalent to --format=dir).
2793
If root is supplied, it will be used as the root directory inside
2794
container formats (tar, zip, etc). If it is not supplied it will default
2795
to the exported filename. The root option has no effect for 'dir' format.
2797
If branch is omitted then the branch containing the current working
2798
directory will be used.
2800
Note: Export of tree with non-ASCII filenames to zip is not supported.
2802
================= =========================
2803
Supported formats Autodetected by extension
2804
================= =========================
2807
tbz2 .tar.bz2, .tbz2
2810
================= =========================
2812
takes_args = ['dest', 'branch_or_subdir?']
2815
help="Type of file to export to.",
2818
Option('filters', help='Apply content filters to export the '
2819
'convenient form.'),
2822
help="Name of the root directory inside the exported file."),
2823
Option('per-file-timestamps',
2824
help='Set modification time of files to that of the last '
2825
'revision in which it was changed.'),
2827
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2828
root=None, filters=False, per_file_timestamps=False):
2829
from bzrlib.export import export
2831
if branch_or_subdir is None:
2832
tree = WorkingTree.open_containing(u'.')[0]
2836
b, subdir = Branch.open_containing(branch_or_subdir)
2839
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2841
export(rev_tree, dest, format, root, subdir, filtered=filters,
2842
per_file_timestamps=per_file_timestamps)
2843
except errors.NoSuchExportFormat, e:
2844
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2847
class cmd_cat(Command):
2848
"""Write the contents of a file as of a given revision to standard output.
2850
If no revision is nominated, the last revision is used.
2852
Note: Take care to redirect standard output when using this command on a
2858
Option('name-from-revision', help='The path name in the old tree.'),
2859
Option('filters', help='Apply content filters to display the '
2860
'convenience form.'),
2863
takes_args = ['filename']
2864
encoding_type = 'exact'
2867
def run(self, filename, revision=None, name_from_revision=False,
2869
if revision is not None and len(revision) != 1:
2870
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2871
" one revision specifier")
2872
tree, branch, relpath = \
2873
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2875
self.add_cleanup(branch.unlock)
2876
return self._run(tree, branch, relpath, filename, revision,
2877
name_from_revision, filters)
2879
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2882
tree = b.basis_tree()
2883
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2884
rev_tree.lock_read()
2885
self.add_cleanup(rev_tree.unlock)
2887
old_file_id = rev_tree.path2id(relpath)
2889
if name_from_revision:
2890
# Try in revision if requested
2891
if old_file_id is None:
2892
raise errors.BzrCommandError(
2893
"%r is not present in revision %s" % (
2894
filename, rev_tree.get_revision_id()))
2896
content = rev_tree.get_file_text(old_file_id)
2898
cur_file_id = tree.path2id(relpath)
2900
if cur_file_id is not None:
2901
# Then try with the actual file id
2903
content = rev_tree.get_file_text(cur_file_id)
2905
except errors.NoSuchId:
2906
# The actual file id didn't exist at that time
2908
if not found and old_file_id is not None:
2909
# Finally try with the old file id
2910
content = rev_tree.get_file_text(old_file_id)
2913
# Can't be found anywhere
2914
raise errors.BzrCommandError(
2915
"%r is not present in revision %s" % (
2916
filename, rev_tree.get_revision_id()))
2918
from bzrlib.filters import (
2919
ContentFilterContext,
2920
filtered_output_bytes,
2922
filters = rev_tree._content_filter_stack(relpath)
2923
chunks = content.splitlines(True)
2924
content = filtered_output_bytes(chunks, filters,
2925
ContentFilterContext(relpath, rev_tree))
2927
self.outf.writelines(content)
2930
self.outf.write(content)
2933
class cmd_local_time_offset(Command):
2934
"""Show the offset in seconds from GMT to local time."""
2938
self.outf.write("%s\n" % osutils.local_time_offset())
2942
class cmd_commit(Command):
2943
"""Commit changes into a new revision.
2945
An explanatory message needs to be given for each commit. This is
2946
often done by using the --message option (getting the message from the
2947
command line) or by using the --file option (getting the message from
2948
a file). If neither of these options is given, an editor is opened for
2949
the user to enter the message. To see the changed files in the
2950
boilerplate text loaded into the editor, use the --show-diff option.
2952
By default, the entire tree is committed and the person doing the
2953
commit is assumed to be the author. These defaults can be overridden
2958
If selected files are specified, only changes to those files are
2959
committed. If a directory is specified then the directory and
2960
everything within it is committed.
2962
When excludes are given, they take precedence over selected files.
2963
For example, to commit only changes within foo, but not changes
2966
bzr commit foo -x foo/bar
2968
A selective commit after a merge is not yet supported.
2972
If the author of the change is not the same person as the committer,
2973
you can specify the author's name using the --author option. The
2974
name should be in the same format as a committer-id, e.g.
2975
"John Doe <jdoe@example.com>". If there is more than one author of
2976
the change you can specify the option multiple times, once for each
2981
A common mistake is to forget to add a new file or directory before
2982
running the commit command. The --strict option checks for unknown
2983
files and aborts the commit if any are found. More advanced pre-commit
2984
checks can be implemented by defining hooks. See ``bzr help hooks``
2989
If you accidentially commit the wrong changes or make a spelling
2990
mistake in the commit message say, you can use the uncommit command
2991
to undo it. See ``bzr help uncommit`` for details.
2993
Hooks can also be configured to run after a commit. This allows you
2994
to trigger updates to external systems like bug trackers. The --fixes
2995
option can be used to record the association between a revision and
2996
one or more bugs. See ``bzr help bugs`` for details.
2998
A selective commit may fail in some cases where the committed
2999
tree would be invalid. Consider::
3004
bzr commit foo -m "committing foo"
3005
bzr mv foo/bar foo/baz
3008
bzr commit foo/bar -m "committing bar but not baz"
3010
In the example above, the last commit will fail by design. This gives
3011
the user the opportunity to decide whether they want to commit the
3012
rename at the same time, separately first, or not at all. (As a general
3013
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3015
# TODO: Run hooks on tree to-be-committed, and after commit.
3017
# TODO: Strict commit that fails if there are deleted files.
3018
# (what does "deleted files" mean ??)
3020
# TODO: Give better message for -s, --summary, used by tla people
3022
# XXX: verbose currently does nothing
3024
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3025
takes_args = ['selected*']
3027
ListOption('exclude', type=str, short_name='x',
3028
help="Do not consider changes made to a given path."),
3029
Option('message', type=unicode,
3031
help="Description of the new revision."),
3034
help='Commit even if nothing has changed.'),
3035
Option('file', type=str,
3038
help='Take commit message from this file.'),
3040
help="Refuse to commit if there are unknown "
3041
"files in the working tree."),
3042
Option('commit-time', type=str,
3043
help="Manually set a commit time using commit date "
3044
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3045
ListOption('fixes', type=str,
3046
help="Mark a bug as being fixed by this revision "
3047
"(see \"bzr help bugs\")."),
3048
ListOption('author', type=unicode,
3049
help="Set the author's name, if it's different "
3050
"from the committer."),
3052
help="Perform a local commit in a bound "
3053
"branch. Local commits are not pushed to "
3054
"the master branch until a normal commit "
3058
help='When no message is supplied, show the diff along'
3059
' with the status summary in the message editor.'),
3061
aliases = ['ci', 'checkin']
3063
def _iter_bug_fix_urls(self, fixes, branch):
3064
# Configure the properties for bug fixing attributes.
3065
for fixed_bug in fixes:
3066
tokens = fixed_bug.split(':')
3067
if len(tokens) != 2:
3068
raise errors.BzrCommandError(
3069
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3070
"See \"bzr help bugs\" for more information on this "
3071
"feature.\nCommit refused." % fixed_bug)
3072
tag, bug_id = tokens
3074
yield bugtracker.get_bug_url(tag, branch, bug_id)
3075
except errors.UnknownBugTrackerAbbreviation:
3076
raise errors.BzrCommandError(
3077
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3078
except errors.MalformedBugIdentifier, e:
3079
raise errors.BzrCommandError(
3080
"%s\nCommit refused." % (str(e),))
3082
def run(self, message=None, file=None, verbose=False, selected_list=None,
3083
unchanged=False, strict=False, local=False, fixes=None,
3084
author=None, show_diff=False, exclude=None, commit_time=None):
3085
from bzrlib.errors import (
3090
from bzrlib.msgeditor import (
3091
edit_commit_message_encoded,
3092
generate_commit_message_template,
3093
make_commit_message_template_encoded
3096
commit_stamp = offset = None
3097
if commit_time is not None:
3099
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3100
except ValueError, e:
3101
raise errors.BzrCommandError(
3102
"Could not parse --commit-time: " + str(e))
3104
# TODO: Need a blackbox test for invoking the external editor; may be
3105
# slightly problematic to run this cross-platform.
3107
# TODO: do more checks that the commit will succeed before
3108
# spending the user's valuable time typing a commit message.
3112
tree, selected_list = tree_files(selected_list)
3113
if selected_list == ['']:
3114
# workaround - commit of root of tree should be exactly the same
3115
# as just default commit in that tree, and succeed even though
3116
# selected-file merge commit is not done yet
3121
bug_property = bugtracker.encode_fixes_bug_urls(
3122
self._iter_bug_fix_urls(fixes, tree.branch))
3124
properties['bugs'] = bug_property
3126
if local and not tree.branch.get_bound_location():
3127
raise errors.LocalRequiresBoundBranch()
3129
if message is not None:
3131
file_exists = osutils.lexists(message)
3132
except UnicodeError:
3133
# The commit message contains unicode characters that can't be
3134
# represented in the filesystem encoding, so that can't be a
3139
'The commit message is a file name: "%(f)s".\n'
3140
'(use --file "%(f)s" to take commit message from that file)'
3142
ui.ui_factory.show_warning(warning_msg)
3144
message = message.replace('\r\n', '\n')
3145
message = message.replace('\r', '\n')
3147
raise errors.BzrCommandError(
3148
"please specify either --message or --file")
3150
def get_message(commit_obj):
3151
"""Callback to get commit message"""
3153
my_message = codecs.open(
3154
file, 'rt', osutils.get_user_encoding()).read()
3155
elif message is not None:
3156
my_message = message
3158
# No message supplied: make one up.
3159
# text is the status of the tree
3160
text = make_commit_message_template_encoded(tree,
3161
selected_list, diff=show_diff,
3162
output_encoding=osutils.get_user_encoding())
3163
# start_message is the template generated from hooks
3164
# XXX: Warning - looks like hooks return unicode,
3165
# make_commit_message_template_encoded returns user encoding.
3166
# We probably want to be using edit_commit_message instead to
3168
start_message = generate_commit_message_template(commit_obj)
3169
my_message = edit_commit_message_encoded(text,
3170
start_message=start_message)
3171
if my_message is None:
3172
raise errors.BzrCommandError("please specify a commit"
3173
" message with either --message or --file")
3174
if my_message == "":
3175
raise errors.BzrCommandError("empty commit message specified")
3178
# The API permits a commit with a filter of [] to mean 'select nothing'
3179
# but the command line should not do that.
3180
if not selected_list:
3181
selected_list = None
3183
tree.commit(message_callback=get_message,
3184
specific_files=selected_list,
3185
allow_pointless=unchanged, strict=strict, local=local,
3186
reporter=None, verbose=verbose, revprops=properties,
3187
authors=author, timestamp=commit_stamp,
3189
exclude=safe_relpath_files(tree, exclude))
3190
except PointlessCommit:
3191
raise errors.BzrCommandError("No changes to commit."
3192
" Use --unchanged to commit anyhow.")
3193
except ConflictsInTree:
3194
raise errors.BzrCommandError('Conflicts detected in working '
3195
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3197
except StrictCommitFailed:
3198
raise errors.BzrCommandError("Commit refused because there are"
3199
" unknown files in the working tree.")
3200
except errors.BoundBranchOutOfDate, e:
3201
e.extra_help = ("\n"
3202
'To commit to master branch, run update and then commit.\n'
3203
'You can also pass --local to commit to continue working '
3208
class cmd_check(Command):
3209
"""Validate working tree structure, branch consistency and repository history.
3211
This command checks various invariants about branch and repository storage
3212
to detect data corruption or bzr bugs.
3214
The working tree and branch checks will only give output if a problem is
3215
detected. The output fields of the repository check are:
3218
This is just the number of revisions checked. It doesn't
3222
This is just the number of versionedfiles checked. It
3223
doesn't indicate a problem.
3225
unreferenced ancestors
3226
Texts that are ancestors of other texts, but
3227
are not properly referenced by the revision ancestry. This is a
3228
subtle problem that Bazaar can work around.
3231
This is the total number of unique file contents
3232
seen in the checked revisions. It does not indicate a problem.
3235
This is the total number of repeated texts seen
3236
in the checked revisions. Texts can be repeated when their file
3237
entries are modified, but the file contents are not. It does not
3240
If no restrictions are specified, all Bazaar data that is found at the given
3241
location will be checked.
3245
Check the tree and branch at 'foo'::
3247
bzr check --tree --branch foo
3249
Check only the repository at 'bar'::
3251
bzr check --repo bar
3253
Check everything at 'baz'::
3258
_see_also = ['reconcile']
3259
takes_args = ['path?']
3260
takes_options = ['verbose',
3261
Option('branch', help="Check the branch related to the"
3262
" current directory."),
3263
Option('repo', help="Check the repository related to the"
3264
" current directory."),
3265
Option('tree', help="Check the working tree related to"
3266
" the current directory.")]
3268
def run(self, path=None, verbose=False, branch=False, repo=False,
3270
from bzrlib.check import check_dwim
3273
if not branch and not repo and not tree:
3274
branch = repo = tree = True
3275
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3278
class cmd_upgrade(Command):
3279
"""Upgrade branch storage to current format.
3281
The check command or bzr developers may sometimes advise you to run
3282
this command. When the default format has changed you may also be warned
3283
during other operations to upgrade.
3286
_see_also = ['check']
3287
takes_args = ['url?']
3289
RegistryOption('format',
3290
help='Upgrade to a specific format. See "bzr help'
3291
' formats" for details.',
3292
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3293
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3294
value_switches=True, title='Branch format'),
3297
def run(self, url='.', format=None):
3298
from bzrlib.upgrade import upgrade
3299
upgrade(url, format)
3302
class cmd_whoami(Command):
3303
"""Show or set bzr user id.
3306
Show the email of the current user::
3310
Set the current user::
3312
bzr whoami "Frank Chu <fchu@example.com>"
3314
takes_options = [ Option('email',
3315
help='Display email address only.'),
3317
help='Set identity for the current branch instead of '
3320
takes_args = ['name?']
3321
encoding_type = 'replace'
3324
def run(self, email=False, branch=False, name=None):
3326
# use branch if we're inside one; otherwise global config
3328
c = Branch.open_containing('.')[0].get_config()
3329
except errors.NotBranchError:
3330
c = config.GlobalConfig()
3332
self.outf.write(c.user_email() + '\n')
3334
self.outf.write(c.username() + '\n')
3337
# display a warning if an email address isn't included in the given name.
3339
config.extract_email_address(name)
3340
except errors.NoEmailInUsername, e:
3341
warning('"%s" does not seem to contain an email address. '
3342
'This is allowed, but not recommended.', name)
3344
# use global config unless --branch given
3346
c = Branch.open_containing('.')[0].get_config()
3348
c = config.GlobalConfig()
3349
c.set_user_option('email', name)
3352
class cmd_nick(Command):
3353
"""Print or set the branch nickname.
3355
If unset, the tree root directory name is used as the nickname.
3356
To print the current nickname, execute with no argument.
3358
Bound branches use the nickname of its master branch unless it is set
3362
_see_also = ['info']
3363
takes_args = ['nickname?']
3364
def run(self, nickname=None):
3365
branch = Branch.open_containing(u'.')[0]
3366
if nickname is None:
3367
self.printme(branch)
3369
branch.nick = nickname
3372
def printme(self, branch):
3373
self.outf.write('%s\n' % branch.nick)
3376
class cmd_alias(Command):
3377
"""Set/unset and display aliases.
3380
Show the current aliases::
3384
Show the alias specified for 'll'::
3388
Set an alias for 'll'::
3390
bzr alias ll="log --line -r-10..-1"
3392
To remove an alias for 'll'::
3394
bzr alias --remove ll
3397
takes_args = ['name?']
3399
Option('remove', help='Remove the alias.'),
3402
def run(self, name=None, remove=False):
3404
self.remove_alias(name)
3406
self.print_aliases()
3408
equal_pos = name.find('=')
3410
self.print_alias(name)
3412
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3414
def remove_alias(self, alias_name):
3415
if alias_name is None:
3416
raise errors.BzrCommandError(
3417
'bzr alias --remove expects an alias to remove.')
3418
# If alias is not found, print something like:
3419
# unalias: foo: not found
3420
c = config.GlobalConfig()
3421
c.unset_alias(alias_name)
3424
def print_aliases(self):
3425
"""Print out the defined aliases in a similar format to bash."""
3426
aliases = config.GlobalConfig().get_aliases()
3427
for key, value in sorted(aliases.iteritems()):
3428
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3431
def print_alias(self, alias_name):
3432
from bzrlib.commands import get_alias
3433
alias = get_alias(alias_name)
3435
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3438
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3440
def set_alias(self, alias_name, alias_command):
3441
"""Save the alias in the global config."""
3442
c = config.GlobalConfig()
3443
c.set_alias(alias_name, alias_command)
3446
class cmd_selftest(Command):
3447
"""Run internal test suite.
3449
If arguments are given, they are regular expressions that say which tests
3450
should run. Tests matching any expression are run, and other tests are
3453
Alternatively if --first is given, matching tests are run first and then
3454
all other tests are run. This is useful if you have been working in a
3455
particular area, but want to make sure nothing else was broken.
3457
If --exclude is given, tests that match that regular expression are
3458
excluded, regardless of whether they match --first or not.
3460
To help catch accidential dependencies between tests, the --randomize
3461
option is useful. In most cases, the argument used is the word 'now'.
3462
Note that the seed used for the random number generator is displayed
3463
when this option is used. The seed can be explicitly passed as the
3464
argument to this option if required. This enables reproduction of the
3465
actual ordering used if and when an order sensitive problem is encountered.
3467
If --list-only is given, the tests that would be run are listed. This is
3468
useful when combined with --first, --exclude and/or --randomize to
3469
understand their impact. The test harness reports "Listed nn tests in ..."
3470
instead of "Ran nn tests in ..." when list mode is enabled.
3472
If the global option '--no-plugins' is given, plugins are not loaded
3473
before running the selftests. This has two effects: features provided or
3474
modified by plugins will not be tested, and tests provided by plugins will
3477
Tests that need working space on disk use a common temporary directory,
3478
typically inside $TMPDIR or /tmp.
3480
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3481
into a pdb postmortem session.
3484
Run only tests relating to 'ignore'::
3488
Disable plugins and list tests as they're run::
3490
bzr --no-plugins selftest -v
3492
# NB: this is used from the class without creating an instance, which is
3493
# why it does not have a self parameter.
3494
def get_transport_type(typestring):
3495
"""Parse and return a transport specifier."""
3496
if typestring == "sftp":
3497
from bzrlib.tests import stub_sftp
3498
return stub_sftp.SFTPAbsoluteServer
3499
if typestring == "memory":
3500
from bzrlib.tests import test_server
3501
return memory.MemoryServer
3502
if typestring == "fakenfs":
3503
from bzrlib.tests import test_server
3504
return test_server.FakeNFSServer
3505
msg = "No known transport type %s. Supported types are: sftp\n" %\
3507
raise errors.BzrCommandError(msg)
3510
takes_args = ['testspecs*']
3511
takes_options = ['verbose',
3513
help='Stop when one test fails.',
3517
help='Use a different transport by default '
3518
'throughout the test suite.',
3519
type=get_transport_type),
3521
help='Run the benchmarks rather than selftests.'),
3522
Option('lsprof-timed',
3523
help='Generate lsprof output for benchmarked'
3524
' sections of code.'),
3525
Option('lsprof-tests',
3526
help='Generate lsprof output for each test.'),
3527
Option('cache-dir', type=str,
3528
help='Cache intermediate benchmark output in this '
3531
help='Run all tests, but run specified tests first.',
3535
help='List the tests instead of running them.'),
3536
RegistryOption('parallel',
3537
help="Run the test suite in parallel.",
3538
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3539
value_switches=False,
3541
Option('randomize', type=str, argname="SEED",
3542
help='Randomize the order of tests using the given'
3543
' seed or "now" for the current time.'),
3544
Option('exclude', type=str, argname="PATTERN",
3546
help='Exclude tests that match this regular'
3549
help='Output test progress via subunit.'),
3550
Option('strict', help='Fail on missing dependencies or '
3552
Option('load-list', type=str, argname='TESTLISTFILE',
3553
help='Load a test id list from a text file.'),
3554
ListOption('debugflag', type=str, short_name='E',
3555
help='Turn on a selftest debug flag.'),
3556
ListOption('starting-with', type=str, argname='TESTID',
3557
param_name='starting_with', short_name='s',
3559
'Load only the tests starting with TESTID.'),
3561
encoding_type = 'replace'
3564
Command.__init__(self)
3565
self.additional_selftest_args = {}
3567
def run(self, testspecs_list=None, verbose=False, one=False,
3568
transport=None, benchmark=None,
3569
lsprof_timed=None, cache_dir=None,
3570
first=False, list_only=False,
3571
randomize=None, exclude=None, strict=False,
3572
load_list=None, debugflag=None, starting_with=None, subunit=False,
3573
parallel=None, lsprof_tests=False):
3574
from bzrlib.tests import selftest
3575
import bzrlib.benchmarks as benchmarks
3576
from bzrlib.benchmarks import tree_creator
3578
# Make deprecation warnings visible, unless -Werror is set
3579
symbol_versioning.activate_deprecation_warnings(override=False)
3581
if cache_dir is not None:
3582
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3583
if testspecs_list is not None:
3584
pattern = '|'.join(testspecs_list)
3589
from bzrlib.tests import SubUnitBzrRunner
3591
raise errors.BzrCommandError("subunit not available. subunit "
3592
"needs to be installed to use --subunit.")
3593
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3595
self.additional_selftest_args.setdefault(
3596
'suite_decorators', []).append(parallel)
3598
test_suite_factory = benchmarks.test_suite
3599
# Unless user explicitly asks for quiet, be verbose in benchmarks
3600
verbose = not is_quiet()
3601
# TODO: should possibly lock the history file...
3602
benchfile = open(".perf_history", "at", buffering=1)
3603
self.add_cleanup(benchfile.close)
3605
test_suite_factory = None
3607
selftest_kwargs = {"verbose": verbose,
3609
"stop_on_failure": one,
3610
"transport": transport,
3611
"test_suite_factory": test_suite_factory,
3612
"lsprof_timed": lsprof_timed,
3613
"lsprof_tests": lsprof_tests,
3614
"bench_history": benchfile,
3615
"matching_tests_first": first,
3616
"list_only": list_only,
3617
"random_seed": randomize,
3618
"exclude_pattern": exclude,
3620
"load_list": load_list,
3621
"debug_flags": debugflag,
3622
"starting_with": starting_with
3624
selftest_kwargs.update(self.additional_selftest_args)
3625
result = selftest(**selftest_kwargs)
3626
return int(not result)
3629
class cmd_version(Command):
3630
"""Show version of bzr."""
3632
encoding_type = 'replace'
3634
Option("short", help="Print just the version number."),
3638
def run(self, short=False):
3639
from bzrlib.version import show_version
3641
self.outf.write(bzrlib.version_string + '\n')
3643
show_version(to_file=self.outf)
3646
class cmd_rocks(Command):
3647
"""Statement of optimism."""
3653
self.outf.write("It sure does!\n")
3656
class cmd_find_merge_base(Command):
3657
"""Find and print a base revision for merging two branches."""
3658
# TODO: Options to specify revisions on either side, as if
3659
# merging only part of the history.
3660
takes_args = ['branch', 'other']
3664
def run(self, branch, other):
3665
from bzrlib.revision import ensure_null
3667
branch1 = Branch.open_containing(branch)[0]
3668
branch2 = Branch.open_containing(other)[0]
3670
self.add_cleanup(branch1.unlock)
3672
self.add_cleanup(branch2.unlock)
3673
last1 = ensure_null(branch1.last_revision())
3674
last2 = ensure_null(branch2.last_revision())
3676
graph = branch1.repository.get_graph(branch2.repository)
3677
base_rev_id = graph.find_unique_lca(last1, last2)
3679
self.outf.write('merge base is revision %s\n' % base_rev_id)
3682
class cmd_merge(Command):
3683
"""Perform a three-way merge.
3685
The source of the merge can be specified either in the form of a branch,
3686
or in the form of a path to a file containing a merge directive generated
3687
with bzr send. If neither is specified, the default is the upstream branch
3688
or the branch most recently merged using --remember.
3690
When merging a branch, by default the tip will be merged. To pick a different
3691
revision, pass --revision. If you specify two values, the first will be used as
3692
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3693
available revisions, like this is commonly referred to as "cherrypicking".
3695
Revision numbers are always relative to the branch being merged.
3697
By default, bzr will try to merge in all new work from the other
3698
branch, automatically determining an appropriate base. If this
3699
fails, you may need to give an explicit base.
3701
Merge will do its best to combine the changes in two branches, but there
3702
are some kinds of problems only a human can fix. When it encounters those,
3703
it will mark a conflict. A conflict means that you need to fix something,
3704
before you should commit.
3706
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3708
If there is no default branch set, the first merge will set it. After
3709
that, you can omit the branch to use the default. To change the
3710
default, use --remember. The value will only be saved if the remote
3711
location can be accessed.
3713
The results of the merge are placed into the destination working
3714
directory, where they can be reviewed (with bzr diff), tested, and then
3715
committed to record the result of the merge.
3717
merge refuses to run if there are any uncommitted changes, unless
3718
--force is given. The --force option can also be used to create a
3719
merge revision which has more than two parents.
3721
If one would like to merge changes from the working tree of the other
3722
branch without merging any committed revisions, the --uncommitted option
3725
To select only some changes to merge, use "merge -i", which will prompt
3726
you to apply each diff hunk and file change, similar to "shelve".
3729
To merge the latest revision from bzr.dev::
3731
bzr merge ../bzr.dev
3733
To merge changes up to and including revision 82 from bzr.dev::
3735
bzr merge -r 82 ../bzr.dev
3737
To merge the changes introduced by 82, without previous changes::
3739
bzr merge -r 81..82 ../bzr.dev
3741
To apply a merge directive contained in /tmp/merge::
3743
bzr merge /tmp/merge
3745
To create a merge revision with three parents from two branches
3746
feature1a and feature1b:
3748
bzr merge ../feature1a
3749
bzr merge ../feature1b --force
3750
bzr commit -m 'revision with three parents'
3753
encoding_type = 'exact'
3754
_see_also = ['update', 'remerge', 'status-flags', 'send']
3755
takes_args = ['location?']
3760
help='Merge even if the destination tree has uncommitted changes.'),
3764
Option('show-base', help="Show base revision text in "
3766
Option('uncommitted', help='Apply uncommitted changes'
3767
' from a working copy, instead of branch changes.'),
3768
Option('pull', help='If the destination is already'
3769
' completely merged into the source, pull from the'
3770
' source rather than merging. When this happens,'
3771
' you do not need to commit the result.'),
3773
help='Branch to merge into, '
3774
'rather than the one containing the working directory.',
3778
Option('preview', help='Instead of merging, show a diff of the'
3780
Option('interactive', help='Select changes interactively.',
3784
def run(self, location=None, revision=None, force=False,
3785
merge_type=None, show_base=False, reprocess=None, remember=False,
3786
uncommitted=False, pull=False,
3791
if merge_type is None:
3792
merge_type = _mod_merge.Merge3Merger
3794
if directory is None: directory = u'.'
3795
possible_transports = []
3797
allow_pending = True
3798
verified = 'inapplicable'
3799
tree = WorkingTree.open_containing(directory)[0]
3802
basis_tree = tree.revision_tree(tree.last_revision())
3803
except errors.NoSuchRevision:
3804
basis_tree = tree.basis_tree()
3806
# die as quickly as possible if there are uncommitted changes
3808
if tree.has_changes():
3809
raise errors.UncommittedChanges(tree)
3811
view_info = _get_view_info_for_change_reporter(tree)
3812
change_reporter = delta._ChangeReporter(
3813
unversioned_filter=tree.is_ignored, view_info=view_info)
3814
pb = ui.ui_factory.nested_progress_bar()
3815
self.add_cleanup(pb.finished)
3817
self.add_cleanup(tree.unlock)
3818
if location is not None:
3820
mergeable = bundle.read_mergeable_from_url(location,
3821
possible_transports=possible_transports)
3822
except errors.NotABundle:
3826
raise errors.BzrCommandError('Cannot use --uncommitted'
3827
' with bundles or merge directives.')
3829
if revision is not None:
3830
raise errors.BzrCommandError(
3831
'Cannot use -r with merge directives or bundles')
3832
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3835
if merger is None and uncommitted:
3836
if revision is not None and len(revision) > 0:
3837
raise errors.BzrCommandError('Cannot use --uncommitted and'
3838
' --revision at the same time.')
3839
merger = self.get_merger_from_uncommitted(tree, location, None)
3840
allow_pending = False
3843
merger, allow_pending = self._get_merger_from_branch(tree,
3844
location, revision, remember, possible_transports, None)
3846
merger.merge_type = merge_type
3847
merger.reprocess = reprocess
3848
merger.show_base = show_base
3849
self.sanity_check_merger(merger)
3850
if (merger.base_rev_id == merger.other_rev_id and
3851
merger.other_rev_id is not None):
3852
note('Nothing to do.')
3855
if merger.interesting_files is not None:
3856
raise errors.BzrCommandError('Cannot pull individual files')
3857
if (merger.base_rev_id == tree.last_revision()):
3858
result = tree.pull(merger.other_branch, False,
3859
merger.other_rev_id)
3860
result.report(self.outf)
3862
if merger.this_basis is None:
3863
raise errors.BzrCommandError(
3864
"This branch has no commits."
3865
" (perhaps you would prefer 'bzr pull')")
3867
return self._do_preview(merger)
3869
return self._do_interactive(merger)
3871
return self._do_merge(merger, change_reporter, allow_pending,
3874
def _get_preview(self, merger):
3875
tree_merger = merger.make_merger()
3876
tt = tree_merger.make_preview_transform()
3877
self.add_cleanup(tt.finalize)
3878
result_tree = tt.get_preview_tree()
3881
def _do_preview(self, merger):
3882
from bzrlib.diff import show_diff_trees
3883
result_tree = self._get_preview(merger)
3884
show_diff_trees(merger.this_tree, result_tree, self.outf,
3885
old_label='', new_label='')
3887
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3888
merger.change_reporter = change_reporter
3889
conflict_count = merger.do_merge()
3891
merger.set_pending()
3892
if verified == 'failed':
3893
warning('Preview patch does not match changes')
3894
if conflict_count != 0:
3899
def _do_interactive(self, merger):
3900
"""Perform an interactive merge.
3902
This works by generating a preview tree of the merge, then using
3903
Shelver to selectively remove the differences between the working tree
3904
and the preview tree.
3906
from bzrlib import shelf_ui
3907
result_tree = self._get_preview(merger)
3908
writer = bzrlib.option.diff_writer_registry.get()
3909
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3910
reporter=shelf_ui.ApplyReporter(),
3911
diff_writer=writer(sys.stdout))
3917
def sanity_check_merger(self, merger):
3918
if (merger.show_base and
3919
not merger.merge_type is _mod_merge.Merge3Merger):
3920
raise errors.BzrCommandError("Show-base is not supported for this"
3921
" merge type. %s" % merger.merge_type)
3922
if merger.reprocess is None:
3923
if merger.show_base:
3924
merger.reprocess = False
3926
# Use reprocess if the merger supports it
3927
merger.reprocess = merger.merge_type.supports_reprocess
3928
if merger.reprocess and not merger.merge_type.supports_reprocess:
3929
raise errors.BzrCommandError("Conflict reduction is not supported"
3930
" for merge type %s." %
3932
if merger.reprocess and merger.show_base:
3933
raise errors.BzrCommandError("Cannot do conflict reduction and"
3936
def _get_merger_from_branch(self, tree, location, revision, remember,
3937
possible_transports, pb):
3938
"""Produce a merger from a location, assuming it refers to a branch."""
3939
from bzrlib.tag import _merge_tags_if_possible
3940
# find the branch locations
3941
other_loc, user_location = self._select_branch_location(tree, location,
3943
if revision is not None and len(revision) == 2:
3944
base_loc, _unused = self._select_branch_location(tree,
3945
location, revision, 0)
3947
base_loc = other_loc
3949
other_branch, other_path = Branch.open_containing(other_loc,
3950
possible_transports)
3951
if base_loc == other_loc:
3952
base_branch = other_branch
3954
base_branch, base_path = Branch.open_containing(base_loc,
3955
possible_transports)
3956
# Find the revision ids
3957
other_revision_id = None
3958
base_revision_id = None
3959
if revision is not None:
3960
if len(revision) >= 1:
3961
other_revision_id = revision[-1].as_revision_id(other_branch)
3962
if len(revision) == 2:
3963
base_revision_id = revision[0].as_revision_id(base_branch)
3964
if other_revision_id is None:
3965
other_revision_id = _mod_revision.ensure_null(
3966
other_branch.last_revision())
3967
# Remember where we merge from
3968
if ((remember or tree.branch.get_submit_branch() is None) and
3969
user_location is not None):
3970
tree.branch.set_submit_branch(other_branch.base)
3971
_merge_tags_if_possible(other_branch, tree.branch)
3972
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3973
other_revision_id, base_revision_id, other_branch, base_branch)
3974
if other_path != '':
3975
allow_pending = False
3976
merger.interesting_files = [other_path]
3978
allow_pending = True
3979
return merger, allow_pending
3981
def get_merger_from_uncommitted(self, tree, location, pb):
3982
"""Get a merger for uncommitted changes.
3984
:param tree: The tree the merger should apply to.
3985
:param location: The location containing uncommitted changes.
3986
:param pb: The progress bar to use for showing progress.
3988
location = self._select_branch_location(tree, location)[0]
3989
other_tree, other_path = WorkingTree.open_containing(location)
3990
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3991
if other_path != '':
3992
merger.interesting_files = [other_path]
3995
def _select_branch_location(self, tree, user_location, revision=None,
3997
"""Select a branch location, according to possible inputs.
3999
If provided, branches from ``revision`` are preferred. (Both
4000
``revision`` and ``index`` must be supplied.)
4002
Otherwise, the ``location`` parameter is used. If it is None, then the
4003
``submit`` or ``parent`` location is used, and a note is printed.
4005
:param tree: The working tree to select a branch for merging into
4006
:param location: The location entered by the user
4007
:param revision: The revision parameter to the command
4008
:param index: The index to use for the revision parameter. Negative
4009
indices are permitted.
4010
:return: (selected_location, user_location). The default location
4011
will be the user-entered location.
4013
if (revision is not None and index is not None
4014
and revision[index] is not None):
4015
branch = revision[index].get_branch()
4016
if branch is not None:
4017
return branch, branch
4018
if user_location is None:
4019
location = self._get_remembered(tree, 'Merging from')
4021
location = user_location
4022
return location, user_location
4024
def _get_remembered(self, tree, verb_string):
4025
"""Use tree.branch's parent if none was supplied.
4027
Report if the remembered location was used.
4029
stored_location = tree.branch.get_submit_branch()
4030
stored_location_type = "submit"
4031
if stored_location is None:
4032
stored_location = tree.branch.get_parent()
4033
stored_location_type = "parent"
4034
mutter("%s", stored_location)
4035
if stored_location is None:
4036
raise errors.BzrCommandError("No location specified or remembered")
4037
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4038
note(u"%s remembered %s location %s", verb_string,
4039
stored_location_type, display_url)
4040
return stored_location
4043
class cmd_remerge(Command):
4046
Use this if you want to try a different merge technique while resolving
4047
conflicts. Some merge techniques are better than others, and remerge
4048
lets you try different ones on different files.
4050
The options for remerge have the same meaning and defaults as the ones for
4051
merge. The difference is that remerge can (only) be run when there is a
4052
pending merge, and it lets you specify particular files.
4055
Re-do the merge of all conflicted files, and show the base text in
4056
conflict regions, in addition to the usual THIS and OTHER texts::
4058
bzr remerge --show-base
4060
Re-do the merge of "foobar", using the weave merge algorithm, with
4061
additional processing to reduce the size of conflict regions::
4063
bzr remerge --merge-type weave --reprocess foobar
4065
takes_args = ['file*']
4070
help="Show base revision text in conflicts."),
4073
def run(self, file_list=None, merge_type=None, show_base=False,
4075
from bzrlib.conflicts import restore
4076
if merge_type is None:
4077
merge_type = _mod_merge.Merge3Merger
4078
tree, file_list = tree_files(file_list)
4080
self.add_cleanup(tree.unlock)
4081
parents = tree.get_parent_ids()
4082
if len(parents) != 2:
4083
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4084
" merges. Not cherrypicking or"
4086
repository = tree.branch.repository
4087
interesting_ids = None
4089
conflicts = tree.conflicts()
4090
if file_list is not None:
4091
interesting_ids = set()
4092
for filename in file_list:
4093
file_id = tree.path2id(filename)
4095
raise errors.NotVersionedError(filename)
4096
interesting_ids.add(file_id)
4097
if tree.kind(file_id) != "directory":
4100
for name, ie in tree.inventory.iter_entries(file_id):
4101
interesting_ids.add(ie.file_id)
4102
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4104
# Remerge only supports resolving contents conflicts
4105
allowed_conflicts = ('text conflict', 'contents conflict')
4106
restore_files = [c.path for c in conflicts
4107
if c.typestring in allowed_conflicts]
4108
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4109
tree.set_conflicts(ConflictList(new_conflicts))
4110
if file_list is not None:
4111
restore_files = file_list
4112
for filename in restore_files:
4114
restore(tree.abspath(filename))
4115
except errors.NotConflicted:
4117
# Disable pending merges, because the file texts we are remerging
4118
# have not had those merges performed. If we use the wrong parents
4119
# list, we imply that the working tree text has seen and rejected
4120
# all the changes from the other tree, when in fact those changes
4121
# have not yet been seen.
4122
tree.set_parent_ids(parents[:1])
4124
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4125
merger.interesting_ids = interesting_ids
4126
merger.merge_type = merge_type
4127
merger.show_base = show_base
4128
merger.reprocess = reprocess
4129
conflicts = merger.do_merge()
4131
tree.set_parent_ids(parents)
4138
class cmd_revert(Command):
4139
"""Revert files to a previous revision.
4141
Giving a list of files will revert only those files. Otherwise, all files
4142
will be reverted. If the revision is not specified with '--revision', the
4143
last committed revision is used.
4145
To remove only some changes, without reverting to a prior version, use
4146
merge instead. For example, "merge . --revision -2..-3" will remove the
4147
changes introduced by -2, without affecting the changes introduced by -1.
4148
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4150
By default, any files that have been manually changed will be backed up
4151
first. (Files changed only by merge are not backed up.) Backup files have
4152
'.~#~' appended to their name, where # is a number.
4154
When you provide files, you can use their current pathname or the pathname
4155
from the target revision. So you can use revert to "undelete" a file by
4156
name. If you name a directory, all the contents of that directory will be
4159
If you have newly added files since the target revision, they will be
4160
removed. If the files to be removed have been changed, backups will be
4161
created as above. Directories containing unknown files will not be
4164
The working tree contains a list of revisions that have been merged but
4165
not yet committed. These revisions will be included as additional parents
4166
of the next commit. Normally, using revert clears that list as well as
4167
reverting the files. If any files are specified, revert leaves the list
4168
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4169
.`` in the tree root to revert all files but keep the recorded merges,
4170
and ``bzr revert --forget-merges`` to clear the pending merge list without
4171
reverting any files.
4173
Using "bzr revert --forget-merges", it is possible to apply all of the
4174
changes from a branch in a single revision. To do this, perform the merge
4175
as desired. Then doing revert with the "--forget-merges" option will keep
4176
the content of the tree as it was, but it will clear the list of pending
4177
merges. The next commit will then contain all of the changes that are
4178
present in the other branch, but without any other parent revisions.
4179
Because this technique forgets where these changes originated, it may
4180
cause additional conflicts on later merges involving the same source and
4184
_see_also = ['cat', 'export']
4187
Option('no-backup', "Do not save backups of reverted files."),
4188
Option('forget-merges',
4189
'Remove pending merge marker, without changing any files.'),
4191
takes_args = ['file*']
4193
def run(self, revision=None, no_backup=False, file_list=None,
4194
forget_merges=None):
4195
tree, file_list = tree_files(file_list)
4197
self.add_cleanup(tree.unlock)
4199
tree.set_parent_ids(tree.get_parent_ids()[:1])
4201
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4204
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4205
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4206
tree.revert(file_list, rev_tree, not no_backup, None,
4207
report_changes=True)
4210
class cmd_assert_fail(Command):
4211
"""Test reporting of assertion failures"""
4212
# intended just for use in testing
4217
raise AssertionError("always fails")
4220
class cmd_help(Command):
4221
"""Show help on a command or other topic.
4224
_see_also = ['topics']
4226
Option('long', 'Show help on all commands.'),
4228
takes_args = ['topic?']
4229
aliases = ['?', '--help', '-?', '-h']
4232
def run(self, topic=None, long=False):
4234
if topic is None and long:
4236
bzrlib.help.help(topic)
4239
class cmd_shell_complete(Command):
4240
"""Show appropriate completions for context.
4242
For a list of all available commands, say 'bzr shell-complete'.
4244
takes_args = ['context?']
4249
def run(self, context=None):
4250
import shellcomplete
4251
shellcomplete.shellcomplete(context)
4254
class cmd_missing(Command):
4255
"""Show unmerged/unpulled revisions between two branches.
4257
OTHER_BRANCH may be local or remote.
4259
To filter on a range of revisions, you can use the command -r begin..end
4260
-r revision requests a specific revision, -r ..end or -r begin.. are
4264
1 - some missing revisions
4265
0 - no missing revisions
4269
Determine the missing revisions between this and the branch at the
4270
remembered pull location::
4274
Determine the missing revisions between this and another branch::
4276
bzr missing http://server/branch
4278
Determine the missing revisions up to a specific revision on the other
4281
bzr missing -r ..-10
4283
Determine the missing revisions up to a specific revision on this
4286
bzr missing --my-revision ..-10
4289
_see_also = ['merge', 'pull']
4290
takes_args = ['other_branch?']
4292
Option('reverse', 'Reverse the order of revisions.'),
4294
'Display changes in the local branch only.'),
4295
Option('this' , 'Same as --mine-only.'),
4296
Option('theirs-only',
4297
'Display changes in the remote branch only.'),
4298
Option('other', 'Same as --theirs-only.'),
4302
custom_help('revision',
4303
help='Filter on other branch revisions (inclusive). '
4304
'See "help revisionspec" for details.'),
4305
Option('my-revision',
4306
type=_parse_revision_str,
4307
help='Filter on local branch revisions (inclusive). '
4308
'See "help revisionspec" for details.'),
4309
Option('include-merges',
4310
'Show all revisions in addition to the mainline ones.'),
4312
encoding_type = 'replace'
4315
def run(self, other_branch=None, reverse=False, mine_only=False,
4317
log_format=None, long=False, short=False, line=False,
4318
show_ids=False, verbose=False, this=False, other=False,
4319
include_merges=False, revision=None, my_revision=None):
4320
from bzrlib.missing import find_unmerged, iter_log_revisions
4329
# TODO: We should probably check that we don't have mine-only and
4330
# theirs-only set, but it gets complicated because we also have
4331
# this and other which could be used.
4338
local_branch = Branch.open_containing(u".")[0]
4339
local_branch.lock_read()
4340
self.add_cleanup(local_branch.unlock)
4342
parent = local_branch.get_parent()
4343
if other_branch is None:
4344
other_branch = parent
4345
if other_branch is None:
4346
raise errors.BzrCommandError("No peer location known"
4348
display_url = urlutils.unescape_for_display(parent,
4350
message("Using saved parent location: "
4351
+ display_url + "\n")
4353
remote_branch = Branch.open(other_branch)
4354
if remote_branch.base == local_branch.base:
4355
remote_branch = local_branch
4357
remote_branch.lock_read()
4358
self.add_cleanup(remote_branch.unlock)
4360
local_revid_range = _revision_range_to_revid_range(
4361
_get_revision_range(my_revision, local_branch,
4364
remote_revid_range = _revision_range_to_revid_range(
4365
_get_revision_range(revision,
4366
remote_branch, self.name()))
4368
local_extra, remote_extra = find_unmerged(
4369
local_branch, remote_branch, restrict,
4370
backward=not reverse,
4371
include_merges=include_merges,
4372
local_revid_range=local_revid_range,
4373
remote_revid_range=remote_revid_range)
4375
if log_format is None:
4376
registry = log.log_formatter_registry
4377
log_format = registry.get_default(local_branch)
4378
lf = log_format(to_file=self.outf,
4380
show_timezone='original')
4383
if local_extra and not theirs_only:
4384
message("You have %d extra revision(s):\n" %
4386
for revision in iter_log_revisions(local_extra,
4387
local_branch.repository,
4389
lf.log_revision(revision)
4390
printed_local = True
4393
printed_local = False
4395
if remote_extra and not mine_only:
4396
if printed_local is True:
4398
message("You are missing %d revision(s):\n" %
4400
for revision in iter_log_revisions(remote_extra,
4401
remote_branch.repository,
4403
lf.log_revision(revision)
4406
if mine_only and not local_extra:
4407
# We checked local, and found nothing extra
4408
message('This branch is up to date.\n')
4409
elif theirs_only and not remote_extra:
4410
# We checked remote, and found nothing extra
4411
message('Other branch is up to date.\n')
4412
elif not (mine_only or theirs_only or local_extra or
4414
# We checked both branches, and neither one had extra
4416
message("Branches are up to date.\n")
4418
if not status_code and parent is None and other_branch is not None:
4419
local_branch.lock_write()
4420
self.add_cleanup(local_branch.unlock)
4421
# handle race conditions - a parent might be set while we run.
4422
if local_branch.get_parent() is None:
4423
local_branch.set_parent(remote_branch.base)
4427
class cmd_pack(Command):
4428
"""Compress the data within a repository."""
4430
_see_also = ['repositories']
4431
takes_args = ['branch_or_repo?']
4433
def run(self, branch_or_repo='.'):
4434
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4436
branch = dir.open_branch()
4437
repository = branch.repository
4438
except errors.NotBranchError:
4439
repository = dir.open_repository()
4443
class cmd_plugins(Command):
4444
"""List the installed plugins.
4446
This command displays the list of installed plugins including
4447
version of plugin and a short description of each.
4449
--verbose shows the path where each plugin is located.
4451
A plugin is an external component for Bazaar that extends the
4452
revision control system, by adding or replacing code in Bazaar.
4453
Plugins can do a variety of things, including overriding commands,
4454
adding new commands, providing additional network transports and
4455
customizing log output.
4457
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4458
for further information on plugins including where to find them and how to
4459
install them. Instructions are also provided there on how to write new
4460
plugins using the Python programming language.
4462
takes_options = ['verbose']
4465
def run(self, verbose=False):
4466
import bzrlib.plugin
4467
from inspect import getdoc
4469
for name, plugin in bzrlib.plugin.plugins().items():
4470
version = plugin.__version__
4471
if version == 'unknown':
4473
name_ver = '%s %s' % (name, version)
4474
d = getdoc(plugin.module)
4476
doc = d.split('\n')[0]
4478
doc = '(no description)'
4479
result.append((name_ver, doc, plugin.path()))
4480
for name_ver, doc, path in sorted(result):
4481
self.outf.write("%s\n" % name_ver)
4482
self.outf.write(" %s\n" % doc)
4484
self.outf.write(" %s\n" % path)
4485
self.outf.write("\n")
4488
class cmd_testament(Command):
4489
"""Show testament (signing-form) of a revision."""
4492
Option('long', help='Produce long-format testament.'),
4494
help='Produce a strict-format testament.')]
4495
takes_args = ['branch?']
4497
def run(self, branch=u'.', revision=None, long=False, strict=False):
4498
from bzrlib.testament import Testament, StrictTestament
4500
testament_class = StrictTestament
4502
testament_class = Testament
4504
b = Branch.open_containing(branch)[0]
4506
b = Branch.open(branch)
4508
self.add_cleanup(b.unlock)
4509
if revision is None:
4510
rev_id = b.last_revision()
4512
rev_id = revision[0].as_revision_id(b)
4513
t = testament_class.from_revision(b.repository, rev_id)
4515
sys.stdout.writelines(t.as_text_lines())
4517
sys.stdout.write(t.as_short_text())
4520
class cmd_annotate(Command):
4521
"""Show the origin of each line in a file.
4523
This prints out the given file with an annotation on the left side
4524
indicating which revision, author and date introduced the change.
4526
If the origin is the same for a run of consecutive lines, it is
4527
shown only at the top, unless the --all option is given.
4529
# TODO: annotate directories; showing when each file was last changed
4530
# TODO: if the working copy is modified, show annotations on that
4531
# with new uncommitted lines marked
4532
aliases = ['ann', 'blame', 'praise']
4533
takes_args = ['filename']
4534
takes_options = [Option('all', help='Show annotations on all lines.'),
4535
Option('long', help='Show commit date in annotations.'),
4539
encoding_type = 'exact'
4542
def run(self, filename, all=False, long=False, revision=None,
4544
from bzrlib.annotate import annotate_file, annotate_file_tree
4545
wt, branch, relpath = \
4546
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4549
self.add_cleanup(wt.unlock)
4552
self.add_cleanup(branch.unlock)
4553
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4555
self.add_cleanup(tree.unlock)
4557
file_id = wt.path2id(relpath)
4559
file_id = tree.path2id(relpath)
4561
raise errors.NotVersionedError(filename)
4562
file_version = tree.inventory[file_id].revision
4563
if wt is not None and revision is None:
4564
# If there is a tree and we're not annotating historical
4565
# versions, annotate the working tree's content.
4566
annotate_file_tree(wt, file_id, self.outf, long, all,
4569
annotate_file(branch, file_version, file_id, long, all, self.outf,
4573
class cmd_re_sign(Command):
4574
"""Create a digital signature for an existing revision."""
4575
# TODO be able to replace existing ones.
4577
hidden = True # is this right ?
4578
takes_args = ['revision_id*']
4579
takes_options = ['revision']
4581
def run(self, revision_id_list=None, revision=None):
4582
if revision_id_list is not None and revision is not None:
4583
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4584
if revision_id_list is None and revision is None:
4585
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4586
b = WorkingTree.open_containing(u'.')[0].branch
4588
self.add_cleanup(b.unlock)
4589
return self._run(b, revision_id_list, revision)
4591
def _run(self, b, revision_id_list, revision):
4592
import bzrlib.gpg as gpg
4593
gpg_strategy = gpg.GPGStrategy(b.get_config())
4594
if revision_id_list is not None:
4595
b.repository.start_write_group()
4597
for revision_id in revision_id_list:
4598
b.repository.sign_revision(revision_id, gpg_strategy)
4600
b.repository.abort_write_group()
4603
b.repository.commit_write_group()
4604
elif revision is not None:
4605
if len(revision) == 1:
4606
revno, rev_id = revision[0].in_history(b)
4607
b.repository.start_write_group()
4609
b.repository.sign_revision(rev_id, gpg_strategy)
4611
b.repository.abort_write_group()
4614
b.repository.commit_write_group()
4615
elif len(revision) == 2:
4616
# are they both on rh- if so we can walk between them
4617
# might be nice to have a range helper for arbitrary
4618
# revision paths. hmm.
4619
from_revno, from_revid = revision[0].in_history(b)
4620
to_revno, to_revid = revision[1].in_history(b)
4621
if to_revid is None:
4622
to_revno = b.revno()
4623
if from_revno is None or to_revno is None:
4624
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4625
b.repository.start_write_group()
4627
for revno in range(from_revno, to_revno + 1):
4628
b.repository.sign_revision(b.get_rev_id(revno),
4631
b.repository.abort_write_group()
4634
b.repository.commit_write_group()
4636
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4639
class cmd_bind(Command):
4640
"""Convert the current branch into a checkout of the supplied branch.
4642
Once converted into a checkout, commits must succeed on the master branch
4643
before they will be applied to the local branch.
4645
Bound branches use the nickname of its master branch unless it is set
4646
locally, in which case binding will update the local nickname to be
4650
_see_also = ['checkouts', 'unbind']
4651
takes_args = ['location?']
4654
def run(self, location=None):
4655
b, relpath = Branch.open_containing(u'.')
4656
if location is None:
4658
location = b.get_old_bound_location()
4659
except errors.UpgradeRequired:
4660
raise errors.BzrCommandError('No location supplied. '
4661
'This format does not remember old locations.')
4663
if location is None:
4664
if b.get_bound_location() is not None:
4665
raise errors.BzrCommandError('Branch is already bound')
4667
raise errors.BzrCommandError('No location supplied '
4668
'and no previous location known')
4669
b_other = Branch.open(location)
4672
except errors.DivergedBranches:
4673
raise errors.BzrCommandError('These branches have diverged.'
4674
' Try merging, and then bind again.')
4675
if b.get_config().has_explicit_nickname():
4676
b.nick = b_other.nick
4679
class cmd_unbind(Command):
4680
"""Convert the current checkout into a regular branch.
4682
After unbinding, the local branch is considered independent and subsequent
4683
commits will be local only.
4686
_see_also = ['checkouts', 'bind']
4691
b, relpath = Branch.open_containing(u'.')
4693
raise errors.BzrCommandError('Local branch is not bound')
4696
class cmd_uncommit(Command):
4697
"""Remove the last committed revision.
4699
--verbose will print out what is being removed.
4700
--dry-run will go through all the motions, but not actually
4703
If --revision is specified, uncommit revisions to leave the branch at the
4704
specified revision. For example, "bzr uncommit -r 15" will leave the
4705
branch at revision 15.
4707
Uncommit leaves the working tree ready for a new commit. The only change
4708
it may make is to restore any pending merges that were present before
4712
# TODO: jam 20060108 Add an option to allow uncommit to remove
4713
# unreferenced information in 'branch-as-repository' branches.
4714
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4715
# information in shared branches as well.
4716
_see_also = ['commit']
4717
takes_options = ['verbose', 'revision',
4718
Option('dry-run', help='Don\'t actually make changes.'),
4719
Option('force', help='Say yes to all questions.'),
4721
help="Only remove the commits from the local branch"
4722
" when in a checkout."
4725
takes_args = ['location?']
4727
encoding_type = 'replace'
4729
def run(self, location=None,
4730
dry_run=False, verbose=False,
4731
revision=None, force=False, local=False):
4732
if location is None:
4734
control, relpath = bzrdir.BzrDir.open_containing(location)
4736
tree = control.open_workingtree()
4738
except (errors.NoWorkingTree, errors.NotLocalUrl):
4740
b = control.open_branch()
4742
if tree is not None:
4744
self.add_cleanup(tree.unlock)
4747
self.add_cleanup(b.unlock)
4748
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4750
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4751
from bzrlib.log import log_formatter, show_log
4752
from bzrlib.uncommit import uncommit
4754
last_revno, last_rev_id = b.last_revision_info()
4757
if revision is None:
4759
rev_id = last_rev_id
4761
# 'bzr uncommit -r 10' actually means uncommit
4762
# so that the final tree is at revno 10.
4763
# but bzrlib.uncommit.uncommit() actually uncommits
4764
# the revisions that are supplied.
4765
# So we need to offset it by one
4766
revno = revision[0].in_history(b).revno + 1
4767
if revno <= last_revno:
4768
rev_id = b.get_rev_id(revno)
4770
if rev_id is None or _mod_revision.is_null(rev_id):
4771
self.outf.write('No revisions to uncommit.\n')
4774
lf = log_formatter('short',
4776
show_timezone='original')
4781
direction='forward',
4782
start_revision=revno,
4783
end_revision=last_revno)
4786
self.outf.write('Dry-run, pretending to remove'
4787
' the above revisions.\n')
4789
self.outf.write('The above revision(s) will be removed.\n')
4792
if not ui.ui_factory.get_boolean('Are you sure'):
4793
self.outf.write('Canceled')
4796
mutter('Uncommitting from {%s} to {%s}',
4797
last_rev_id, rev_id)
4798
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4799
revno=revno, local=local)
4800
self.outf.write('You can restore the old tip by running:\n'
4801
' bzr pull . -r revid:%s\n' % last_rev_id)
4804
class cmd_break_lock(Command):
4805
"""Break a dead lock on a repository, branch or working directory.
4807
CAUTION: Locks should only be broken when you are sure that the process
4808
holding the lock has been stopped.
4810
You can get information on what locks are open via the 'bzr info
4811
[location]' command.
4815
bzr break-lock bzr+ssh://example.com/bzr/foo
4817
takes_args = ['location?']
4819
def run(self, location=None, show=False):
4820
if location is None:
4822
control, relpath = bzrdir.BzrDir.open_containing(location)
4824
control.break_lock()
4825
except NotImplementedError:
4829
class cmd_wait_until_signalled(Command):
4830
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4832
This just prints a line to signal when it is ready, then blocks on stdin.
4838
sys.stdout.write("running\n")
4840
sys.stdin.readline()
4843
class cmd_serve(Command):
4844
"""Run the bzr server."""
4846
aliases = ['server']
4850
help='Serve on stdin/out for use from inetd or sshd.'),
4851
RegistryOption('protocol',
4852
help="Protocol to serve.",
4853
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4854
value_switches=True),
4856
help='Listen for connections on nominated port of the form '
4857
'[hostname:]portnumber. Passing 0 as the port number will '
4858
'result in a dynamically allocated port. The default port '
4859
'depends on the protocol.',
4862
help='Serve contents of this directory.',
4864
Option('allow-writes',
4865
help='By default the server is a readonly server. Supplying '
4866
'--allow-writes enables write access to the contents of '
4867
'the served directory and below. Note that ``bzr serve`` '
4868
'does not perform authentication, so unless some form of '
4869
'external authentication is arranged supplying this '
4870
'option leads to global uncontrolled write access to your '
4875
def get_host_and_port(self, port):
4876
"""Return the host and port to run the smart server on.
4878
If 'port' is None, None will be returned for the host and port.
4880
If 'port' has a colon in it, the string before the colon will be
4881
interpreted as the host.
4883
:param port: A string of the port to run the server on.
4884
:return: A tuple of (host, port), where 'host' is a host name or IP,
4885
and port is an integer TCP/IP port.
4888
if port is not None:
4890
host, port = port.split(':')
4894
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4896
from bzrlib.transport import get_transport, transport_server_registry
4897
if directory is None:
4898
directory = os.getcwd()
4899
if protocol is None:
4900
protocol = transport_server_registry.get()
4901
host, port = self.get_host_and_port(port)
4902
url = urlutils.local_path_to_url(directory)
4903
if not allow_writes:
4904
url = 'readonly+' + url
4905
transport = get_transport(url)
4906
protocol(transport, host, port, inet)
4909
class cmd_join(Command):
4910
"""Combine a tree into its containing tree.
4912
This command requires the target tree to be in a rich-root format.
4914
The TREE argument should be an independent tree, inside another tree, but
4915
not part of it. (Such trees can be produced by "bzr split", but also by
4916
running "bzr branch" with the target inside a tree.)
4918
The result is a combined tree, with the subtree no longer an independant
4919
part. This is marked as a merge of the subtree into the containing tree,
4920
and all history is preserved.
4923
_see_also = ['split']
4924
takes_args = ['tree']
4926
Option('reference', help='Join by reference.', hidden=True),
4929
def run(self, tree, reference=False):
4930
sub_tree = WorkingTree.open(tree)
4931
parent_dir = osutils.dirname(sub_tree.basedir)
4932
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4933
repo = containing_tree.branch.repository
4934
if not repo.supports_rich_root():
4935
raise errors.BzrCommandError(
4936
"Can't join trees because %s doesn't support rich root data.\n"
4937
"You can use bzr upgrade on the repository."
4941
containing_tree.add_reference(sub_tree)
4942
except errors.BadReferenceTarget, e:
4943
# XXX: Would be better to just raise a nicely printable
4944
# exception from the real origin. Also below. mbp 20070306
4945
raise errors.BzrCommandError("Cannot join %s. %s" %
4949
containing_tree.subsume(sub_tree)
4950
except errors.BadSubsumeSource, e:
4951
raise errors.BzrCommandError("Cannot join %s. %s" %
4955
class cmd_split(Command):
4956
"""Split a subdirectory of a tree into a separate tree.
4958
This command will produce a target tree in a format that supports
4959
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4960
converted into earlier formats like 'dirstate-tags'.
4962
The TREE argument should be a subdirectory of a working tree. That
4963
subdirectory will be converted into an independent tree, with its own
4964
branch. Commits in the top-level tree will not apply to the new subtree.
4967
_see_also = ['join']
4968
takes_args = ['tree']
4970
def run(self, tree):
4971
containing_tree, subdir = WorkingTree.open_containing(tree)
4972
sub_id = containing_tree.path2id(subdir)
4974
raise errors.NotVersionedError(subdir)
4976
containing_tree.extract(sub_id)
4977
except errors.RootNotRich:
4978
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4981
class cmd_merge_directive(Command):
4982
"""Generate a merge directive for auto-merge tools.
4984
A directive requests a merge to be performed, and also provides all the
4985
information necessary to do so. This means it must either include a
4986
revision bundle, or the location of a branch containing the desired
4989
A submit branch (the location to merge into) must be supplied the first
4990
time the command is issued. After it has been supplied once, it will
4991
be remembered as the default.
4993
A public branch is optional if a revision bundle is supplied, but required
4994
if --diff or --plain is specified. It will be remembered as the default
4995
after the first use.
4998
takes_args = ['submit_branch?', 'public_branch?']
5002
_see_also = ['send']
5005
RegistryOption.from_kwargs('patch-type',
5006
'The type of patch to include in the directive.',
5008
value_switches=True,
5010
bundle='Bazaar revision bundle (default).',
5011
diff='Normal unified diff.',
5012
plain='No patch, just directive.'),
5013
Option('sign', help='GPG-sign the directive.'), 'revision',
5014
Option('mail-to', type=str,
5015
help='Instead of printing the directive, email to this address.'),
5016
Option('message', type=str, short_name='m',
5017
help='Message to use when committing this merge.')
5020
encoding_type = 'exact'
5022
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5023
sign=False, revision=None, mail_to=None, message=None):
5024
from bzrlib.revision import ensure_null, NULL_REVISION
5025
include_patch, include_bundle = {
5026
'plain': (False, False),
5027
'diff': (True, False),
5028
'bundle': (True, True),
5030
branch = Branch.open('.')
5031
stored_submit_branch = branch.get_submit_branch()
5032
if submit_branch is None:
5033
submit_branch = stored_submit_branch
5035
if stored_submit_branch is None:
5036
branch.set_submit_branch(submit_branch)
5037
if submit_branch is None:
5038
submit_branch = branch.get_parent()
5039
if submit_branch is None:
5040
raise errors.BzrCommandError('No submit branch specified or known')
5042
stored_public_branch = branch.get_public_branch()
5043
if public_branch is None:
5044
public_branch = stored_public_branch
5045
elif stored_public_branch is None:
5046
branch.set_public_branch(public_branch)
5047
if not include_bundle and public_branch is None:
5048
raise errors.BzrCommandError('No public branch specified or'
5050
base_revision_id = None
5051
if revision is not None:
5052
if len(revision) > 2:
5053
raise errors.BzrCommandError('bzr merge-directive takes '
5054
'at most two one revision identifiers')
5055
revision_id = revision[-1].as_revision_id(branch)
5056
if len(revision) == 2:
5057
base_revision_id = revision[0].as_revision_id(branch)
5059
revision_id = branch.last_revision()
5060
revision_id = ensure_null(revision_id)
5061
if revision_id == NULL_REVISION:
5062
raise errors.BzrCommandError('No revisions to bundle.')
5063
directive = merge_directive.MergeDirective2.from_objects(
5064
branch.repository, revision_id, time.time(),
5065
osutils.local_time_offset(), submit_branch,
5066
public_branch=public_branch, include_patch=include_patch,
5067
include_bundle=include_bundle, message=message,
5068
base_revision_id=base_revision_id)
5071
self.outf.write(directive.to_signed(branch))
5073
self.outf.writelines(directive.to_lines())
5075
message = directive.to_email(mail_to, branch, sign)
5076
s = SMTPConnection(branch.get_config())
5077
s.send_email(message)
5080
class cmd_send(Command):
5081
"""Mail or create a merge-directive for submitting changes.
5083
A merge directive provides many things needed for requesting merges:
5085
* A machine-readable description of the merge to perform
5087
* An optional patch that is a preview of the changes requested
5089
* An optional bundle of revision data, so that the changes can be applied
5090
directly from the merge directive, without retrieving data from a
5093
`bzr send` creates a compact data set that, when applied using bzr
5094
merge, has the same effect as merging from the source branch.
5096
By default the merge directive is self-contained and can be applied to any
5097
branch containing submit_branch in its ancestory without needing access to
5100
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5101
revisions, but only a structured request to merge from the
5102
public_location. In that case the public_branch is needed and it must be
5103
up-to-date and accessible to the recipient. The public_branch is always
5104
included if known, so that people can check it later.
5106
The submit branch defaults to the parent of the source branch, but can be
5107
overridden. Both submit branch and public branch will be remembered in
5108
branch.conf the first time they are used for a particular branch. The
5109
source branch defaults to that containing the working directory, but can
5110
be changed using --from.
5112
In order to calculate those changes, bzr must analyse the submit branch.
5113
Therefore it is most efficient for the submit branch to be a local mirror.
5114
If a public location is known for the submit_branch, that location is used
5115
in the merge directive.
5117
The default behaviour is to send the merge directive by mail, unless -o is
5118
given, in which case it is sent to a file.
5120
Mail is sent using your preferred mail program. This should be transparent
5121
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5122
If the preferred client can't be found (or used), your editor will be used.
5124
To use a specific mail program, set the mail_client configuration option.
5125
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5126
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5127
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5128
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5131
If mail is being sent, a to address is required. This can be supplied
5132
either on the commandline, by setting the submit_to configuration
5133
option in the branch itself or the child_submit_to configuration option
5134
in the submit branch.
5136
Two formats are currently supported: "4" uses revision bundle format 4 and
5137
merge directive format 2. It is significantly faster and smaller than
5138
older formats. It is compatible with Bazaar 0.19 and later. It is the
5139
default. "0.9" uses revision bundle format 0.9 and merge directive
5140
format 1. It is compatible with Bazaar 0.12 - 0.18.
5142
The merge directives created by bzr send may be applied using bzr merge or
5143
bzr pull by specifying a file containing a merge directive as the location.
5145
bzr send makes extensive use of public locations to map local locations into
5146
URLs that can be used by other people. See `bzr help configuration` to
5147
set them, and use `bzr info` to display them.
5150
encoding_type = 'exact'
5152
_see_also = ['merge', 'pull']
5154
takes_args = ['submit_branch?', 'public_branch?']
5158
help='Do not include a bundle in the merge directive.'),
5159
Option('no-patch', help='Do not include a preview patch in the merge'
5162
help='Remember submit and public branch.'),
5164
help='Branch to generate the submission from, '
5165
'rather than the one containing the working directory.',
5168
Option('output', short_name='o',
5169
help='Write merge directive to this file or directory; '
5170
'use - for stdout.',
5173
help='Refuse to send if there are uncommitted changes in'
5174
' the working tree, --no-strict disables the check.'),
5175
Option('mail-to', help='Mail the request to this address.',
5179
Option('body', help='Body for the email.', type=unicode),
5180
RegistryOption('format',
5181
help='Use the specified output format.',
5182
lazy_registry=('bzrlib.send', 'format_registry')),
5185
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5186
no_patch=False, revision=None, remember=False, output=None,
5187
format=None, mail_to=None, message=None, body=None,
5188
strict=None, **kwargs):
5189
from bzrlib.send import send
5190
return send(submit_branch, revision, public_branch, remember,
5191
format, no_bundle, no_patch, output,
5192
kwargs.get('from', '.'), mail_to, message, body,
5197
class cmd_bundle_revisions(cmd_send):
5198
"""Create a merge-directive for submitting changes.
5200
A merge directive provides many things needed for requesting merges:
5202
* A machine-readable description of the merge to perform
5204
* An optional patch that is a preview of the changes requested
5206
* An optional bundle of revision data, so that the changes can be applied
5207
directly from the merge directive, without retrieving data from a
5210
If --no-bundle is specified, then public_branch is needed (and must be
5211
up-to-date), so that the receiver can perform the merge using the
5212
public_branch. The public_branch is always included if known, so that
5213
people can check it later.
5215
The submit branch defaults to the parent, but can be overridden. Both
5216
submit branch and public branch will be remembered if supplied.
5218
If a public_branch is known for the submit_branch, that public submit
5219
branch is used in the merge instructions. This means that a local mirror
5220
can be used as your actual submit branch, once you have set public_branch
5223
Two formats are currently supported: "4" uses revision bundle format 4 and
5224
merge directive format 2. It is significantly faster and smaller than
5225
older formats. It is compatible with Bazaar 0.19 and later. It is the
5226
default. "0.9" uses revision bundle format 0.9 and merge directive
5227
format 1. It is compatible with Bazaar 0.12 - 0.18.
5232
help='Do not include a bundle in the merge directive.'),
5233
Option('no-patch', help='Do not include a preview patch in the merge'
5236
help='Remember submit and public branch.'),
5238
help='Branch to generate the submission from, '
5239
'rather than the one containing the working directory.',
5242
Option('output', short_name='o', help='Write directive to this file.',
5245
help='Refuse to bundle revisions if there are uncommitted'
5246
' changes in the working tree, --no-strict disables the check.'),
5248
RegistryOption('format',
5249
help='Use the specified output format.',
5250
lazy_registry=('bzrlib.send', 'format_registry')),
5252
aliases = ['bundle']
5254
_see_also = ['send', 'merge']
5258
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5259
no_patch=False, revision=None, remember=False, output=None,
5260
format=None, strict=None, **kwargs):
5263
from bzrlib.send import send
5264
return send(submit_branch, revision, public_branch, remember,
5265
format, no_bundle, no_patch, output,
5266
kwargs.get('from', '.'), None, None, None,
5267
self.outf, strict=strict)
5270
class cmd_tag(Command):
5271
"""Create, remove or modify a tag naming a revision.
5273
Tags give human-meaningful names to revisions. Commands that take a -r
5274
(--revision) option can be given -rtag:X, where X is any previously
5277
Tags are stored in the branch. Tags are copied from one branch to another
5278
along when you branch, push, pull or merge.
5280
It is an error to give a tag name that already exists unless you pass
5281
--force, in which case the tag is moved to point to the new revision.
5283
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5284
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5286
If no tag name is specified it will be determined through the
5287
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5288
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5292
_see_also = ['commit', 'tags']
5293
takes_args = ['tag_name?']
5296
help='Delete this tag rather than placing it.',
5299
help='Branch in which to place the tag.',
5304
help='Replace existing tags.',
5309
def run(self, tag_name=None,
5315
branch, relpath = Branch.open_containing(directory)
5317
self.add_cleanup(branch.unlock)
5319
if tag_name is None:
5320
raise errors.BzrCommandError("No tag specified to delete.")
5321
branch.tags.delete_tag(tag_name)
5322
self.outf.write('Deleted tag %s.\n' % tag_name)
5325
if len(revision) != 1:
5326
raise errors.BzrCommandError(
5327
"Tags can only be placed on a single revision, "
5329
revision_id = revision[0].as_revision_id(branch)
5331
revision_id = branch.last_revision()
5332
if tag_name is None:
5333
tag_name = branch.automatic_tag_name(revision_id)
5334
if tag_name is None:
5335
raise errors.BzrCommandError(
5336
"Please specify a tag name.")
5337
if (not force) and branch.tags.has_tag(tag_name):
5338
raise errors.TagAlreadyExists(tag_name)
5339
branch.tags.set_tag(tag_name, revision_id)
5340
self.outf.write('Created tag %s.\n' % tag_name)
5343
class cmd_tags(Command):
5346
This command shows a table of tag names and the revisions they reference.
5352
help='Branch whose tags should be displayed.',
5356
RegistryOption.from_kwargs('sort',
5357
'Sort tags by different criteria.', title='Sorting',
5358
alpha='Sort tags lexicographically (default).',
5359
time='Sort tags chronologically.',
5372
branch, relpath = Branch.open_containing(directory)
5374
tags = branch.tags.get_tag_dict().items()
5379
self.add_cleanup(branch.unlock)
5381
graph = branch.repository.get_graph()
5382
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5383
revid1, revid2 = rev1.rev_id, rev2.rev_id
5384
# only show revisions between revid1 and revid2 (inclusive)
5385
tags = [(tag, revid) for tag, revid in tags if
5386
graph.is_between(revid, revid1, revid2)]
5389
elif sort == 'time':
5391
for tag, revid in tags:
5393
revobj = branch.repository.get_revision(revid)
5394
except errors.NoSuchRevision:
5395
timestamp = sys.maxint # place them at the end
5397
timestamp = revobj.timestamp
5398
timestamps[revid] = timestamp
5399
tags.sort(key=lambda x: timestamps[x[1]])
5401
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5402
for index, (tag, revid) in enumerate(tags):
5404
revno = branch.revision_id_to_dotted_revno(revid)
5405
if isinstance(revno, tuple):
5406
revno = '.'.join(map(str, revno))
5407
except errors.NoSuchRevision:
5408
# Bad tag data/merges can lead to tagged revisions
5409
# which are not in this branch. Fail gracefully ...
5411
tags[index] = (tag, revno)
5413
for tag, revspec in tags:
5414
self.outf.write('%-20s %s\n' % (tag, revspec))
5417
class cmd_reconfigure(Command):
5418
"""Reconfigure the type of a bzr directory.
5420
A target configuration must be specified.
5422
For checkouts, the bind-to location will be auto-detected if not specified.
5423
The order of preference is
5424
1. For a lightweight checkout, the current bound location.
5425
2. For branches that used to be checkouts, the previously-bound location.
5426
3. The push location.
5427
4. The parent location.
5428
If none of these is available, --bind-to must be specified.
5431
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5432
takes_args = ['location?']
5434
RegistryOption.from_kwargs(
5436
title='Target type',
5437
help='The type to reconfigure the directory to.',
5438
value_switches=True, enum_switch=False,
5439
branch='Reconfigure to be an unbound branch with no working tree.',
5440
tree='Reconfigure to be an unbound branch with a working tree.',
5441
checkout='Reconfigure to be a bound branch with a working tree.',
5442
lightweight_checkout='Reconfigure to be a lightweight'
5443
' checkout (with no local history).',
5444
standalone='Reconfigure to be a standalone branch '
5445
'(i.e. stop using shared repository).',
5446
use_shared='Reconfigure to use a shared repository.',
5447
with_trees='Reconfigure repository to create '
5448
'working trees on branches by default.',
5449
with_no_trees='Reconfigure repository to not create '
5450
'working trees on branches by default.'
5452
Option('bind-to', help='Branch to bind checkout to.', type=str),
5454
help='Perform reconfiguration even if local changes'
5456
Option('stacked-on',
5457
help='Reconfigure a branch to be stacked on another branch.',
5461
help='Reconfigure a branch to be unstacked. This '
5462
'may require copying substantial data into it.',
5466
def run(self, location=None, target_type=None, bind_to=None, force=False,
5469
directory = bzrdir.BzrDir.open(location)
5470
if stacked_on and unstacked:
5471
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5472
elif stacked_on is not None:
5473
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5475
reconfigure.ReconfigureUnstacked().apply(directory)
5476
# At the moment you can use --stacked-on and a different
5477
# reconfiguration shape at the same time; there seems no good reason
5479
if target_type is None:
5480
if stacked_on or unstacked:
5483
raise errors.BzrCommandError('No target configuration '
5485
elif target_type == 'branch':
5486
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
elif target_type == 'tree':
5488
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5489
elif target_type == 'checkout':
5490
reconfiguration = reconfigure.Reconfigure.to_checkout(
5492
elif target_type == 'lightweight-checkout':
5493
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5495
elif target_type == 'use-shared':
5496
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5497
elif target_type == 'standalone':
5498
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5499
elif target_type == 'with-trees':
5500
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5502
elif target_type == 'with-no-trees':
5503
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5505
reconfiguration.apply(force)
5508
class cmd_switch(Command):
5509
"""Set the branch of a checkout and update.
5511
For lightweight checkouts, this changes the branch being referenced.
5512
For heavyweight checkouts, this checks that there are no local commits
5513
versus the current bound branch, then it makes the local branch a mirror
5514
of the new location and binds to it.
5516
In both cases, the working tree is updated and uncommitted changes
5517
are merged. The user can commit or revert these as they desire.
5519
Pending merges need to be committed or reverted before using switch.
5521
The path to the branch to switch to can be specified relative to the parent
5522
directory of the current branch. For example, if you are currently in a
5523
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5526
Bound branches use the nickname of its master branch unless it is set
5527
locally, in which case switching will update the local nickname to be
5531
takes_args = ['to_location?']
5532
takes_options = [Option('force',
5533
help='Switch even if local commits will be lost.'),
5535
Option('create-branch', short_name='b',
5536
help='Create the target branch from this one before'
5537
' switching to it.'),
5540
def run(self, to_location=None, force=False, create_branch=False,
5542
from bzrlib import switch
5544
revision = _get_one_revision('switch', revision)
5545
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
if to_location is None:
5547
if revision is None:
5548
raise errors.BzrCommandError('You must supply either a'
5549
' revision or a location')
5552
branch = control_dir.open_branch()
5553
had_explicit_nick = branch.get_config().has_explicit_nickname()
5554
except errors.NotBranchError:
5556
had_explicit_nick = False
5559
raise errors.BzrCommandError('cannot create branch without'
5561
to_location = directory_service.directories.dereference(
5563
if '/' not in to_location and '\\' not in to_location:
5564
# This path is meant to be relative to the existing branch
5565
this_url = self._get_branch_location(control_dir)
5566
to_location = urlutils.join(this_url, '..', to_location)
5567
to_branch = branch.bzrdir.sprout(to_location,
5568
possible_transports=[branch.bzrdir.root_transport],
5569
source_branch=branch).open_branch()
5572
to_branch = Branch.open(to_location)
5573
except errors.NotBranchError:
5574
this_url = self._get_branch_location(control_dir)
5575
to_branch = Branch.open(
5576
urlutils.join(this_url, '..', to_location))
5577
if revision is not None:
5578
revision = revision.as_revision_id(to_branch)
5579
switch.switch(control_dir, to_branch, force, revision_id=revision)
5580
if had_explicit_nick:
5581
branch = control_dir.open_branch() #get the new branch!
5582
branch.nick = to_branch.nick
5583
note('Switched to branch: %s',
5584
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5586
def _get_branch_location(self, control_dir):
5587
"""Return location of branch for this control dir."""
5589
this_branch = control_dir.open_branch()
5590
# This may be a heavy checkout, where we want the master branch
5591
master_location = this_branch.get_bound_location()
5592
if master_location is not None:
5593
return master_location
5594
# If not, use a local sibling
5595
return this_branch.base
5596
except errors.NotBranchError:
5597
format = control_dir.find_branch_format()
5598
if getattr(format, 'get_reference', None) is not None:
5599
return format.get_reference(control_dir)
5601
return control_dir.root_transport.base
5604
class cmd_view(Command):
5605
"""Manage filtered views.
5607
Views provide a mask over the tree so that users can focus on
5608
a subset of a tree when doing their work. After creating a view,
5609
commands that support a list of files - status, diff, commit, etc -
5610
effectively have that list of files implicitly given each time.
5611
An explicit list of files can still be given but those files
5612
must be within the current view.
5614
In most cases, a view has a short life-span: it is created to make
5615
a selected change and is deleted once that change is committed.
5616
At other times, you may wish to create one or more named views
5617
and switch between them.
5619
To disable the current view without deleting it, you can switch to
5620
the pseudo view called ``off``. This can be useful when you need
5621
to see the whole tree for an operation or two (e.g. merge) but
5622
want to switch back to your view after that.
5625
To define the current view::
5627
bzr view file1 dir1 ...
5629
To list the current view::
5633
To delete the current view::
5637
To disable the current view without deleting it::
5639
bzr view --switch off
5641
To define a named view and switch to it::
5643
bzr view --name view-name file1 dir1 ...
5645
To list a named view::
5647
bzr view --name view-name
5649
To delete a named view::
5651
bzr view --name view-name --delete
5653
To switch to a named view::
5655
bzr view --switch view-name
5657
To list all views defined::
5661
To delete all views::
5663
bzr view --delete --all
5667
takes_args = ['file*']
5670
help='Apply list or delete action to all views.',
5673
help='Delete the view.',
5676
help='Name of the view to define, list or delete.',
5680
help='Name of the view to switch to.',
5685
def run(self, file_list,
5691
tree, file_list = tree_files(file_list, apply_view=False)
5692
current_view, view_dict = tree.views.get_view_info()
5697
raise errors.BzrCommandError(
5698
"Both --delete and a file list specified")
5700
raise errors.BzrCommandError(
5701
"Both --delete and --switch specified")
5703
tree.views.set_view_info(None, {})
5704
self.outf.write("Deleted all views.\n")
5706
raise errors.BzrCommandError("No current view to delete")
5708
tree.views.delete_view(name)
5709
self.outf.write("Deleted '%s' view.\n" % name)
5712
raise errors.BzrCommandError(
5713
"Both --switch and a file list specified")
5715
raise errors.BzrCommandError(
5716
"Both --switch and --all specified")
5717
elif switch == 'off':
5718
if current_view is None:
5719
raise errors.BzrCommandError("No current view to disable")
5720
tree.views.set_view_info(None, view_dict)
5721
self.outf.write("Disabled '%s' view.\n" % (current_view))
5723
tree.views.set_view_info(switch, view_dict)
5724
view_str = views.view_display_str(tree.views.lookup_view())
5725
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5728
self.outf.write('Views defined:\n')
5729
for view in sorted(view_dict):
5730
if view == current_view:
5734
view_str = views.view_display_str(view_dict[view])
5735
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5737
self.outf.write('No views defined.\n')
5740
# No name given and no current view set
5743
raise errors.BzrCommandError(
5744
"Cannot change the 'off' pseudo view")
5745
tree.views.set_view(name, sorted(file_list))
5746
view_str = views.view_display_str(tree.views.lookup_view())
5747
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5751
# No name given and no current view set
5752
self.outf.write('No current view.\n')
5754
view_str = views.view_display_str(tree.views.lookup_view(name))
5755
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5758
class cmd_hooks(Command):
5764
for hook_key in sorted(hooks.known_hooks.keys()):
5765
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5766
self.outf.write("%s:\n" % type(some_hooks).__name__)
5767
for hook_name, hook_point in sorted(some_hooks.items()):
5768
self.outf.write(" %s:\n" % (hook_name,))
5769
found_hooks = list(hook_point)
5771
for hook in found_hooks:
5772
self.outf.write(" %s\n" %
5773
(some_hooks.get_hook_name(hook),))
5775
self.outf.write(" <no hooks installed>\n")
5778
class cmd_remove_branch(Command):
5781
This will remove the branch from the specified location but
5782
will keep any working tree or repository in place.
5786
Remove the branch at repo/trunk::
5788
bzr remove-branch repo/trunk
5792
takes_args = ["location?"]
5794
aliases = ["rmbranch"]
5796
def run(self, location=None):
5797
if location is None:
5799
branch = Branch.open_containing(location)[0]
5800
branch.bzrdir.destroy_branch()
5803
class cmd_shelve(Command):
5804
"""Temporarily set aside some changes from the current tree.
5806
Shelve allows you to temporarily put changes you've made "on the shelf",
5807
ie. out of the way, until a later time when you can bring them back from
5808
the shelf with the 'unshelve' command. The changes are stored alongside
5809
your working tree, and so they aren't propagated along with your branch nor
5810
will they survive its deletion.
5812
If shelve --list is specified, previously-shelved changes are listed.
5814
Shelve is intended to help separate several sets of changes that have
5815
been inappropriately mingled. If you just want to get rid of all changes
5816
and you don't need to restore them later, use revert. If you want to
5817
shelve all text changes at once, use shelve --all.
5819
If filenames are specified, only the changes to those files will be
5820
shelved. Other files will be left untouched.
5822
If a revision is specified, changes since that revision will be shelved.
5824
You can put multiple items on the shelf, and by default, 'unshelve' will
5825
restore the most recently shelved changes.
5828
takes_args = ['file*']
5832
Option('all', help='Shelve all changes.'),
5834
RegistryOption('writer', 'Method to use for writing diffs.',
5835
bzrlib.option.diff_writer_registry,
5836
value_switches=True, enum_switch=False),
5838
Option('list', help='List shelved changes.'),
5840
help='Destroy removed changes instead of shelving them.'),
5842
_see_also = ['unshelve']
5844
def run(self, revision=None, all=False, file_list=None, message=None,
5845
writer=None, list=False, destroy=False):
5847
return self.run_for_list()
5848
from bzrlib.shelf_ui import Shelver
5850
writer = bzrlib.option.diff_writer_registry.get()
5852
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
file_list, message, destroy=destroy)
5858
except errors.UserAbort:
5861
def run_for_list(self):
5862
tree = WorkingTree.open_containing('.')[0]
5864
self.add_cleanup(tree.unlock)
5865
manager = tree.get_shelf_manager()
5866
shelves = manager.active_shelves()
5867
if len(shelves) == 0:
5868
note('No shelved changes.')
5870
for shelf_id in reversed(shelves):
5871
message = manager.get_metadata(shelf_id).get('message')
5873
message = '<no message>'
5874
self.outf.write('%3d: %s\n' % (shelf_id, message))
5878
class cmd_unshelve(Command):
5879
"""Restore shelved changes.
5881
By default, the most recently shelved changes are restored. However if you
5882
specify a shelf by id those changes will be restored instead. This works
5883
best when the changes don't depend on each other.
5886
takes_args = ['shelf_id?']
5888
RegistryOption.from_kwargs(
5889
'action', help="The action to perform.",
5890
enum_switch=False, value_switches=True,
5891
apply="Apply changes and remove from the shelf.",
5892
dry_run="Show changes, but do not apply or remove them.",
5893
preview="Instead of unshelving the changes, show the diff that "
5894
"would result from unshelving.",
5895
delete_only="Delete changes without applying them.",
5896
keep="Apply changes but don't delete them.",
5899
_see_also = ['shelve']
5901
def run(self, shelf_id=None, action='apply'):
5902
from bzrlib.shelf_ui import Unshelver
5903
unshelver = Unshelver.from_args(shelf_id, action)
5907
unshelver.tree.unlock()
5910
class cmd_clean_tree(Command):
5911
"""Remove unwanted files from working tree.
5913
By default, only unknown files, not ignored files, are deleted. Versioned
5914
files are never deleted.
5916
Another class is 'detritus', which includes files emitted by bzr during
5917
normal operations and selftests. (The value of these files decreases with
5920
If no options are specified, unknown files are deleted. Otherwise, option
5921
flags are respected, and may be combined.
5923
To check what clean-tree will do, use --dry-run.
5925
takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
Option('detritus', help='Delete conflict files, merge'
5927
' backups, and failed selftest dirs.'),
5929
help='Delete files unknown to bzr (default).'),
5930
Option('dry-run', help='Show files to delete instead of'
5932
Option('force', help='Do not prompt before deleting.')]
5933
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5935
from bzrlib.clean_tree import clean_tree
5936
if not (unknown or ignored or detritus):
5940
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5941
dry_run=dry_run, no_prompt=force)
5944
class cmd_reference(Command):
5945
"""list, view and set branch locations for nested trees.
5947
If no arguments are provided, lists the branch locations for nested trees.
5948
If one argument is provided, display the branch location for that tree.
5949
If two arguments are provided, set the branch location for that tree.
5954
takes_args = ['path?', 'location?']
5956
def run(self, path=None, location=None):
5958
if path is not None:
5960
tree, branch, relpath =(
5961
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5962
if path is not None:
5965
tree = branch.basis_tree()
5967
info = branch._get_all_reference_info().iteritems()
5968
self._display_reference_info(tree, branch, info)
5970
file_id = tree.path2id(path)
5972
raise errors.NotVersionedError(path)
5973
if location is None:
5974
info = [(file_id, branch.get_reference_info(file_id))]
5975
self._display_reference_info(tree, branch, info)
5977
branch.set_reference_info(file_id, path, location)
5979
def _display_reference_info(self, tree, branch, info):
5981
for file_id, (path, location) in info:
5983
path = tree.id2path(file_id)
5984
except errors.NoSuchId:
5986
ref_list.append((path, location))
5987
for path, location in sorted(ref_list):
5988
self.outf.write('%s %s\n' % (path, location))
5991
def _register_lazy_builtins():
5992
# register lazy builtins from other modules; called at startup and should
5993
# be only called once.
5994
for (name, aliases, module_name) in [
5995
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5996
('cmd_dpush', [], 'bzrlib.foreign'),
5997
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5998
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5999
('cmd_conflicts', [], 'bzrlib.conflicts'),
6000
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6002
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
