1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import (
71
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
74
def tree_files(file_list, default_branch=u'.', canonicalize=True,
77
return internal_tree_files(file_list, default_branch, canonicalize,
79
except errors.FileInWrongBranch, e:
80
raise errors.BzrCommandError("%s is not in the same branch as %s" %
81
(e.path, file_list[0]))
84
def tree_files_for_add(file_list):
86
Return a tree and list of absolute paths from a file list.
88
Similar to tree_files, but add handles files a bit differently, so it a
89
custom implementation. In particular, MutableTreeTree.smart_add expects
90
absolute paths, which it immediately converts to relative paths.
92
# FIXME Would be nice to just return the relative paths like
93
# internal_tree_files does, but there are a large number of unit tests
94
# that assume the current interface to mutabletree.smart_add
96
tree, relpath = WorkingTree.open_containing(file_list[0])
97
if tree.supports_views():
98
view_files = tree.views.lookup_view()
100
for filename in file_list:
101
if not osutils.is_inside_any(view_files, filename):
102
raise errors.FileOutsideView(filename, view_files)
103
file_list = file_list[:]
104
file_list[0] = tree.abspath(relpath)
106
tree = WorkingTree.open_containing(u'.')[0]
107
if tree.supports_views():
108
view_files = tree.views.lookup_view()
110
file_list = view_files
111
view_str = views.view_display_str(view_files)
112
note("Ignoring files outside view. View is %s" % view_str)
113
return tree, file_list
116
def _get_one_revision(command_name, revisions):
117
if revisions is None:
119
if len(revisions) != 1:
120
raise errors.BzrCommandError(
121
'bzr %s --revision takes exactly one revision identifier' % (
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
127
"""Get a revision tree. Not suitable for commands that change the tree.
129
Specifically, the basis tree in dirstate trees is coupled to the dirstate
130
and doing a commit/uncommit/pull will at best fail due to changing the
133
If tree is passed in, it should be already locked, for lifetime management
134
of the trees internal cached state.
138
if revisions is None:
140
rev_tree = tree.basis_tree()
142
rev_tree = branch.basis_tree()
144
revision = _get_one_revision(command_name, revisions)
145
rev_tree = revision.as_tree(branch)
149
# XXX: Bad function name; should possibly also be a class method of
150
# WorkingTree rather than a function.
151
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
"""Convert command-line paths to a WorkingTree and relative paths.
155
This is typically used for command-line processors that take one or
156
more filenames, and infer the workingtree that contains them.
158
The filenames given are not required to exist.
160
:param file_list: Filenames to convert.
162
:param default_branch: Fallback tree path to use if file_list is empty or
165
:param apply_view: if True and a view is set, apply it or check that
166
specified files are within it
168
:return: workingtree, [relative_paths]
170
if file_list is None or len(file_list) == 0:
171
tree = WorkingTree.open_containing(default_branch)[0]
172
if tree.supports_views() and apply_view:
173
view_files = tree.views.lookup_view()
175
file_list = view_files
176
view_str = views.view_display_str(view_files)
177
note("Ignoring files outside view. View is %s" % view_str)
178
return tree, file_list
179
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
180
return tree, safe_relpath_files(tree, file_list, canonicalize,
181
apply_view=apply_view)
184
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
185
"""Convert file_list into a list of relpaths in tree.
187
:param tree: A tree to operate on.
188
:param file_list: A list of user provided paths or None.
189
:param apply_view: if True and a view is set, apply it or check that
190
specified files are within it
191
:return: A list of relative paths.
192
:raises errors.PathNotChild: When a provided path is in a different tree
195
if file_list is None:
197
if tree.supports_views() and apply_view:
198
view_files = tree.views.lookup_view()
202
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
203
# doesn't - fix that up here before we enter the loop.
205
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
208
for filename in file_list:
210
relpath = fixer(osutils.dereference_path(filename))
211
if view_files and not osutils.is_inside_any(view_files, relpath):
212
raise errors.FileOutsideView(filename, view_files)
213
new_list.append(relpath)
214
except errors.PathNotChild:
215
raise errors.FileInWrongBranch(tree.branch, filename)
219
def _get_view_info_for_change_reporter(tree):
220
"""Get the view information from a tree for change reporting."""
223
current_view = tree.views.get_view_info()[0]
224
if current_view is not None:
225
view_info = (current_view, tree.views.lookup_view())
226
except errors.ViewsNotSupported:
231
# TODO: Make sure no commands unconditionally use the working directory as a
232
# branch. If a filename argument is used, the first of them should be used to
233
# specify the branch. (Perhaps this can be factored out into some kind of
234
# Argument class, representing a file in a branch, where the first occurrence
237
class cmd_status(Command):
238
"""Display status summary.
240
This reports on versioned and unknown files, reporting them
241
grouped by state. Possible states are:
244
Versioned in the working copy but not in the previous revision.
247
Versioned in the previous revision but removed or deleted
251
Path of this file changed from the previous revision;
252
the text may also have changed. This includes files whose
253
parent directory was renamed.
256
Text has changed since the previous revision.
259
File kind has been changed (e.g. from file to directory).
262
Not versioned and not matching an ignore pattern.
264
Additionally for directories, symlinks and files with an executable
265
bit, Bazaar indicates their type using a trailing character: '/', '@'
268
To see ignored files use 'bzr ignored'. For details on the
269
changes to file texts, use 'bzr diff'.
271
Note that --short or -S gives status flags for each item, similar
272
to Subversion's status command. To get output similar to svn -q,
275
If no arguments are specified, the status of the entire working
276
directory is shown. Otherwise, only the status of the specified
277
files or directories is reported. If a directory is given, status
278
is reported for everything inside that directory.
280
Before merges are committed, the pending merge tip revisions are
281
shown. To see all pending merge revisions, use the -v option.
282
To skip the display of pending merge information altogether, use
283
the no-pending option or specify a file/directory.
285
If a revision argument is given, the status is calculated against
286
that revision, or between two revisions if two are provided.
289
# TODO: --no-recurse, --recurse options
291
takes_args = ['file*']
292
takes_options = ['show-ids', 'revision', 'change', 'verbose',
293
Option('short', help='Use short status indicators.',
295
Option('versioned', help='Only show versioned files.',
297
Option('no-pending', help='Don\'t show pending merges.',
300
aliases = ['st', 'stat']
302
encoding_type = 'replace'
303
_see_also = ['diff', 'revert', 'status-flags']
306
def run(self, show_ids=False, file_list=None, revision=None, short=False,
307
versioned=False, no_pending=False, verbose=False):
308
from bzrlib.status import show_tree_status
310
if revision and len(revision) > 2:
311
raise errors.BzrCommandError('bzr status --revision takes exactly'
312
' one or two revision specifiers')
314
tree, relfile_list = tree_files(file_list)
315
# Avoid asking for specific files when that is not needed.
316
if relfile_list == ['']:
318
# Don't disable pending merges for full trees other than '.'.
319
if file_list == ['.']:
321
# A specific path within a tree was given.
322
elif relfile_list is not None:
324
show_tree_status(tree, show_ids=show_ids,
325
specific_files=relfile_list, revision=revision,
326
to_file=self.outf, short=short, versioned=versioned,
327
show_pending=(not no_pending), verbose=verbose)
330
class cmd_cat_revision(Command):
331
"""Write out metadata for a revision.
333
The revision to print can either be specified by a specific
334
revision identifier, or you can use --revision.
338
takes_args = ['revision_id?']
339
takes_options = ['revision']
340
# cat-revision is more for frontends so should be exact
343
def print_revision(self, revisions, revid):
344
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
345
record = stream.next()
346
if record.storage_kind == 'absent':
347
raise errors.NoSuchRevision(revisions, revid)
348
revtext = record.get_bytes_as('fulltext')
349
self.outf.write(revtext.decode('utf-8'))
352
def run(self, revision_id=None, revision=None):
353
if revision_id is not None and revision is not None:
354
raise errors.BzrCommandError('You can only supply one of'
355
' revision_id or --revision')
356
if revision_id is None and revision is None:
357
raise errors.BzrCommandError('You must supply either'
358
' --revision or a revision_id')
359
b = WorkingTree.open_containing(u'.')[0].branch
361
revisions = b.repository.revisions
362
if revisions is None:
363
raise errors.BzrCommandError('Repository %r does not support '
364
'access to raw revision texts')
366
b.repository.lock_read()
368
# TODO: jam 20060112 should cat-revision always output utf-8?
369
if revision_id is not None:
370
revision_id = osutils.safe_revision_id(revision_id, warn=False)
372
self.print_revision(revisions, revision_id)
373
except errors.NoSuchRevision:
374
msg = "The repository %s contains no revision %s." % (
375
b.repository.base, revision_id)
376
raise errors.BzrCommandError(msg)
377
elif revision is not None:
380
raise errors.BzrCommandError(
381
'You cannot specify a NULL revision.')
382
rev_id = rev.as_revision_id(b)
383
self.print_revision(revisions, rev_id)
385
b.repository.unlock()
388
class cmd_dump_btree(Command):
389
"""Dump the contents of a btree index file to stdout.
391
PATH is a btree index file, it can be any URL. This includes things like
392
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
394
By default, the tuples stored in the index file will be displayed. With
395
--raw, we will uncompress the pages, but otherwise display the raw bytes
399
# TODO: Do we want to dump the internal nodes as well?
400
# TODO: It would be nice to be able to dump the un-parsed information,
401
# rather than only going through iter_all_entries. However, this is
402
# good enough for a start
404
encoding_type = 'exact'
405
takes_args = ['path']
406
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
407
' rather than the parsed tuples.'),
410
def run(self, path, raw=False):
411
dirname, basename = osutils.split(path)
412
t = transport.get_transport(dirname)
414
self._dump_raw_bytes(t, basename)
416
self._dump_entries(t, basename)
418
def _get_index_and_bytes(self, trans, basename):
419
"""Create a BTreeGraphIndex and raw bytes."""
420
bt = btree_index.BTreeGraphIndex(trans, basename, None)
421
bytes = trans.get_bytes(basename)
422
bt._file = cStringIO.StringIO(bytes)
423
bt._size = len(bytes)
426
def _dump_raw_bytes(self, trans, basename):
429
# We need to parse at least the root node.
430
# This is because the first page of every row starts with an
431
# uncompressed header.
432
bt, bytes = self._get_index_and_bytes(trans, basename)
433
for page_idx, page_start in enumerate(xrange(0, len(bytes),
434
btree_index._PAGE_SIZE)):
435
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
436
page_bytes = bytes[page_start:page_end]
438
self.outf.write('Root node:\n')
439
header_end, data = bt._parse_header_from_bytes(page_bytes)
440
self.outf.write(page_bytes[:header_end])
442
self.outf.write('\nPage %d\n' % (page_idx,))
443
decomp_bytes = zlib.decompress(page_bytes)
444
self.outf.write(decomp_bytes)
445
self.outf.write('\n')
447
def _dump_entries(self, trans, basename):
449
st = trans.stat(basename)
450
except errors.TransportNotPossible:
451
# We can't stat, so we'll fake it because we have to do the 'get()'
453
bt, _ = self._get_index_and_bytes(trans, basename)
455
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
456
for node in bt.iter_all_entries():
457
# Node is made up of:
458
# (index, key, value, [references])
462
refs_as_tuples = None
464
refs_as_tuples = static_tuple.as_tuples(refs)
465
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
466
self.outf.write('%s\n' % (as_tuple,))
469
class cmd_remove_tree(Command):
470
"""Remove the working tree from a given branch/checkout.
472
Since a lightweight checkout is little more than a working tree
473
this will refuse to run against one.
475
To re-create the working tree, use "bzr checkout".
477
_see_also = ['checkout', 'working-trees']
478
takes_args = ['location*']
481
help='Remove the working tree even if it has '
482
'uncommitted changes.'),
485
def run(self, location_list, force=False):
486
if not location_list:
489
for location in location_list:
490
d = bzrdir.BzrDir.open(location)
493
working = d.open_workingtree()
494
except errors.NoWorkingTree:
495
raise errors.BzrCommandError("No working tree to remove")
496
except errors.NotLocalUrl:
497
raise errors.BzrCommandError("You cannot remove the working tree"
500
if (working.has_changes()):
501
raise errors.UncommittedChanges(working)
503
working_path = working.bzrdir.root_transport.base
504
branch_path = working.branch.bzrdir.root_transport.base
505
if working_path != branch_path:
506
raise errors.BzrCommandError("You cannot remove the working tree"
507
" from a lightweight checkout")
509
d.destroy_workingtree()
512
class cmd_revno(Command):
513
"""Show current revision number.
515
This is equal to the number of revisions on this branch.
519
takes_args = ['location?']
521
Option('tree', help='Show revno of working tree'),
525
def run(self, tree=False, location=u'.'):
528
wt = WorkingTree.open_containing(location)[0]
530
except (errors.NoWorkingTree, errors.NotLocalUrl):
531
raise errors.NoWorkingTree(location)
532
self.add_cleanup(wt.unlock)
533
revid = wt.last_revision()
535
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
536
except errors.NoSuchRevision:
538
revno = ".".join(str(n) for n in revno_t)
540
b = Branch.open_containing(location)[0]
542
self.add_cleanup(b.unlock)
545
self.outf.write(str(revno) + '\n')
548
class cmd_revision_info(Command):
549
"""Show revision number and revision id for a given revision identifier.
552
takes_args = ['revision_info*']
556
help='Branch to examine, '
557
'rather than the one containing the working directory.',
561
Option('tree', help='Show revno of working tree'),
565
def run(self, revision=None, directory=u'.', tree=False,
566
revision_info_list=[]):
569
wt = WorkingTree.open_containing(directory)[0]
572
self.add_cleanup(wt.unlock)
573
except (errors.NoWorkingTree, errors.NotLocalUrl):
575
b = Branch.open_containing(directory)[0]
577
self.add_cleanup(b.unlock)
579
if revision is not None:
580
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
581
if revision_info_list is not None:
582
for rev_str in revision_info_list:
583
rev_spec = RevisionSpec.from_string(rev_str)
584
revision_ids.append(rev_spec.as_revision_id(b))
585
# No arguments supplied, default to the last revision
586
if len(revision_ids) == 0:
589
raise errors.NoWorkingTree(directory)
590
revision_ids.append(wt.last_revision())
592
revision_ids.append(b.last_revision())
596
for revision_id in revision_ids:
598
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
599
revno = '.'.join(str(i) for i in dotted_revno)
600
except errors.NoSuchRevision:
602
maxlen = max(maxlen, len(revno))
603
revinfos.append([revno, revision_id])
607
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
610
class cmd_add(Command):
611
"""Add specified files or directories.
613
In non-recursive mode, all the named items are added, regardless
614
of whether they were previously ignored. A warning is given if
615
any of the named files are already versioned.
617
In recursive mode (the default), files are treated the same way
618
but the behaviour for directories is different. Directories that
619
are already versioned do not give a warning. All directories,
620
whether already versioned or not, are searched for files or
621
subdirectories that are neither versioned or ignored, and these
622
are added. This search proceeds recursively into versioned
623
directories. If no names are given '.' is assumed.
625
Therefore simply saying 'bzr add' will version all files that
626
are currently unknown.
628
Adding a file whose parent directory is not versioned will
629
implicitly add the parent, and so on up to the root. This means
630
you should never need to explicitly add a directory, they'll just
631
get added when you add a file in the directory.
633
--dry-run will show which files would be added, but not actually
636
--file-ids-from will try to use the file ids from the supplied path.
637
It looks up ids trying to find a matching parent directory with the
638
same filename, and then by pure path. This option is rarely needed
639
but can be useful when adding the same logical file into two
640
branches that will be merged later (without showing the two different
641
adds as a conflict). It is also useful when merging another project
642
into a subdirectory of this one.
644
Any files matching patterns in the ignore list will not be added
645
unless they are explicitly mentioned.
647
takes_args = ['file*']
650
help="Don't recursively add the contents of directories."),
652
help="Show what would be done, but don't actually do anything."),
654
Option('file-ids-from',
656
help='Lookup file ids from this tree.'),
658
encoding_type = 'replace'
659
_see_also = ['remove', 'ignore']
661
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
666
if file_ids_from is not None:
668
base_tree, base_path = WorkingTree.open_containing(
670
except errors.NoWorkingTree:
671
base_branch, base_path = Branch.open_containing(
673
base_tree = base_branch.basis_tree()
675
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
676
to_file=self.outf, should_print=(not is_quiet()))
678
action = bzrlib.add.AddAction(to_file=self.outf,
679
should_print=(not is_quiet()))
682
base_tree.lock_read()
683
self.add_cleanup(base_tree.unlock)
684
tree, file_list = tree_files_for_add(file_list)
685
added, ignored = tree.smart_add(file_list, not
686
no_recurse, action=action, save=not dry_run)
690
for glob in sorted(ignored.keys()):
691
for path in ignored[glob]:
692
self.outf.write("ignored %s matching \"%s\"\n"
696
class cmd_mkdir(Command):
697
"""Create a new versioned directory.
699
This is equivalent to creating the directory and then adding it.
702
takes_args = ['dir+']
703
encoding_type = 'replace'
705
def run(self, dir_list):
707
wt, dd = WorkingTree.open_containing(d)
708
base = os.path.dirname(dd)
709
id = wt.path2id(base)
713
self.outf.write('added %s\n' % d)
715
raise errors.NotVersionedError(path=base)
718
class cmd_relpath(Command):
719
"""Show path of a file relative to root"""
721
takes_args = ['filename']
725
def run(self, filename):
726
# TODO: jam 20050106 Can relpath return a munged path if
727
# sys.stdout encoding cannot represent it?
728
tree, relpath = WorkingTree.open_containing(filename)
729
self.outf.write(relpath)
730
self.outf.write('\n')
733
class cmd_inventory(Command):
734
"""Show inventory of the current working copy or a revision.
736
It is possible to limit the output to a particular entry
737
type using the --kind option. For example: --kind file.
739
It is also possible to restrict the list of files to a specific
740
set. For example: bzr inventory --show-ids this/file
749
help='List entries of a particular kind: file, directory, symlink.',
752
takes_args = ['file*']
755
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
756
if kind and kind not in ['file', 'directory', 'symlink']:
757
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
759
revision = _get_one_revision('inventory', revision)
760
work_tree, file_list = tree_files(file_list)
761
work_tree.lock_read()
762
self.add_cleanup(work_tree.unlock)
763
if revision is not None:
764
tree = revision.as_tree(work_tree.branch)
766
extra_trees = [work_tree]
768
self.add_cleanup(tree.unlock)
773
if file_list is not None:
774
file_ids = tree.paths2ids(file_list, trees=extra_trees,
775
require_versioned=True)
776
# find_ids_across_trees may include some paths that don't
778
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
779
for file_id in file_ids if file_id in tree)
781
entries = tree.inventory.entries()
784
for path, entry in entries:
785
if kind and kind != entry.kind:
788
self.outf.write('%-50s %s\n' % (path, entry.file_id))
790
self.outf.write(path)
791
self.outf.write('\n')
794
class cmd_mv(Command):
795
"""Move or rename a file.
798
bzr mv OLDNAME NEWNAME
800
bzr mv SOURCE... DESTINATION
802
If the last argument is a versioned directory, all the other names
803
are moved into it. Otherwise, there must be exactly two arguments
804
and the file is changed to a new name.
806
If OLDNAME does not exist on the filesystem but is versioned and
807
NEWNAME does exist on the filesystem but is not versioned, mv
808
assumes that the file has been manually moved and only updates
809
its internal inventory to reflect that change.
810
The same is valid when moving many SOURCE files to a DESTINATION.
812
Files cannot be moved between branches.
815
takes_args = ['names*']
816
takes_options = [Option("after", help="Move only the bzr identifier"
817
" of the file, because the file has already been moved."),
818
Option('auto', help='Automatically guess renames.'),
819
Option('dry-run', help='Avoid making changes when guessing renames.'),
821
aliases = ['move', 'rename']
822
encoding_type = 'replace'
824
def run(self, names_list, after=False, auto=False, dry_run=False):
826
return self.run_auto(names_list, after, dry_run)
828
raise errors.BzrCommandError('--dry-run requires --auto.')
829
if names_list is None:
831
if len(names_list) < 2:
832
raise errors.BzrCommandError("missing file argument")
833
tree, rel_names = tree_files(names_list, canonicalize=False)
834
tree.lock_tree_write()
835
self.add_cleanup(tree.unlock)
836
self._run(tree, names_list, rel_names, after)
838
def run_auto(self, names_list, after, dry_run):
839
if names_list is not None and len(names_list) > 1:
840
raise errors.BzrCommandError('Only one path may be specified to'
843
raise errors.BzrCommandError('--after cannot be specified with'
845
work_tree, file_list = tree_files(names_list, default_branch='.')
846
work_tree.lock_tree_write()
847
self.add_cleanup(work_tree.unlock)
848
rename_map.RenameMap.guess_renames(work_tree, dry_run)
850
def _run(self, tree, names_list, rel_names, after):
851
into_existing = osutils.isdir(names_list[-1])
852
if into_existing and len(names_list) == 2:
854
# a. case-insensitive filesystem and change case of dir
855
# b. move directory after the fact (if the source used to be
856
# a directory, but now doesn't exist in the working tree
857
# and the target is an existing directory, just rename it)
858
if (not tree.case_sensitive
859
and rel_names[0].lower() == rel_names[1].lower()):
860
into_existing = False
863
# 'fix' the case of a potential 'from'
864
from_id = tree.path2id(
865
tree.get_canonical_inventory_path(rel_names[0]))
866
if (not osutils.lexists(names_list[0]) and
867
from_id and inv.get_file_kind(from_id) == "directory"):
868
into_existing = False
871
# move into existing directory
872
# All entries reference existing inventory items, so fix them up
873
# for cicp file-systems.
874
rel_names = tree.get_canonical_inventory_paths(rel_names)
875
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
877
self.outf.write("%s => %s\n" % (src, dest))
879
if len(names_list) != 2:
880
raise errors.BzrCommandError('to mv multiple files the'
881
' destination must be a versioned'
884
# for cicp file-systems: the src references an existing inventory
886
src = tree.get_canonical_inventory_path(rel_names[0])
887
# Find the canonical version of the destination: In all cases, the
888
# parent of the target must be in the inventory, so we fetch the
889
# canonical version from there (we do not always *use* the
890
# canonicalized tail portion - we may be attempting to rename the
892
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
893
dest_parent = osutils.dirname(canon_dest)
894
spec_tail = osutils.basename(rel_names[1])
895
# For a CICP file-system, we need to avoid creating 2 inventory
896
# entries that differ only by case. So regardless of the case
897
# we *want* to use (ie, specified by the user or the file-system),
898
# we must always choose to use the case of any existing inventory
899
# items. The only exception to this is when we are attempting a
900
# case-only rename (ie, canonical versions of src and dest are
902
dest_id = tree.path2id(canon_dest)
903
if dest_id is None or tree.path2id(src) == dest_id:
904
# No existing item we care about, so work out what case we
905
# are actually going to use.
907
# If 'after' is specified, the tail must refer to a file on disk.
909
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
911
# pathjoin with an empty tail adds a slash, which breaks
913
dest_parent_fq = tree.basedir
915
dest_tail = osutils.canonical_relpath(
917
osutils.pathjoin(dest_parent_fq, spec_tail))
919
# not 'after', so case as specified is used
920
dest_tail = spec_tail
922
# Use the existing item so 'mv' fails with AlreadyVersioned.
923
dest_tail = os.path.basename(canon_dest)
924
dest = osutils.pathjoin(dest_parent, dest_tail)
925
mutter("attempting to move %s => %s", src, dest)
926
tree.rename_one(src, dest, after=after)
928
self.outf.write("%s => %s\n" % (src, dest))
931
class cmd_pull(Command):
932
"""Turn this branch into a mirror of another branch.
934
By default, this command only works on branches that have not diverged.
935
Branches are considered diverged if the destination branch's most recent
936
commit is one that has not been merged (directly or indirectly) into the
939
If branches have diverged, you can use 'bzr merge' to integrate the changes
940
from one into the other. Once one branch has merged, the other should
941
be able to pull it again.
943
If you want to replace your local changes and just want your branch to
944
match the remote one, use pull --overwrite. This will work even if the two
945
branches have diverged.
947
If there is no default location set, the first pull will set it. After
948
that, you can omit the location to use the default. To change the
949
default, use --remember. The value will only be saved if the remote
950
location can be accessed.
952
Note: The location can be specified either in the form of a branch,
953
or in the form of a path to a file containing a merge directive generated
957
_see_also = ['push', 'update', 'status-flags', 'send']
958
takes_options = ['remember', 'overwrite', 'revision',
959
custom_help('verbose',
960
help='Show logs of pulled revisions.'),
962
help='Branch to pull into, '
963
'rather than the one containing the working directory.',
968
help="Perform a local pull in a bound "
969
"branch. Local pulls are not applied to "
973
takes_args = ['location?']
974
encoding_type = 'replace'
976
def run(self, location=None, remember=False, overwrite=False,
977
revision=None, verbose=False,
978
directory=None, local=False):
979
# FIXME: too much stuff is in the command class
982
if directory is None:
985
tree_to = WorkingTree.open_containing(directory)[0]
986
branch_to = tree_to.branch
987
except errors.NoWorkingTree:
989
branch_to = Branch.open_containing(directory)[0]
991
if local and not branch_to.get_bound_location():
992
raise errors.LocalRequiresBoundBranch()
994
possible_transports = []
995
if location is not None:
997
mergeable = bundle.read_mergeable_from_url(location,
998
possible_transports=possible_transports)
999
except errors.NotABundle:
1002
stored_loc = branch_to.get_parent()
1003
if location is None:
1004
if stored_loc is None:
1005
raise errors.BzrCommandError("No pull location known or"
1008
display_url = urlutils.unescape_for_display(stored_loc,
1011
self.outf.write("Using saved parent location: %s\n" % display_url)
1012
location = stored_loc
1014
revision = _get_one_revision('pull', revision)
1015
if mergeable is not None:
1016
if revision is not None:
1017
raise errors.BzrCommandError(
1018
'Cannot use -r with merge directives or bundles')
1019
mergeable.install_revisions(branch_to.repository)
1020
base_revision_id, revision_id, verified = \
1021
mergeable.get_merge_request(branch_to.repository)
1022
branch_from = branch_to
1024
branch_from = Branch.open(location,
1025
possible_transports=possible_transports)
1027
if branch_to.get_parent() is None or remember:
1028
branch_to.set_parent(branch_from.base)
1030
if branch_from is not branch_to:
1031
branch_from.lock_read()
1032
self.add_cleanup(branch_from.unlock)
1033
if revision is not None:
1034
revision_id = revision.as_revision_id(branch_from)
1036
branch_to.lock_write()
1037
self.add_cleanup(branch_to.unlock)
1038
if tree_to is not None:
1039
view_info = _get_view_info_for_change_reporter(tree_to)
1040
change_reporter = delta._ChangeReporter(
1041
unversioned_filter=tree_to.is_ignored,
1042
view_info=view_info)
1043
result = tree_to.pull(
1044
branch_from, overwrite, revision_id, change_reporter,
1045
possible_transports=possible_transports, local=local)
1047
result = branch_to.pull(
1048
branch_from, overwrite, revision_id, local=local)
1050
result.report(self.outf)
1051
if verbose and result.old_revid != result.new_revid:
1052
log.show_branch_change(
1053
branch_to, self.outf, result.old_revno,
1057
class cmd_push(Command):
1058
"""Update a mirror of this branch.
1060
The target branch will not have its working tree populated because this
1061
is both expensive, and is not supported on remote file systems.
1063
Some smart servers or protocols *may* put the working tree in place in
1066
This command only works on branches that have not diverged. Branches are
1067
considered diverged if the destination branch's most recent commit is one
1068
that has not been merged (directly or indirectly) by the source branch.
1070
If branches have diverged, you can use 'bzr push --overwrite' to replace
1071
the other branch completely, discarding its unmerged changes.
1073
If you want to ensure you have the different changes in the other branch,
1074
do a merge (see bzr help merge) from the other branch, and commit that.
1075
After that you will be able to do a push without '--overwrite'.
1077
If there is no default push location set, the first push will set it.
1078
After that, you can omit the location to use the default. To change the
1079
default, use --remember. The value will only be saved if the remote
1080
location can be accessed.
1083
_see_also = ['pull', 'update', 'working-trees']
1084
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1085
Option('create-prefix',
1086
help='Create the path leading up to the branch '
1087
'if it does not already exist.'),
1089
help='Branch to push from, '
1090
'rather than the one containing the working directory.',
1094
Option('use-existing-dir',
1095
help='By default push will fail if the target'
1096
' directory exists, but does not already'
1097
' have a control directory. This flag will'
1098
' allow push to proceed.'),
1100
help='Create a stacked branch that references the public location '
1101
'of the parent branch.'),
1102
Option('stacked-on',
1103
help='Create a stacked branch that refers to another branch '
1104
'for the commit history. Only the work not present in the '
1105
'referenced branch is included in the branch created.',
1108
help='Refuse to push if there are uncommitted changes in'
1109
' the working tree, --no-strict disables the check.'),
1111
takes_args = ['location?']
1112
encoding_type = 'replace'
1114
def run(self, location=None, remember=False, overwrite=False,
1115
create_prefix=False, verbose=False, revision=None,
1116
use_existing_dir=False, directory=None, stacked_on=None,
1117
stacked=False, strict=None):
1118
from bzrlib.push import _show_push_branch
1120
if directory is None:
1122
# Get the source branch
1124
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1126
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1127
if strict is None: strict = True # default value
1128
# Get the tip's revision_id
1129
revision = _get_one_revision('push', revision)
1130
if revision is not None:
1131
revision_id = revision.in_history(br_from).rev_id
1134
if strict and tree is not None and revision_id is None:
1135
if (tree.has_changes()):
1136
raise errors.UncommittedChanges(
1137
tree, more='Use --no-strict to force the push.')
1138
if tree.last_revision() != tree.branch.last_revision():
1139
# The tree has lost sync with its branch, there is little
1140
# chance that the user is aware of it but he can still force
1141
# the push with --no-strict
1142
raise errors.OutOfDateTree(
1143
tree, more='Use --no-strict to force the push.')
1145
# Get the stacked_on branch, if any
1146
if stacked_on is not None:
1147
stacked_on = urlutils.normalize_url(stacked_on)
1149
parent_url = br_from.get_parent()
1151
parent = Branch.open(parent_url)
1152
stacked_on = parent.get_public_branch()
1154
# I considered excluding non-http url's here, thus forcing
1155
# 'public' branches only, but that only works for some
1156
# users, so it's best to just depend on the user spotting an
1157
# error by the feedback given to them. RBC 20080227.
1158
stacked_on = parent_url
1160
raise errors.BzrCommandError(
1161
"Could not determine branch to refer to.")
1163
# Get the destination location
1164
if location is None:
1165
stored_loc = br_from.get_push_location()
1166
if stored_loc is None:
1167
raise errors.BzrCommandError(
1168
"No push location known or specified.")
1170
display_url = urlutils.unescape_for_display(stored_loc,
1172
self.outf.write("Using saved push location: %s\n" % display_url)
1173
location = stored_loc
1175
_show_push_branch(br_from, revision_id, location, self.outf,
1176
verbose=verbose, overwrite=overwrite, remember=remember,
1177
stacked_on=stacked_on, create_prefix=create_prefix,
1178
use_existing_dir=use_existing_dir)
1181
class cmd_branch(Command):
1182
"""Create a new branch that is a copy of an existing branch.
1184
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1185
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1186
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1187
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1188
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1191
To retrieve the branch as of a particular revision, supply the --revision
1192
parameter, as in "branch foo/bar -r 5".
1195
_see_also = ['checkout']
1196
takes_args = ['from_location', 'to_location?']
1197
takes_options = ['revision', Option('hardlink',
1198
help='Hard-link working tree files where possible.'),
1200
help="Create a branch without a working-tree."),
1202
help="Switch the checkout in the current directory "
1203
"to the new branch."),
1205
help='Create a stacked branch referring to the source branch. '
1206
'The new branch will depend on the availability of the source '
1207
'branch for all operations.'),
1208
Option('standalone',
1209
help='Do not use a shared repository, even if available.'),
1210
Option('use-existing-dir',
1211
help='By default branch will fail if the target'
1212
' directory exists, but does not already'
1213
' have a control directory. This flag will'
1214
' allow branch to proceed.'),
1216
help="Bind new branch to from location."),
1218
aliases = ['get', 'clone']
1220
def run(self, from_location, to_location=None, revision=None,
1221
hardlink=False, stacked=False, standalone=False, no_tree=False,
1222
use_existing_dir=False, switch=False, bind=False):
1223
from bzrlib import switch as _mod_switch
1224
from bzrlib.tag import _merge_tags_if_possible
1225
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1227
revision = _get_one_revision('branch', revision)
1229
self.add_cleanup(br_from.unlock)
1230
if revision is not None:
1231
revision_id = revision.as_revision_id(br_from)
1233
# FIXME - wt.last_revision, fallback to branch, fall back to
1234
# None or perhaps NULL_REVISION to mean copy nothing
1236
revision_id = br_from.last_revision()
1237
if to_location is None:
1238
to_location = urlutils.derive_to_location(from_location)
1239
to_transport = transport.get_transport(to_location)
1241
to_transport.mkdir('.')
1242
except errors.FileExists:
1243
if not use_existing_dir:
1244
raise errors.BzrCommandError('Target directory "%s" '
1245
'already exists.' % to_location)
1248
bzrdir.BzrDir.open_from_transport(to_transport)
1249
except errors.NotBranchError:
1252
raise errors.AlreadyBranchError(to_location)
1253
except errors.NoSuchFile:
1254
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1257
# preserve whatever source format we have.
1258
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1259
possible_transports=[to_transport],
1260
accelerator_tree=accelerator_tree,
1261
hardlink=hardlink, stacked=stacked,
1262
force_new_repo=standalone,
1263
create_tree_if_local=not no_tree,
1264
source_branch=br_from)
1265
branch = dir.open_branch()
1266
except errors.NoSuchRevision:
1267
to_transport.delete_tree('.')
1268
msg = "The branch %s has no revision %s." % (from_location,
1270
raise errors.BzrCommandError(msg)
1271
_merge_tags_if_possible(br_from, branch)
1272
# If the source branch is stacked, the new branch may
1273
# be stacked whether we asked for that explicitly or not.
1274
# We therefore need a try/except here and not just 'if stacked:'
1276
note('Created new stacked branch referring to %s.' %
1277
branch.get_stacked_on_url())
1278
except (errors.NotStacked, errors.UnstackableBranchFormat,
1279
errors.UnstackableRepositoryFormat), e:
1280
note('Branched %d revision(s).' % branch.revno())
1282
# Bind to the parent
1283
parent_branch = Branch.open(from_location)
1284
branch.bind(parent_branch)
1285
note('New branch bound to %s' % from_location)
1287
# Switch to the new branch
1288
wt, _ = WorkingTree.open_containing('.')
1289
_mod_switch.switch(wt.bzrdir, branch)
1290
note('Switched to branch: %s',
1291
urlutils.unescape_for_display(branch.base, 'utf-8'))
1294
class cmd_checkout(Command):
1295
"""Create a new checkout of an existing branch.
1297
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1298
the branch found in '.'. This is useful if you have removed the working tree
1299
or if it was never created - i.e. if you pushed the branch to its current
1300
location using SFTP.
1302
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1303
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1304
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1305
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1306
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1309
To retrieve the branch as of a particular revision, supply the --revision
1310
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1311
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1315
_see_also = ['checkouts', 'branch']
1316
takes_args = ['branch_location?', 'to_location?']
1317
takes_options = ['revision',
1318
Option('lightweight',
1319
help="Perform a lightweight checkout. Lightweight "
1320
"checkouts depend on access to the branch for "
1321
"every operation. Normal checkouts can perform "
1322
"common operations like diff and status without "
1323
"such access, and also support local commits."
1325
Option('files-from', type=str,
1326
help="Get file contents from this tree."),
1328
help='Hard-link working tree files where possible.'
1333
def run(self, branch_location=None, to_location=None, revision=None,
1334
lightweight=False, files_from=None, hardlink=False):
1335
if branch_location is None:
1336
branch_location = osutils.getcwd()
1337
to_location = branch_location
1338
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1340
revision = _get_one_revision('checkout', revision)
1341
if files_from is not None:
1342
accelerator_tree = WorkingTree.open(files_from)
1343
if revision is not None:
1344
revision_id = revision.as_revision_id(source)
1347
if to_location is None:
1348
to_location = urlutils.derive_to_location(branch_location)
1349
# if the source and to_location are the same,
1350
# and there is no working tree,
1351
# then reconstitute a branch
1352
if (osutils.abspath(to_location) ==
1353
osutils.abspath(branch_location)):
1355
source.bzrdir.open_workingtree()
1356
except errors.NoWorkingTree:
1357
source.bzrdir.create_workingtree(revision_id)
1359
source.create_checkout(to_location, revision_id, lightweight,
1360
accelerator_tree, hardlink)
1363
class cmd_renames(Command):
1364
"""Show list of renamed files.
1366
# TODO: Option to show renames between two historical versions.
1368
# TODO: Only show renames under dir, rather than in the whole branch.
1369
_see_also = ['status']
1370
takes_args = ['dir?']
1373
def run(self, dir=u'.'):
1374
tree = WorkingTree.open_containing(dir)[0]
1376
self.add_cleanup(tree.unlock)
1377
new_inv = tree.inventory
1378
old_tree = tree.basis_tree()
1379
old_tree.lock_read()
1380
self.add_cleanup(old_tree.unlock)
1381
old_inv = old_tree.inventory
1383
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1384
for f, paths, c, v, p, n, k, e in iterator:
1385
if paths[0] == paths[1]:
1389
renames.append(paths)
1391
for old_name, new_name in renames:
1392
self.outf.write("%s => %s\n" % (old_name, new_name))
1395
class cmd_update(Command):
1396
"""Update a tree to have the latest code committed to its branch.
1398
This will perform a merge into the working tree, and may generate
1399
conflicts. If you have any local changes, you will still
1400
need to commit them after the update for the update to be complete.
1402
If you want to discard your local changes, you can just do a
1403
'bzr revert' instead of 'bzr commit' after the update.
1405
If the tree's branch is bound to a master branch, it will also update
1406
the branch from the master.
1409
_see_also = ['pull', 'working-trees', 'status-flags']
1410
takes_args = ['dir?']
1411
takes_options = ['revision']
1414
def run(self, dir='.', revision=None):
1415
if revision is not None and len(revision) != 1:
1416
raise errors.BzrCommandError(
1417
"bzr update --revision takes exactly one revision")
1418
tree = WorkingTree.open_containing(dir)[0]
1419
branch = tree.branch
1420
possible_transports = []
1421
master = branch.get_master_branch(
1422
possible_transports=possible_transports)
1423
if master is not None:
1425
branch_location = master.base
1427
tree.lock_tree_write()
1428
branch_location = tree.branch.base
1429
self.add_cleanup(tree.unlock)
1430
# get rid of the final '/' and be ready for display
1431
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1433
existing_pending_merges = tree.get_parent_ids()[1:]
1437
# may need to fetch data into a heavyweight checkout
1438
# XXX: this may take some time, maybe we should display a
1440
old_tip = branch.update(possible_transports)
1441
if revision is not None:
1442
revision_id = revision[0].as_revision_id(branch)
1444
revision_id = branch.last_revision()
1445
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1446
revno = branch.revision_id_to_revno(revision_id)
1447
note("Tree is up to date at revision %d of branch %s" %
1448
(revno, branch_location))
1450
view_info = _get_view_info_for_change_reporter(tree)
1451
change_reporter = delta._ChangeReporter(
1452
unversioned_filter=tree.is_ignored,
1453
view_info=view_info)
1455
conflicts = tree.update(
1457
possible_transports=possible_transports,
1458
revision=revision_id,
1460
except errors.NoSuchRevision, e:
1461
raise errors.BzrCommandError(
1462
"branch has no revision %s\n"
1463
"bzr update --revision only works"
1464
" for a revision in the branch history"
1466
revno = tree.branch.revision_id_to_revno(
1467
_mod_revision.ensure_null(tree.last_revision()))
1468
note('Updated to revision %d of branch %s' %
1469
(revno, branch_location))
1470
if tree.get_parent_ids()[1:] != existing_pending_merges:
1471
note('Your local commits will now show as pending merges with '
1472
"'bzr status', and can be committed with 'bzr commit'.")
1479
class cmd_info(Command):
1480
"""Show information about a working tree, branch or repository.
1482
This command will show all known locations and formats associated to the
1483
tree, branch or repository.
1485
In verbose mode, statistical information is included with each report.
1486
To see extended statistic information, use a verbosity level of 2 or
1487
higher by specifying the verbose option multiple times, e.g. -vv.
1489
Branches and working trees will also report any missing revisions.
1493
Display information on the format and related locations:
1497
Display the above together with extended format information and
1498
basic statistics (like the number of files in the working tree and
1499
number of revisions in the branch and repository):
1503
Display the above together with number of committers to the branch:
1507
_see_also = ['revno', 'working-trees', 'repositories']
1508
takes_args = ['location?']
1509
takes_options = ['verbose']
1510
encoding_type = 'replace'
1513
def run(self, location=None, verbose=False):
1515
noise_level = get_verbosity_level()
1518
from bzrlib.info import show_bzrdir_info
1519
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1520
verbose=noise_level, outfile=self.outf)
1523
class cmd_remove(Command):
1524
"""Remove files or directories.
1526
This makes bzr stop tracking changes to the specified files. bzr will delete
1527
them if they can easily be recovered using revert. If no options or
1528
parameters are given bzr will scan for files that are being tracked by bzr
1529
but missing in your tree and stop tracking them for you.
1531
takes_args = ['file*']
1532
takes_options = ['verbose',
1533
Option('new', help='Only remove files that have never been committed.'),
1534
RegistryOption.from_kwargs('file-deletion-strategy',
1535
'The file deletion mode to be used.',
1536
title='Deletion Strategy', value_switches=True, enum_switch=False,
1537
safe='Only delete files if they can be'
1538
' safely recovered (default).',
1539
keep='Delete from bzr but leave the working copy.',
1540
force='Delete all the specified files, even if they can not be '
1541
'recovered and even if they are non-empty directories.')]
1542
aliases = ['rm', 'del']
1543
encoding_type = 'replace'
1545
def run(self, file_list, verbose=False, new=False,
1546
file_deletion_strategy='safe'):
1547
tree, file_list = tree_files(file_list)
1549
if file_list is not None:
1550
file_list = [f for f in file_list]
1553
self.add_cleanup(tree.unlock)
1554
# Heuristics should probably all move into tree.remove_smart or
1557
added = tree.changes_from(tree.basis_tree(),
1558
specific_files=file_list).added
1559
file_list = sorted([f[0] for f in added], reverse=True)
1560
if len(file_list) == 0:
1561
raise errors.BzrCommandError('No matching files.')
1562
elif file_list is None:
1563
# missing files show up in iter_changes(basis) as
1564
# versioned-with-no-kind.
1566
for change in tree.iter_changes(tree.basis_tree()):
1567
# Find paths in the working tree that have no kind:
1568
if change[1][1] is not None and change[6][1] is None:
1569
missing.append(change[1][1])
1570
file_list = sorted(missing, reverse=True)
1571
file_deletion_strategy = 'keep'
1572
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1573
keep_files=file_deletion_strategy=='keep',
1574
force=file_deletion_strategy=='force')
1577
class cmd_file_id(Command):
1578
"""Print file_id of a particular file or directory.
1580
The file_id is assigned when the file is first added and remains the
1581
same through all revisions where the file exists, even when it is
1586
_see_also = ['inventory', 'ls']
1587
takes_args = ['filename']
1590
def run(self, filename):
1591
tree, relpath = WorkingTree.open_containing(filename)
1592
i = tree.path2id(relpath)
1594
raise errors.NotVersionedError(filename)
1596
self.outf.write(i + '\n')
1599
class cmd_file_path(Command):
1600
"""Print path of file_ids to a file or directory.
1602
This prints one line for each directory down to the target,
1603
starting at the branch root.
1607
takes_args = ['filename']
1610
def run(self, filename):
1611
tree, relpath = WorkingTree.open_containing(filename)
1612
fid = tree.path2id(relpath)
1614
raise errors.NotVersionedError(filename)
1615
segments = osutils.splitpath(relpath)
1616
for pos in range(1, len(segments) + 1):
1617
path = osutils.joinpath(segments[:pos])
1618
self.outf.write("%s\n" % tree.path2id(path))
1621
class cmd_reconcile(Command):
1622
"""Reconcile bzr metadata in a branch.
1624
This can correct data mismatches that may have been caused by
1625
previous ghost operations or bzr upgrades. You should only
1626
need to run this command if 'bzr check' or a bzr developer
1627
advises you to run it.
1629
If a second branch is provided, cross-branch reconciliation is
1630
also attempted, which will check that data like the tree root
1631
id which was not present in very early bzr versions is represented
1632
correctly in both branches.
1634
At the same time it is run it may recompress data resulting in
1635
a potential saving in disk space or performance gain.
1637
The branch *MUST* be on a listable system such as local disk or sftp.
1640
_see_also = ['check']
1641
takes_args = ['branch?']
1643
def run(self, branch="."):
1644
from bzrlib.reconcile import reconcile
1645
dir = bzrdir.BzrDir.open(branch)
1649
class cmd_revision_history(Command):
1650
"""Display the list of revision ids on a branch."""
1653
takes_args = ['location?']
1658
def run(self, location="."):
1659
branch = Branch.open_containing(location)[0]
1660
for revid in branch.revision_history():
1661
self.outf.write(revid)
1662
self.outf.write('\n')
1665
class cmd_ancestry(Command):
1666
"""List all revisions merged into this branch."""
1668
_see_also = ['log', 'revision-history']
1669
takes_args = ['location?']
1674
def run(self, location="."):
1676
wt = WorkingTree.open_containing(location)[0]
1677
except errors.NoWorkingTree:
1678
b = Branch.open(location)
1679
last_revision = b.last_revision()
1682
last_revision = wt.last_revision()
1684
revision_ids = b.repository.get_ancestry(last_revision)
1686
for revision_id in revision_ids:
1687
self.outf.write(revision_id + '\n')
1690
class cmd_init(Command):
1691
"""Make a directory into a versioned branch.
1693
Use this to create an empty branch, or before importing an
1696
If there is a repository in a parent directory of the location, then
1697
the history of the branch will be stored in the repository. Otherwise
1698
init creates a standalone branch which carries its own history
1699
in the .bzr directory.
1701
If there is already a branch at the location but it has no working tree,
1702
the tree can be populated with 'bzr checkout'.
1704
Recipe for importing a tree of files::
1710
bzr commit -m "imported project"
1713
_see_also = ['init-repository', 'branch', 'checkout']
1714
takes_args = ['location?']
1716
Option('create-prefix',
1717
help='Create the path leading up to the branch '
1718
'if it does not already exist.'),
1719
RegistryOption('format',
1720
help='Specify a format for this branch. '
1721
'See "help formats".',
1722
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1723
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1724
value_switches=True,
1725
title="Branch format",
1727
Option('append-revisions-only',
1728
help='Never change revnos or the existing log.'
1729
' Append revisions to it only.')
1731
def run(self, location=None, format=None, append_revisions_only=False,
1732
create_prefix=False):
1734
format = bzrdir.format_registry.make_bzrdir('default')
1735
if location is None:
1738
to_transport = transport.get_transport(location)
1740
# The path has to exist to initialize a
1741
# branch inside of it.
1742
# Just using os.mkdir, since I don't
1743
# believe that we want to create a bunch of
1744
# locations if the user supplies an extended path
1746
to_transport.ensure_base()
1747
except errors.NoSuchFile:
1748
if not create_prefix:
1749
raise errors.BzrCommandError("Parent directory of %s"
1751
"\nYou may supply --create-prefix to create all"
1752
" leading parent directories."
1754
to_transport.create_prefix()
1757
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1758
except errors.NotBranchError:
1759
# really a NotBzrDir error...
1760
create_branch = bzrdir.BzrDir.create_branch_convenience
1761
branch = create_branch(to_transport.base, format=format,
1762
possible_transports=[to_transport])
1763
a_bzrdir = branch.bzrdir
1765
from bzrlib.transport.local import LocalTransport
1766
if a_bzrdir.has_branch():
1767
if (isinstance(to_transport, LocalTransport)
1768
and not a_bzrdir.has_workingtree()):
1769
raise errors.BranchExistsWithoutWorkingTree(location)
1770
raise errors.AlreadyBranchError(location)
1771
branch = a_bzrdir.create_branch()
1772
a_bzrdir.create_workingtree()
1773
if append_revisions_only:
1775
branch.set_append_revisions_only(True)
1776
except errors.UpgradeRequired:
1777
raise errors.BzrCommandError('This branch format cannot be set'
1778
' to append-revisions-only. Try --default.')
1780
from bzrlib.info import describe_layout, describe_format
1782
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1783
except (errors.NoWorkingTree, errors.NotLocalUrl):
1785
repository = branch.repository
1786
layout = describe_layout(repository, branch, tree).lower()
1787
format = describe_format(a_bzrdir, repository, branch, tree)
1788
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1789
if repository.is_shared():
1790
#XXX: maybe this can be refactored into transport.path_or_url()
1791
url = repository.bzrdir.root_transport.external_url()
1793
url = urlutils.local_path_from_url(url)
1794
except errors.InvalidURL:
1796
self.outf.write("Using shared repository: %s\n" % url)
1799
class cmd_init_repository(Command):
1800
"""Create a shared repository for branches to share storage space.
1802
New branches created under the repository directory will store their
1803
revisions in the repository, not in the branch directory. For branches
1804
with shared history, this reduces the amount of storage needed and
1805
speeds up the creation of new branches.
1807
If the --no-trees option is given then the branches in the repository
1808
will not have working trees by default. They will still exist as
1809
directories on disk, but they will not have separate copies of the
1810
files at a certain revision. This can be useful for repositories that
1811
store branches which are interacted with through checkouts or remote
1812
branches, such as on a server.
1815
Create a shared repository holding just branches::
1817
bzr init-repo --no-trees repo
1820
Make a lightweight checkout elsewhere::
1822
bzr checkout --lightweight repo/trunk trunk-checkout
1827
_see_also = ['init', 'branch', 'checkout', 'repositories']
1828
takes_args = ["location"]
1829
takes_options = [RegistryOption('format',
1830
help='Specify a format for this repository. See'
1831
' "bzr help formats" for details.',
1832
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1833
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1834
value_switches=True, title='Repository format'),
1836
help='Branches in the repository will default to'
1837
' not having a working tree.'),
1839
aliases = ["init-repo"]
1841
def run(self, location, format=None, no_trees=False):
1843
format = bzrdir.format_registry.make_bzrdir('default')
1845
if location is None:
1848
to_transport = transport.get_transport(location)
1849
to_transport.ensure_base()
1851
newdir = format.initialize_on_transport(to_transport)
1852
repo = newdir.create_repository(shared=True)
1853
repo.set_make_working_trees(not no_trees)
1855
from bzrlib.info import show_bzrdir_info
1856
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1859
class cmd_diff(Command):
1860
"""Show differences in the working tree, between revisions or branches.
1862
If no arguments are given, all changes for the current tree are listed.
1863
If files are given, only the changes in those files are listed.
1864
Remote and multiple branches can be compared by using the --old and
1865
--new options. If not provided, the default for both is derived from
1866
the first argument, if any, or the current tree if no arguments are
1869
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1870
produces patches suitable for "patch -p1".
1874
2 - unrepresentable changes
1879
Shows the difference in the working tree versus the last commit::
1883
Difference between the working tree and revision 1::
1887
Difference between revision 3 and revision 1::
1891
Difference between revision 3 and revision 1 for branch xxx::
1895
To see the changes introduced in revision X::
1899
Note that in the case of a merge, the -c option shows the changes
1900
compared to the left hand parent. To see the changes against
1901
another parent, use::
1903
bzr diff -r<chosen_parent>..X
1905
The changes introduced by revision 2 (equivalent to -r1..2)::
1909
Show just the differences for file NEWS::
1913
Show the differences in working tree xxx for file NEWS::
1917
Show the differences from branch xxx to this working tree:
1921
Show the differences between two branches for file NEWS::
1923
bzr diff --old xxx --new yyy NEWS
1925
Same as 'bzr diff' but prefix paths with old/ and new/::
1927
bzr diff --prefix old/:new/
1929
_see_also = ['status']
1930
takes_args = ['file*']
1932
Option('diff-options', type=str,
1933
help='Pass these options to the external diff program.'),
1934
Option('prefix', type=str,
1936
help='Set prefixes added to old and new filenames, as '
1937
'two values separated by a colon. (eg "old/:new/").'),
1939
help='Branch/tree to compare from.',
1943
help='Branch/tree to compare to.',
1949
help='Use this command to compare files.',
1953
aliases = ['di', 'dif']
1954
encoding_type = 'exact'
1957
def run(self, revision=None, file_list=None, diff_options=None,
1958
prefix=None, old=None, new=None, using=None):
1959
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
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
(old_tree, new_tree,
1980
old_branch, new_branch,
1981
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1982
file_list, revision, old, new, apply_view=True)
1983
return show_diff_trees(old_tree, new_tree, sys.stdout,
1984
specific_files=specific_files,
1985
external_diff_options=diff_options,
1986
old_label=old_label, new_label=new_label,
1987
extra_trees=extra_trees, using=using)
1990
class cmd_deleted(Command):
1991
"""List files deleted in the working tree.
1993
# TODO: Show files deleted since a previous revision, or
1994
# between two revisions.
1995
# TODO: Much more efficient way to do this: read in new
1996
# directories with readdir, rather than stating each one. Same
1997
# level of effort but possibly much less IO. (Or possibly not,
1998
# if the directories are very large...)
1999
_see_also = ['status', 'ls']
2000
takes_options = ['show-ids']
2003
def run(self, show_ids=False):
2004
tree = WorkingTree.open_containing(u'.')[0]
2006
self.add_cleanup(tree.unlock)
2007
old = tree.basis_tree()
2009
self.add_cleanup(old.unlock)
2010
for path, ie in old.inventory.iter_entries():
2011
if not tree.has_id(ie.file_id):
2012
self.outf.write(path)
2014
self.outf.write(' ')
2015
self.outf.write(ie.file_id)
2016
self.outf.write('\n')
2019
class cmd_modified(Command):
2020
"""List files modified in working tree.
2024
_see_also = ['status', 'ls']
2027
help='Write an ascii NUL (\\0) separator '
2028
'between files rather than a newline.')
2032
def run(self, null=False):
2033
tree = WorkingTree.open_containing(u'.')[0]
2034
td = tree.changes_from(tree.basis_tree())
2035
for path, id, kind, text_modified, meta_modified in td.modified:
2037
self.outf.write(path + '\0')
2039
self.outf.write(osutils.quotefn(path) + '\n')
2042
class cmd_added(Command):
2043
"""List files added in working tree.
2047
_see_also = ['status', 'ls']
2050
help='Write an ascii NUL (\\0) separator '
2051
'between files rather than a newline.')
2055
def run(self, null=False):
2056
wt = WorkingTree.open_containing(u'.')[0]
2058
self.add_cleanup(wt.unlock)
2059
basis = wt.basis_tree()
2061
self.add_cleanup(basis.unlock)
2062
basis_inv = basis.inventory
2065
if file_id in basis_inv:
2067
if inv.is_root(file_id) and len(basis_inv) == 0:
2069
path = inv.id2path(file_id)
2070
if not os.access(osutils.abspath(path), os.F_OK):
2073
self.outf.write(path + '\0')
2075
self.outf.write(osutils.quotefn(path) + '\n')
2078
class cmd_root(Command):
2079
"""Show the tree root directory.
2081
The root is the nearest enclosing directory with a .bzr control
2084
takes_args = ['filename?']
2086
def run(self, filename=None):
2087
"""Print the branch root."""
2088
tree = WorkingTree.open_containing(filename)[0]
2089
self.outf.write(tree.basedir + '\n')
2092
def _parse_limit(limitstring):
2094
return int(limitstring)
2096
msg = "The limit argument must be an integer."
2097
raise errors.BzrCommandError(msg)
2100
def _parse_levels(s):
2104
msg = "The levels argument must be an integer."
2105
raise errors.BzrCommandError(msg)
2108
class cmd_log(Command):
2109
"""Show historical log for a branch or subset of a branch.
2111
log is bzr's default tool for exploring the history of a branch.
2112
The branch to use is taken from the first parameter. If no parameters
2113
are given, the branch containing the working directory is logged.
2114
Here are some simple examples::
2116
bzr log log the current branch
2117
bzr log foo.py log a file in its branch
2118
bzr log http://server/branch log a branch on a server
2120
The filtering, ordering and information shown for each revision can
2121
be controlled as explained below. By default, all revisions are
2122
shown sorted (topologically) so that newer revisions appear before
2123
older ones and descendants always appear before ancestors. If displayed,
2124
merged revisions are shown indented under the revision in which they
2129
The log format controls how information about each revision is
2130
displayed. The standard log formats are called ``long``, ``short``
2131
and ``line``. The default is long. See ``bzr help log-formats``
2132
for more details on log formats.
2134
The following options can be used to control what information is
2137
-l N display a maximum of N revisions
2138
-n N display N levels of revisions (0 for all, 1 for collapsed)
2139
-v display a status summary (delta) for each revision
2140
-p display a diff (patch) for each revision
2141
--show-ids display revision-ids (and file-ids), not just revnos
2143
Note that the default number of levels to display is a function of the
2144
log format. If the -n option is not used, the standard log formats show
2145
just the top level (mainline).
2147
Status summaries are shown using status flags like A, M, etc. To see
2148
the changes explained using words like ``added`` and ``modified``
2149
instead, use the -vv option.
2153
To display revisions from oldest to newest, use the --forward option.
2154
In most cases, using this option will have little impact on the total
2155
time taken to produce a log, though --forward does not incrementally
2156
display revisions like --reverse does when it can.
2158
:Revision filtering:
2160
The -r option can be used to specify what revision or range of revisions
2161
to filter against. The various forms are shown below::
2163
-rX display revision X
2164
-rX.. display revision X and later
2165
-r..Y display up to and including revision Y
2166
-rX..Y display from X to Y inclusive
2168
See ``bzr help revisionspec`` for details on how to specify X and Y.
2169
Some common examples are given below::
2171
-r-1 show just the tip
2172
-r-10.. show the last 10 mainline revisions
2173
-rsubmit:.. show what's new on this branch
2174
-rancestor:path.. show changes since the common ancestor of this
2175
branch and the one at location path
2176
-rdate:yesterday.. show changes since yesterday
2178
When logging a range of revisions using -rX..Y, log starts at
2179
revision Y and searches back in history through the primary
2180
("left-hand") parents until it finds X. When logging just the
2181
top level (using -n1), an error is reported if X is not found
2182
along the way. If multi-level logging is used (-n0), X may be
2183
a nested merge revision and the log will be truncated accordingly.
2187
If parameters are given and the first one is not a branch, the log
2188
will be filtered to show only those revisions that changed the
2189
nominated files or directories.
2191
Filenames are interpreted within their historical context. To log a
2192
deleted file, specify a revision range so that the file existed at
2193
the end or start of the range.
2195
Historical context is also important when interpreting pathnames of
2196
renamed files/directories. Consider the following example:
2198
* revision 1: add tutorial.txt
2199
* revision 2: modify tutorial.txt
2200
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2204
* ``bzr log guide.txt`` will log the file added in revision 1
2206
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2208
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2209
the original file in revision 2.
2211
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2212
was no file called guide.txt in revision 2.
2214
Renames are always followed by log. By design, there is no need to
2215
explicitly ask for this (and no way to stop logging a file back
2216
until it was last renamed).
2220
The --message option can be used for finding revisions that match a
2221
regular expression in a commit message.
2225
GUI tools and IDEs are often better at exploring history than command
2226
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2227
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2228
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2229
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2231
You may find it useful to add the aliases below to ``bazaar.conf``::
2235
top = log -l10 --line
2238
``bzr tip`` will then show the latest revision while ``bzr top``
2239
will show the last 10 mainline revisions. To see the details of a
2240
particular revision X, ``bzr show -rX``.
2242
If you are interested in looking deeper into a particular merge X,
2243
use ``bzr log -n0 -rX``.
2245
``bzr log -v`` on a branch with lots of history is currently
2246
very slow. A fix for this issue is currently under development.
2247
With or without that fix, it is recommended that a revision range
2248
be given when using the -v option.
2250
bzr has a generic full-text matching plugin, bzr-search, that can be
2251
used to find revisions matching user names, commit messages, etc.
2252
Among other features, this plugin can find all revisions containing
2253
a list of words but not others.
2255
When exploring non-mainline history on large projects with deep
2256
history, the performance of log can be greatly improved by installing
2257
the historycache plugin. This plugin buffers historical information
2258
trading disk space for faster speed.
2260
takes_args = ['file*']
2261
_see_also = ['log-formats', 'revisionspec']
2264
help='Show from oldest to newest.'),
2266
custom_help('verbose',
2267
help='Show files changed in each revision.'),
2271
type=bzrlib.option._parse_revision_str,
2273
help='Show just the specified revision.'
2274
' See also "help revisionspec".'),
2278
help='Number of levels to display - 0 for all, 1 for flat.',
2280
type=_parse_levels),
2283
help='Show revisions whose message matches this '
2284
'regular expression.',
2288
help='Limit the output to the first N revisions.',
2293
help='Show changes made in each revision as a patch.'),
2294
Option('include-merges',
2295
help='Show merged revisions like --levels 0 does.'),
2297
encoding_type = 'replace'
2300
def run(self, file_list=None, timezone='original',
2311
include_merges=False):
2312
from bzrlib.log import (
2314
make_log_request_dict,
2315
_get_info_for_log_files,
2317
direction = (forward and 'forward') or 'reverse'
2322
raise errors.BzrCommandError(
2323
'--levels and --include-merges are mutually exclusive')
2325
if change is not None:
2327
raise errors.RangeInChangeOption()
2328
if revision is not None:
2329
raise errors.BzrCommandError(
2330
'--revision and --change are mutually exclusive')
2335
filter_by_dir = False
2337
# find the file ids to log and check for directory filtering
2338
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2339
revision, file_list)
2340
self.add_cleanup(b.unlock)
2341
for relpath, file_id, kind in file_info_list:
2343
raise errors.BzrCommandError(
2344
"Path unknown at end or start of revision range: %s" %
2346
# If the relpath is the top of the tree, we log everything
2351
file_ids.append(file_id)
2352
filter_by_dir = filter_by_dir or (
2353
kind in ['directory', 'tree-reference'])
2356
# FIXME ? log the current subdir only RBC 20060203
2357
if revision is not None \
2358
and len(revision) > 0 and revision[0].get_branch():
2359
location = revision[0].get_branch()
2362
dir, relpath = bzrdir.BzrDir.open_containing(location)
2363
b = dir.open_branch()
2365
self.add_cleanup(b.unlock)
2366
rev1, rev2 = _get_revision_range(revision, b, self.name())
2368
# Decide on the type of delta & diff filtering to use
2369
# TODO: add an --all-files option to make this configurable & consistent
2377
diff_type = 'partial'
2381
# Build the log formatter
2382
if log_format is None:
2383
log_format = log.log_formatter_registry.get_default(b)
2384
# Make a non-encoding output to include the diffs - bug 328007
2385
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2386
lf = log_format(show_ids=show_ids, to_file=self.outf,
2387
to_exact_file=unencoded_output,
2388
show_timezone=timezone,
2389
delta_format=get_verbosity_level(),
2391
show_advice=levels is None)
2393
# Choose the algorithm for doing the logging. It's annoying
2394
# having multiple code paths like this but necessary until
2395
# the underlying repository format is faster at generating
2396
# deltas or can provide everything we need from the indices.
2397
# The default algorithm - match-using-deltas - works for
2398
# multiple files and directories and is faster for small
2399
# amounts of history (200 revisions say). However, it's too
2400
# slow for logging a single file in a repository with deep
2401
# history, i.e. > 10K revisions. In the spirit of "do no
2402
# evil when adding features", we continue to use the
2403
# original algorithm - per-file-graph - for the "single
2404
# file that isn't a directory without showing a delta" case.
2405
partial_history = revision and b.repository._format.supports_chks
2406
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2407
or delta_type or partial_history)
2409
# Build the LogRequest and execute it
2410
if len(file_ids) == 0:
2412
rqst = make_log_request_dict(
2413
direction=direction, specific_fileids=file_ids,
2414
start_revision=rev1, end_revision=rev2, limit=limit,
2415
message_search=message, delta_type=delta_type,
2416
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2417
Logger(b, rqst).show(lf)
2420
def _get_revision_range(revisionspec_list, branch, command_name):
2421
"""Take the input of a revision option and turn it into a revision range.
2423
It returns RevisionInfo objects which can be used to obtain the rev_id's
2424
of the desired revisions. It does some user input validations.
2426
if revisionspec_list is None:
2429
elif len(revisionspec_list) == 1:
2430
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2431
elif len(revisionspec_list) == 2:
2432
start_spec = revisionspec_list[0]
2433
end_spec = revisionspec_list[1]
2434
if end_spec.get_branch() != start_spec.get_branch():
2435
# b is taken from revision[0].get_branch(), and
2436
# show_log will use its revision_history. Having
2437
# different branches will lead to weird behaviors.
2438
raise errors.BzrCommandError(
2439
"bzr %s doesn't accept two revisions in different"
2440
" branches." % command_name)
2441
if start_spec.spec is None:
2442
# Avoid loading all the history.
2443
rev1 = RevisionInfo(branch, None, None)
2445
rev1 = start_spec.in_history(branch)
2446
# Avoid loading all of history when we know a missing
2447
# end of range means the last revision ...
2448
if end_spec.spec is None:
2449
last_revno, last_revision_id = branch.last_revision_info()
2450
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2452
rev2 = end_spec.in_history(branch)
2454
raise errors.BzrCommandError(
2455
'bzr %s --revision takes one or two values.' % command_name)
2459
def _revision_range_to_revid_range(revision_range):
2462
if revision_range[0] is not None:
2463
rev_id1 = revision_range[0].rev_id
2464
if revision_range[1] is not None:
2465
rev_id2 = revision_range[1].rev_id
2466
return rev_id1, rev_id2
2468
def get_log_format(long=False, short=False, line=False, default='long'):
2469
log_format = default
2473
log_format = 'short'
2479
class cmd_touching_revisions(Command):
2480
"""Return revision-ids which affected a particular file.
2482
A more user-friendly interface is "bzr log FILE".
2486
takes_args = ["filename"]
2489
def run(self, filename):
2490
tree, relpath = WorkingTree.open_containing(filename)
2491
file_id = tree.path2id(relpath)
2494
self.add_cleanup(b.unlock)
2495
touching_revs = log.find_touching_revisions(b, file_id)
2496
for revno, revision_id, what in touching_revs:
2497
self.outf.write("%6d %s\n" % (revno, what))
2500
class cmd_ls(Command):
2501
"""List files in a tree.
2504
_see_also = ['status', 'cat']
2505
takes_args = ['path?']
2509
Option('recursive', short_name='R',
2510
help='Recurse into subdirectories.'),
2512
help='Print paths relative to the root of the branch.'),
2513
Option('unknown', help='Print unknown files.'),
2514
Option('versioned', help='Print versioned files.',
2516
Option('ignored', help='Print ignored files.'),
2518
help='Write an ascii NUL (\\0) separator '
2519
'between files rather than a newline.'),
2521
help='List entries of a particular kind: file, directory, symlink.',
2526
def run(self, revision=None, verbose=False,
2527
recursive=False, from_root=False,
2528
unknown=False, versioned=False, ignored=False,
2529
null=False, kind=None, show_ids=False, path=None):
2531
if kind and kind not in ('file', 'directory', 'symlink'):
2532
raise errors.BzrCommandError('invalid kind specified')
2534
if verbose and null:
2535
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2536
all = not (unknown or versioned or ignored)
2538
selection = {'I':ignored, '?':unknown, 'V':versioned}
2544
raise errors.BzrCommandError('cannot specify both --from-root'
2547
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2550
# Calculate the prefix to use
2554
prefix = relpath + '/'
2555
elif fs_path != '.' and not fs_path.endswith('/'):
2556
prefix = fs_path + '/'
2558
if revision is not None or tree is None:
2559
tree = _get_one_revision_tree('ls', revision, branch=branch)
2562
if isinstance(tree, WorkingTree) and tree.supports_views():
2563
view_files = tree.views.lookup_view()
2566
view_str = views.view_display_str(view_files)
2567
note("Ignoring files outside view. View is %s" % view_str)
2570
self.add_cleanup(tree.unlock)
2571
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2572
from_dir=relpath, recursive=recursive):
2573
# Apply additional masking
2574
if not all and not selection[fc]:
2576
if kind is not None and fkind != kind:
2581
fullpath = osutils.pathjoin(relpath, fp)
2584
views.check_path_in_view(tree, fullpath)
2585
except errors.FileOutsideView:
2590
fp = osutils.pathjoin(prefix, fp)
2591
kindch = entry.kind_character()
2592
outstring = fp + kindch
2593
ui.ui_factory.clear_term()
2595
outstring = '%-8s %s' % (fc, outstring)
2596
if show_ids and fid is not None:
2597
outstring = "%-50s %s" % (outstring, fid)
2598
self.outf.write(outstring + '\n')
2600
self.outf.write(fp + '\0')
2603
self.outf.write(fid)
2604
self.outf.write('\0')
2612
self.outf.write('%-50s %s\n' % (outstring, my_id))
2614
self.outf.write(outstring + '\n')
2617
class cmd_unknowns(Command):
2618
"""List unknown files.
2626
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2627
self.outf.write(osutils.quotefn(f) + '\n')
2630
class cmd_ignore(Command):
2631
"""Ignore specified files or patterns.
2633
See ``bzr help patterns`` for details on the syntax of patterns.
2635
If a .bzrignore file does not exist, the ignore command
2636
will create one and add the specified files or patterns to the newly
2637
created file. The ignore command will also automatically add the
2638
.bzrignore file to be versioned. Creating a .bzrignore file without
2639
the use of the ignore command will require an explicit add command.
2641
To remove patterns from the ignore list, edit the .bzrignore file.
2642
After adding, editing or deleting that file either indirectly by
2643
using this command or directly by using an editor, be sure to commit
2646
Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
precedence over regular ignores. Such exceptions are used to specify
2648
files that should be versioned which would otherwise be ignored.
2650
Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
precedence over the '!' exception patterns.
2653
Note: ignore patterns containing shell wildcards must be quoted from
2657
Ignore the top level Makefile::
2659
bzr ignore ./Makefile
2661
Ignore .class files in all directories...::
2663
bzr ignore "*.class"
2665
...but do not ignore "special.class"::
2667
bzr ignore "!special.class"
2669
Ignore .o files under the lib directory::
2671
bzr ignore "lib/**/*.o"
2673
Ignore .o files under the lib directory::
2675
bzr ignore "RE:lib/.*\.o"
2677
Ignore everything but the "debian" toplevel directory::
2679
bzr ignore "RE:(?!debian/).*"
2681
Ignore everything except the "local" toplevel directory,
2682
but always ignore "*~" autosave files, even under local/::
2685
bzr ignore "!./local"
2689
_see_also = ['status', 'ignored', 'patterns']
2690
takes_args = ['name_pattern*']
2692
Option('old-default-rules',
2693
help='Write out the ignore rules bzr < 0.9 always used.')
2696
def run(self, name_pattern_list=None, old_default_rules=None):
2697
from bzrlib import ignores
2698
if old_default_rules is not None:
2699
# dump the rules and exit
2700
for pattern in ignores.OLD_DEFAULTS:
2701
self.outf.write("%s\n" % pattern)
2703
if not name_pattern_list:
2704
raise errors.BzrCommandError("ignore requires at least one "
2705
"NAME_PATTERN or --old-default-rules")
2706
name_pattern_list = [globbing.normalize_pattern(p)
2707
for p in name_pattern_list]
2708
for name_pattern in name_pattern_list:
2709
if (name_pattern[0] == '/' or
2710
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2711
raise errors.BzrCommandError(
2712
"NAME_PATTERN should not be an absolute path")
2713
tree, relpath = WorkingTree.open_containing(u'.')
2714
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2715
ignored = globbing.Globster(name_pattern_list)
2718
for entry in tree.list_files():
2722
if ignored.match(filename):
2723
matches.append(filename)
2725
if len(matches) > 0:
2726
self.outf.write("Warning: the following files are version controlled and"
2727
" match your ignore pattern:\n%s"
2728
"\nThese files will continue to be version controlled"
2729
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2732
class cmd_ignored(Command):
2733
"""List ignored files and the patterns that matched them.
2735
List all the ignored files and the ignore pattern that caused the file to
2738
Alternatively, to list just the files::
2743
encoding_type = 'replace'
2744
_see_also = ['ignore', 'ls']
2748
tree = WorkingTree.open_containing(u'.')[0]
2750
self.add_cleanup(tree.unlock)
2751
for path, file_class, kind, file_id, entry in tree.list_files():
2752
if file_class != 'I':
2754
## XXX: Slightly inefficient since this was already calculated
2755
pat = tree.is_ignored(path)
2756
self.outf.write('%-50s %s\n' % (path, pat))
2759
class cmd_lookup_revision(Command):
2760
"""Lookup the revision-id from a revision-number
2763
bzr lookup-revision 33
2766
takes_args = ['revno']
2769
def run(self, revno):
2773
raise errors.BzrCommandError("not a valid revision-number: %r"
2775
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2776
self.outf.write("%s\n" % revid)
2779
class cmd_export(Command):
2780
"""Export current or past revision to a destination directory or archive.
2782
If no revision is specified this exports the last committed revision.
2784
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2785
given, try to find the format with the extension. If no extension
2786
is found exports to a directory (equivalent to --format=dir).
2788
If root is supplied, it will be used as the root directory inside
2789
container formats (tar, zip, etc). If it is not supplied it will default
2790
to the exported filename. The root option has no effect for 'dir' format.
2792
If branch is omitted then the branch containing the current working
2793
directory will be used.
2795
Note: Export of tree with non-ASCII filenames to zip is not supported.
2797
================= =========================
2798
Supported formats Autodetected by extension
2799
================= =========================
2802
tbz2 .tar.bz2, .tbz2
2805
================= =========================
2807
takes_args = ['dest', 'branch_or_subdir?']
2810
help="Type of file to export to.",
2813
Option('filters', help='Apply content filters to export the '
2814
'convenient form.'),
2817
help="Name of the root directory inside the exported file."),
2818
Option('per-file-timestamps',
2819
help='Set modification time of files to that of the last '
2820
'revision in which it was changed.'),
2822
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2823
root=None, filters=False, per_file_timestamps=False):
2824
from bzrlib.export import export
2826
if branch_or_subdir is None:
2827
tree = WorkingTree.open_containing(u'.')[0]
2831
b, subdir = Branch.open_containing(branch_or_subdir)
2834
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2836
export(rev_tree, dest, format, root, subdir, filtered=filters,
2837
per_file_timestamps=per_file_timestamps)
2838
except errors.NoSuchExportFormat, e:
2839
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2842
class cmd_cat(Command):
2843
"""Write the contents of a file as of a given revision to standard output.
2845
If no revision is nominated, the last revision is used.
2847
Note: Take care to redirect standard output when using this command on a
2853
Option('name-from-revision', help='The path name in the old tree.'),
2854
Option('filters', help='Apply content filters to display the '
2855
'convenience form.'),
2858
takes_args = ['filename']
2859
encoding_type = 'exact'
2862
def run(self, filename, revision=None, name_from_revision=False,
2864
if revision is not None and len(revision) != 1:
2865
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2866
" one revision specifier")
2867
tree, branch, relpath = \
2868
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2870
self.add_cleanup(branch.unlock)
2871
return self._run(tree, branch, relpath, filename, revision,
2872
name_from_revision, filters)
2874
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2877
tree = b.basis_tree()
2878
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2879
rev_tree.lock_read()
2880
self.add_cleanup(rev_tree.unlock)
2882
old_file_id = rev_tree.path2id(relpath)
2884
if name_from_revision:
2885
# Try in revision if requested
2886
if old_file_id is None:
2887
raise errors.BzrCommandError(
2888
"%r is not present in revision %s" % (
2889
filename, rev_tree.get_revision_id()))
2891
content = rev_tree.get_file_text(old_file_id)
2893
cur_file_id = tree.path2id(relpath)
2895
if cur_file_id is not None:
2896
# Then try with the actual file id
2898
content = rev_tree.get_file_text(cur_file_id)
2900
except errors.NoSuchId:
2901
# The actual file id didn't exist at that time
2903
if not found and old_file_id is not None:
2904
# Finally try with the old file id
2905
content = rev_tree.get_file_text(old_file_id)
2908
# Can't be found anywhere
2909
raise errors.BzrCommandError(
2910
"%r is not present in revision %s" % (
2911
filename, rev_tree.get_revision_id()))
2913
from bzrlib.filters import (
2914
ContentFilterContext,
2915
filtered_output_bytes,
2917
filters = rev_tree._content_filter_stack(relpath)
2918
chunks = content.splitlines(True)
2919
content = filtered_output_bytes(chunks, filters,
2920
ContentFilterContext(relpath, rev_tree))
2922
self.outf.writelines(content)
2925
self.outf.write(content)
2928
class cmd_local_time_offset(Command):
2929
"""Show the offset in seconds from GMT to local time."""
2933
self.outf.write("%s\n" % osutils.local_time_offset())
2937
class cmd_commit(Command):
2938
"""Commit changes into a new revision.
2940
An explanatory message needs to be given for each commit. This is
2941
often done by using the --message option (getting the message from the
2942
command line) or by using the --file option (getting the message from
2943
a file). If neither of these options is given, an editor is opened for
2944
the user to enter the message. To see the changed files in the
2945
boilerplate text loaded into the editor, use the --show-diff option.
2947
By default, the entire tree is committed and the person doing the
2948
commit is assumed to be the author. These defaults can be overridden
2953
If selected files are specified, only changes to those files are
2954
committed. If a directory is specified then the directory and
2955
everything within it is committed.
2957
When excludes are given, they take precedence over selected files.
2958
For example, to commit only changes within foo, but not changes
2961
bzr commit foo -x foo/bar
2963
A selective commit after a merge is not yet supported.
2967
If the author of the change is not the same person as the committer,
2968
you can specify the author's name using the --author option. The
2969
name should be in the same format as a committer-id, e.g.
2970
"John Doe <jdoe@example.com>". If there is more than one author of
2971
the change you can specify the option multiple times, once for each
2976
A common mistake is to forget to add a new file or directory before
2977
running the commit command. The --strict option checks for unknown
2978
files and aborts the commit if any are found. More advanced pre-commit
2979
checks can be implemented by defining hooks. See ``bzr help hooks``
2984
If you accidentially commit the wrong changes or make a spelling
2985
mistake in the commit message say, you can use the uncommit command
2986
to undo it. See ``bzr help uncommit`` for details.
2988
Hooks can also be configured to run after a commit. This allows you
2989
to trigger updates to external systems like bug trackers. The --fixes
2990
option can be used to record the association between a revision and
2991
one or more bugs. See ``bzr help bugs`` for details.
2993
A selective commit may fail in some cases where the committed
2994
tree would be invalid. Consider::
2999
bzr commit foo -m "committing foo"
3000
bzr mv foo/bar foo/baz
3003
bzr commit foo/bar -m "committing bar but not baz"
3005
In the example above, the last commit will fail by design. This gives
3006
the user the opportunity to decide whether they want to commit the
3007
rename at the same time, separately first, or not at all. (As a general
3008
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3010
# TODO: Run hooks on tree to-be-committed, and after commit.
3012
# TODO: Strict commit that fails if there are deleted files.
3013
# (what does "deleted files" mean ??)
3015
# TODO: Give better message for -s, --summary, used by tla people
3017
# XXX: verbose currently does nothing
3019
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3020
takes_args = ['selected*']
3022
ListOption('exclude', type=str, short_name='x',
3023
help="Do not consider changes made to a given path."),
3024
Option('message', type=unicode,
3026
help="Description of the new revision."),
3029
help='Commit even if nothing has changed.'),
3030
Option('file', type=str,
3033
help='Take commit message from this file.'),
3035
help="Refuse to commit if there are unknown "
3036
"files in the working tree."),
3037
Option('commit-time', type=str,
3038
help="Manually set a commit time using commit date "
3039
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3040
ListOption('fixes', type=str,
3041
help="Mark a bug as being fixed by this revision "
3042
"(see \"bzr help bugs\")."),
3043
ListOption('author', type=unicode,
3044
help="Set the author's name, if it's different "
3045
"from the committer."),
3047
help="Perform a local commit in a bound "
3048
"branch. Local commits are not pushed to "
3049
"the master branch until a normal commit "
3053
help='When no message is supplied, show the diff along'
3054
' with the status summary in the message editor.'),
3056
aliases = ['ci', 'checkin']
3058
def _iter_bug_fix_urls(self, fixes, branch):
3059
# Configure the properties for bug fixing attributes.
3060
for fixed_bug in fixes:
3061
tokens = fixed_bug.split(':')
3062
if len(tokens) != 2:
3063
raise errors.BzrCommandError(
3064
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3065
"See \"bzr help bugs\" for more information on this "
3066
"feature.\nCommit refused." % fixed_bug)
3067
tag, bug_id = tokens
3069
yield bugtracker.get_bug_url(tag, branch, bug_id)
3070
except errors.UnknownBugTrackerAbbreviation:
3071
raise errors.BzrCommandError(
3072
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3073
except errors.MalformedBugIdentifier, e:
3074
raise errors.BzrCommandError(
3075
"%s\nCommit refused." % (str(e),))
3077
def run(self, message=None, file=None, verbose=False, selected_list=None,
3078
unchanged=False, strict=False, local=False, fixes=None,
3079
author=None, show_diff=False, exclude=None, commit_time=None):
3080
from bzrlib.errors import (
3085
from bzrlib.msgeditor import (
3086
edit_commit_message_encoded,
3087
generate_commit_message_template,
3088
make_commit_message_template_encoded
3091
commit_stamp = offset = None
3092
if commit_time is not None:
3094
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3095
except ValueError, e:
3096
raise errors.BzrCommandError(
3097
"Could not parse --commit-time: " + str(e))
3099
# TODO: Need a blackbox test for invoking the external editor; may be
3100
# slightly problematic to run this cross-platform.
3102
# TODO: do more checks that the commit will succeed before
3103
# spending the user's valuable time typing a commit message.
3107
tree, selected_list = tree_files(selected_list)
3108
if selected_list == ['']:
3109
# workaround - commit of root of tree should be exactly the same
3110
# as just default commit in that tree, and succeed even though
3111
# selected-file merge commit is not done yet
3116
bug_property = bugtracker.encode_fixes_bug_urls(
3117
self._iter_bug_fix_urls(fixes, tree.branch))
3119
properties['bugs'] = bug_property
3121
if local and not tree.branch.get_bound_location():
3122
raise errors.LocalRequiresBoundBranch()
3124
if message is not None:
3126
file_exists = osutils.lexists(message)
3127
except UnicodeError:
3128
# The commit message contains unicode characters that can't be
3129
# represented in the filesystem encoding, so that can't be a
3134
'The commit message is a file name: "%(f)s".\n'
3135
'(use --file "%(f)s" to take commit message from that file)'
3137
ui.ui_factory.show_warning(warning_msg)
3139
def get_message(commit_obj):
3140
"""Callback to get commit message"""
3141
my_message = message
3142
if my_message is not None and '\r' in my_message:
3143
my_message = my_message.replace('\r\n', '\n')
3144
my_message = my_message.replace('\r', '\n')
3145
if my_message is None and not file:
3146
t = make_commit_message_template_encoded(tree,
3147
selected_list, diff=show_diff,
3148
output_encoding=osutils.get_user_encoding())
3149
start_message = generate_commit_message_template(commit_obj)
3150
my_message = edit_commit_message_encoded(t,
3151
start_message=start_message)
3152
if my_message is None:
3153
raise errors.BzrCommandError("please specify a commit"
3154
" message with either --message or --file")
3155
elif my_message and file:
3156
raise errors.BzrCommandError(
3157
"please specify either --message or --file")
3159
my_message = codecs.open(file, 'rt',
3160
osutils.get_user_encoding()).read()
3161
if my_message == "":
3162
raise errors.BzrCommandError("empty commit message specified")
3165
# The API permits a commit with a filter of [] to mean 'select nothing'
3166
# but the command line should not do that.
3167
if not selected_list:
3168
selected_list = None
3170
tree.commit(message_callback=get_message,
3171
specific_files=selected_list,
3172
allow_pointless=unchanged, strict=strict, local=local,
3173
reporter=None, verbose=verbose, revprops=properties,
3174
authors=author, timestamp=commit_stamp,
3176
exclude=safe_relpath_files(tree, exclude))
3177
except PointlessCommit:
3178
# FIXME: This should really happen before the file is read in;
3179
# perhaps prepare the commit; get the message; then actually commit
3180
raise errors.BzrCommandError("No changes to commit."
3181
" Use --unchanged to commit anyhow.")
3182
except ConflictsInTree:
3183
raise errors.BzrCommandError('Conflicts detected in working '
3184
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3186
except StrictCommitFailed:
3187
raise errors.BzrCommandError("Commit refused because there are"
3188
" unknown files in the working tree.")
3189
except errors.BoundBranchOutOfDate, e:
3190
e.extra_help = ("\n"
3191
'To commit to master branch, run update and then commit.\n'
3192
'You can also pass --local to commit to continue working '
3197
class cmd_check(Command):
3198
"""Validate working tree structure, branch consistency and repository history.
3200
This command checks various invariants about branch and repository storage
3201
to detect data corruption or bzr bugs.
3203
The working tree and branch checks will only give output if a problem is
3204
detected. The output fields of the repository check are:
3207
This is just the number of revisions checked. It doesn't
3211
This is just the number of versionedfiles checked. It
3212
doesn't indicate a problem.
3214
unreferenced ancestors
3215
Texts that are ancestors of other texts, but
3216
are not properly referenced by the revision ancestry. This is a
3217
subtle problem that Bazaar can work around.
3220
This is the total number of unique file contents
3221
seen in the checked revisions. It does not indicate a problem.
3224
This is the total number of repeated texts seen
3225
in the checked revisions. Texts can be repeated when their file
3226
entries are modified, but the file contents are not. It does not
3229
If no restrictions are specified, all Bazaar data that is found at the given
3230
location will be checked.
3234
Check the tree and branch at 'foo'::
3236
bzr check --tree --branch foo
3238
Check only the repository at 'bar'::
3240
bzr check --repo bar
3242
Check everything at 'baz'::
3247
_see_also = ['reconcile']
3248
takes_args = ['path?']
3249
takes_options = ['verbose',
3250
Option('branch', help="Check the branch related to the"
3251
" current directory."),
3252
Option('repo', help="Check the repository related to the"
3253
" current directory."),
3254
Option('tree', help="Check the working tree related to"
3255
" the current directory.")]
3257
def run(self, path=None, verbose=False, branch=False, repo=False,
3259
from bzrlib.check import check_dwim
3262
if not branch and not repo and not tree:
3263
branch = repo = tree = True
3264
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3267
class cmd_upgrade(Command):
3268
"""Upgrade branch storage to current format.
3270
The check command or bzr developers may sometimes advise you to run
3271
this command. When the default format has changed you may also be warned
3272
during other operations to upgrade.
3275
_see_also = ['check']
3276
takes_args = ['url?']
3278
RegistryOption('format',
3279
help='Upgrade to a specific format. See "bzr help'
3280
' formats" for details.',
3281
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3282
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3283
value_switches=True, title='Branch format'),
3286
def run(self, url='.', format=None):
3287
from bzrlib.upgrade import upgrade
3288
upgrade(url, format)
3291
class cmd_whoami(Command):
3292
"""Show or set bzr user id.
3295
Show the email of the current user::
3299
Set the current user::
3301
bzr whoami "Frank Chu <fchu@example.com>"
3303
takes_options = [ Option('email',
3304
help='Display email address only.'),
3306
help='Set identity for the current branch instead of '
3309
takes_args = ['name?']
3310
encoding_type = 'replace'
3313
def run(self, email=False, branch=False, name=None):
3315
# use branch if we're inside one; otherwise global config
3317
c = Branch.open_containing('.')[0].get_config()
3318
except errors.NotBranchError:
3319
c = config.GlobalConfig()
3321
self.outf.write(c.user_email() + '\n')
3323
self.outf.write(c.username() + '\n')
3326
# display a warning if an email address isn't included in the given name.
3328
config.extract_email_address(name)
3329
except errors.NoEmailInUsername, e:
3330
warning('"%s" does not seem to contain an email address. '
3331
'This is allowed, but not recommended.', name)
3333
# use global config unless --branch given
3335
c = Branch.open_containing('.')[0].get_config()
3337
c = config.GlobalConfig()
3338
c.set_user_option('email', name)
3341
class cmd_nick(Command):
3342
"""Print or set the branch nickname.
3344
If unset, the tree root directory name is used as the nickname.
3345
To print the current nickname, execute with no argument.
3347
Bound branches use the nickname of its master branch unless it is set
3351
_see_also = ['info']
3352
takes_args = ['nickname?']
3353
def run(self, nickname=None):
3354
branch = Branch.open_containing(u'.')[0]
3355
if nickname is None:
3356
self.printme(branch)
3358
branch.nick = nickname
3361
def printme(self, branch):
3362
self.outf.write('%s\n' % branch.nick)
3365
class cmd_alias(Command):
3366
"""Set/unset and display aliases.
3369
Show the current aliases::
3373
Show the alias specified for 'll'::
3377
Set an alias for 'll'::
3379
bzr alias ll="log --line -r-10..-1"
3381
To remove an alias for 'll'::
3383
bzr alias --remove ll
3386
takes_args = ['name?']
3388
Option('remove', help='Remove the alias.'),
3391
def run(self, name=None, remove=False):
3393
self.remove_alias(name)
3395
self.print_aliases()
3397
equal_pos = name.find('=')
3399
self.print_alias(name)
3401
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3403
def remove_alias(self, alias_name):
3404
if alias_name is None:
3405
raise errors.BzrCommandError(
3406
'bzr alias --remove expects an alias to remove.')
3407
# If alias is not found, print something like:
3408
# unalias: foo: not found
3409
c = config.GlobalConfig()
3410
c.unset_alias(alias_name)
3413
def print_aliases(self):
3414
"""Print out the defined aliases in a similar format to bash."""
3415
aliases = config.GlobalConfig().get_aliases()
3416
for key, value in sorted(aliases.iteritems()):
3417
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3420
def print_alias(self, alias_name):
3421
from bzrlib.commands import get_alias
3422
alias = get_alias(alias_name)
3424
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3427
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3429
def set_alias(self, alias_name, alias_command):
3430
"""Save the alias in the global config."""
3431
c = config.GlobalConfig()
3432
c.set_alias(alias_name, alias_command)
3435
class cmd_selftest(Command):
3436
"""Run internal test suite.
3438
If arguments are given, they are regular expressions that say which tests
3439
should run. Tests matching any expression are run, and other tests are
3442
Alternatively if --first is given, matching tests are run first and then
3443
all other tests are run. This is useful if you have been working in a
3444
particular area, but want to make sure nothing else was broken.
3446
If --exclude is given, tests that match that regular expression are
3447
excluded, regardless of whether they match --first or not.
3449
To help catch accidential dependencies between tests, the --randomize
3450
option is useful. In most cases, the argument used is the word 'now'.
3451
Note that the seed used for the random number generator is displayed
3452
when this option is used. The seed can be explicitly passed as the
3453
argument to this option if required. This enables reproduction of the
3454
actual ordering used if and when an order sensitive problem is encountered.
3456
If --list-only is given, the tests that would be run are listed. This is
3457
useful when combined with --first, --exclude and/or --randomize to
3458
understand their impact. The test harness reports "Listed nn tests in ..."
3459
instead of "Ran nn tests in ..." when list mode is enabled.
3461
If the global option '--no-plugins' is given, plugins are not loaded
3462
before running the selftests. This has two effects: features provided or
3463
modified by plugins will not be tested, and tests provided by plugins will
3466
Tests that need working space on disk use a common temporary directory,
3467
typically inside $TMPDIR or /tmp.
3469
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3470
into a pdb postmortem session.
3473
Run only tests relating to 'ignore'::
3477
Disable plugins and list tests as they're run::
3479
bzr --no-plugins selftest -v
3481
# NB: this is used from the class without creating an instance, which is
3482
# why it does not have a self parameter.
3483
def get_transport_type(typestring):
3484
"""Parse and return a transport specifier."""
3485
if typestring == "sftp":
3486
from bzrlib.tests import stub_sftp
3487
return stub_sftp.SFTPAbsoluteServer
3488
if typestring == "memory":
3489
from bzrlib.tests import test_server
3490
return memory.MemoryServer
3491
if typestring == "fakenfs":
3492
from bzrlib.tests import test_server
3493
return test_server.FakeNFSServer
3494
msg = "No known transport type %s. Supported types are: sftp\n" %\
3496
raise errors.BzrCommandError(msg)
3499
takes_args = ['testspecs*']
3500
takes_options = ['verbose',
3502
help='Stop when one test fails.',
3506
help='Use a different transport by default '
3507
'throughout the test suite.',
3508
type=get_transport_type),
3510
help='Run the benchmarks rather than selftests.'),
3511
Option('lsprof-timed',
3512
help='Generate lsprof output for benchmarked'
3513
' sections of code.'),
3514
Option('lsprof-tests',
3515
help='Generate lsprof output for each test.'),
3516
Option('cache-dir', type=str,
3517
help='Cache intermediate benchmark output in this '
3520
help='Run all tests, but run specified tests first.',
3524
help='List the tests instead of running them.'),
3525
RegistryOption('parallel',
3526
help="Run the test suite in parallel.",
3527
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3528
value_switches=False,
3530
Option('randomize', type=str, argname="SEED",
3531
help='Randomize the order of tests using the given'
3532
' seed or "now" for the current time.'),
3533
Option('exclude', type=str, argname="PATTERN",
3535
help='Exclude tests that match this regular'
3538
help='Output test progress via subunit.'),
3539
Option('strict', help='Fail on missing dependencies or '
3541
Option('load-list', type=str, argname='TESTLISTFILE',
3542
help='Load a test id list from a text file.'),
3543
ListOption('debugflag', type=str, short_name='E',
3544
help='Turn on a selftest debug flag.'),
3545
ListOption('starting-with', type=str, argname='TESTID',
3546
param_name='starting_with', short_name='s',
3548
'Load only the tests starting with TESTID.'),
3550
encoding_type = 'replace'
3553
Command.__init__(self)
3554
self.additional_selftest_args = {}
3556
def run(self, testspecs_list=None, verbose=False, one=False,
3557
transport=None, benchmark=None,
3558
lsprof_timed=None, cache_dir=None,
3559
first=False, list_only=False,
3560
randomize=None, exclude=None, strict=False,
3561
load_list=None, debugflag=None, starting_with=None, subunit=False,
3562
parallel=None, lsprof_tests=False):
3563
from bzrlib.tests import selftest
3564
import bzrlib.benchmarks as benchmarks
3565
from bzrlib.benchmarks import tree_creator
3567
# Make deprecation warnings visible, unless -Werror is set
3568
symbol_versioning.activate_deprecation_warnings(override=False)
3570
if cache_dir is not None:
3571
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3572
if testspecs_list is not None:
3573
pattern = '|'.join(testspecs_list)
3578
from bzrlib.tests import SubUnitBzrRunner
3580
raise errors.BzrCommandError("subunit not available. subunit "
3581
"needs to be installed to use --subunit.")
3582
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3584
self.additional_selftest_args.setdefault(
3585
'suite_decorators', []).append(parallel)
3587
test_suite_factory = benchmarks.test_suite
3588
# Unless user explicitly asks for quiet, be verbose in benchmarks
3589
verbose = not is_quiet()
3590
# TODO: should possibly lock the history file...
3591
benchfile = open(".perf_history", "at", buffering=1)
3592
self.add_cleanup(benchfile.close)
3594
test_suite_factory = None
3596
selftest_kwargs = {"verbose": verbose,
3598
"stop_on_failure": one,
3599
"transport": transport,
3600
"test_suite_factory": test_suite_factory,
3601
"lsprof_timed": lsprof_timed,
3602
"lsprof_tests": lsprof_tests,
3603
"bench_history": benchfile,
3604
"matching_tests_first": first,
3605
"list_only": list_only,
3606
"random_seed": randomize,
3607
"exclude_pattern": exclude,
3609
"load_list": load_list,
3610
"debug_flags": debugflag,
3611
"starting_with": starting_with
3613
selftest_kwargs.update(self.additional_selftest_args)
3614
result = selftest(**selftest_kwargs)
3615
return int(not result)
3618
class cmd_version(Command):
3619
"""Show version of bzr."""
3621
encoding_type = 'replace'
3623
Option("short", help="Print just the version number."),
3627
def run(self, short=False):
3628
from bzrlib.version import show_version
3630
self.outf.write(bzrlib.version_string + '\n')
3632
show_version(to_file=self.outf)
3635
class cmd_rocks(Command):
3636
"""Statement of optimism."""
3642
self.outf.write("It sure does!\n")
3645
class cmd_find_merge_base(Command):
3646
"""Find and print a base revision for merging two branches."""
3647
# TODO: Options to specify revisions on either side, as if
3648
# merging only part of the history.
3649
takes_args = ['branch', 'other']
3653
def run(self, branch, other):
3654
from bzrlib.revision import ensure_null
3656
branch1 = Branch.open_containing(branch)[0]
3657
branch2 = Branch.open_containing(other)[0]
3659
self.add_cleanup(branch1.unlock)
3661
self.add_cleanup(branch2.unlock)
3662
last1 = ensure_null(branch1.last_revision())
3663
last2 = ensure_null(branch2.last_revision())
3665
graph = branch1.repository.get_graph(branch2.repository)
3666
base_rev_id = graph.find_unique_lca(last1, last2)
3668
self.outf.write('merge base is revision %s\n' % base_rev_id)
3671
class cmd_merge(Command):
3672
"""Perform a three-way merge.
3674
The source of the merge can be specified either in the form of a branch,
3675
or in the form of a path to a file containing a merge directive generated
3676
with bzr send. If neither is specified, the default is the upstream branch
3677
or the branch most recently merged using --remember.
3679
When merging a branch, by default the tip will be merged. To pick a different
3680
revision, pass --revision. If you specify two values, the first will be used as
3681
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3682
available revisions, like this is commonly referred to as "cherrypicking".
3684
Revision numbers are always relative to the branch being merged.
3686
By default, bzr will try to merge in all new work from the other
3687
branch, automatically determining an appropriate base. If this
3688
fails, you may need to give an explicit base.
3690
Merge will do its best to combine the changes in two branches, but there
3691
are some kinds of problems only a human can fix. When it encounters those,
3692
it will mark a conflict. A conflict means that you need to fix something,
3693
before you should commit.
3695
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3697
If there is no default branch set, the first merge will set it. After
3698
that, you can omit the branch to use the default. To change the
3699
default, use --remember. The value will only be saved if the remote
3700
location can be accessed.
3702
The results of the merge are placed into the destination working
3703
directory, where they can be reviewed (with bzr diff), tested, and then
3704
committed to record the result of the merge.
3706
merge refuses to run if there are any uncommitted changes, unless
3707
--force is given. The --force option can also be used to create a
3708
merge revision which has more than two parents.
3710
If one would like to merge changes from the working tree of the other
3711
branch without merging any committed revisions, the --uncommitted option
3714
To select only some changes to merge, use "merge -i", which will prompt
3715
you to apply each diff hunk and file change, similar to "shelve".
3718
To merge the latest revision from bzr.dev::
3720
bzr merge ../bzr.dev
3722
To merge changes up to and including revision 82 from bzr.dev::
3724
bzr merge -r 82 ../bzr.dev
3726
To merge the changes introduced by 82, without previous changes::
3728
bzr merge -r 81..82 ../bzr.dev
3730
To apply a merge directive contained in /tmp/merge::
3732
bzr merge /tmp/merge
3734
To create a merge revision with three parents from two branches
3735
feature1a and feature1b:
3737
bzr merge ../feature1a
3738
bzr merge ../feature1b --force
3739
bzr commit -m 'revision with three parents'
3742
encoding_type = 'exact'
3743
_see_also = ['update', 'remerge', 'status-flags', 'send']
3744
takes_args = ['location?']
3749
help='Merge even if the destination tree has uncommitted changes.'),
3753
Option('show-base', help="Show base revision text in "
3755
Option('uncommitted', help='Apply uncommitted changes'
3756
' from a working copy, instead of branch changes.'),
3757
Option('pull', help='If the destination is already'
3758
' completely merged into the source, pull from the'
3759
' source rather than merging. When this happens,'
3760
' you do not need to commit the result.'),
3762
help='Branch to merge into, '
3763
'rather than the one containing the working directory.',
3767
Option('preview', help='Instead of merging, show a diff of the'
3769
Option('interactive', help='Select changes interactively.',
3773
def run(self, location=None, revision=None, force=False,
3774
merge_type=None, show_base=False, reprocess=None, remember=False,
3775
uncommitted=False, pull=False,
3780
if merge_type is None:
3781
merge_type = _mod_merge.Merge3Merger
3783
if directory is None: directory = u'.'
3784
possible_transports = []
3786
allow_pending = True
3787
verified = 'inapplicable'
3788
tree = WorkingTree.open_containing(directory)[0]
3791
basis_tree = tree.revision_tree(tree.last_revision())
3792
except errors.NoSuchRevision:
3793
basis_tree = tree.basis_tree()
3795
# die as quickly as possible if there are uncommitted changes
3797
if tree.has_changes():
3798
raise errors.UncommittedChanges(tree)
3800
view_info = _get_view_info_for_change_reporter(tree)
3801
change_reporter = delta._ChangeReporter(
3802
unversioned_filter=tree.is_ignored, view_info=view_info)
3803
pb = ui.ui_factory.nested_progress_bar()
3804
self.add_cleanup(pb.finished)
3806
self.add_cleanup(tree.unlock)
3807
if location is not None:
3809
mergeable = bundle.read_mergeable_from_url(location,
3810
possible_transports=possible_transports)
3811
except errors.NotABundle:
3815
raise errors.BzrCommandError('Cannot use --uncommitted'
3816
' with bundles or merge directives.')
3818
if revision is not None:
3819
raise errors.BzrCommandError(
3820
'Cannot use -r with merge directives or bundles')
3821
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3824
if merger is None and uncommitted:
3825
if revision is not None and len(revision) > 0:
3826
raise errors.BzrCommandError('Cannot use --uncommitted and'
3827
' --revision at the same time.')
3828
merger = self.get_merger_from_uncommitted(tree, location, None)
3829
allow_pending = False
3832
merger, allow_pending = self._get_merger_from_branch(tree,
3833
location, revision, remember, possible_transports, None)
3835
merger.merge_type = merge_type
3836
merger.reprocess = reprocess
3837
merger.show_base = show_base
3838
self.sanity_check_merger(merger)
3839
if (merger.base_rev_id == merger.other_rev_id and
3840
merger.other_rev_id is not None):
3841
note('Nothing to do.')
3844
if merger.interesting_files is not None:
3845
raise errors.BzrCommandError('Cannot pull individual files')
3846
if (merger.base_rev_id == tree.last_revision()):
3847
result = tree.pull(merger.other_branch, False,
3848
merger.other_rev_id)
3849
result.report(self.outf)
3851
if merger.this_basis is None:
3852
raise errors.BzrCommandError(
3853
"This branch has no commits."
3854
" (perhaps you would prefer 'bzr pull')")
3856
return self._do_preview(merger)
3858
return self._do_interactive(merger)
3860
return self._do_merge(merger, change_reporter, allow_pending,
3863
def _get_preview(self, merger):
3864
tree_merger = merger.make_merger()
3865
tt = tree_merger.make_preview_transform()
3866
self.add_cleanup(tt.finalize)
3867
result_tree = tt.get_preview_tree()
3870
def _do_preview(self, merger):
3871
from bzrlib.diff import show_diff_trees
3872
result_tree = self._get_preview(merger)
3873
show_diff_trees(merger.this_tree, result_tree, self.outf,
3874
old_label='', new_label='')
3876
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3877
merger.change_reporter = change_reporter
3878
conflict_count = merger.do_merge()
3880
merger.set_pending()
3881
if verified == 'failed':
3882
warning('Preview patch does not match changes')
3883
if conflict_count != 0:
3888
def _do_interactive(self, merger):
3889
"""Perform an interactive merge.
3891
This works by generating a preview tree of the merge, then using
3892
Shelver to selectively remove the differences between the working tree
3893
and the preview tree.
3895
from bzrlib import shelf_ui
3896
result_tree = self._get_preview(merger)
3897
writer = bzrlib.option.diff_writer_registry.get()
3898
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3899
reporter=shelf_ui.ApplyReporter(),
3900
diff_writer=writer(sys.stdout))
3906
def sanity_check_merger(self, merger):
3907
if (merger.show_base and
3908
not merger.merge_type is _mod_merge.Merge3Merger):
3909
raise errors.BzrCommandError("Show-base is not supported for this"
3910
" merge type. %s" % merger.merge_type)
3911
if merger.reprocess is None:
3912
if merger.show_base:
3913
merger.reprocess = False
3915
# Use reprocess if the merger supports it
3916
merger.reprocess = merger.merge_type.supports_reprocess
3917
if merger.reprocess and not merger.merge_type.supports_reprocess:
3918
raise errors.BzrCommandError("Conflict reduction is not supported"
3919
" for merge type %s." %
3921
if merger.reprocess and merger.show_base:
3922
raise errors.BzrCommandError("Cannot do conflict reduction and"
3925
def _get_merger_from_branch(self, tree, location, revision, remember,
3926
possible_transports, pb):
3927
"""Produce a merger from a location, assuming it refers to a branch."""
3928
from bzrlib.tag import _merge_tags_if_possible
3929
# find the branch locations
3930
other_loc, user_location = self._select_branch_location(tree, location,
3932
if revision is not None and len(revision) == 2:
3933
base_loc, _unused = self._select_branch_location(tree,
3934
location, revision, 0)
3936
base_loc = other_loc
3938
other_branch, other_path = Branch.open_containing(other_loc,
3939
possible_transports)
3940
if base_loc == other_loc:
3941
base_branch = other_branch
3943
base_branch, base_path = Branch.open_containing(base_loc,
3944
possible_transports)
3945
# Find the revision ids
3946
other_revision_id = None
3947
base_revision_id = None
3948
if revision is not None:
3949
if len(revision) >= 1:
3950
other_revision_id = revision[-1].as_revision_id(other_branch)
3951
if len(revision) == 2:
3952
base_revision_id = revision[0].as_revision_id(base_branch)
3953
if other_revision_id is None:
3954
other_revision_id = _mod_revision.ensure_null(
3955
other_branch.last_revision())
3956
# Remember where we merge from
3957
if ((remember or tree.branch.get_submit_branch() is None) and
3958
user_location is not None):
3959
tree.branch.set_submit_branch(other_branch.base)
3960
_merge_tags_if_possible(other_branch, tree.branch)
3961
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3962
other_revision_id, base_revision_id, other_branch, base_branch)
3963
if other_path != '':
3964
allow_pending = False
3965
merger.interesting_files = [other_path]
3967
allow_pending = True
3968
return merger, allow_pending
3970
def get_merger_from_uncommitted(self, tree, location, pb):
3971
"""Get a merger for uncommitted changes.
3973
:param tree: The tree the merger should apply to.
3974
:param location: The location containing uncommitted changes.
3975
:param pb: The progress bar to use for showing progress.
3977
location = self._select_branch_location(tree, location)[0]
3978
other_tree, other_path = WorkingTree.open_containing(location)
3979
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3980
if other_path != '':
3981
merger.interesting_files = [other_path]
3984
def _select_branch_location(self, tree, user_location, revision=None,
3986
"""Select a branch location, according to possible inputs.
3988
If provided, branches from ``revision`` are preferred. (Both
3989
``revision`` and ``index`` must be supplied.)
3991
Otherwise, the ``location`` parameter is used. If it is None, then the
3992
``submit`` or ``parent`` location is used, and a note is printed.
3994
:param tree: The working tree to select a branch for merging into
3995
:param location: The location entered by the user
3996
:param revision: The revision parameter to the command
3997
:param index: The index to use for the revision parameter. Negative
3998
indices are permitted.
3999
:return: (selected_location, user_location). The default location
4000
will be the user-entered location.
4002
if (revision is not None and index is not None
4003
and revision[index] is not None):
4004
branch = revision[index].get_branch()
4005
if branch is not None:
4006
return branch, branch
4007
if user_location is None:
4008
location = self._get_remembered(tree, 'Merging from')
4010
location = user_location
4011
return location, user_location
4013
def _get_remembered(self, tree, verb_string):
4014
"""Use tree.branch's parent if none was supplied.
4016
Report if the remembered location was used.
4018
stored_location = tree.branch.get_submit_branch()
4019
stored_location_type = "submit"
4020
if stored_location is None:
4021
stored_location = tree.branch.get_parent()
4022
stored_location_type = "parent"
4023
mutter("%s", stored_location)
4024
if stored_location is None:
4025
raise errors.BzrCommandError("No location specified or remembered")
4026
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4027
note(u"%s remembered %s location %s", verb_string,
4028
stored_location_type, display_url)
4029
return stored_location
4032
class cmd_remerge(Command):
4035
Use this if you want to try a different merge technique while resolving
4036
conflicts. Some merge techniques are better than others, and remerge
4037
lets you try different ones on different files.
4039
The options for remerge have the same meaning and defaults as the ones for
4040
merge. The difference is that remerge can (only) be run when there is a
4041
pending merge, and it lets you specify particular files.
4044
Re-do the merge of all conflicted files, and show the base text in
4045
conflict regions, in addition to the usual THIS and OTHER texts::
4047
bzr remerge --show-base
4049
Re-do the merge of "foobar", using the weave merge algorithm, with
4050
additional processing to reduce the size of conflict regions::
4052
bzr remerge --merge-type weave --reprocess foobar
4054
takes_args = ['file*']
4059
help="Show base revision text in conflicts."),
4062
def run(self, file_list=None, merge_type=None, show_base=False,
4064
if merge_type is None:
4065
merge_type = _mod_merge.Merge3Merger
4066
tree, file_list = tree_files(file_list)
4068
self.add_cleanup(tree.unlock)
4069
parents = tree.get_parent_ids()
4070
if len(parents) != 2:
4071
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4072
" merges. Not cherrypicking or"
4074
repository = tree.branch.repository
4075
interesting_ids = None
4077
conflicts = tree.conflicts()
4078
if file_list is not None:
4079
interesting_ids = set()
4080
for filename in file_list:
4081
file_id = tree.path2id(filename)
4083
raise errors.NotVersionedError(filename)
4084
interesting_ids.add(file_id)
4085
if tree.kind(file_id) != "directory":
4088
for name, ie in tree.inventory.iter_entries(file_id):
4089
interesting_ids.add(ie.file_id)
4090
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4092
# Remerge only supports resolving contents conflicts
4093
allowed_conflicts = ('text conflict', 'contents conflict')
4094
restore_files = [c.path for c in conflicts
4095
if c.typestring in allowed_conflicts]
4096
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4097
tree.set_conflicts(ConflictList(new_conflicts))
4098
if file_list is not None:
4099
restore_files = file_list
4100
for filename in restore_files:
4102
restore(tree.abspath(filename))
4103
except errors.NotConflicted:
4105
# Disable pending merges, because the file texts we are remerging
4106
# have not had those merges performed. If we use the wrong parents
4107
# list, we imply that the working tree text has seen and rejected
4108
# all the changes from the other tree, when in fact those changes
4109
# have not yet been seen.
4110
tree.set_parent_ids(parents[:1])
4112
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4113
merger.interesting_ids = interesting_ids
4114
merger.merge_type = merge_type
4115
merger.show_base = show_base
4116
merger.reprocess = reprocess
4117
conflicts = merger.do_merge()
4119
tree.set_parent_ids(parents)
4126
class cmd_revert(Command):
4127
"""Revert files to a previous revision.
4129
Giving a list of files will revert only those files. Otherwise, all files
4130
will be reverted. If the revision is not specified with '--revision', the
4131
last committed revision is used.
4133
To remove only some changes, without reverting to a prior version, use
4134
merge instead. For example, "merge . --revision -2..-3" will remove the
4135
changes introduced by -2, without affecting the changes introduced by -1.
4136
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4138
By default, any files that have been manually changed will be backed up
4139
first. (Files changed only by merge are not backed up.) Backup files have
4140
'.~#~' appended to their name, where # is a number.
4142
When you provide files, you can use their current pathname or the pathname
4143
from the target revision. So you can use revert to "undelete" a file by
4144
name. If you name a directory, all the contents of that directory will be
4147
If you have newly added files since the target revision, they will be
4148
removed. If the files to be removed have been changed, backups will be
4149
created as above. Directories containing unknown files will not be
4152
The working tree contains a list of revisions that have been merged but
4153
not yet committed. These revisions will be included as additional parents
4154
of the next commit. Normally, using revert clears that list as well as
4155
reverting the files. If any files are specified, revert leaves the list
4156
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4157
.`` in the tree root to revert all files but keep the recorded merges,
4158
and ``bzr revert --forget-merges`` to clear the pending merge list without
4159
reverting any files.
4161
Using "bzr revert --forget-merges", it is possible to apply all of the
4162
changes from a branch in a single revision. To do this, perform the merge
4163
as desired. Then doing revert with the "--forget-merges" option will keep
4164
the content of the tree as it was, but it will clear the list of pending
4165
merges. The next commit will then contain all of the changes that are
4166
present in the other branch, but without any other parent revisions.
4167
Because this technique forgets where these changes originated, it may
4168
cause additional conflicts on later merges involving the same source and
4172
_see_also = ['cat', 'export']
4175
Option('no-backup', "Do not save backups of reverted files."),
4176
Option('forget-merges',
4177
'Remove pending merge marker, without changing any files.'),
4179
takes_args = ['file*']
4181
def run(self, revision=None, no_backup=False, file_list=None,
4182
forget_merges=None):
4183
tree, file_list = tree_files(file_list)
4185
self.add_cleanup(tree.unlock)
4187
tree.set_parent_ids(tree.get_parent_ids()[:1])
4189
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4192
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4193
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4194
tree.revert(file_list, rev_tree, not no_backup, None,
4195
report_changes=True)
4198
class cmd_assert_fail(Command):
4199
"""Test reporting of assertion failures"""
4200
# intended just for use in testing
4205
raise AssertionError("always fails")
4208
class cmd_help(Command):
4209
"""Show help on a command or other topic.
4212
_see_also = ['topics']
4214
Option('long', 'Show help on all commands.'),
4216
takes_args = ['topic?']
4217
aliases = ['?', '--help', '-?', '-h']
4220
def run(self, topic=None, long=False):
4222
if topic is None and long:
4224
bzrlib.help.help(topic)
4227
class cmd_shell_complete(Command):
4228
"""Show appropriate completions for context.
4230
For a list of all available commands, say 'bzr shell-complete'.
4232
takes_args = ['context?']
4237
def run(self, context=None):
4238
import shellcomplete
4239
shellcomplete.shellcomplete(context)
4242
class cmd_missing(Command):
4243
"""Show unmerged/unpulled revisions between two branches.
4245
OTHER_BRANCH may be local or remote.
4247
To filter on a range of revisions, you can use the command -r begin..end
4248
-r revision requests a specific revision, -r ..end or -r begin.. are
4252
1 - some missing revisions
4253
0 - no missing revisions
4257
Determine the missing revisions between this and the branch at the
4258
remembered pull location::
4262
Determine the missing revisions between this and another branch::
4264
bzr missing http://server/branch
4266
Determine the missing revisions up to a specific revision on the other
4269
bzr missing -r ..-10
4271
Determine the missing revisions up to a specific revision on this
4274
bzr missing --my-revision ..-10
4277
_see_also = ['merge', 'pull']
4278
takes_args = ['other_branch?']
4280
Option('reverse', 'Reverse the order of revisions.'),
4282
'Display changes in the local branch only.'),
4283
Option('this' , 'Same as --mine-only.'),
4284
Option('theirs-only',
4285
'Display changes in the remote branch only.'),
4286
Option('other', 'Same as --theirs-only.'),
4290
custom_help('revision',
4291
help='Filter on other branch revisions (inclusive). '
4292
'See "help revisionspec" for details.'),
4293
Option('my-revision',
4294
type=_parse_revision_str,
4295
help='Filter on local branch revisions (inclusive). '
4296
'See "help revisionspec" for details.'),
4297
Option('include-merges',
4298
'Show all revisions in addition to the mainline ones.'),
4300
encoding_type = 'replace'
4303
def run(self, other_branch=None, reverse=False, mine_only=False,
4305
log_format=None, long=False, short=False, line=False,
4306
show_ids=False, verbose=False, this=False, other=False,
4307
include_merges=False, revision=None, my_revision=None):
4308
from bzrlib.missing import find_unmerged, iter_log_revisions
4317
# TODO: We should probably check that we don't have mine-only and
4318
# theirs-only set, but it gets complicated because we also have
4319
# this and other which could be used.
4326
local_branch = Branch.open_containing(u".")[0]
4327
parent = local_branch.get_parent()
4328
if other_branch is None:
4329
other_branch = parent
4330
if other_branch is None:
4331
raise errors.BzrCommandError("No peer location known"
4333
display_url = urlutils.unescape_for_display(parent,
4335
message("Using saved parent location: "
4336
+ display_url + "\n")
4338
remote_branch = Branch.open(other_branch)
4339
if remote_branch.base == local_branch.base:
4340
remote_branch = local_branch
4342
local_branch.lock_read()
4343
self.add_cleanup(local_branch.unlock)
4344
local_revid_range = _revision_range_to_revid_range(
4345
_get_revision_range(my_revision, local_branch,
4348
remote_branch.lock_read()
4349
self.add_cleanup(remote_branch.unlock)
4350
remote_revid_range = _revision_range_to_revid_range(
4351
_get_revision_range(revision,
4352
remote_branch, self.name()))
4354
local_extra, remote_extra = find_unmerged(
4355
local_branch, remote_branch, restrict,
4356
backward=not reverse,
4357
include_merges=include_merges,
4358
local_revid_range=local_revid_range,
4359
remote_revid_range=remote_revid_range)
4361
if log_format is None:
4362
registry = log.log_formatter_registry
4363
log_format = registry.get_default(local_branch)
4364
lf = log_format(to_file=self.outf,
4366
show_timezone='original')
4369
if local_extra and not theirs_only:
4370
message("You have %d extra revision(s):\n" %
4372
for revision in iter_log_revisions(local_extra,
4373
local_branch.repository,
4375
lf.log_revision(revision)
4376
printed_local = True
4379
printed_local = False
4381
if remote_extra and not mine_only:
4382
if printed_local is True:
4384
message("You are missing %d revision(s):\n" %
4386
for revision in iter_log_revisions(remote_extra,
4387
remote_branch.repository,
4389
lf.log_revision(revision)
4392
if mine_only and not local_extra:
4393
# We checked local, and found nothing extra
4394
message('This branch is up to date.\n')
4395
elif theirs_only and not remote_extra:
4396
# We checked remote, and found nothing extra
4397
message('Other branch is up to date.\n')
4398
elif not (mine_only or theirs_only or local_extra or
4400
# We checked both branches, and neither one had extra
4402
message("Branches are up to date.\n")
4404
if not status_code and parent is None and other_branch is not None:
4405
local_branch.lock_write()
4406
self.add_cleanup(local_branch.unlock)
4407
# handle race conditions - a parent might be set while we run.
4408
if local_branch.get_parent() is None:
4409
local_branch.set_parent(remote_branch.base)
4413
class cmd_pack(Command):
4414
"""Compress the data within a repository."""
4416
_see_also = ['repositories']
4417
takes_args = ['branch_or_repo?']
4419
def run(self, branch_or_repo='.'):
4420
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4422
branch = dir.open_branch()
4423
repository = branch.repository
4424
except errors.NotBranchError:
4425
repository = dir.open_repository()
4429
class cmd_plugins(Command):
4430
"""List the installed plugins.
4432
This command displays the list of installed plugins including
4433
version of plugin and a short description of each.
4435
--verbose shows the path where each plugin is located.
4437
A plugin is an external component for Bazaar that extends the
4438
revision control system, by adding or replacing code in Bazaar.
4439
Plugins can do a variety of things, including overriding commands,
4440
adding new commands, providing additional network transports and
4441
customizing log output.
4443
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4444
for further information on plugins including where to find them and how to
4445
install them. Instructions are also provided there on how to write new
4446
plugins using the Python programming language.
4448
takes_options = ['verbose']
4451
def run(self, verbose=False):
4452
import bzrlib.plugin
4453
from inspect import getdoc
4455
for name, plugin in bzrlib.plugin.plugins().items():
4456
version = plugin.__version__
4457
if version == 'unknown':
4459
name_ver = '%s %s' % (name, version)
4460
d = getdoc(plugin.module)
4462
doc = d.split('\n')[0]
4464
doc = '(no description)'
4465
result.append((name_ver, doc, plugin.path()))
4466
for name_ver, doc, path in sorted(result):
4467
self.outf.write("%s\n" % name_ver)
4468
self.outf.write(" %s\n" % doc)
4470
self.outf.write(" %s\n" % path)
4471
self.outf.write("\n")
4474
class cmd_testament(Command):
4475
"""Show testament (signing-form) of a revision."""
4478
Option('long', help='Produce long-format testament.'),
4480
help='Produce a strict-format testament.')]
4481
takes_args = ['branch?']
4483
def run(self, branch=u'.', revision=None, long=False, strict=False):
4484
from bzrlib.testament import Testament, StrictTestament
4486
testament_class = StrictTestament
4488
testament_class = Testament
4490
b = Branch.open_containing(branch)[0]
4492
b = Branch.open(branch)
4494
self.add_cleanup(b.unlock)
4495
if revision is None:
4496
rev_id = b.last_revision()
4498
rev_id = revision[0].as_revision_id(b)
4499
t = testament_class.from_revision(b.repository, rev_id)
4501
sys.stdout.writelines(t.as_text_lines())
4503
sys.stdout.write(t.as_short_text())
4506
class cmd_annotate(Command):
4507
"""Show the origin of each line in a file.
4509
This prints out the given file with an annotation on the left side
4510
indicating which revision, author and date introduced the change.
4512
If the origin is the same for a run of consecutive lines, it is
4513
shown only at the top, unless the --all option is given.
4515
# TODO: annotate directories; showing when each file was last changed
4516
# TODO: if the working copy is modified, show annotations on that
4517
# with new uncommitted lines marked
4518
aliases = ['ann', 'blame', 'praise']
4519
takes_args = ['filename']
4520
takes_options = [Option('all', help='Show annotations on all lines.'),
4521
Option('long', help='Show commit date in annotations.'),
4525
encoding_type = 'exact'
4528
def run(self, filename, all=False, long=False, revision=None,
4530
from bzrlib.annotate import annotate_file, annotate_file_tree
4531
wt, branch, relpath = \
4532
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4535
self.add_cleanup(wt.unlock)
4538
self.add_cleanup(branch.unlock)
4539
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4541
self.add_cleanup(tree.unlock)
4543
file_id = wt.path2id(relpath)
4545
file_id = tree.path2id(relpath)
4547
raise errors.NotVersionedError(filename)
4548
file_version = tree.inventory[file_id].revision
4549
if wt is not None and revision is None:
4550
# If there is a tree and we're not annotating historical
4551
# versions, annotate the working tree's content.
4552
annotate_file_tree(wt, file_id, self.outf, long, all,
4555
annotate_file(branch, file_version, file_id, long, all, self.outf,
4559
class cmd_re_sign(Command):
4560
"""Create a digital signature for an existing revision."""
4561
# TODO be able to replace existing ones.
4563
hidden = True # is this right ?
4564
takes_args = ['revision_id*']
4565
takes_options = ['revision']
4567
def run(self, revision_id_list=None, revision=None):
4568
if revision_id_list is not None and revision is not None:
4569
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4570
if revision_id_list is None and revision is None:
4571
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4572
b = WorkingTree.open_containing(u'.')[0].branch
4574
self.add_cleanup(b.unlock)
4575
return self._run(b, revision_id_list, revision)
4577
def _run(self, b, revision_id_list, revision):
4578
import bzrlib.gpg as gpg
4579
gpg_strategy = gpg.GPGStrategy(b.get_config())
4580
if revision_id_list is not None:
4581
b.repository.start_write_group()
4583
for revision_id in revision_id_list:
4584
b.repository.sign_revision(revision_id, gpg_strategy)
4586
b.repository.abort_write_group()
4589
b.repository.commit_write_group()
4590
elif revision is not None:
4591
if len(revision) == 1:
4592
revno, rev_id = revision[0].in_history(b)
4593
b.repository.start_write_group()
4595
b.repository.sign_revision(rev_id, gpg_strategy)
4597
b.repository.abort_write_group()
4600
b.repository.commit_write_group()
4601
elif len(revision) == 2:
4602
# are they both on rh- if so we can walk between them
4603
# might be nice to have a range helper for arbitrary
4604
# revision paths. hmm.
4605
from_revno, from_revid = revision[0].in_history(b)
4606
to_revno, to_revid = revision[1].in_history(b)
4607
if to_revid is None:
4608
to_revno = b.revno()
4609
if from_revno is None or to_revno is None:
4610
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4611
b.repository.start_write_group()
4613
for revno in range(from_revno, to_revno + 1):
4614
b.repository.sign_revision(b.get_rev_id(revno),
4617
b.repository.abort_write_group()
4620
b.repository.commit_write_group()
4622
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4625
class cmd_bind(Command):
4626
"""Convert the current branch into a checkout of the supplied branch.
4628
Once converted into a checkout, commits must succeed on the master branch
4629
before they will be applied to the local branch.
4631
Bound branches use the nickname of its master branch unless it is set
4632
locally, in which case binding will update the local nickname to be
4636
_see_also = ['checkouts', 'unbind']
4637
takes_args = ['location?']
4640
def run(self, location=None):
4641
b, relpath = Branch.open_containing(u'.')
4642
if location is None:
4644
location = b.get_old_bound_location()
4645
except errors.UpgradeRequired:
4646
raise errors.BzrCommandError('No location supplied. '
4647
'This format does not remember old locations.')
4649
if location is None:
4650
if b.get_bound_location() is not None:
4651
raise errors.BzrCommandError('Branch is already bound')
4653
raise errors.BzrCommandError('No location supplied '
4654
'and no previous location known')
4655
b_other = Branch.open(location)
4658
except errors.DivergedBranches:
4659
raise errors.BzrCommandError('These branches have diverged.'
4660
' Try merging, and then bind again.')
4661
if b.get_config().has_explicit_nickname():
4662
b.nick = b_other.nick
4665
class cmd_unbind(Command):
4666
"""Convert the current checkout into a regular branch.
4668
After unbinding, the local branch is considered independent and subsequent
4669
commits will be local only.
4672
_see_also = ['checkouts', 'bind']
4677
b, relpath = Branch.open_containing(u'.')
4679
raise errors.BzrCommandError('Local branch is not bound')
4682
class cmd_uncommit(Command):
4683
"""Remove the last committed revision.
4685
--verbose will print out what is being removed.
4686
--dry-run will go through all the motions, but not actually
4689
If --revision is specified, uncommit revisions to leave the branch at the
4690
specified revision. For example, "bzr uncommit -r 15" will leave the
4691
branch at revision 15.
4693
Uncommit leaves the working tree ready for a new commit. The only change
4694
it may make is to restore any pending merges that were present before
4698
# TODO: jam 20060108 Add an option to allow uncommit to remove
4699
# unreferenced information in 'branch-as-repository' branches.
4700
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4701
# information in shared branches as well.
4702
_see_also = ['commit']
4703
takes_options = ['verbose', 'revision',
4704
Option('dry-run', help='Don\'t actually make changes.'),
4705
Option('force', help='Say yes to all questions.'),
4707
help="Only remove the commits from the local branch"
4708
" when in a checkout."
4711
takes_args = ['location?']
4713
encoding_type = 'replace'
4715
def run(self, location=None,
4716
dry_run=False, verbose=False,
4717
revision=None, force=False, local=False):
4718
if location is None:
4720
control, relpath = bzrdir.BzrDir.open_containing(location)
4722
tree = control.open_workingtree()
4724
except (errors.NoWorkingTree, errors.NotLocalUrl):
4726
b = control.open_branch()
4728
if tree is not None:
4730
self.add_cleanup(tree.unlock)
4733
self.add_cleanup(b.unlock)
4734
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4736
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4737
from bzrlib.log import log_formatter, show_log
4738
from bzrlib.uncommit import uncommit
4740
last_revno, last_rev_id = b.last_revision_info()
4743
if revision is None:
4745
rev_id = last_rev_id
4747
# 'bzr uncommit -r 10' actually means uncommit
4748
# so that the final tree is at revno 10.
4749
# but bzrlib.uncommit.uncommit() actually uncommits
4750
# the revisions that are supplied.
4751
# So we need to offset it by one
4752
revno = revision[0].in_history(b).revno + 1
4753
if revno <= last_revno:
4754
rev_id = b.get_rev_id(revno)
4756
if rev_id is None or _mod_revision.is_null(rev_id):
4757
self.outf.write('No revisions to uncommit.\n')
4760
lf = log_formatter('short',
4762
show_timezone='original')
4767
direction='forward',
4768
start_revision=revno,
4769
end_revision=last_revno)
4772
self.outf.write('Dry-run, pretending to remove'
4773
' the above revisions.\n')
4775
self.outf.write('The above revision(s) will be removed.\n')
4778
if not ui.ui_factory.get_boolean('Are you sure'):
4779
self.outf.write('Canceled')
4782
mutter('Uncommitting from {%s} to {%s}',
4783
last_rev_id, rev_id)
4784
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4785
revno=revno, local=local)
4786
self.outf.write('You can restore the old tip by running:\n'
4787
' bzr pull . -r revid:%s\n' % last_rev_id)
4790
class cmd_break_lock(Command):
4791
"""Break a dead lock on a repository, branch or working directory.
4793
CAUTION: Locks should only be broken when you are sure that the process
4794
holding the lock has been stopped.
4796
You can get information on what locks are open via the 'bzr info
4797
[location]' command.
4801
bzr break-lock bzr+ssh://example.com/bzr/foo
4803
takes_args = ['location?']
4805
def run(self, location=None, show=False):
4806
if location is None:
4808
control, relpath = bzrdir.BzrDir.open_containing(location)
4810
control.break_lock()
4811
except NotImplementedError:
4815
class cmd_wait_until_signalled(Command):
4816
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4818
This just prints a line to signal when it is ready, then blocks on stdin.
4824
sys.stdout.write("running\n")
4826
sys.stdin.readline()
4829
class cmd_serve(Command):
4830
"""Run the bzr server."""
4832
aliases = ['server']
4836
help='Serve on stdin/out for use from inetd or sshd.'),
4837
RegistryOption('protocol',
4838
help="Protocol to serve.",
4839
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4840
value_switches=True),
4842
help='Listen for connections on nominated port of the form '
4843
'[hostname:]portnumber. Passing 0 as the port number will '
4844
'result in a dynamically allocated port. The default port '
4845
'depends on the protocol.',
4848
help='Serve contents of this directory.',
4850
Option('allow-writes',
4851
help='By default the server is a readonly server. Supplying '
4852
'--allow-writes enables write access to the contents of '
4853
'the served directory and below. Note that ``bzr serve`` '
4854
'does not perform authentication, so unless some form of '
4855
'external authentication is arranged supplying this '
4856
'option leads to global uncontrolled write access to your '
4861
def get_host_and_port(self, port):
4862
"""Return the host and port to run the smart server on.
4864
If 'port' is None, None will be returned for the host and port.
4866
If 'port' has a colon in it, the string before the colon will be
4867
interpreted as the host.
4869
:param port: A string of the port to run the server on.
4870
:return: A tuple of (host, port), where 'host' is a host name or IP,
4871
and port is an integer TCP/IP port.
4874
if port is not None:
4876
host, port = port.split(':')
4880
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4882
from bzrlib.transport import get_transport, transport_server_registry
4883
if directory is None:
4884
directory = os.getcwd()
4885
if protocol is None:
4886
protocol = transport_server_registry.get()
4887
host, port = self.get_host_and_port(port)
4888
url = urlutils.local_path_to_url(directory)
4889
if not allow_writes:
4890
url = 'readonly+' + url
4891
transport = get_transport(url)
4892
protocol(transport, host, port, inet)
4895
class cmd_join(Command):
4896
"""Combine a tree into its containing tree.
4898
This command requires the target tree to be in a rich-root format.
4900
The TREE argument should be an independent tree, inside another tree, but
4901
not part of it. (Such trees can be produced by "bzr split", but also by
4902
running "bzr branch" with the target inside a tree.)
4904
The result is a combined tree, with the subtree no longer an independant
4905
part. This is marked as a merge of the subtree into the containing tree,
4906
and all history is preserved.
4909
_see_also = ['split']
4910
takes_args = ['tree']
4912
Option('reference', help='Join by reference.', hidden=True),
4915
def run(self, tree, reference=False):
4916
sub_tree = WorkingTree.open(tree)
4917
parent_dir = osutils.dirname(sub_tree.basedir)
4918
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4919
repo = containing_tree.branch.repository
4920
if not repo.supports_rich_root():
4921
raise errors.BzrCommandError(
4922
"Can't join trees because %s doesn't support rich root data.\n"
4923
"You can use bzr upgrade on the repository."
4927
containing_tree.add_reference(sub_tree)
4928
except errors.BadReferenceTarget, e:
4929
# XXX: Would be better to just raise a nicely printable
4930
# exception from the real origin. Also below. mbp 20070306
4931
raise errors.BzrCommandError("Cannot join %s. %s" %
4935
containing_tree.subsume(sub_tree)
4936
except errors.BadSubsumeSource, e:
4937
raise errors.BzrCommandError("Cannot join %s. %s" %
4941
class cmd_split(Command):
4942
"""Split a subdirectory of a tree into a separate tree.
4944
This command will produce a target tree in a format that supports
4945
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4946
converted into earlier formats like 'dirstate-tags'.
4948
The TREE argument should be a subdirectory of a working tree. That
4949
subdirectory will be converted into an independent tree, with its own
4950
branch. Commits in the top-level tree will not apply to the new subtree.
4953
_see_also = ['join']
4954
takes_args = ['tree']
4956
def run(self, tree):
4957
containing_tree, subdir = WorkingTree.open_containing(tree)
4958
sub_id = containing_tree.path2id(subdir)
4960
raise errors.NotVersionedError(subdir)
4962
containing_tree.extract(sub_id)
4963
except errors.RootNotRich:
4964
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4967
class cmd_merge_directive(Command):
4968
"""Generate a merge directive for auto-merge tools.
4970
A directive requests a merge to be performed, and also provides all the
4971
information necessary to do so. This means it must either include a
4972
revision bundle, or the location of a branch containing the desired
4975
A submit branch (the location to merge into) must be supplied the first
4976
time the command is issued. After it has been supplied once, it will
4977
be remembered as the default.
4979
A public branch is optional if a revision bundle is supplied, but required
4980
if --diff or --plain is specified. It will be remembered as the default
4981
after the first use.
4984
takes_args = ['submit_branch?', 'public_branch?']
4988
_see_also = ['send']
4991
RegistryOption.from_kwargs('patch-type',
4992
'The type of patch to include in the directive.',
4994
value_switches=True,
4996
bundle='Bazaar revision bundle (default).',
4997
diff='Normal unified diff.',
4998
plain='No patch, just directive.'),
4999
Option('sign', help='GPG-sign the directive.'), 'revision',
5000
Option('mail-to', type=str,
5001
help='Instead of printing the directive, email to this address.'),
5002
Option('message', type=str, short_name='m',
5003
help='Message to use when committing this merge.')
5006
encoding_type = 'exact'
5008
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5009
sign=False, revision=None, mail_to=None, message=None):
5010
from bzrlib.revision import ensure_null, NULL_REVISION
5011
include_patch, include_bundle = {
5012
'plain': (False, False),
5013
'diff': (True, False),
5014
'bundle': (True, True),
5016
branch = Branch.open('.')
5017
stored_submit_branch = branch.get_submit_branch()
5018
if submit_branch is None:
5019
submit_branch = stored_submit_branch
5021
if stored_submit_branch is None:
5022
branch.set_submit_branch(submit_branch)
5023
if submit_branch is None:
5024
submit_branch = branch.get_parent()
5025
if submit_branch is None:
5026
raise errors.BzrCommandError('No submit branch specified or known')
5028
stored_public_branch = branch.get_public_branch()
5029
if public_branch is None:
5030
public_branch = stored_public_branch
5031
elif stored_public_branch is None:
5032
branch.set_public_branch(public_branch)
5033
if not include_bundle and public_branch is None:
5034
raise errors.BzrCommandError('No public branch specified or'
5036
base_revision_id = None
5037
if revision is not None:
5038
if len(revision) > 2:
5039
raise errors.BzrCommandError('bzr merge-directive takes '
5040
'at most two one revision identifiers')
5041
revision_id = revision[-1].as_revision_id(branch)
5042
if len(revision) == 2:
5043
base_revision_id = revision[0].as_revision_id(branch)
5045
revision_id = branch.last_revision()
5046
revision_id = ensure_null(revision_id)
5047
if revision_id == NULL_REVISION:
5048
raise errors.BzrCommandError('No revisions to bundle.')
5049
directive = merge_directive.MergeDirective2.from_objects(
5050
branch.repository, revision_id, time.time(),
5051
osutils.local_time_offset(), submit_branch,
5052
public_branch=public_branch, include_patch=include_patch,
5053
include_bundle=include_bundle, message=message,
5054
base_revision_id=base_revision_id)
5057
self.outf.write(directive.to_signed(branch))
5059
self.outf.writelines(directive.to_lines())
5061
message = directive.to_email(mail_to, branch, sign)
5062
s = SMTPConnection(branch.get_config())
5063
s.send_email(message)
5066
class cmd_send(Command):
5067
"""Mail or create a merge-directive for submitting changes.
5069
A merge directive provides many things needed for requesting merges:
5071
* A machine-readable description of the merge to perform
5073
* An optional patch that is a preview of the changes requested
5075
* An optional bundle of revision data, so that the changes can be applied
5076
directly from the merge directive, without retrieving data from a
5079
`bzr send` creates a compact data set that, when applied using bzr
5080
merge, has the same effect as merging from the source branch.
5082
By default the merge directive is self-contained and can be applied to any
5083
branch containing submit_branch in its ancestory without needing access to
5086
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5087
revisions, but only a structured request to merge from the
5088
public_location. In that case the public_branch is needed and it must be
5089
up-to-date and accessible to the recipient. The public_branch is always
5090
included if known, so that people can check it later.
5092
The submit branch defaults to the parent of the source branch, but can be
5093
overridden. Both submit branch and public branch will be remembered in
5094
branch.conf the first time they are used for a particular branch. The
5095
source branch defaults to that containing the working directory, but can
5096
be changed using --from.
5098
In order to calculate those changes, bzr must analyse the submit branch.
5099
Therefore it is most efficient for the submit branch to be a local mirror.
5100
If a public location is known for the submit_branch, that location is used
5101
in the merge directive.
5103
The default behaviour is to send the merge directive by mail, unless -o is
5104
given, in which case it is sent to a file.
5106
Mail is sent using your preferred mail program. This should be transparent
5107
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5108
If the preferred client can't be found (or used), your editor will be used.
5110
To use a specific mail program, set the mail_client configuration option.
5111
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5112
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5113
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5114
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5117
If mail is being sent, a to address is required. This can be supplied
5118
either on the commandline, by setting the submit_to configuration
5119
option in the branch itself or the child_submit_to configuration option
5120
in the submit branch.
5122
Two formats are currently supported: "4" uses revision bundle format 4 and
5123
merge directive format 2. It is significantly faster and smaller than
5124
older formats. It is compatible with Bazaar 0.19 and later. It is the
5125
default. "0.9" uses revision bundle format 0.9 and merge directive
5126
format 1. It is compatible with Bazaar 0.12 - 0.18.
5128
The merge directives created by bzr send may be applied using bzr merge or
5129
bzr pull by specifying a file containing a merge directive as the location.
5131
bzr send makes extensive use of public locations to map local locations into
5132
URLs that can be used by other people. See `bzr help configuration` to
5133
set them, and use `bzr info` to display them.
5136
encoding_type = 'exact'
5138
_see_also = ['merge', 'pull']
5140
takes_args = ['submit_branch?', 'public_branch?']
5144
help='Do not include a bundle in the merge directive.'),
5145
Option('no-patch', help='Do not include a preview patch in the merge'
5148
help='Remember submit and public branch.'),
5150
help='Branch to generate the submission from, '
5151
'rather than the one containing the working directory.',
5154
Option('output', short_name='o',
5155
help='Write merge directive to this file or directory; '
5156
'use - for stdout.',
5159
help='Refuse to send if there are uncommitted changes in'
5160
' the working tree, --no-strict disables the check.'),
5161
Option('mail-to', help='Mail the request to this address.',
5165
Option('body', help='Body for the email.', type=unicode),
5166
RegistryOption('format',
5167
help='Use the specified output format.',
5168
lazy_registry=('bzrlib.send', 'format_registry')),
5171
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5172
no_patch=False, revision=None, remember=False, output=None,
5173
format=None, mail_to=None, message=None, body=None,
5174
strict=None, **kwargs):
5175
from bzrlib.send import send
5176
return send(submit_branch, revision, public_branch, remember,
5177
format, no_bundle, no_patch, output,
5178
kwargs.get('from', '.'), mail_to, message, body,
5183
class cmd_bundle_revisions(cmd_send):
5184
"""Create a merge-directive for submitting changes.
5186
A merge directive provides many things needed for requesting merges:
5188
* A machine-readable description of the merge to perform
5190
* An optional patch that is a preview of the changes requested
5192
* An optional bundle of revision data, so that the changes can be applied
5193
directly from the merge directive, without retrieving data from a
5196
If --no-bundle is specified, then public_branch is needed (and must be
5197
up-to-date), so that the receiver can perform the merge using the
5198
public_branch. The public_branch is always included if known, so that
5199
people can check it later.
5201
The submit branch defaults to the parent, but can be overridden. Both
5202
submit branch and public branch will be remembered if supplied.
5204
If a public_branch is known for the submit_branch, that public submit
5205
branch is used in the merge instructions. This means that a local mirror
5206
can be used as your actual submit branch, once you have set public_branch
5209
Two formats are currently supported: "4" uses revision bundle format 4 and
5210
merge directive format 2. It is significantly faster and smaller than
5211
older formats. It is compatible with Bazaar 0.19 and later. It is the
5212
default. "0.9" uses revision bundle format 0.9 and merge directive
5213
format 1. It is compatible with Bazaar 0.12 - 0.18.
5218
help='Do not include a bundle in the merge directive.'),
5219
Option('no-patch', help='Do not include a preview patch in the merge'
5222
help='Remember submit and public branch.'),
5224
help='Branch to generate the submission from, '
5225
'rather than the one containing the working directory.',
5228
Option('output', short_name='o', help='Write directive to this file.',
5231
help='Refuse to bundle revisions if there are uncommitted'
5232
' changes in the working tree, --no-strict disables the check.'),
5234
RegistryOption('format',
5235
help='Use the specified output format.',
5236
lazy_registry=('bzrlib.send', 'format_registry')),
5238
aliases = ['bundle']
5240
_see_also = ['send', 'merge']
5244
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5245
no_patch=False, revision=None, remember=False, output=None,
5246
format=None, strict=None, **kwargs):
5249
from bzrlib.send import send
5250
return send(submit_branch, revision, public_branch, remember,
5251
format, no_bundle, no_patch, output,
5252
kwargs.get('from', '.'), None, None, None,
5253
self.outf, strict=strict)
5256
class cmd_tag(Command):
5257
"""Create, remove or modify a tag naming a revision.
5259
Tags give human-meaningful names to revisions. Commands that take a -r
5260
(--revision) option can be given -rtag:X, where X is any previously
5263
Tags are stored in the branch. Tags are copied from one branch to another
5264
along when you branch, push, pull or merge.
5266
It is an error to give a tag name that already exists unless you pass
5267
--force, in which case the tag is moved to point to the new revision.
5269
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5270
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5272
If no tag name is specified it will be determined through the
5273
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5274
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5278
_see_also = ['commit', 'tags']
5279
takes_args = ['tag_name?']
5282
help='Delete this tag rather than placing it.',
5285
help='Branch in which to place the tag.',
5290
help='Replace existing tags.',
5295
def run(self, tag_name=None,
5301
branch, relpath = Branch.open_containing(directory)
5303
self.add_cleanup(branch.unlock)
5305
if tag_name is None:
5306
raise errors.BzrCommandError("No tag specified to delete.")
5307
branch.tags.delete_tag(tag_name)
5308
self.outf.write('Deleted tag %s.\n' % tag_name)
5311
if len(revision) != 1:
5312
raise errors.BzrCommandError(
5313
"Tags can only be placed on a single revision, "
5315
revision_id = revision[0].as_revision_id(branch)
5317
revision_id = branch.last_revision()
5318
if tag_name is None:
5319
tag_name = branch.automatic_tag_name(revision_id)
5320
if tag_name is None:
5321
raise errors.BzrCommandError(
5322
"Please specify a tag name.")
5323
if (not force) and branch.tags.has_tag(tag_name):
5324
raise errors.TagAlreadyExists(tag_name)
5325
branch.tags.set_tag(tag_name, revision_id)
5326
self.outf.write('Created tag %s.\n' % tag_name)
5329
class cmd_tags(Command):
5332
This command shows a table of tag names and the revisions they reference.
5338
help='Branch whose tags should be displayed.',
5342
RegistryOption.from_kwargs('sort',
5343
'Sort tags by different criteria.', title='Sorting',
5344
alpha='Sort tags lexicographically (default).',
5345
time='Sort tags chronologically.',
5358
branch, relpath = Branch.open_containing(directory)
5360
tags = branch.tags.get_tag_dict().items()
5365
self.add_cleanup(branch.unlock)
5367
graph = branch.repository.get_graph()
5368
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5369
revid1, revid2 = rev1.rev_id, rev2.rev_id
5370
# only show revisions between revid1 and revid2 (inclusive)
5371
tags = [(tag, revid) for tag, revid in tags if
5372
graph.is_between(revid, revid1, revid2)]
5375
elif sort == 'time':
5377
for tag, revid in tags:
5379
revobj = branch.repository.get_revision(revid)
5380
except errors.NoSuchRevision:
5381
timestamp = sys.maxint # place them at the end
5383
timestamp = revobj.timestamp
5384
timestamps[revid] = timestamp
5385
tags.sort(key=lambda x: timestamps[x[1]])
5387
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5388
for index, (tag, revid) in enumerate(tags):
5390
revno = branch.revision_id_to_dotted_revno(revid)
5391
if isinstance(revno, tuple):
5392
revno = '.'.join(map(str, revno))
5393
except errors.NoSuchRevision:
5394
# Bad tag data/merges can lead to tagged revisions
5395
# which are not in this branch. Fail gracefully ...
5397
tags[index] = (tag, revno)
5399
for tag, revspec in tags:
5400
self.outf.write('%-20s %s\n' % (tag, revspec))
5403
class cmd_reconfigure(Command):
5404
"""Reconfigure the type of a bzr directory.
5406
A target configuration must be specified.
5408
For checkouts, the bind-to location will be auto-detected if not specified.
5409
The order of preference is
5410
1. For a lightweight checkout, the current bound location.
5411
2. For branches that used to be checkouts, the previously-bound location.
5412
3. The push location.
5413
4. The parent location.
5414
If none of these is available, --bind-to must be specified.
5417
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5418
takes_args = ['location?']
5420
RegistryOption.from_kwargs(
5422
title='Target type',
5423
help='The type to reconfigure the directory to.',
5424
value_switches=True, enum_switch=False,
5425
branch='Reconfigure to be an unbound branch with no working tree.',
5426
tree='Reconfigure to be an unbound branch with a working tree.',
5427
checkout='Reconfigure to be a bound branch with a working tree.',
5428
lightweight_checkout='Reconfigure to be a lightweight'
5429
' checkout (with no local history).',
5430
standalone='Reconfigure to be a standalone branch '
5431
'(i.e. stop using shared repository).',
5432
use_shared='Reconfigure to use a shared repository.',
5433
with_trees='Reconfigure repository to create '
5434
'working trees on branches by default.',
5435
with_no_trees='Reconfigure repository to not create '
5436
'working trees on branches by default.'
5438
Option('bind-to', help='Branch to bind checkout to.', type=str),
5440
help='Perform reconfiguration even if local changes'
5442
Option('stacked-on',
5443
help='Reconfigure a branch to be stacked on another branch.',
5447
help='Reconfigure a branch to be unstacked. This '
5448
'may require copying substantial data into it.',
5452
def run(self, location=None, target_type=None, bind_to=None, force=False,
5455
directory = bzrdir.BzrDir.open(location)
5456
if stacked_on and unstacked:
5457
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5458
elif stacked_on is not None:
5459
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5461
reconfigure.ReconfigureUnstacked().apply(directory)
5462
# At the moment you can use --stacked-on and a different
5463
# reconfiguration shape at the same time; there seems no good reason
5465
if target_type is None:
5466
if stacked_on or unstacked:
5469
raise errors.BzrCommandError('No target configuration '
5471
elif target_type == 'branch':
5472
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5473
elif target_type == 'tree':
5474
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5475
elif target_type == 'checkout':
5476
reconfiguration = reconfigure.Reconfigure.to_checkout(
5478
elif target_type == 'lightweight-checkout':
5479
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5481
elif target_type == 'use-shared':
5482
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5483
elif target_type == 'standalone':
5484
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5485
elif target_type == 'with-trees':
5486
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5488
elif target_type == 'with-no-trees':
5489
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5491
reconfiguration.apply(force)
5494
class cmd_switch(Command):
5495
"""Set the branch of a checkout and update.
5497
For lightweight checkouts, this changes the branch being referenced.
5498
For heavyweight checkouts, this checks that there are no local commits
5499
versus the current bound branch, then it makes the local branch a mirror
5500
of the new location and binds to it.
5502
In both cases, the working tree is updated and uncommitted changes
5503
are merged. The user can commit or revert these as they desire.
5505
Pending merges need to be committed or reverted before using switch.
5507
The path to the branch to switch to can be specified relative to the parent
5508
directory of the current branch. For example, if you are currently in a
5509
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5512
Bound branches use the nickname of its master branch unless it is set
5513
locally, in which case switching will update the local nickname to be
5517
takes_args = ['to_location?']
5518
takes_options = [Option('force',
5519
help='Switch even if local commits will be lost.'),
5521
Option('create-branch', short_name='b',
5522
help='Create the target branch from this one before'
5523
' switching to it.'),
5526
def run(self, to_location=None, force=False, create_branch=False,
5528
from bzrlib import switch
5530
revision = _get_one_revision('switch', revision)
5531
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5532
if to_location is None:
5533
if revision is None:
5534
raise errors.BzrCommandError('You must supply either a'
5535
' revision or a location')
5538
branch = control_dir.open_branch()
5539
had_explicit_nick = branch.get_config().has_explicit_nickname()
5540
except errors.NotBranchError:
5542
had_explicit_nick = False
5545
raise errors.BzrCommandError('cannot create branch without'
5547
to_location = directory_service.directories.dereference(
5549
if '/' not in to_location and '\\' not in to_location:
5550
# This path is meant to be relative to the existing branch
5551
this_url = self._get_branch_location(control_dir)
5552
to_location = urlutils.join(this_url, '..', to_location)
5553
to_branch = branch.bzrdir.sprout(to_location,
5554
possible_transports=[branch.bzrdir.root_transport],
5555
source_branch=branch).open_branch()
5558
to_branch = Branch.open(to_location)
5559
except errors.NotBranchError:
5560
this_url = self._get_branch_location(control_dir)
5561
to_branch = Branch.open(
5562
urlutils.join(this_url, '..', to_location))
5563
if revision is not None:
5564
revision = revision.as_revision_id(to_branch)
5565
switch.switch(control_dir, to_branch, force, revision_id=revision)
5566
if had_explicit_nick:
5567
branch = control_dir.open_branch() #get the new branch!
5568
branch.nick = to_branch.nick
5569
note('Switched to branch: %s',
5570
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5572
def _get_branch_location(self, control_dir):
5573
"""Return location of branch for this control dir."""
5575
this_branch = control_dir.open_branch()
5576
# This may be a heavy checkout, where we want the master branch
5577
master_location = this_branch.get_bound_location()
5578
if master_location is not None:
5579
return master_location
5580
# If not, use a local sibling
5581
return this_branch.base
5582
except errors.NotBranchError:
5583
format = control_dir.find_branch_format()
5584
if getattr(format, 'get_reference', None) is not None:
5585
return format.get_reference(control_dir)
5587
return control_dir.root_transport.base
5590
class cmd_view(Command):
5591
"""Manage filtered views.
5593
Views provide a mask over the tree so that users can focus on
5594
a subset of a tree when doing their work. After creating a view,
5595
commands that support a list of files - status, diff, commit, etc -
5596
effectively have that list of files implicitly given each time.
5597
An explicit list of files can still be given but those files
5598
must be within the current view.
5600
In most cases, a view has a short life-span: it is created to make
5601
a selected change and is deleted once that change is committed.
5602
At other times, you may wish to create one or more named views
5603
and switch between them.
5605
To disable the current view without deleting it, you can switch to
5606
the pseudo view called ``off``. This can be useful when you need
5607
to see the whole tree for an operation or two (e.g. merge) but
5608
want to switch back to your view after that.
5611
To define the current view::
5613
bzr view file1 dir1 ...
5615
To list the current view::
5619
To delete the current view::
5623
To disable the current view without deleting it::
5625
bzr view --switch off
5627
To define a named view and switch to it::
5629
bzr view --name view-name file1 dir1 ...
5631
To list a named view::
5633
bzr view --name view-name
5635
To delete a named view::
5637
bzr view --name view-name --delete
5639
To switch to a named view::
5641
bzr view --switch view-name
5643
To list all views defined::
5647
To delete all views::
5649
bzr view --delete --all
5653
takes_args = ['file*']
5656
help='Apply list or delete action to all views.',
5659
help='Delete the view.',
5662
help='Name of the view to define, list or delete.',
5666
help='Name of the view to switch to.',
5671
def run(self, file_list,
5677
tree, file_list = tree_files(file_list, apply_view=False)
5678
current_view, view_dict = tree.views.get_view_info()
5683
raise errors.BzrCommandError(
5684
"Both --delete and a file list specified")
5686
raise errors.BzrCommandError(
5687
"Both --delete and --switch specified")
5689
tree.views.set_view_info(None, {})
5690
self.outf.write("Deleted all views.\n")
5692
raise errors.BzrCommandError("No current view to delete")
5694
tree.views.delete_view(name)
5695
self.outf.write("Deleted '%s' view.\n" % name)
5698
raise errors.BzrCommandError(
5699
"Both --switch and a file list specified")
5701
raise errors.BzrCommandError(
5702
"Both --switch and --all specified")
5703
elif switch == 'off':
5704
if current_view is None:
5705
raise errors.BzrCommandError("No current view to disable")
5706
tree.views.set_view_info(None, view_dict)
5707
self.outf.write("Disabled '%s' view.\n" % (current_view))
5709
tree.views.set_view_info(switch, view_dict)
5710
view_str = views.view_display_str(tree.views.lookup_view())
5711
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5714
self.outf.write('Views defined:\n')
5715
for view in sorted(view_dict):
5716
if view == current_view:
5720
view_str = views.view_display_str(view_dict[view])
5721
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5723
self.outf.write('No views defined.\n')
5726
# No name given and no current view set
5729
raise errors.BzrCommandError(
5730
"Cannot change the 'off' pseudo view")
5731
tree.views.set_view(name, sorted(file_list))
5732
view_str = views.view_display_str(tree.views.lookup_view())
5733
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5737
# No name given and no current view set
5738
self.outf.write('No current view.\n')
5740
view_str = views.view_display_str(tree.views.lookup_view(name))
5741
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5744
class cmd_hooks(Command):
5750
for hook_key in sorted(hooks.known_hooks.keys()):
5751
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5752
self.outf.write("%s:\n" % type(some_hooks).__name__)
5753
for hook_name, hook_point in sorted(some_hooks.items()):
5754
self.outf.write(" %s:\n" % (hook_name,))
5755
found_hooks = list(hook_point)
5757
for hook in found_hooks:
5758
self.outf.write(" %s\n" %
5759
(some_hooks.get_hook_name(hook),))
5761
self.outf.write(" <no hooks installed>\n")
5764
class cmd_remove_branch(Command):
5767
This will remove the branch from the specified location but
5768
will keep any working tree or repository in place.
5772
Remove the branch at repo/trunk::
5774
bzr remove-branch repo/trunk
5778
takes_args = ["location?"]
5780
aliases = ["rmbranch"]
5782
def run(self, location=None):
5783
if location is None:
5785
branch = Branch.open_containing(location)[0]
5786
branch.bzrdir.destroy_branch()
5789
class cmd_shelve(Command):
5790
"""Temporarily set aside some changes from the current tree.
5792
Shelve allows you to temporarily put changes you've made "on the shelf",
5793
ie. out of the way, until a later time when you can bring them back from
5794
the shelf with the 'unshelve' command. The changes are stored alongside
5795
your working tree, and so they aren't propagated along with your branch nor
5796
will they survive its deletion.
5798
If shelve --list is specified, previously-shelved changes are listed.
5800
Shelve is intended to help separate several sets of changes that have
5801
been inappropriately mingled. If you just want to get rid of all changes
5802
and you don't need to restore them later, use revert. If you want to
5803
shelve all text changes at once, use shelve --all.
5805
If filenames are specified, only the changes to those files will be
5806
shelved. Other files will be left untouched.
5808
If a revision is specified, changes since that revision will be shelved.
5810
You can put multiple items on the shelf, and by default, 'unshelve' will
5811
restore the most recently shelved changes.
5814
takes_args = ['file*']
5818
Option('all', help='Shelve all changes.'),
5820
RegistryOption('writer', 'Method to use for writing diffs.',
5821
bzrlib.option.diff_writer_registry,
5822
value_switches=True, enum_switch=False),
5824
Option('list', help='List shelved changes.'),
5826
help='Destroy removed changes instead of shelving them.'),
5828
_see_also = ['unshelve']
5830
def run(self, revision=None, all=False, file_list=None, message=None,
5831
writer=None, list=False, destroy=False):
5833
return self.run_for_list()
5834
from bzrlib.shelf_ui import Shelver
5836
writer = bzrlib.option.diff_writer_registry.get()
5838
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5839
file_list, message, destroy=destroy)
5844
except errors.UserAbort:
5847
def run_for_list(self):
5848
tree = WorkingTree.open_containing('.')[0]
5850
self.add_cleanup(tree.unlock)
5851
manager = tree.get_shelf_manager()
5852
shelves = manager.active_shelves()
5853
if len(shelves) == 0:
5854
note('No shelved changes.')
5856
for shelf_id in reversed(shelves):
5857
message = manager.get_metadata(shelf_id).get('message')
5859
message = '<no message>'
5860
self.outf.write('%3d: %s\n' % (shelf_id, message))
5864
class cmd_unshelve(Command):
5865
"""Restore shelved changes.
5867
By default, the most recently shelved changes are restored. However if you
5868
specify a shelf by id those changes will be restored instead. This works
5869
best when the changes don't depend on each other.
5872
takes_args = ['shelf_id?']
5874
RegistryOption.from_kwargs(
5875
'action', help="The action to perform.",
5876
enum_switch=False, value_switches=True,
5877
apply="Apply changes and remove from the shelf.",
5878
dry_run="Show changes, but do not apply or remove them.",
5879
preview="Instead of unshelving the changes, show the diff that "
5880
"would result from unshelving.",
5881
delete_only="Delete changes without applying them.",
5882
keep="Apply changes but don't delete them.",
5885
_see_also = ['shelve']
5887
def run(self, shelf_id=None, action='apply'):
5888
from bzrlib.shelf_ui import Unshelver
5889
unshelver = Unshelver.from_args(shelf_id, action)
5893
unshelver.tree.unlock()
5896
class cmd_clean_tree(Command):
5897
"""Remove unwanted files from working tree.
5899
By default, only unknown files, not ignored files, are deleted. Versioned
5900
files are never deleted.
5902
Another class is 'detritus', which includes files emitted by bzr during
5903
normal operations and selftests. (The value of these files decreases with
5906
If no options are specified, unknown files are deleted. Otherwise, option
5907
flags are respected, and may be combined.
5909
To check what clean-tree will do, use --dry-run.
5911
takes_options = [Option('ignored', help='Delete all ignored files.'),
5912
Option('detritus', help='Delete conflict files, merge'
5913
' backups, and failed selftest dirs.'),
5915
help='Delete files unknown to bzr (default).'),
5916
Option('dry-run', help='Show files to delete instead of'
5918
Option('force', help='Do not prompt before deleting.')]
5919
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5921
from bzrlib.clean_tree import clean_tree
5922
if not (unknown or ignored or detritus):
5926
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5927
dry_run=dry_run, no_prompt=force)
5930
class cmd_reference(Command):
5931
"""list, view and set branch locations for nested trees.
5933
If no arguments are provided, lists the branch locations for nested trees.
5934
If one argument is provided, display the branch location for that tree.
5935
If two arguments are provided, set the branch location for that tree.
5940
takes_args = ['path?', 'location?']
5942
def run(self, path=None, location=None):
5944
if path is not None:
5946
tree, branch, relpath =(
5947
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5948
if path is not None:
5951
tree = branch.basis_tree()
5953
info = branch._get_all_reference_info().iteritems()
5954
self._display_reference_info(tree, branch, info)
5956
file_id = tree.path2id(path)
5958
raise errors.NotVersionedError(path)
5959
if location is None:
5960
info = [(file_id, branch.get_reference_info(file_id))]
5961
self._display_reference_info(tree, branch, info)
5963
branch.set_reference_info(file_id, path, location)
5965
def _display_reference_info(self, tree, branch, info):
5967
for file_id, (path, location) in info:
5969
path = tree.id2path(file_id)
5970
except errors.NoSuchId:
5972
ref_list.append((path, location))
5973
for path, location in sorted(ref_list):
5974
self.outf.write('%s %s\n' % (path, location))
5977
# these get imported and then picked up by the scan for cmd_*
5978
# TODO: Some more consistent way to split command definitions across files;
5979
# we do need to load at least some information about them to know of
5980
# aliases. ideally we would avoid loading the implementation until the
5981
# details were needed.
5982
from bzrlib.cmd_version_info import cmd_version_info
5983
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5984
from bzrlib.bundle.commands import (
5987
from bzrlib.foreign import cmd_dpush
5988
from bzrlib.sign_my_commits import cmd_sign_my_commits
added
removed
bzrlib/builtins.py
