1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import (
65
builtin_command_registry,
68
from bzrlib.option import (
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
78
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
79
def tree_files(file_list, default_branch=u'.', canonicalize=True,
81
return internal_tree_files(file_list, default_branch, canonicalize,
85
def tree_files_for_add(file_list):
87
Return a tree and list of absolute paths from a file list.
89
Similar to tree_files, but add handles files a bit differently, so it a
90
custom implementation. In particular, MutableTreeTree.smart_add expects
91
absolute paths, which it immediately converts to relative paths.
93
# FIXME Would be nice to just return the relative paths like
94
# internal_tree_files does, but there are a large number of unit tests
95
# that assume the current interface to mutabletree.smart_add
97
tree, relpath = WorkingTree.open_containing(file_list[0])
98
if tree.supports_views():
99
view_files = tree.views.lookup_view()
101
for filename in file_list:
102
if not osutils.is_inside_any(view_files, filename):
103
raise errors.FileOutsideView(filename, view_files)
104
file_list = file_list[:]
105
file_list[0] = tree.abspath(relpath)
107
tree = WorkingTree.open_containing(u'.')[0]
108
if tree.supports_views():
109
view_files = tree.views.lookup_view()
111
file_list = view_files
112
view_str = views.view_display_str(view_files)
113
note("Ignoring files outside view. View is %s" % view_str)
114
return tree, file_list
117
def _get_one_revision(command_name, revisions):
118
if revisions is None:
120
if len(revisions) != 1:
121
raise errors.BzrCommandError(
122
'bzr %s --revision takes exactly one revision identifier' % (
127
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
128
"""Get a revision tree. Not suitable for commands that change the tree.
130
Specifically, the basis tree in dirstate trees is coupled to the dirstate
131
and doing a commit/uncommit/pull will at best fail due to changing the
134
If tree is passed in, it should be already locked, for lifetime management
135
of the trees internal cached state.
139
if revisions is None:
141
rev_tree = tree.basis_tree()
143
rev_tree = branch.basis_tree()
145
revision = _get_one_revision(command_name, revisions)
146
rev_tree = revision.as_tree(branch)
150
# XXX: Bad function name; should possibly also be a class method of
151
# WorkingTree rather than a function.
152
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
153
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
155
"""Convert command-line paths to a WorkingTree and relative paths.
157
Deprecated: use WorkingTree.open_containing_paths instead.
159
This is typically used for command-line processors that take one or
160
more filenames, and infer the workingtree that contains them.
162
The filenames given are not required to exist.
164
:param file_list: Filenames to convert.
166
:param default_branch: Fallback tree path to use if file_list is empty or
169
:param apply_view: if True and a view is set, apply it or check that
170
specified files are within it
172
:return: workingtree, [relative_paths]
174
return WorkingTree.open_containing_paths(
175
file_list, default_directory='.',
180
def _get_view_info_for_change_reporter(tree):
181
"""Get the view information from a tree for change reporting."""
184
current_view = tree.views.get_view_info()[0]
185
if current_view is not None:
186
view_info = (current_view, tree.views.lookup_view())
187
except errors.ViewsNotSupported:
192
def _open_directory_or_containing_tree_or_branch(filename, directory):
193
"""Open the tree or branch containing the specified file, unless
194
the --directory option is used to specify a different branch."""
195
if directory is not None:
196
return (None, Branch.open(directory), filename)
197
return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
200
# TODO: Make sure no commands unconditionally use the working directory as a
201
# branch. If a filename argument is used, the first of them should be used to
202
# specify the branch. (Perhaps this can be factored out into some kind of
203
# Argument class, representing a file in a branch, where the first occurrence
206
class cmd_status(Command):
207
__doc__ = """Display status summary.
209
This reports on versioned and unknown files, reporting them
210
grouped by state. Possible states are:
213
Versioned in the working copy but not in the previous revision.
216
Versioned in the previous revision but removed or deleted
220
Path of this file changed from the previous revision;
221
the text may also have changed. This includes files whose
222
parent directory was renamed.
225
Text has changed since the previous revision.
228
File kind has been changed (e.g. from file to directory).
231
Not versioned and not matching an ignore pattern.
233
Additionally for directories, symlinks and files with an executable
234
bit, Bazaar indicates their type using a trailing character: '/', '@'
237
To see ignored files use 'bzr ignored'. For details on the
238
changes to file texts, use 'bzr diff'.
240
Note that --short or -S gives status flags for each item, similar
241
to Subversion's status command. To get output similar to svn -q,
244
If no arguments are specified, the status of the entire working
245
directory is shown. Otherwise, only the status of the specified
246
files or directories is reported. If a directory is given, status
247
is reported for everything inside that directory.
249
Before merges are committed, the pending merge tip revisions are
250
shown. To see all pending merge revisions, use the -v option.
251
To skip the display of pending merge information altogether, use
252
the no-pending option or specify a file/directory.
254
If a revision argument is given, the status is calculated against
255
that revision, or between two revisions if two are provided.
258
# TODO: --no-recurse, --recurse options
260
takes_args = ['file*']
261
takes_options = ['show-ids', 'revision', 'change', 'verbose',
262
Option('short', help='Use short status indicators.',
264
Option('versioned', help='Only show versioned files.',
266
Option('no-pending', help='Don\'t show pending merges.',
269
aliases = ['st', 'stat']
271
encoding_type = 'replace'
272
_see_also = ['diff', 'revert', 'status-flags']
275
def run(self, show_ids=False, file_list=None, revision=None, short=False,
276
versioned=False, no_pending=False, verbose=False):
277
from bzrlib.status import show_tree_status
279
if revision and len(revision) > 2:
280
raise errors.BzrCommandError('bzr status --revision takes exactly'
281
' one or two revision specifiers')
283
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
284
# Avoid asking for specific files when that is not needed.
285
if relfile_list == ['']:
287
# Don't disable pending merges for full trees other than '.'.
288
if file_list == ['.']:
290
# A specific path within a tree was given.
291
elif relfile_list is not None:
293
show_tree_status(tree, show_ids=show_ids,
294
specific_files=relfile_list, revision=revision,
295
to_file=self.outf, short=short, versioned=versioned,
296
show_pending=(not no_pending), verbose=verbose)
299
class cmd_cat_revision(Command):
300
__doc__ = """Write out metadata for a revision.
302
The revision to print can either be specified by a specific
303
revision identifier, or you can use --revision.
307
takes_args = ['revision_id?']
308
takes_options = ['directory', 'revision']
309
# cat-revision is more for frontends so should be exact
312
def print_revision(self, revisions, revid):
313
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
314
record = stream.next()
315
if record.storage_kind == 'absent':
316
raise errors.NoSuchRevision(revisions, revid)
317
revtext = record.get_bytes_as('fulltext')
318
self.outf.write(revtext.decode('utf-8'))
321
def run(self, revision_id=None, revision=None, directory=u'.'):
322
if revision_id is not None and revision is not None:
323
raise errors.BzrCommandError('You can only supply one of'
324
' revision_id or --revision')
325
if revision_id is None and revision is None:
326
raise errors.BzrCommandError('You must supply either'
327
' --revision or a revision_id')
328
b = WorkingTree.open_containing(directory)[0].branch
330
revisions = b.repository.revisions
331
if revisions is None:
332
raise errors.BzrCommandError('Repository %r does not support '
333
'access to raw revision texts')
335
b.repository.lock_read()
337
# TODO: jam 20060112 should cat-revision always output utf-8?
338
if revision_id is not None:
339
revision_id = osutils.safe_revision_id(revision_id, warn=False)
341
self.print_revision(revisions, revision_id)
342
except errors.NoSuchRevision:
343
msg = "The repository %s contains no revision %s." % (
344
b.repository.base, revision_id)
345
raise errors.BzrCommandError(msg)
346
elif revision is not None:
349
raise errors.BzrCommandError(
350
'You cannot specify a NULL revision.')
351
rev_id = rev.as_revision_id(b)
352
self.print_revision(revisions, rev_id)
354
b.repository.unlock()
357
class cmd_dump_btree(Command):
358
__doc__ = """Dump the contents of a btree index file to stdout.
360
PATH is a btree index file, it can be any URL. This includes things like
361
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
363
By default, the tuples stored in the index file will be displayed. With
364
--raw, we will uncompress the pages, but otherwise display the raw bytes
368
# TODO: Do we want to dump the internal nodes as well?
369
# TODO: It would be nice to be able to dump the un-parsed information,
370
# rather than only going through iter_all_entries. However, this is
371
# good enough for a start
373
encoding_type = 'exact'
374
takes_args = ['path']
375
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
376
' rather than the parsed tuples.'),
379
def run(self, path, raw=False):
380
dirname, basename = osutils.split(path)
381
t = transport.get_transport(dirname)
383
self._dump_raw_bytes(t, basename)
385
self._dump_entries(t, basename)
387
def _get_index_and_bytes(self, trans, basename):
388
"""Create a BTreeGraphIndex and raw bytes."""
389
bt = btree_index.BTreeGraphIndex(trans, basename, None)
390
bytes = trans.get_bytes(basename)
391
bt._file = cStringIO.StringIO(bytes)
392
bt._size = len(bytes)
395
def _dump_raw_bytes(self, trans, basename):
398
# We need to parse at least the root node.
399
# This is because the first page of every row starts with an
400
# uncompressed header.
401
bt, bytes = self._get_index_and_bytes(trans, basename)
402
for page_idx, page_start in enumerate(xrange(0, len(bytes),
403
btree_index._PAGE_SIZE)):
404
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
405
page_bytes = bytes[page_start:page_end]
407
self.outf.write('Root node:\n')
408
header_end, data = bt._parse_header_from_bytes(page_bytes)
409
self.outf.write(page_bytes[:header_end])
411
self.outf.write('\nPage %d\n' % (page_idx,))
412
decomp_bytes = zlib.decompress(page_bytes)
413
self.outf.write(decomp_bytes)
414
self.outf.write('\n')
416
def _dump_entries(self, trans, basename):
418
st = trans.stat(basename)
419
except errors.TransportNotPossible:
420
# We can't stat, so we'll fake it because we have to do the 'get()'
422
bt, _ = self._get_index_and_bytes(trans, basename)
424
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
425
for node in bt.iter_all_entries():
426
# Node is made up of:
427
# (index, key, value, [references])
431
refs_as_tuples = None
433
refs_as_tuples = static_tuple.as_tuples(refs)
434
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
435
self.outf.write('%s\n' % (as_tuple,))
438
class cmd_remove_tree(Command):
439
__doc__ = """Remove the working tree from a given branch/checkout.
441
Since a lightweight checkout is little more than a working tree
442
this will refuse to run against one.
444
To re-create the working tree, use "bzr checkout".
446
_see_also = ['checkout', 'working-trees']
447
takes_args = ['location*']
450
help='Remove the working tree even if it has '
451
'uncommitted or shelved changes.'),
454
def run(self, location_list, force=False):
455
if not location_list:
458
for location in location_list:
459
d = bzrdir.BzrDir.open(location)
462
working = d.open_workingtree()
463
except errors.NoWorkingTree:
464
raise errors.BzrCommandError("No working tree to remove")
465
except errors.NotLocalUrl:
466
raise errors.BzrCommandError("You cannot remove the working tree"
469
if (working.has_changes()):
470
raise errors.UncommittedChanges(working)
471
if working.get_shelf_manager().last_shelf() is not None:
472
raise errors.ShelvedChanges(working)
474
if working.user_url != working.branch.user_url:
475
raise errors.BzrCommandError("You cannot remove the working tree"
476
" from a lightweight checkout")
478
d.destroy_workingtree()
481
class cmd_revno(Command):
482
__doc__ = """Show current revision number.
484
This is equal to the number of revisions on this branch.
488
takes_args = ['location?']
490
Option('tree', help='Show revno of working tree'),
494
def run(self, tree=False, location=u'.'):
497
wt = WorkingTree.open_containing(location)[0]
498
self.add_cleanup(wt.lock_read().unlock)
499
except (errors.NoWorkingTree, errors.NotLocalUrl):
500
raise errors.NoWorkingTree(location)
501
revid = wt.last_revision()
503
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
504
except errors.NoSuchRevision:
506
revno = ".".join(str(n) for n in revno_t)
508
b = Branch.open_containing(location)[0]
509
self.add_cleanup(b.lock_read().unlock)
512
self.outf.write(str(revno) + '\n')
515
class cmd_revision_info(Command):
516
__doc__ = """Show revision number and revision id for a given revision identifier.
519
takes_args = ['revision_info*']
522
custom_help('directory',
523
help='Branch to examine, '
524
'rather than the one containing the working directory.'),
525
Option('tree', help='Show revno of working tree'),
529
def run(self, revision=None, directory=u'.', tree=False,
530
revision_info_list=[]):
533
wt = WorkingTree.open_containing(directory)[0]
535
self.add_cleanup(wt.lock_read().unlock)
536
except (errors.NoWorkingTree, errors.NotLocalUrl):
538
b = Branch.open_containing(directory)[0]
539
self.add_cleanup(b.lock_read().unlock)
541
if revision is not None:
542
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
543
if revision_info_list is not None:
544
for rev_str in revision_info_list:
545
rev_spec = RevisionSpec.from_string(rev_str)
546
revision_ids.append(rev_spec.as_revision_id(b))
547
# No arguments supplied, default to the last revision
548
if len(revision_ids) == 0:
551
raise errors.NoWorkingTree(directory)
552
revision_ids.append(wt.last_revision())
554
revision_ids.append(b.last_revision())
558
for revision_id in revision_ids:
560
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
561
revno = '.'.join(str(i) for i in dotted_revno)
562
except errors.NoSuchRevision:
564
maxlen = max(maxlen, len(revno))
565
revinfos.append([revno, revision_id])
569
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
572
class cmd_add(Command):
573
__doc__ = """Add specified files or directories.
575
In non-recursive mode, all the named items are added, regardless
576
of whether they were previously ignored. A warning is given if
577
any of the named files are already versioned.
579
In recursive mode (the default), files are treated the same way
580
but the behaviour for directories is different. Directories that
581
are already versioned do not give a warning. All directories,
582
whether already versioned or not, are searched for files or
583
subdirectories that are neither versioned or ignored, and these
584
are added. This search proceeds recursively into versioned
585
directories. If no names are given '.' is assumed.
587
Therefore simply saying 'bzr add' will version all files that
588
are currently unknown.
590
Adding a file whose parent directory is not versioned will
591
implicitly add the parent, and so on up to the root. This means
592
you should never need to explicitly add a directory, they'll just
593
get added when you add a file in the directory.
595
--dry-run will show which files would be added, but not actually
598
--file-ids-from will try to use the file ids from the supplied path.
599
It looks up ids trying to find a matching parent directory with the
600
same filename, and then by pure path. This option is rarely needed
601
but can be useful when adding the same logical file into two
602
branches that will be merged later (without showing the two different
603
adds as a conflict). It is also useful when merging another project
604
into a subdirectory of this one.
606
Any files matching patterns in the ignore list will not be added
607
unless they are explicitly mentioned.
609
takes_args = ['file*']
612
help="Don't recursively add the contents of directories."),
614
help="Show what would be done, but don't actually do anything."),
616
Option('file-ids-from',
618
help='Lookup file ids from this tree.'),
620
encoding_type = 'replace'
621
_see_also = ['remove', 'ignore']
623
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
628
if file_ids_from is not None:
630
base_tree, base_path = WorkingTree.open_containing(
632
except errors.NoWorkingTree:
633
base_branch, base_path = Branch.open_containing(
635
base_tree = base_branch.basis_tree()
637
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
638
to_file=self.outf, should_print=(not is_quiet()))
640
action = bzrlib.add.AddAction(to_file=self.outf,
641
should_print=(not is_quiet()))
644
self.add_cleanup(base_tree.lock_read().unlock)
645
tree, file_list = tree_files_for_add(file_list)
646
added, ignored = tree.smart_add(file_list, not
647
no_recurse, action=action, save=not dry_run)
651
for glob in sorted(ignored.keys()):
652
for path in ignored[glob]:
653
self.outf.write("ignored %s matching \"%s\"\n"
657
class cmd_mkdir(Command):
658
__doc__ = """Create a new versioned directory.
660
This is equivalent to creating the directory and then adding it.
663
takes_args = ['dir+']
664
encoding_type = 'replace'
666
def run(self, dir_list):
668
wt, dd = WorkingTree.open_containing(d)
669
base = os.path.dirname(dd)
670
id = wt.path2id(base)
674
self.outf.write('added %s\n' % d)
676
raise errors.NotVersionedError(path=base)
679
class cmd_relpath(Command):
680
__doc__ = """Show path of a file relative to root"""
682
takes_args = ['filename']
686
def run(self, filename):
687
# TODO: jam 20050106 Can relpath return a munged path if
688
# sys.stdout encoding cannot represent it?
689
tree, relpath = WorkingTree.open_containing(filename)
690
self.outf.write(relpath)
691
self.outf.write('\n')
694
class cmd_inventory(Command):
695
__doc__ = """Show inventory of the current working copy or a revision.
697
It is possible to limit the output to a particular entry
698
type using the --kind option. For example: --kind file.
700
It is also possible to restrict the list of files to a specific
701
set. For example: bzr inventory --show-ids this/file
710
help='List entries of a particular kind: file, directory, symlink.',
713
takes_args = ['file*']
716
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
717
if kind and kind not in ['file', 'directory', 'symlink']:
718
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
720
revision = _get_one_revision('inventory', revision)
721
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
722
self.add_cleanup(work_tree.lock_read().unlock)
723
if revision is not None:
724
tree = revision.as_tree(work_tree.branch)
726
extra_trees = [work_tree]
727
self.add_cleanup(tree.lock_read().unlock)
732
if file_list is not None:
733
file_ids = tree.paths2ids(file_list, trees=extra_trees,
734
require_versioned=True)
735
# find_ids_across_trees may include some paths that don't
737
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
738
for file_id in file_ids if file_id in tree)
740
entries = tree.inventory.entries()
743
for path, entry in entries:
744
if kind and kind != entry.kind:
747
self.outf.write('%-50s %s\n' % (path, entry.file_id))
749
self.outf.write(path)
750
self.outf.write('\n')
753
class cmd_mv(Command):
754
__doc__ = """Move or rename a file.
757
bzr mv OLDNAME NEWNAME
759
bzr mv SOURCE... DESTINATION
761
If the last argument is a versioned directory, all the other names
762
are moved into it. Otherwise, there must be exactly two arguments
763
and the file is changed to a new name.
765
If OLDNAME does not exist on the filesystem but is versioned and
766
NEWNAME does exist on the filesystem but is not versioned, mv
767
assumes that the file has been manually moved and only updates
768
its internal inventory to reflect that change.
769
The same is valid when moving many SOURCE files to a DESTINATION.
771
Files cannot be moved between branches.
774
takes_args = ['names*']
775
takes_options = [Option("after", help="Move only the bzr identifier"
776
" of the file, because the file has already been moved."),
777
Option('auto', help='Automatically guess renames.'),
778
Option('dry-run', help='Avoid making changes when guessing renames.'),
780
aliases = ['move', 'rename']
781
encoding_type = 'replace'
783
def run(self, names_list, after=False, auto=False, dry_run=False):
785
return self.run_auto(names_list, after, dry_run)
787
raise errors.BzrCommandError('--dry-run requires --auto.')
788
if names_list is None:
790
if len(names_list) < 2:
791
raise errors.BzrCommandError("missing file argument")
792
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
793
self.add_cleanup(tree.lock_tree_write().unlock)
794
self._run(tree, names_list, rel_names, after)
796
def run_auto(self, names_list, after, dry_run):
797
if names_list is not None and len(names_list) > 1:
798
raise errors.BzrCommandError('Only one path may be specified to'
801
raise errors.BzrCommandError('--after cannot be specified with'
803
work_tree, file_list = WorkingTree.open_containing_paths(
804
names_list, default_directory='.')
805
self.add_cleanup(work_tree.lock_tree_write().unlock)
806
rename_map.RenameMap.guess_renames(work_tree, dry_run)
808
def _run(self, tree, names_list, rel_names, after):
809
into_existing = osutils.isdir(names_list[-1])
810
if into_existing and len(names_list) == 2:
812
# a. case-insensitive filesystem and change case of dir
813
# b. move directory after the fact (if the source used to be
814
# a directory, but now doesn't exist in the working tree
815
# and the target is an existing directory, just rename it)
816
if (not tree.case_sensitive
817
and rel_names[0].lower() == rel_names[1].lower()):
818
into_existing = False
821
# 'fix' the case of a potential 'from'
822
from_id = tree.path2id(
823
tree.get_canonical_inventory_path(rel_names[0]))
824
if (not osutils.lexists(names_list[0]) and
825
from_id and inv.get_file_kind(from_id) == "directory"):
826
into_existing = False
829
# move into existing directory
830
# All entries reference existing inventory items, so fix them up
831
# for cicp file-systems.
832
rel_names = tree.get_canonical_inventory_paths(rel_names)
833
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
835
self.outf.write("%s => %s\n" % (src, dest))
837
if len(names_list) != 2:
838
raise errors.BzrCommandError('to mv multiple files the'
839
' destination must be a versioned'
842
# for cicp file-systems: the src references an existing inventory
844
src = tree.get_canonical_inventory_path(rel_names[0])
845
# Find the canonical version of the destination: In all cases, the
846
# parent of the target must be in the inventory, so we fetch the
847
# canonical version from there (we do not always *use* the
848
# canonicalized tail portion - we may be attempting to rename the
850
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
851
dest_parent = osutils.dirname(canon_dest)
852
spec_tail = osutils.basename(rel_names[1])
853
# For a CICP file-system, we need to avoid creating 2 inventory
854
# entries that differ only by case. So regardless of the case
855
# we *want* to use (ie, specified by the user or the file-system),
856
# we must always choose to use the case of any existing inventory
857
# items. The only exception to this is when we are attempting a
858
# case-only rename (ie, canonical versions of src and dest are
860
dest_id = tree.path2id(canon_dest)
861
if dest_id is None or tree.path2id(src) == dest_id:
862
# No existing item we care about, so work out what case we
863
# are actually going to use.
865
# If 'after' is specified, the tail must refer to a file on disk.
867
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
869
# pathjoin with an empty tail adds a slash, which breaks
871
dest_parent_fq = tree.basedir
873
dest_tail = osutils.canonical_relpath(
875
osutils.pathjoin(dest_parent_fq, spec_tail))
877
# not 'after', so case as specified is used
878
dest_tail = spec_tail
880
# Use the existing item so 'mv' fails with AlreadyVersioned.
881
dest_tail = os.path.basename(canon_dest)
882
dest = osutils.pathjoin(dest_parent, dest_tail)
883
mutter("attempting to move %s => %s", src, dest)
884
tree.rename_one(src, dest, after=after)
886
self.outf.write("%s => %s\n" % (src, dest))
889
class cmd_pull(Command):
890
__doc__ = """Turn this branch into a mirror of another branch.
892
By default, this command only works on branches that have not diverged.
893
Branches are considered diverged if the destination branch's most recent
894
commit is one that has not been merged (directly or indirectly) into the
897
If branches have diverged, you can use 'bzr merge' to integrate the changes
898
from one into the other. Once one branch has merged, the other should
899
be able to pull it again.
901
If you want to replace your local changes and just want your branch to
902
match the remote one, use pull --overwrite. This will work even if the two
903
branches have diverged.
905
If there is no default location set, the first pull will set it. After
906
that, you can omit the location to use the default. To change the
907
default, use --remember. The value will only be saved if the remote
908
location can be accessed.
910
Note: The location can be specified either in the form of a branch,
911
or in the form of a path to a file containing a merge directive generated
915
_see_also = ['push', 'update', 'status-flags', 'send']
916
takes_options = ['remember', 'overwrite', 'revision',
917
custom_help('verbose',
918
help='Show logs of pulled revisions.'),
919
custom_help('directory',
920
help='Branch to pull into, '
921
'rather than the one containing the working directory.'),
923
help="Perform a local pull in a bound "
924
"branch. Local pulls are not applied to "
928
takes_args = ['location?']
929
encoding_type = 'replace'
931
def run(self, location=None, remember=False, overwrite=False,
932
revision=None, verbose=False,
933
directory=None, local=False):
934
# FIXME: too much stuff is in the command class
937
if directory is None:
940
tree_to = WorkingTree.open_containing(directory)[0]
941
branch_to = tree_to.branch
942
self.add_cleanup(tree_to.lock_write().unlock)
943
except errors.NoWorkingTree:
945
branch_to = Branch.open_containing(directory)[0]
946
self.add_cleanup(branch_to.lock_write().unlock)
948
if local and not branch_to.get_bound_location():
949
raise errors.LocalRequiresBoundBranch()
951
possible_transports = []
952
if location is not None:
954
mergeable = bundle.read_mergeable_from_url(location,
955
possible_transports=possible_transports)
956
except errors.NotABundle:
959
stored_loc = branch_to.get_parent()
961
if stored_loc is None:
962
raise errors.BzrCommandError("No pull location known or"
965
display_url = urlutils.unescape_for_display(stored_loc,
968
self.outf.write("Using saved parent location: %s\n" % display_url)
969
location = stored_loc
971
revision = _get_one_revision('pull', revision)
972
if mergeable is not None:
973
if revision is not None:
974
raise errors.BzrCommandError(
975
'Cannot use -r with merge directives or bundles')
976
mergeable.install_revisions(branch_to.repository)
977
base_revision_id, revision_id, verified = \
978
mergeable.get_merge_request(branch_to.repository)
979
branch_from = branch_to
981
branch_from = Branch.open(location,
982
possible_transports=possible_transports)
983
self.add_cleanup(branch_from.lock_read().unlock)
985
if branch_to.get_parent() is None or remember:
986
branch_to.set_parent(branch_from.base)
988
if revision is not None:
989
revision_id = revision.as_revision_id(branch_from)
991
if tree_to is not None:
992
view_info = _get_view_info_for_change_reporter(tree_to)
993
change_reporter = delta._ChangeReporter(
994
unversioned_filter=tree_to.is_ignored,
996
result = tree_to.pull(
997
branch_from, overwrite, revision_id, change_reporter,
998
possible_transports=possible_transports, local=local)
1000
result = branch_to.pull(
1001
branch_from, overwrite, revision_id, local=local)
1003
result.report(self.outf)
1004
if verbose and result.old_revid != result.new_revid:
1005
log.show_branch_change(
1006
branch_to, self.outf, result.old_revno,
1010
class cmd_push(Command):
1011
__doc__ = """Update a mirror of this branch.
1013
The target branch will not have its working tree populated because this
1014
is both expensive, and is not supported on remote file systems.
1016
Some smart servers or protocols *may* put the working tree in place in
1019
This command only works on branches that have not diverged. Branches are
1020
considered diverged if the destination branch's most recent commit is one
1021
that has not been merged (directly or indirectly) by the source branch.
1023
If branches have diverged, you can use 'bzr push --overwrite' to replace
1024
the other branch completely, discarding its unmerged changes.
1026
If you want to ensure you have the different changes in the other branch,
1027
do a merge (see bzr help merge) from the other branch, and commit that.
1028
After that you will be able to do a push without '--overwrite'.
1030
If there is no default push location set, the first push will set it.
1031
After that, you can omit the location to use the default. To change the
1032
default, use --remember. The value will only be saved if the remote
1033
location can be accessed.
1036
_see_also = ['pull', 'update', 'working-trees']
1037
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1038
Option('create-prefix',
1039
help='Create the path leading up to the branch '
1040
'if it does not already exist.'),
1041
custom_help('directory',
1042
help='Branch to push from, '
1043
'rather than the one containing the working directory.'),
1044
Option('use-existing-dir',
1045
help='By default push will fail if the target'
1046
' directory exists, but does not already'
1047
' have a control directory. This flag will'
1048
' allow push to proceed.'),
1050
help='Create a stacked branch that references the public location '
1051
'of the parent branch.'),
1052
Option('stacked-on',
1053
help='Create a stacked branch that refers to another branch '
1054
'for the commit history. Only the work not present in the '
1055
'referenced branch is included in the branch created.',
1058
help='Refuse to push if there are uncommitted changes in'
1059
' the working tree, --no-strict disables the check.'),
1061
takes_args = ['location?']
1062
encoding_type = 'replace'
1064
def run(self, location=None, remember=False, overwrite=False,
1065
create_prefix=False, verbose=False, revision=None,
1066
use_existing_dir=False, directory=None, stacked_on=None,
1067
stacked=False, strict=None):
1068
from bzrlib.push import _show_push_branch
1070
if directory is None:
1072
# Get the source branch
1074
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1075
# Get the tip's revision_id
1076
revision = _get_one_revision('push', revision)
1077
if revision is not None:
1078
revision_id = revision.in_history(br_from).rev_id
1081
if tree is not None and revision_id is None:
1082
tree.check_changed_or_out_of_date(
1083
strict, 'push_strict',
1084
more_error='Use --no-strict to force the push.',
1085
more_warning='Uncommitted changes will not be pushed.')
1086
# Get the stacked_on branch, if any
1087
if stacked_on is not None:
1088
stacked_on = urlutils.normalize_url(stacked_on)
1090
parent_url = br_from.get_parent()
1092
parent = Branch.open(parent_url)
1093
stacked_on = parent.get_public_branch()
1095
# I considered excluding non-http url's here, thus forcing
1096
# 'public' branches only, but that only works for some
1097
# users, so it's best to just depend on the user spotting an
1098
# error by the feedback given to them. RBC 20080227.
1099
stacked_on = parent_url
1101
raise errors.BzrCommandError(
1102
"Could not determine branch to refer to.")
1104
# Get the destination location
1105
if location is None:
1106
stored_loc = br_from.get_push_location()
1107
if stored_loc is None:
1108
raise errors.BzrCommandError(
1109
"No push location known or specified.")
1111
display_url = urlutils.unescape_for_display(stored_loc,
1113
self.outf.write("Using saved push location: %s\n" % display_url)
1114
location = stored_loc
1116
_show_push_branch(br_from, revision_id, location, self.outf,
1117
verbose=verbose, overwrite=overwrite, remember=remember,
1118
stacked_on=stacked_on, create_prefix=create_prefix,
1119
use_existing_dir=use_existing_dir)
1122
class cmd_branch(Command):
1123
__doc__ = """Create a new branch that is a copy of an existing branch.
1125
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1126
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1127
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1128
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1129
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1132
To retrieve the branch as of a particular revision, supply the --revision
1133
parameter, as in "branch foo/bar -r 5".
1136
_see_also = ['checkout']
1137
takes_args = ['from_location', 'to_location?']
1138
takes_options = ['revision',
1139
Option('hardlink', help='Hard-link working tree files where possible.'),
1140
Option('files-from', type=str,
1141
help="Get file contents from this tree."),
1143
help="Create a branch without a working-tree."),
1145
help="Switch the checkout in the current directory "
1146
"to the new branch."),
1148
help='Create a stacked branch referring to the source branch. '
1149
'The new branch will depend on the availability of the source '
1150
'branch for all operations.'),
1151
Option('standalone',
1152
help='Do not use a shared repository, even if available.'),
1153
Option('use-existing-dir',
1154
help='By default branch will fail if the target'
1155
' directory exists, but does not already'
1156
' have a control directory. This flag will'
1157
' allow branch to proceed.'),
1159
help="Bind new branch to from location."),
1161
aliases = ['get', 'clone']
1163
def run(self, from_location, to_location=None, revision=None,
1164
hardlink=False, stacked=False, standalone=False, no_tree=False,
1165
use_existing_dir=False, switch=False, bind=False,
1167
from bzrlib import switch as _mod_switch
1168
from bzrlib.tag import _merge_tags_if_possible
1169
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1171
if not (hardlink or files_from):
1172
# accelerator_tree is usually slower because you have to read N
1173
# files (no readahead, lots of seeks, etc), but allow the user to
1174
# explicitly request it
1175
accelerator_tree = None
1176
if files_from is not None and files_from != from_location:
1177
accelerator_tree = WorkingTree.open(files_from)
1178
revision = _get_one_revision('branch', revision)
1179
self.add_cleanup(br_from.lock_read().unlock)
1180
if revision is not None:
1181
revision_id = revision.as_revision_id(br_from)
1183
# FIXME - wt.last_revision, fallback to branch, fall back to
1184
# None or perhaps NULL_REVISION to mean copy nothing
1186
revision_id = br_from.last_revision()
1187
if to_location is None:
1188
to_location = urlutils.derive_to_location(from_location)
1189
to_transport = transport.get_transport(to_location)
1191
to_transport.mkdir('.')
1192
except errors.FileExists:
1193
if not use_existing_dir:
1194
raise errors.BzrCommandError('Target directory "%s" '
1195
'already exists.' % to_location)
1198
bzrdir.BzrDir.open_from_transport(to_transport)
1199
except errors.NotBranchError:
1202
raise errors.AlreadyBranchError(to_location)
1203
except errors.NoSuchFile:
1204
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1207
# preserve whatever source format we have.
1208
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1209
possible_transports=[to_transport],
1210
accelerator_tree=accelerator_tree,
1211
hardlink=hardlink, stacked=stacked,
1212
force_new_repo=standalone,
1213
create_tree_if_local=not no_tree,
1214
source_branch=br_from)
1215
branch = dir.open_branch()
1216
except errors.NoSuchRevision:
1217
to_transport.delete_tree('.')
1218
msg = "The branch %s has no revision %s." % (from_location,
1220
raise errors.BzrCommandError(msg)
1221
_merge_tags_if_possible(br_from, branch)
1222
# If the source branch is stacked, the new branch may
1223
# be stacked whether we asked for that explicitly or not.
1224
# We therefore need a try/except here and not just 'if stacked:'
1226
note('Created new stacked branch referring to %s.' %
1227
branch.get_stacked_on_url())
1228
except (errors.NotStacked, errors.UnstackableBranchFormat,
1229
errors.UnstackableRepositoryFormat), e:
1230
note('Branched %d revision(s).' % branch.revno())
1232
# Bind to the parent
1233
parent_branch = Branch.open(from_location)
1234
branch.bind(parent_branch)
1235
note('New branch bound to %s' % from_location)
1237
# Switch to the new branch
1238
wt, _ = WorkingTree.open_containing('.')
1239
_mod_switch.switch(wt.bzrdir, branch)
1240
note('Switched to branch: %s',
1241
urlutils.unescape_for_display(branch.base, 'utf-8'))
1244
class cmd_checkout(Command):
1245
__doc__ = """Create a new checkout of an existing branch.
1247
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1248
the branch found in '.'. This is useful if you have removed the working tree
1249
or if it was never created - i.e. if you pushed the branch to its current
1250
location using SFTP.
1252
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1253
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1254
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1255
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1256
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1259
To retrieve the branch as of a particular revision, supply the --revision
1260
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1261
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1265
_see_also = ['checkouts', 'branch']
1266
takes_args = ['branch_location?', 'to_location?']
1267
takes_options = ['revision',
1268
Option('lightweight',
1269
help="Perform a lightweight checkout. Lightweight "
1270
"checkouts depend on access to the branch for "
1271
"every operation. Normal checkouts can perform "
1272
"common operations like diff and status without "
1273
"such access, and also support local commits."
1275
Option('files-from', type=str,
1276
help="Get file contents from this tree."),
1278
help='Hard-link working tree files where possible.'
1283
def run(self, branch_location=None, to_location=None, revision=None,
1284
lightweight=False, files_from=None, hardlink=False):
1285
if branch_location is None:
1286
branch_location = osutils.getcwd()
1287
to_location = branch_location
1288
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1290
if not (hardlink or files_from):
1291
# accelerator_tree is usually slower because you have to read N
1292
# files (no readahead, lots of seeks, etc), but allow the user to
1293
# explicitly request it
1294
accelerator_tree = None
1295
revision = _get_one_revision('checkout', revision)
1296
if files_from is not None and files_from != branch_location:
1297
accelerator_tree = WorkingTree.open(files_from)
1298
if revision is not None:
1299
revision_id = revision.as_revision_id(source)
1302
if to_location is None:
1303
to_location = urlutils.derive_to_location(branch_location)
1304
# if the source and to_location are the same,
1305
# and there is no working tree,
1306
# then reconstitute a branch
1307
if (osutils.abspath(to_location) ==
1308
osutils.abspath(branch_location)):
1310
source.bzrdir.open_workingtree()
1311
except errors.NoWorkingTree:
1312
source.bzrdir.create_workingtree(revision_id)
1314
source.create_checkout(to_location, revision_id, lightweight,
1315
accelerator_tree, hardlink)
1318
class cmd_renames(Command):
1319
__doc__ = """Show list of renamed files.
1321
# TODO: Option to show renames between two historical versions.
1323
# TODO: Only show renames under dir, rather than in the whole branch.
1324
_see_also = ['status']
1325
takes_args = ['dir?']
1328
def run(self, dir=u'.'):
1329
tree = WorkingTree.open_containing(dir)[0]
1330
self.add_cleanup(tree.lock_read().unlock)
1331
new_inv = tree.inventory
1332
old_tree = tree.basis_tree()
1333
self.add_cleanup(old_tree.lock_read().unlock)
1334
old_inv = old_tree.inventory
1336
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1337
for f, paths, c, v, p, n, k, e in iterator:
1338
if paths[0] == paths[1]:
1342
renames.append(paths)
1344
for old_name, new_name in renames:
1345
self.outf.write("%s => %s\n" % (old_name, new_name))
1348
class cmd_update(Command):
1349
__doc__ = """Update a tree to have the latest code committed to its branch.
1351
This will perform a merge into the working tree, and may generate
1352
conflicts. If you have any local changes, you will still
1353
need to commit them after the update for the update to be complete.
1355
If you want to discard your local changes, you can just do a
1356
'bzr revert' instead of 'bzr commit' after the update.
1358
If the tree's branch is bound to a master branch, it will also update
1359
the branch from the master.
1362
_see_also = ['pull', 'working-trees', 'status-flags']
1363
takes_args = ['dir?']
1364
takes_options = ['revision']
1367
def run(self, dir='.', revision=None):
1368
if revision is not None and len(revision) != 1:
1369
raise errors.BzrCommandError(
1370
"bzr update --revision takes exactly one revision")
1371
tree = WorkingTree.open_containing(dir)[0]
1372
branch = tree.branch
1373
possible_transports = []
1374
master = branch.get_master_branch(
1375
possible_transports=possible_transports)
1376
if master is not None:
1377
branch_location = master.base
1380
branch_location = tree.branch.base
1381
tree.lock_tree_write()
1382
self.add_cleanup(tree.unlock)
1383
# get rid of the final '/' and be ready for display
1384
branch_location = urlutils.unescape_for_display(
1385
branch_location.rstrip('/'),
1387
existing_pending_merges = tree.get_parent_ids()[1:]
1391
# may need to fetch data into a heavyweight checkout
1392
# XXX: this may take some time, maybe we should display a
1394
old_tip = branch.update(possible_transports)
1395
if revision is not None:
1396
revision_id = revision[0].as_revision_id(branch)
1398
revision_id = branch.last_revision()
1399
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1400
revno = branch.revision_id_to_dotted_revno(revision_id)
1401
note("Tree is up to date at revision %s of branch %s" %
1402
('.'.join(map(str, revno)), branch_location))
1404
view_info = _get_view_info_for_change_reporter(tree)
1405
change_reporter = delta._ChangeReporter(
1406
unversioned_filter=tree.is_ignored,
1407
view_info=view_info)
1409
conflicts = tree.update(
1411
possible_transports=possible_transports,
1412
revision=revision_id,
1414
except errors.NoSuchRevision, e:
1415
raise errors.BzrCommandError(
1416
"branch has no revision %s\n"
1417
"bzr update --revision only works"
1418
" for a revision in the branch history"
1420
revno = tree.branch.revision_id_to_dotted_revno(
1421
_mod_revision.ensure_null(tree.last_revision()))
1422
note('Updated to revision %s of branch %s' %
1423
('.'.join(map(str, revno)), branch_location))
1424
parent_ids = tree.get_parent_ids()
1425
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1426
note('Your local commits will now show as pending merges with '
1427
"'bzr status', and can be committed with 'bzr commit'.")
1434
class cmd_info(Command):
1435
__doc__ = """Show information about a working tree, branch or repository.
1437
This command will show all known locations and formats associated to the
1438
tree, branch or repository.
1440
In verbose mode, statistical information is included with each report.
1441
To see extended statistic information, use a verbosity level of 2 or
1442
higher by specifying the verbose option multiple times, e.g. -vv.
1444
Branches and working trees will also report any missing revisions.
1448
Display information on the format and related locations:
1452
Display the above together with extended format information and
1453
basic statistics (like the number of files in the working tree and
1454
number of revisions in the branch and repository):
1458
Display the above together with number of committers to the branch:
1462
_see_also = ['revno', 'working-trees', 'repositories']
1463
takes_args = ['location?']
1464
takes_options = ['verbose']
1465
encoding_type = 'replace'
1468
def run(self, location=None, verbose=False):
1470
noise_level = get_verbosity_level()
1473
from bzrlib.info import show_bzrdir_info
1474
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1475
verbose=noise_level, outfile=self.outf)
1478
class cmd_remove(Command):
1479
__doc__ = """Remove files or directories.
1481
This makes bzr stop tracking changes to the specified files. bzr will delete
1482
them if they can easily be recovered using revert. If no options or
1483
parameters are given bzr will scan for files that are being tracked by bzr
1484
but missing in your tree and stop tracking them for you.
1486
takes_args = ['file*']
1487
takes_options = ['verbose',
1488
Option('new', help='Only remove files that have never been committed.'),
1489
RegistryOption.from_kwargs('file-deletion-strategy',
1490
'The file deletion mode to be used.',
1491
title='Deletion Strategy', value_switches=True, enum_switch=False,
1492
safe='Only delete files if they can be'
1493
' safely recovered (default).',
1494
keep='Delete from bzr but leave the working copy.',
1495
force='Delete all the specified files, even if they can not be '
1496
'recovered and even if they are non-empty directories.')]
1497
aliases = ['rm', 'del']
1498
encoding_type = 'replace'
1500
def run(self, file_list, verbose=False, new=False,
1501
file_deletion_strategy='safe'):
1502
tree, file_list = WorkingTree.open_containing_paths(file_list)
1504
if file_list is not None:
1505
file_list = [f for f in file_list]
1507
self.add_cleanup(tree.lock_write().unlock)
1508
# Heuristics should probably all move into tree.remove_smart or
1511
added = tree.changes_from(tree.basis_tree(),
1512
specific_files=file_list).added
1513
file_list = sorted([f[0] for f in added], reverse=True)
1514
if len(file_list) == 0:
1515
raise errors.BzrCommandError('No matching files.')
1516
elif file_list is None:
1517
# missing files show up in iter_changes(basis) as
1518
# versioned-with-no-kind.
1520
for change in tree.iter_changes(tree.basis_tree()):
1521
# Find paths in the working tree that have no kind:
1522
if change[1][1] is not None and change[6][1] is None:
1523
missing.append(change[1][1])
1524
file_list = sorted(missing, reverse=True)
1525
file_deletion_strategy = 'keep'
1526
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1527
keep_files=file_deletion_strategy=='keep',
1528
force=file_deletion_strategy=='force')
1531
class cmd_file_id(Command):
1532
__doc__ = """Print file_id of a particular file or directory.
1534
The file_id is assigned when the file is first added and remains the
1535
same through all revisions where the file exists, even when it is
1540
_see_also = ['inventory', 'ls']
1541
takes_args = ['filename']
1544
def run(self, filename):
1545
tree, relpath = WorkingTree.open_containing(filename)
1546
i = tree.path2id(relpath)
1548
raise errors.NotVersionedError(filename)
1550
self.outf.write(i + '\n')
1553
class cmd_file_path(Command):
1554
__doc__ = """Print path of file_ids to a file or directory.
1556
This prints one line for each directory down to the target,
1557
starting at the branch root.
1561
takes_args = ['filename']
1564
def run(self, filename):
1565
tree, relpath = WorkingTree.open_containing(filename)
1566
fid = tree.path2id(relpath)
1568
raise errors.NotVersionedError(filename)
1569
segments = osutils.splitpath(relpath)
1570
for pos in range(1, len(segments) + 1):
1571
path = osutils.joinpath(segments[:pos])
1572
self.outf.write("%s\n" % tree.path2id(path))
1575
class cmd_reconcile(Command):
1576
__doc__ = """Reconcile bzr metadata in a branch.
1578
This can correct data mismatches that may have been caused by
1579
previous ghost operations or bzr upgrades. You should only
1580
need to run this command if 'bzr check' or a bzr developer
1581
advises you to run it.
1583
If a second branch is provided, cross-branch reconciliation is
1584
also attempted, which will check that data like the tree root
1585
id which was not present in very early bzr versions is represented
1586
correctly in both branches.
1588
At the same time it is run it may recompress data resulting in
1589
a potential saving in disk space or performance gain.
1591
The branch *MUST* be on a listable system such as local disk or sftp.
1594
_see_also = ['check']
1595
takes_args = ['branch?']
1597
def run(self, branch="."):
1598
from bzrlib.reconcile import reconcile
1599
dir = bzrdir.BzrDir.open(branch)
1603
class cmd_revision_history(Command):
1604
__doc__ = """Display the list of revision ids on a branch."""
1607
takes_args = ['location?']
1612
def run(self, location="."):
1613
branch = Branch.open_containing(location)[0]
1614
for revid in branch.revision_history():
1615
self.outf.write(revid)
1616
self.outf.write('\n')
1619
class cmd_ancestry(Command):
1620
__doc__ = """List all revisions merged into this branch."""
1622
_see_also = ['log', 'revision-history']
1623
takes_args = ['location?']
1628
def run(self, location="."):
1630
wt = WorkingTree.open_containing(location)[0]
1631
except errors.NoWorkingTree:
1632
b = Branch.open(location)
1633
last_revision = b.last_revision()
1636
last_revision = wt.last_revision()
1638
revision_ids = b.repository.get_ancestry(last_revision)
1640
for revision_id in revision_ids:
1641
self.outf.write(revision_id + '\n')
1644
class cmd_init(Command):
1645
__doc__ = """Make a directory into a versioned branch.
1647
Use this to create an empty branch, or before importing an
1650
If there is a repository in a parent directory of the location, then
1651
the history of the branch will be stored in the repository. Otherwise
1652
init creates a standalone branch which carries its own history
1653
in the .bzr directory.
1655
If there is already a branch at the location but it has no working tree,
1656
the tree can be populated with 'bzr checkout'.
1658
Recipe for importing a tree of files::
1664
bzr commit -m "imported project"
1667
_see_also = ['init-repository', 'branch', 'checkout']
1668
takes_args = ['location?']
1670
Option('create-prefix',
1671
help='Create the path leading up to the branch '
1672
'if it does not already exist.'),
1673
RegistryOption('format',
1674
help='Specify a format for this branch. '
1675
'See "help formats".',
1676
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1677
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1678
value_switches=True,
1679
title="Branch format",
1681
Option('append-revisions-only',
1682
help='Never change revnos or the existing log.'
1683
' Append revisions to it only.')
1685
def run(self, location=None, format=None, append_revisions_only=False,
1686
create_prefix=False):
1688
format = bzrdir.format_registry.make_bzrdir('default')
1689
if location is None:
1692
to_transport = transport.get_transport(location)
1694
# The path has to exist to initialize a
1695
# branch inside of it.
1696
# Just using os.mkdir, since I don't
1697
# believe that we want to create a bunch of
1698
# locations if the user supplies an extended path
1700
to_transport.ensure_base()
1701
except errors.NoSuchFile:
1702
if not create_prefix:
1703
raise errors.BzrCommandError("Parent directory of %s"
1705
"\nYou may supply --create-prefix to create all"
1706
" leading parent directories."
1708
to_transport.create_prefix()
1711
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1712
except errors.NotBranchError:
1713
# really a NotBzrDir error...
1714
create_branch = bzrdir.BzrDir.create_branch_convenience
1715
branch = create_branch(to_transport.base, format=format,
1716
possible_transports=[to_transport])
1717
a_bzrdir = branch.bzrdir
1719
from bzrlib.transport.local import LocalTransport
1720
if a_bzrdir.has_branch():
1721
if (isinstance(to_transport, LocalTransport)
1722
and not a_bzrdir.has_workingtree()):
1723
raise errors.BranchExistsWithoutWorkingTree(location)
1724
raise errors.AlreadyBranchError(location)
1725
branch = a_bzrdir.create_branch()
1726
a_bzrdir.create_workingtree()
1727
if append_revisions_only:
1729
branch.set_append_revisions_only(True)
1730
except errors.UpgradeRequired:
1731
raise errors.BzrCommandError('This branch format cannot be set'
1732
' to append-revisions-only. Try --default.')
1734
from bzrlib.info import describe_layout, describe_format
1736
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1737
except (errors.NoWorkingTree, errors.NotLocalUrl):
1739
repository = branch.repository
1740
layout = describe_layout(repository, branch, tree).lower()
1741
format = describe_format(a_bzrdir, repository, branch, tree)
1742
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1743
if repository.is_shared():
1744
#XXX: maybe this can be refactored into transport.path_or_url()
1745
url = repository.bzrdir.root_transport.external_url()
1747
url = urlutils.local_path_from_url(url)
1748
except errors.InvalidURL:
1750
self.outf.write("Using shared repository: %s\n" % url)
1753
class cmd_init_repository(Command):
1754
__doc__ = """Create a shared repository for branches to share storage space.
1756
New branches created under the repository directory will store their
1757
revisions in the repository, not in the branch directory. For branches
1758
with shared history, this reduces the amount of storage needed and
1759
speeds up the creation of new branches.
1761
If the --no-trees option is given then the branches in the repository
1762
will not have working trees by default. They will still exist as
1763
directories on disk, but they will not have separate copies of the
1764
files at a certain revision. This can be useful for repositories that
1765
store branches which are interacted with through checkouts or remote
1766
branches, such as on a server.
1769
Create a shared repository holding just branches::
1771
bzr init-repo --no-trees repo
1774
Make a lightweight checkout elsewhere::
1776
bzr checkout --lightweight repo/trunk trunk-checkout
1781
_see_also = ['init', 'branch', 'checkout', 'repositories']
1782
takes_args = ["location"]
1783
takes_options = [RegistryOption('format',
1784
help='Specify a format for this repository. See'
1785
' "bzr help formats" for details.',
1786
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1787
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1788
value_switches=True, title='Repository format'),
1790
help='Branches in the repository will default to'
1791
' not having a working tree.'),
1793
aliases = ["init-repo"]
1795
def run(self, location, format=None, no_trees=False):
1797
format = bzrdir.format_registry.make_bzrdir('default')
1799
if location is None:
1802
to_transport = transport.get_transport(location)
1803
to_transport.ensure_base()
1805
newdir = format.initialize_on_transport(to_transport)
1806
repo = newdir.create_repository(shared=True)
1807
repo.set_make_working_trees(not no_trees)
1809
from bzrlib.info import show_bzrdir_info
1810
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1813
class cmd_diff(Command):
1814
__doc__ = """Show differences in the working tree, between revisions or branches.
1816
If no arguments are given, all changes for the current tree are listed.
1817
If files are given, only the changes in those files are listed.
1818
Remote and multiple branches can be compared by using the --old and
1819
--new options. If not provided, the default for both is derived from
1820
the first argument, if any, or the current tree if no arguments are
1823
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1824
produces patches suitable for "patch -p1".
1828
2 - unrepresentable changes
1833
Shows the difference in the working tree versus the last commit::
1837
Difference between the working tree and revision 1::
1841
Difference between revision 3 and revision 1::
1845
Difference between revision 3 and revision 1 for branch xxx::
1849
To see the changes introduced in revision X::
1853
Note that in the case of a merge, the -c option shows the changes
1854
compared to the left hand parent. To see the changes against
1855
another parent, use::
1857
bzr diff -r<chosen_parent>..X
1859
The changes introduced by revision 2 (equivalent to -r1..2)::
1863
Show just the differences for file NEWS::
1867
Show the differences in working tree xxx for file NEWS::
1871
Show the differences from branch xxx to this working tree:
1875
Show the differences between two branches for file NEWS::
1877
bzr diff --old xxx --new yyy NEWS
1879
Same as 'bzr diff' but prefix paths with old/ and new/::
1881
bzr diff --prefix old/:new/
1883
_see_also = ['status']
1884
takes_args = ['file*']
1886
Option('diff-options', type=str,
1887
help='Pass these options to the diff program.'),
1888
Option('prefix', type=str,
1890
help='Set prefixes added to old and new filenames, as '
1891
'two values separated by a colon. (eg "old/:new/").'),
1893
help='Branch/tree to compare from.',
1897
help='Branch/tree to compare to.',
1903
help='Use this command to compare files.',
1906
RegistryOption('format',
1907
help='Diff format to use.',
1908
lazy_registry=('bzrlib.diff', 'format_registry'),
1909
value_switches=False, title='Diff format'),
1911
aliases = ['di', 'dif']
1912
encoding_type = 'exact'
1915
def run(self, revision=None, file_list=None, diff_options=None,
1916
prefix=None, old=None, new=None, using=None, format=None):
1917
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1920
if (prefix is None) or (prefix == '0'):
1928
old_label, new_label = prefix.split(":")
1930
raise errors.BzrCommandError(
1931
'--prefix expects two values separated by a colon'
1932
' (eg "old/:new/")')
1934
if using is not None and diff_options is not None:
1935
raise errors.BzrCommandError(
1936
'--diff-options and --using are mutually exclusive.')
1938
if revision and len(revision) > 2:
1939
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1940
' one or two revision specifiers')
1942
if using is not None and format is not None:
1943
raise errors.BzrCommandError('--using and --format are mutually '
1946
(old_tree, new_tree,
1947
old_branch, new_branch,
1948
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1949
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1950
# GNU diff on Windows uses ANSI encoding for filenames
1951
path_encoding = osutils.get_diff_header_encoding()
1952
return show_diff_trees(old_tree, new_tree, sys.stdout,
1953
specific_files=specific_files,
1954
external_diff_options=diff_options,
1955
old_label=old_label, new_label=new_label,
1956
extra_trees=extra_trees,
1957
path_encoding=path_encoding,
1962
class cmd_deleted(Command):
1963
__doc__ = """List files deleted in the working tree.
1965
# TODO: Show files deleted since a previous revision, or
1966
# between two revisions.
1967
# TODO: Much more efficient way to do this: read in new
1968
# directories with readdir, rather than stating each one. Same
1969
# level of effort but possibly much less IO. (Or possibly not,
1970
# if the directories are very large...)
1971
_see_also = ['status', 'ls']
1972
takes_options = ['directory', 'show-ids']
1975
def run(self, show_ids=False, directory=u'.'):
1976
tree = WorkingTree.open_containing(directory)[0]
1977
self.add_cleanup(tree.lock_read().unlock)
1978
old = tree.basis_tree()
1979
self.add_cleanup(old.lock_read().unlock)
1980
for path, ie in old.inventory.iter_entries():
1981
if not tree.has_id(ie.file_id):
1982
self.outf.write(path)
1984
self.outf.write(' ')
1985
self.outf.write(ie.file_id)
1986
self.outf.write('\n')
1989
class cmd_modified(Command):
1990
__doc__ = """List files modified in working tree.
1994
_see_also = ['status', 'ls']
1995
takes_options = ['directory', 'null']
1998
def run(self, null=False, directory=u'.'):
1999
tree = WorkingTree.open_containing(directory)[0]
2000
td = tree.changes_from(tree.basis_tree())
2001
for path, id, kind, text_modified, meta_modified in td.modified:
2003
self.outf.write(path + '\0')
2005
self.outf.write(osutils.quotefn(path) + '\n')
2008
class cmd_added(Command):
2009
__doc__ = """List files added in working tree.
2013
_see_also = ['status', 'ls']
2014
takes_options = ['directory', 'null']
2017
def run(self, null=False, directory=u'.'):
2018
wt = WorkingTree.open_containing(directory)[0]
2019
self.add_cleanup(wt.lock_read().unlock)
2020
basis = wt.basis_tree()
2021
self.add_cleanup(basis.lock_read().unlock)
2022
basis_inv = basis.inventory
2025
if file_id in basis_inv:
2027
if inv.is_root(file_id) and len(basis_inv) == 0:
2029
path = inv.id2path(file_id)
2030
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2033
self.outf.write(path + '\0')
2035
self.outf.write(osutils.quotefn(path) + '\n')
2038
class cmd_root(Command):
2039
__doc__ = """Show the tree root directory.
2041
The root is the nearest enclosing directory with a .bzr control
2044
takes_args = ['filename?']
2046
def run(self, filename=None):
2047
"""Print the branch root."""
2048
tree = WorkingTree.open_containing(filename)[0]
2049
self.outf.write(tree.basedir + '\n')
2052
def _parse_limit(limitstring):
2054
return int(limitstring)
2056
msg = "The limit argument must be an integer."
2057
raise errors.BzrCommandError(msg)
2060
def _parse_levels(s):
2064
msg = "The levels argument must be an integer."
2065
raise errors.BzrCommandError(msg)
2068
class cmd_log(Command):
2069
__doc__ = """Show historical log for a branch or subset of a branch.
2071
log is bzr's default tool for exploring the history of a branch.
2072
The branch to use is taken from the first parameter. If no parameters
2073
are given, the branch containing the working directory is logged.
2074
Here are some simple examples::
2076
bzr log log the current branch
2077
bzr log foo.py log a file in its branch
2078
bzr log http://server/branch log a branch on a server
2080
The filtering, ordering and information shown for each revision can
2081
be controlled as explained below. By default, all revisions are
2082
shown sorted (topologically) so that newer revisions appear before
2083
older ones and descendants always appear before ancestors. If displayed,
2084
merged revisions are shown indented under the revision in which they
2089
The log format controls how information about each revision is
2090
displayed. The standard log formats are called ``long``, ``short``
2091
and ``line``. The default is long. See ``bzr help log-formats``
2092
for more details on log formats.
2094
The following options can be used to control what information is
2097
-l N display a maximum of N revisions
2098
-n N display N levels of revisions (0 for all, 1 for collapsed)
2099
-v display a status summary (delta) for each revision
2100
-p display a diff (patch) for each revision
2101
--show-ids display revision-ids (and file-ids), not just revnos
2103
Note that the default number of levels to display is a function of the
2104
log format. If the -n option is not used, the standard log formats show
2105
just the top level (mainline).
2107
Status summaries are shown using status flags like A, M, etc. To see
2108
the changes explained using words like ``added`` and ``modified``
2109
instead, use the -vv option.
2113
To display revisions from oldest to newest, use the --forward option.
2114
In most cases, using this option will have little impact on the total
2115
time taken to produce a log, though --forward does not incrementally
2116
display revisions like --reverse does when it can.
2118
:Revision filtering:
2120
The -r option can be used to specify what revision or range of revisions
2121
to filter against. The various forms are shown below::
2123
-rX display revision X
2124
-rX.. display revision X and later
2125
-r..Y display up to and including revision Y
2126
-rX..Y display from X to Y inclusive
2128
See ``bzr help revisionspec`` for details on how to specify X and Y.
2129
Some common examples are given below::
2131
-r-1 show just the tip
2132
-r-10.. show the last 10 mainline revisions
2133
-rsubmit:.. show what's new on this branch
2134
-rancestor:path.. show changes since the common ancestor of this
2135
branch and the one at location path
2136
-rdate:yesterday.. show changes since yesterday
2138
When logging a range of revisions using -rX..Y, log starts at
2139
revision Y and searches back in history through the primary
2140
("left-hand") parents until it finds X. When logging just the
2141
top level (using -n1), an error is reported if X is not found
2142
along the way. If multi-level logging is used (-n0), X may be
2143
a nested merge revision and the log will be truncated accordingly.
2147
If parameters are given and the first one is not a branch, the log
2148
will be filtered to show only those revisions that changed the
2149
nominated files or directories.
2151
Filenames are interpreted within their historical context. To log a
2152
deleted file, specify a revision range so that the file existed at
2153
the end or start of the range.
2155
Historical context is also important when interpreting pathnames of
2156
renamed files/directories. Consider the following example:
2158
* revision 1: add tutorial.txt
2159
* revision 2: modify tutorial.txt
2160
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2164
* ``bzr log guide.txt`` will log the file added in revision 1
2166
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2168
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2169
the original file in revision 2.
2171
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2172
was no file called guide.txt in revision 2.
2174
Renames are always followed by log. By design, there is no need to
2175
explicitly ask for this (and no way to stop logging a file back
2176
until it was last renamed).
2180
The --message option can be used for finding revisions that match a
2181
regular expression in a commit message.
2185
GUI tools and IDEs are often better at exploring history than command
2186
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2187
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2188
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2189
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2191
You may find it useful to add the aliases below to ``bazaar.conf``::
2195
top = log -l10 --line
2198
``bzr tip`` will then show the latest revision while ``bzr top``
2199
will show the last 10 mainline revisions. To see the details of a
2200
particular revision X, ``bzr show -rX``.
2202
If you are interested in looking deeper into a particular merge X,
2203
use ``bzr log -n0 -rX``.
2205
``bzr log -v`` on a branch with lots of history is currently
2206
very slow. A fix for this issue is currently under development.
2207
With or without that fix, it is recommended that a revision range
2208
be given when using the -v option.
2210
bzr has a generic full-text matching plugin, bzr-search, that can be
2211
used to find revisions matching user names, commit messages, etc.
2212
Among other features, this plugin can find all revisions containing
2213
a list of words but not others.
2215
When exploring non-mainline history on large projects with deep
2216
history, the performance of log can be greatly improved by installing
2217
the historycache plugin. This plugin buffers historical information
2218
trading disk space for faster speed.
2220
takes_args = ['file*']
2221
_see_also = ['log-formats', 'revisionspec']
2224
help='Show from oldest to newest.'),
2226
custom_help('verbose',
2227
help='Show files changed in each revision.'),
2231
type=bzrlib.option._parse_revision_str,
2233
help='Show just the specified revision.'
2234
' See also "help revisionspec".'),
2236
RegistryOption('authors',
2237
'What names to list as authors - first, all or committer.',
2239
lazy_registry=('bzrlib.log', 'author_list_registry'),
2243
help='Number of levels to display - 0 for all, 1 for flat.',
2245
type=_parse_levels),
2248
help='Show revisions whose message matches this '
2249
'regular expression.',
2253
help='Limit the output to the first N revisions.',
2258
help='Show changes made in each revision as a patch.'),
2259
Option('include-merges',
2260
help='Show merged revisions like --levels 0 does.'),
2261
Option('exclude-common-ancestry',
2262
help='Display only the revisions that are not part'
2263
' of both ancestries (require -rX..Y)'
2266
encoding_type = 'replace'
2269
def run(self, file_list=None, timezone='original',
2280
include_merges=False,
2282
exclude_common_ancestry=False,
2284
from bzrlib.log import (
2286
make_log_request_dict,
2287
_get_info_for_log_files,
2289
direction = (forward and 'forward') or 'reverse'
2290
if (exclude_common_ancestry
2291
and (revision is None or len(revision) != 2)):
2292
raise errors.BzrCommandError(
2293
'--exclude-common-ancestry requires -r with two revisions')
2298
raise errors.BzrCommandError(
2299
'--levels and --include-merges are mutually exclusive')
2301
if change is not None:
2303
raise errors.RangeInChangeOption()
2304
if revision is not None:
2305
raise errors.BzrCommandError(
2306
'--revision and --change are mutually exclusive')
2311
filter_by_dir = False
2313
# find the file ids to log and check for directory filtering
2314
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2315
revision, file_list, self.add_cleanup)
2316
for relpath, file_id, kind in file_info_list:
2318
raise errors.BzrCommandError(
2319
"Path unknown at end or start of revision range: %s" %
2321
# If the relpath is the top of the tree, we log everything
2326
file_ids.append(file_id)
2327
filter_by_dir = filter_by_dir or (
2328
kind in ['directory', 'tree-reference'])
2331
# FIXME ? log the current subdir only RBC 20060203
2332
if revision is not None \
2333
and len(revision) > 0 and revision[0].get_branch():
2334
location = revision[0].get_branch()
2337
dir, relpath = bzrdir.BzrDir.open_containing(location)
2338
b = dir.open_branch()
2339
self.add_cleanup(b.lock_read().unlock)
2340
rev1, rev2 = _get_revision_range(revision, b, self.name())
2342
# Decide on the type of delta & diff filtering to use
2343
# TODO: add an --all-files option to make this configurable & consistent
2351
diff_type = 'partial'
2355
# Build the log formatter
2356
if log_format is None:
2357
log_format = log.log_formatter_registry.get_default(b)
2358
# Make a non-encoding output to include the diffs - bug 328007
2359
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2360
lf = log_format(show_ids=show_ids, to_file=self.outf,
2361
to_exact_file=unencoded_output,
2362
show_timezone=timezone,
2363
delta_format=get_verbosity_level(),
2365
show_advice=levels is None,
2366
author_list_handler=authors)
2368
# Choose the algorithm for doing the logging. It's annoying
2369
# having multiple code paths like this but necessary until
2370
# the underlying repository format is faster at generating
2371
# deltas or can provide everything we need from the indices.
2372
# The default algorithm - match-using-deltas - works for
2373
# multiple files and directories and is faster for small
2374
# amounts of history (200 revisions say). However, it's too
2375
# slow for logging a single file in a repository with deep
2376
# history, i.e. > 10K revisions. In the spirit of "do no
2377
# evil when adding features", we continue to use the
2378
# original algorithm - per-file-graph - for the "single
2379
# file that isn't a directory without showing a delta" case.
2380
partial_history = revision and b.repository._format.supports_chks
2381
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2382
or delta_type or partial_history)
2384
# Build the LogRequest and execute it
2385
if len(file_ids) == 0:
2387
rqst = make_log_request_dict(
2388
direction=direction, specific_fileids=file_ids,
2389
start_revision=rev1, end_revision=rev2, limit=limit,
2390
message_search=message, delta_type=delta_type,
2391
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2392
exclude_common_ancestry=exclude_common_ancestry,
2394
Logger(b, rqst).show(lf)
2397
def _get_revision_range(revisionspec_list, branch, command_name):
2398
"""Take the input of a revision option and turn it into a revision range.
2400
It returns RevisionInfo objects which can be used to obtain the rev_id's
2401
of the desired revisions. It does some user input validations.
2403
if revisionspec_list is None:
2406
elif len(revisionspec_list) == 1:
2407
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2408
elif len(revisionspec_list) == 2:
2409
start_spec = revisionspec_list[0]
2410
end_spec = revisionspec_list[1]
2411
if end_spec.get_branch() != start_spec.get_branch():
2412
# b is taken from revision[0].get_branch(), and
2413
# show_log will use its revision_history. Having
2414
# different branches will lead to weird behaviors.
2415
raise errors.BzrCommandError(
2416
"bzr %s doesn't accept two revisions in different"
2417
" branches." % command_name)
2418
if start_spec.spec is None:
2419
# Avoid loading all the history.
2420
rev1 = RevisionInfo(branch, None, None)
2422
rev1 = start_spec.in_history(branch)
2423
# Avoid loading all of history when we know a missing
2424
# end of range means the last revision ...
2425
if end_spec.spec is None:
2426
last_revno, last_revision_id = branch.last_revision_info()
2427
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2429
rev2 = end_spec.in_history(branch)
2431
raise errors.BzrCommandError(
2432
'bzr %s --revision takes one or two values.' % command_name)
2436
def _revision_range_to_revid_range(revision_range):
2439
if revision_range[0] is not None:
2440
rev_id1 = revision_range[0].rev_id
2441
if revision_range[1] is not None:
2442
rev_id2 = revision_range[1].rev_id
2443
return rev_id1, rev_id2
2445
def get_log_format(long=False, short=False, line=False, default='long'):
2446
log_format = default
2450
log_format = 'short'
2456
class cmd_touching_revisions(Command):
2457
__doc__ = """Return revision-ids which affected a particular file.
2459
A more user-friendly interface is "bzr log FILE".
2463
takes_args = ["filename"]
2466
def run(self, filename):
2467
tree, relpath = WorkingTree.open_containing(filename)
2468
file_id = tree.path2id(relpath)
2470
self.add_cleanup(b.lock_read().unlock)
2471
touching_revs = log.find_touching_revisions(b, file_id)
2472
for revno, revision_id, what in touching_revs:
2473
self.outf.write("%6d %s\n" % (revno, what))
2476
class cmd_ls(Command):
2477
__doc__ = """List files in a tree.
2480
_see_also = ['status', 'cat']
2481
takes_args = ['path?']
2485
Option('recursive', short_name='R',
2486
help='Recurse into subdirectories.'),
2488
help='Print paths relative to the root of the branch.'),
2489
Option('unknown', short_name='u',
2490
help='Print unknown files.'),
2491
Option('versioned', help='Print versioned files.',
2493
Option('ignored', short_name='i',
2494
help='Print ignored files.'),
2495
Option('kind', short_name='k',
2496
help='List entries of a particular kind: file, directory, symlink.',
2503
def run(self, revision=None, verbose=False,
2504
recursive=False, from_root=False,
2505
unknown=False, versioned=False, ignored=False,
2506
null=False, kind=None, show_ids=False, path=None, directory=None):
2508
if kind and kind not in ('file', 'directory', 'symlink'):
2509
raise errors.BzrCommandError('invalid kind specified')
2511
if verbose and null:
2512
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2513
all = not (unknown or versioned or ignored)
2515
selection = {'I':ignored, '?':unknown, 'V':versioned}
2521
raise errors.BzrCommandError('cannot specify both --from-root'
2524
tree, branch, relpath = \
2525
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2527
# Calculate the prefix to use
2531
prefix = relpath + '/'
2532
elif fs_path != '.' and not fs_path.endswith('/'):
2533
prefix = fs_path + '/'
2535
if revision is not None or tree is None:
2536
tree = _get_one_revision_tree('ls', revision, branch=branch)
2539
if isinstance(tree, WorkingTree) and tree.supports_views():
2540
view_files = tree.views.lookup_view()
2543
view_str = views.view_display_str(view_files)
2544
note("Ignoring files outside view. View is %s" % view_str)
2546
self.add_cleanup(tree.lock_read().unlock)
2547
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2548
from_dir=relpath, recursive=recursive):
2549
# Apply additional masking
2550
if not all and not selection[fc]:
2552
if kind is not None and fkind != kind:
2557
fullpath = osutils.pathjoin(relpath, fp)
2560
views.check_path_in_view(tree, fullpath)
2561
except errors.FileOutsideView:
2566
fp = osutils.pathjoin(prefix, fp)
2567
kindch = entry.kind_character()
2568
outstring = fp + kindch
2569
ui.ui_factory.clear_term()
2571
outstring = '%-8s %s' % (fc, outstring)
2572
if show_ids and fid is not None:
2573
outstring = "%-50s %s" % (outstring, fid)
2574
self.outf.write(outstring + '\n')
2576
self.outf.write(fp + '\0')
2579
self.outf.write(fid)
2580
self.outf.write('\0')
2588
self.outf.write('%-50s %s\n' % (outstring, my_id))
2590
self.outf.write(outstring + '\n')
2593
class cmd_unknowns(Command):
2594
__doc__ = """List unknown files.
2599
takes_options = ['directory']
2602
def run(self, directory=u'.'):
2603
for f in WorkingTree.open_containing(directory)[0].unknowns():
2604
self.outf.write(osutils.quotefn(f) + '\n')
2607
class cmd_ignore(Command):
2608
__doc__ = """Ignore specified files or patterns.
2610
See ``bzr help patterns`` for details on the syntax of patterns.
2612
If a .bzrignore file does not exist, the ignore command
2613
will create one and add the specified files or patterns to the newly
2614
created file. The ignore command will also automatically add the
2615
.bzrignore file to be versioned. Creating a .bzrignore file without
2616
the use of the ignore command will require an explicit add command.
2618
To remove patterns from the ignore list, edit the .bzrignore file.
2619
After adding, editing or deleting that file either indirectly by
2620
using this command or directly by using an editor, be sure to commit
2623
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2624
the global ignore file can be found in the application data directory as
2625
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2626
Global ignores are not touched by this command. The global ignore file
2627
can be edited directly using an editor.
2629
Patterns prefixed with '!' are exceptions to ignore patterns and take
2630
precedence over regular ignores. Such exceptions are used to specify
2631
files that should be versioned which would otherwise be ignored.
2633
Patterns prefixed with '!!' act as regular ignore patterns, but have
2634
precedence over the '!' exception patterns.
2636
Note: ignore patterns containing shell wildcards must be quoted from
2640
Ignore the top level Makefile::
2642
bzr ignore ./Makefile
2644
Ignore .class files in all directories...::
2646
bzr ignore "*.class"
2648
...but do not ignore "special.class"::
2650
bzr ignore "!special.class"
2652
Ignore .o files under the lib directory::
2654
bzr ignore "lib/**/*.o"
2656
Ignore .o files under the lib directory::
2658
bzr ignore "RE:lib/.*\.o"
2660
Ignore everything but the "debian" toplevel directory::
2662
bzr ignore "RE:(?!debian/).*"
2664
Ignore everything except the "local" toplevel directory,
2665
but always ignore "*~" autosave files, even under local/::
2668
bzr ignore "!./local"
2672
_see_also = ['status', 'ignored', 'patterns']
2673
takes_args = ['name_pattern*']
2674
takes_options = ['directory',
2675
Option('default-rules',
2676
help='Display the default ignore rules that bzr uses.')
2679
def run(self, name_pattern_list=None, default_rules=None,
2681
from bzrlib import ignores
2682
if default_rules is not None:
2683
# dump the default rules and exit
2684
for pattern in ignores.USER_DEFAULTS:
2685
self.outf.write("%s\n" % pattern)
2687
if not name_pattern_list:
2688
raise errors.BzrCommandError("ignore requires at least one "
2689
"NAME_PATTERN or --default-rules.")
2690
name_pattern_list = [globbing.normalize_pattern(p)
2691
for p in name_pattern_list]
2693
for p in name_pattern_list:
2694
if not globbing.Globster.is_pattern_valid(p):
2695
bad_patterns += ('\n %s' % p)
2697
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2698
ui.ui_factory.show_error(msg)
2699
raise errors.InvalidPattern('')
2700
for name_pattern in name_pattern_list:
2701
if (name_pattern[0] == '/' or
2702
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2703
raise errors.BzrCommandError(
2704
"NAME_PATTERN should not be an absolute path")
2705
tree, relpath = WorkingTree.open_containing(directory)
2706
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2707
ignored = globbing.Globster(name_pattern_list)
2709
self.add_cleanup(tree.lock_read().unlock)
2710
for entry in tree.list_files():
2714
if ignored.match(filename):
2715
matches.append(filename)
2716
if len(matches) > 0:
2717
self.outf.write("Warning: the following files are version controlled and"
2718
" match your ignore pattern:\n%s"
2719
"\nThese files will continue to be version controlled"
2720
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2723
class cmd_ignored(Command):
2724
__doc__ = """List ignored files and the patterns that matched them.
2726
List all the ignored files and the ignore pattern that caused the file to
2729
Alternatively, to list just the files::
2734
encoding_type = 'replace'
2735
_see_also = ['ignore', 'ls']
2736
takes_options = ['directory']
2739
def run(self, directory=u'.'):
2740
tree = WorkingTree.open_containing(directory)[0]
2741
self.add_cleanup(tree.lock_read().unlock)
2742
for path, file_class, kind, file_id, entry in tree.list_files():
2743
if file_class != 'I':
2745
## XXX: Slightly inefficient since this was already calculated
2746
pat = tree.is_ignored(path)
2747
self.outf.write('%-50s %s\n' % (path, pat))
2750
class cmd_lookup_revision(Command):
2751
__doc__ = """Lookup the revision-id from a revision-number
2754
bzr lookup-revision 33
2757
takes_args = ['revno']
2758
takes_options = ['directory']
2761
def run(self, revno, directory=u'.'):
2765
raise errors.BzrCommandError("not a valid revision-number: %r"
2767
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2768
self.outf.write("%s\n" % revid)
2771
class cmd_export(Command):
2772
__doc__ = """Export current or past revision to a destination directory or archive.
2774
If no revision is specified this exports the last committed revision.
2776
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2777
given, try to find the format with the extension. If no extension
2778
is found exports to a directory (equivalent to --format=dir).
2780
If root is supplied, it will be used as the root directory inside
2781
container formats (tar, zip, etc). If it is not supplied it will default
2782
to the exported filename. The root option has no effect for 'dir' format.
2784
If branch is omitted then the branch containing the current working
2785
directory will be used.
2787
Note: Export of tree with non-ASCII filenames to zip is not supported.
2789
================= =========================
2790
Supported formats Autodetected by extension
2791
================= =========================
2794
tbz2 .tar.bz2, .tbz2
2797
================= =========================
2799
takes_args = ['dest', 'branch_or_subdir?']
2800
takes_options = ['directory',
2802
help="Type of file to export to.",
2805
Option('filters', help='Apply content filters to export the '
2806
'convenient form.'),
2809
help="Name of the root directory inside the exported file."),
2810
Option('per-file-timestamps',
2811
help='Set modification time of files to that of the last '
2812
'revision in which it was changed.'),
2814
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2815
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2816
from bzrlib.export import export
2818
if branch_or_subdir is None:
2819
tree = WorkingTree.open_containing(directory)[0]
2823
b, subdir = Branch.open_containing(branch_or_subdir)
2826
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2828
export(rev_tree, dest, format, root, subdir, filtered=filters,
2829
per_file_timestamps=per_file_timestamps)
2830
except errors.NoSuchExportFormat, e:
2831
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2834
class cmd_cat(Command):
2835
__doc__ = """Write the contents of a file as of a given revision to standard output.
2837
If no revision is nominated, the last revision is used.
2839
Note: Take care to redirect standard output when using this command on a
2844
takes_options = ['directory',
2845
Option('name-from-revision', help='The path name in the old tree.'),
2846
Option('filters', help='Apply content filters to display the '
2847
'convenience form.'),
2850
takes_args = ['filename']
2851
encoding_type = 'exact'
2854
def run(self, filename, revision=None, name_from_revision=False,
2855
filters=False, directory=None):
2856
if revision is not None and len(revision) != 1:
2857
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2858
" one revision specifier")
2859
tree, branch, relpath = \
2860
_open_directory_or_containing_tree_or_branch(filename, directory)
2861
self.add_cleanup(branch.lock_read().unlock)
2862
return self._run(tree, branch, relpath, filename, revision,
2863
name_from_revision, filters)
2865
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2868
tree = b.basis_tree()
2869
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2870
self.add_cleanup(rev_tree.lock_read().unlock)
2872
old_file_id = rev_tree.path2id(relpath)
2874
if name_from_revision:
2875
# Try in revision if requested
2876
if old_file_id is None:
2877
raise errors.BzrCommandError(
2878
"%r is not present in revision %s" % (
2879
filename, rev_tree.get_revision_id()))
2881
content = rev_tree.get_file_text(old_file_id)
2883
cur_file_id = tree.path2id(relpath)
2885
if cur_file_id is not None:
2886
# Then try with the actual file id
2888
content = rev_tree.get_file_text(cur_file_id)
2890
except errors.NoSuchId:
2891
# The actual file id didn't exist at that time
2893
if not found and old_file_id is not None:
2894
# Finally try with the old file id
2895
content = rev_tree.get_file_text(old_file_id)
2898
# Can't be found anywhere
2899
raise errors.BzrCommandError(
2900
"%r is not present in revision %s" % (
2901
filename, rev_tree.get_revision_id()))
2903
from bzrlib.filters import (
2904
ContentFilterContext,
2905
filtered_output_bytes,
2907
filters = rev_tree._content_filter_stack(relpath)
2908
chunks = content.splitlines(True)
2909
content = filtered_output_bytes(chunks, filters,
2910
ContentFilterContext(relpath, rev_tree))
2912
self.outf.writelines(content)
2915
self.outf.write(content)
2918
class cmd_local_time_offset(Command):
2919
__doc__ = """Show the offset in seconds from GMT to local time."""
2923
self.outf.write("%s\n" % osutils.local_time_offset())
2927
class cmd_commit(Command):
2928
__doc__ = """Commit changes into a new revision.
2930
An explanatory message needs to be given for each commit. This is
2931
often done by using the --message option (getting the message from the
2932
command line) or by using the --file option (getting the message from
2933
a file). If neither of these options is given, an editor is opened for
2934
the user to enter the message. To see the changed files in the
2935
boilerplate text loaded into the editor, use the --show-diff option.
2937
By default, the entire tree is committed and the person doing the
2938
commit is assumed to be the author. These defaults can be overridden
2943
If selected files are specified, only changes to those files are
2944
committed. If a directory is specified then the directory and
2945
everything within it is committed.
2947
When excludes are given, they take precedence over selected files.
2948
For example, to commit only changes within foo, but not changes
2951
bzr commit foo -x foo/bar
2953
A selective commit after a merge is not yet supported.
2957
If the author of the change is not the same person as the committer,
2958
you can specify the author's name using the --author option. The
2959
name should be in the same format as a committer-id, e.g.
2960
"John Doe <jdoe@example.com>". If there is more than one author of
2961
the change you can specify the option multiple times, once for each
2966
A common mistake is to forget to add a new file or directory before
2967
running the commit command. The --strict option checks for unknown
2968
files and aborts the commit if any are found. More advanced pre-commit
2969
checks can be implemented by defining hooks. See ``bzr help hooks``
2974
If you accidentially commit the wrong changes or make a spelling
2975
mistake in the commit message say, you can use the uncommit command
2976
to undo it. See ``bzr help uncommit`` for details.
2978
Hooks can also be configured to run after a commit. This allows you
2979
to trigger updates to external systems like bug trackers. The --fixes
2980
option can be used to record the association between a revision and
2981
one or more bugs. See ``bzr help bugs`` for details.
2983
A selective commit may fail in some cases where the committed
2984
tree would be invalid. Consider::
2989
bzr commit foo -m "committing foo"
2990
bzr mv foo/bar foo/baz
2993
bzr commit foo/bar -m "committing bar but not baz"
2995
In the example above, the last commit will fail by design. This gives
2996
the user the opportunity to decide whether they want to commit the
2997
rename at the same time, separately first, or not at all. (As a general
2998
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3000
# TODO: Run hooks on tree to-be-committed, and after commit.
3002
# TODO: Strict commit that fails if there are deleted files.
3003
# (what does "deleted files" mean ??)
3005
# TODO: Give better message for -s, --summary, used by tla people
3007
# XXX: verbose currently does nothing
3009
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3010
takes_args = ['selected*']
3012
ListOption('exclude', type=str, short_name='x',
3013
help="Do not consider changes made to a given path."),
3014
Option('message', type=unicode,
3016
help="Description of the new revision."),
3019
help='Commit even if nothing has changed.'),
3020
Option('file', type=str,
3023
help='Take commit message from this file.'),
3025
help="Refuse to commit if there are unknown "
3026
"files in the working tree."),
3027
Option('commit-time', type=str,
3028
help="Manually set a commit time using commit date "
3029
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3030
ListOption('fixes', type=str,
3031
help="Mark a bug as being fixed by this revision "
3032
"(see \"bzr help bugs\")."),
3033
ListOption('author', type=unicode,
3034
help="Set the author's name, if it's different "
3035
"from the committer."),
3037
help="Perform a local commit in a bound "
3038
"branch. Local commits are not pushed to "
3039
"the master branch until a normal commit "
3042
Option('show-diff', short_name='p',
3043
help='When no message is supplied, show the diff along'
3044
' with the status summary in the message editor.'),
3046
aliases = ['ci', 'checkin']
3048
def _iter_bug_fix_urls(self, fixes, branch):
3049
# Configure the properties for bug fixing attributes.
3050
for fixed_bug in fixes:
3051
tokens = fixed_bug.split(':')
3052
if len(tokens) != 2:
3053
raise errors.BzrCommandError(
3054
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3055
"See \"bzr help bugs\" for more information on this "
3056
"feature.\nCommit refused." % fixed_bug)
3057
tag, bug_id = tokens
3059
yield bugtracker.get_bug_url(tag, branch, bug_id)
3060
except errors.UnknownBugTrackerAbbreviation:
3061
raise errors.BzrCommandError(
3062
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3063
except errors.MalformedBugIdentifier, e:
3064
raise errors.BzrCommandError(
3065
"%s\nCommit refused." % (str(e),))
3067
def run(self, message=None, file=None, verbose=False, selected_list=None,
3068
unchanged=False, strict=False, local=False, fixes=None,
3069
author=None, show_diff=False, exclude=None, commit_time=None):
3070
from bzrlib.errors import (
3075
from bzrlib.msgeditor import (
3076
edit_commit_message_encoded,
3077
generate_commit_message_template,
3078
make_commit_message_template_encoded
3081
commit_stamp = offset = None
3082
if commit_time is not None:
3084
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3085
except ValueError, e:
3086
raise errors.BzrCommandError(
3087
"Could not parse --commit-time: " + str(e))
3089
# TODO: Need a blackbox test for invoking the external editor; may be
3090
# slightly problematic to run this cross-platform.
3092
# TODO: do more checks that the commit will succeed before
3093
# spending the user's valuable time typing a commit message.
3097
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3098
if selected_list == ['']:
3099
# workaround - commit of root of tree should be exactly the same
3100
# as just default commit in that tree, and succeed even though
3101
# selected-file merge commit is not done yet
3106
bug_property = bugtracker.encode_fixes_bug_urls(
3107
self._iter_bug_fix_urls(fixes, tree.branch))
3109
properties['bugs'] = bug_property
3111
if local and not tree.branch.get_bound_location():
3112
raise errors.LocalRequiresBoundBranch()
3114
if message is not None:
3116
file_exists = osutils.lexists(message)
3117
except UnicodeError:
3118
# The commit message contains unicode characters that can't be
3119
# represented in the filesystem encoding, so that can't be a
3124
'The commit message is a file name: "%(f)s".\n'
3125
'(use --file "%(f)s" to take commit message from that file)'
3127
ui.ui_factory.show_warning(warning_msg)
3129
message = message.replace('\r\n', '\n')
3130
message = message.replace('\r', '\n')
3132
raise errors.BzrCommandError(
3133
"please specify either --message or --file")
3135
def get_message(commit_obj):
3136
"""Callback to get commit message"""
3138
f = codecs.open(file, 'rt', osutils.get_user_encoding())
3140
my_message = f.read()
3143
elif message is not None:
3144
my_message = message
3146
# No message supplied: make one up.
3147
# text is the status of the tree
3148
text = make_commit_message_template_encoded(tree,
3149
selected_list, diff=show_diff,
3150
output_encoding=osutils.get_user_encoding())
3151
# start_message is the template generated from hooks
3152
# XXX: Warning - looks like hooks return unicode,
3153
# make_commit_message_template_encoded returns user encoding.
3154
# We probably want to be using edit_commit_message instead to
3156
start_message = generate_commit_message_template(commit_obj)
3157
my_message = edit_commit_message_encoded(text,
3158
start_message=start_message)
3159
if my_message is None:
3160
raise errors.BzrCommandError("please specify a commit"
3161
" message with either --message or --file")
3162
if my_message == "":
3163
raise errors.BzrCommandError("empty commit message specified")
3166
# The API permits a commit with a filter of [] to mean 'select nothing'
3167
# but the command line should not do that.
3168
if not selected_list:
3169
selected_list = None
3171
tree.commit(message_callback=get_message,
3172
specific_files=selected_list,
3173
allow_pointless=unchanged, strict=strict, local=local,
3174
reporter=None, verbose=verbose, revprops=properties,
3175
authors=author, timestamp=commit_stamp,
3177
exclude=tree.safe_relpath_files(exclude))
3178
except PointlessCommit:
3179
raise errors.BzrCommandError("No changes to commit."
3180
" Use --unchanged to commit anyhow.")
3181
except ConflictsInTree:
3182
raise errors.BzrCommandError('Conflicts detected in working '
3183
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3185
except StrictCommitFailed:
3186
raise errors.BzrCommandError("Commit refused because there are"
3187
" unknown files in the working tree.")
3188
except errors.BoundBranchOutOfDate, e:
3189
e.extra_help = ("\n"
3190
'To commit to master branch, run update and then commit.\n'
3191
'You can also pass --local to commit to continue working '
3196
class cmd_check(Command):
3197
__doc__ = """Validate working tree structure, branch consistency and repository history.
3199
This command checks various invariants about branch and repository storage
3200
to detect data corruption or bzr bugs.
3202
The working tree and branch checks will only give output if a problem is
3203
detected. The output fields of the repository check are:
3206
This is just the number of revisions checked. It doesn't
3210
This is just the number of versionedfiles checked. It
3211
doesn't indicate a problem.
3213
unreferenced ancestors
3214
Texts that are ancestors of other texts, but
3215
are not properly referenced by the revision ancestry. This is a
3216
subtle problem that Bazaar can work around.
3219
This is the total number of unique file contents
3220
seen in the checked revisions. It does not indicate a problem.
3223
This is the total number of repeated texts seen
3224
in the checked revisions. Texts can be repeated when their file
3225
entries are modified, but the file contents are not. It does not
3228
If no restrictions are specified, all Bazaar data that is found at the given
3229
location will be checked.
3233
Check the tree and branch at 'foo'::
3235
bzr check --tree --branch foo
3237
Check only the repository at 'bar'::
3239
bzr check --repo bar
3241
Check everything at 'baz'::
3246
_see_also = ['reconcile']
3247
takes_args = ['path?']
3248
takes_options = ['verbose',
3249
Option('branch', help="Check the branch related to the"
3250
" current directory."),
3251
Option('repo', help="Check the repository related to the"
3252
" current directory."),
3253
Option('tree', help="Check the working tree related to"
3254
" the current directory.")]
3256
def run(self, path=None, verbose=False, branch=False, repo=False,
3258
from bzrlib.check import check_dwim
3261
if not branch and not repo and not tree:
3262
branch = repo = tree = True
3263
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3266
class cmd_upgrade(Command):
3267
__doc__ = """Upgrade branch storage to current format.
3269
The check command or bzr developers may sometimes advise you to run
3270
this command. When the default format has changed you may also be warned
3271
during other operations to upgrade.
3274
_see_also = ['check']
3275
takes_args = ['url?']
3277
RegistryOption('format',
3278
help='Upgrade to a specific format. See "bzr help'
3279
' formats" for details.',
3280
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3281
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3282
value_switches=True, title='Branch format'),
3285
def run(self, url='.', format=None):
3286
from bzrlib.upgrade import upgrade
3287
upgrade(url, format)
3290
class cmd_whoami(Command):
3291
__doc__ = """Show or set bzr user id.
3294
Show the email of the current user::
3298
Set the current user::
3300
bzr whoami "Frank Chu <fchu@example.com>"
3302
takes_options = [ 'directory',
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, directory=None):
3315
if directory is None:
3316
# use branch if we're inside one; otherwise global config
3318
c = Branch.open_containing(u'.')[0].get_config()
3319
except errors.NotBranchError:
3320
c = config.GlobalConfig()
3322
c = Branch.open(directory).get_config()
3324
self.outf.write(c.user_email() + '\n')
3326
self.outf.write(c.username() + '\n')
3329
# display a warning if an email address isn't included in the given name.
3331
config.extract_email_address(name)
3332
except errors.NoEmailInUsername, e:
3333
warning('"%s" does not seem to contain an email address. '
3334
'This is allowed, but not recommended.', name)
3336
# use global config unless --branch given
3338
if directory is None:
3339
c = Branch.open_containing(u'.')[0].get_config()
3341
c = Branch.open(directory).get_config()
3343
c = config.GlobalConfig()
3344
c.set_user_option('email', name)
3347
class cmd_nick(Command):
3348
__doc__ = """Print or set the branch nickname.
3350
If unset, the tree root directory name is used as the nickname.
3351
To print the current nickname, execute with no argument.
3353
Bound branches use the nickname of its master branch unless it is set
3357
_see_also = ['info']
3358
takes_args = ['nickname?']
3359
takes_options = ['directory']
3360
def run(self, nickname=None, directory=u'.'):
3361
branch = Branch.open_containing(directory)[0]
3362
if nickname is None:
3363
self.printme(branch)
3365
branch.nick = nickname
3368
def printme(self, branch):
3369
self.outf.write('%s\n' % branch.nick)
3372
class cmd_alias(Command):
3373
__doc__ = """Set/unset and display aliases.
3376
Show the current aliases::
3380
Show the alias specified for 'll'::
3384
Set an alias for 'll'::
3386
bzr alias ll="log --line -r-10..-1"
3388
To remove an alias for 'll'::
3390
bzr alias --remove ll
3393
takes_args = ['name?']
3395
Option('remove', help='Remove the alias.'),
3398
def run(self, name=None, remove=False):
3400
self.remove_alias(name)
3402
self.print_aliases()
3404
equal_pos = name.find('=')
3406
self.print_alias(name)
3408
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3410
def remove_alias(self, alias_name):
3411
if alias_name is None:
3412
raise errors.BzrCommandError(
3413
'bzr alias --remove expects an alias to remove.')
3414
# If alias is not found, print something like:
3415
# unalias: foo: not found
3416
c = config.GlobalConfig()
3417
c.unset_alias(alias_name)
3420
def print_aliases(self):
3421
"""Print out the defined aliases in a similar format to bash."""
3422
aliases = config.GlobalConfig().get_aliases()
3423
for key, value in sorted(aliases.iteritems()):
3424
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3427
def print_alias(self, alias_name):
3428
from bzrlib.commands import get_alias
3429
alias = get_alias(alias_name)
3431
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3434
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3436
def set_alias(self, alias_name, alias_command):
3437
"""Save the alias in the global config."""
3438
c = config.GlobalConfig()
3439
c.set_alias(alias_name, alias_command)
3442
class cmd_selftest(Command):
3443
__doc__ = """Run internal test suite.
3445
If arguments are given, they are regular expressions that say which tests
3446
should run. Tests matching any expression are run, and other tests are
3449
Alternatively if --first is given, matching tests are run first and then
3450
all other tests are run. This is useful if you have been working in a
3451
particular area, but want to make sure nothing else was broken.
3453
If --exclude is given, tests that match that regular expression are
3454
excluded, regardless of whether they match --first or not.
3456
To help catch accidential dependencies between tests, the --randomize
3457
option is useful. In most cases, the argument used is the word 'now'.
3458
Note that the seed used for the random number generator is displayed
3459
when this option is used. The seed can be explicitly passed as the
3460
argument to this option if required. This enables reproduction of the
3461
actual ordering used if and when an order sensitive problem is encountered.
3463
If --list-only is given, the tests that would be run are listed. This is
3464
useful when combined with --first, --exclude and/or --randomize to
3465
understand their impact. The test harness reports "Listed nn tests in ..."
3466
instead of "Ran nn tests in ..." when list mode is enabled.
3468
If the global option '--no-plugins' is given, plugins are not loaded
3469
before running the selftests. This has two effects: features provided or
3470
modified by plugins will not be tested, and tests provided by plugins will
3473
Tests that need working space on disk use a common temporary directory,
3474
typically inside $TMPDIR or /tmp.
3476
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3477
into a pdb postmortem session.
3480
Run only tests relating to 'ignore'::
3484
Disable plugins and list tests as they're run::
3486
bzr --no-plugins selftest -v
3488
# NB: this is used from the class without creating an instance, which is
3489
# why it does not have a self parameter.
3490
def get_transport_type(typestring):
3491
"""Parse and return a transport specifier."""
3492
if typestring == "sftp":
3493
from bzrlib.tests import stub_sftp
3494
return stub_sftp.SFTPAbsoluteServer
3495
if typestring == "memory":
3496
from bzrlib.tests import test_server
3497
return memory.MemoryServer
3498
if typestring == "fakenfs":
3499
from bzrlib.tests import test_server
3500
return test_server.FakeNFSServer
3501
msg = "No known transport type %s. Supported types are: sftp\n" %\
3503
raise errors.BzrCommandError(msg)
3506
takes_args = ['testspecs*']
3507
takes_options = ['verbose',
3509
help='Stop when one test fails.',
3513
help='Use a different transport by default '
3514
'throughout the test suite.',
3515
type=get_transport_type),
3517
help='Run the benchmarks rather than selftests.',
3519
Option('lsprof-timed',
3520
help='Generate lsprof output for benchmarked'
3521
' sections of code.'),
3522
Option('lsprof-tests',
3523
help='Generate lsprof output for each test.'),
3525
help='Run all tests, but run specified tests first.',
3529
help='List the tests instead of running them.'),
3530
RegistryOption('parallel',
3531
help="Run the test suite in parallel.",
3532
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3533
value_switches=False,
3535
Option('randomize', type=str, argname="SEED",
3536
help='Randomize the order of tests using the given'
3537
' seed or "now" for the current time.'),
3538
Option('exclude', type=str, argname="PATTERN",
3540
help='Exclude tests that match this regular'
3543
help='Output test progress via subunit.'),
3544
Option('strict', help='Fail on missing dependencies or '
3546
Option('load-list', type=str, argname='TESTLISTFILE',
3547
help='Load a test id list from a text file.'),
3548
ListOption('debugflag', type=str, short_name='E',
3549
help='Turn on a selftest debug flag.'),
3550
ListOption('starting-with', type=str, argname='TESTID',
3551
param_name='starting_with', short_name='s',
3553
'Load only the tests starting with TESTID.'),
3555
encoding_type = 'replace'
3558
Command.__init__(self)
3559
self.additional_selftest_args = {}
3561
def run(self, testspecs_list=None, verbose=False, one=False,
3562
transport=None, benchmark=None,
3564
first=False, list_only=False,
3565
randomize=None, exclude=None, strict=False,
3566
load_list=None, debugflag=None, starting_with=None, subunit=False,
3567
parallel=None, lsprof_tests=False):
3568
from bzrlib.tests import selftest
3570
# Make deprecation warnings visible, unless -Werror is set
3571
symbol_versioning.activate_deprecation_warnings(override=False)
3573
if testspecs_list is not None:
3574
pattern = '|'.join(testspecs_list)
3579
from bzrlib.tests import SubUnitBzrRunner
3581
raise errors.BzrCommandError("subunit not available. subunit "
3582
"needs to be installed to use --subunit.")
3583
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3584
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3585
# stdout, which would corrupt the subunit stream.
3586
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3587
# following code can be deleted when it's sufficiently deployed
3588
# -- vila/mgz 20100514
3589
if (sys.platform == "win32"
3590
and getattr(sys.stdout, 'fileno', None) is not None):
3592
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3594
self.additional_selftest_args.setdefault(
3595
'suite_decorators', []).append(parallel)
3597
raise errors.BzrCommandError(
3598
"--benchmark is no longer supported from bzr 2.2; "
3599
"use bzr-usertest instead")
3600
test_suite_factory = None
3601
selftest_kwargs = {"verbose": verbose,
3603
"stop_on_failure": one,
3604
"transport": transport,
3605
"test_suite_factory": test_suite_factory,
3606
"lsprof_timed": lsprof_timed,
3607
"lsprof_tests": lsprof_tests,
3608
"matching_tests_first": first,
3609
"list_only": list_only,
3610
"random_seed": randomize,
3611
"exclude_pattern": exclude,
3613
"load_list": load_list,
3614
"debug_flags": debugflag,
3615
"starting_with": starting_with
3617
selftest_kwargs.update(self.additional_selftest_args)
3618
result = selftest(**selftest_kwargs)
3619
return int(not result)
3622
class cmd_version(Command):
3623
__doc__ = """Show version of bzr."""
3625
encoding_type = 'replace'
3627
Option("short", help="Print just the version number."),
3631
def run(self, short=False):
3632
from bzrlib.version import show_version
3634
self.outf.write(bzrlib.version_string + '\n')
3636
show_version(to_file=self.outf)
3639
class cmd_rocks(Command):
3640
__doc__ = """Statement of optimism."""
3646
self.outf.write("It sure does!\n")
3649
class cmd_find_merge_base(Command):
3650
__doc__ = """Find and print a base revision for merging two branches."""
3651
# TODO: Options to specify revisions on either side, as if
3652
# merging only part of the history.
3653
takes_args = ['branch', 'other']
3657
def run(self, branch, other):
3658
from bzrlib.revision import ensure_null
3660
branch1 = Branch.open_containing(branch)[0]
3661
branch2 = Branch.open_containing(other)[0]
3662
self.add_cleanup(branch1.lock_read().unlock)
3663
self.add_cleanup(branch2.lock_read().unlock)
3664
last1 = ensure_null(branch1.last_revision())
3665
last2 = ensure_null(branch2.last_revision())
3667
graph = branch1.repository.get_graph(branch2.repository)
3668
base_rev_id = graph.find_unique_lca(last1, last2)
3670
self.outf.write('merge base is revision %s\n' % base_rev_id)
3673
class cmd_merge(Command):
3674
__doc__ = """Perform a three-way merge.
3676
The source of the merge can be specified either in the form of a branch,
3677
or in the form of a path to a file containing a merge directive generated
3678
with bzr send. If neither is specified, the default is the upstream branch
3679
or the branch most recently merged using --remember.
3681
When merging a branch, by default the tip will be merged. To pick a different
3682
revision, pass --revision. If you specify two values, the first will be used as
3683
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3684
available revisions, like this is commonly referred to as "cherrypicking".
3686
Revision numbers are always relative to the branch being merged.
3688
By default, bzr will try to merge in all new work from the other
3689
branch, automatically determining an appropriate base. If this
3690
fails, you may need to give an explicit base.
3692
Merge will do its best to combine the changes in two branches, but there
3693
are some kinds of problems only a human can fix. When it encounters those,
3694
it will mark a conflict. A conflict means that you need to fix something,
3695
before you should commit.
3697
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3699
If there is no default branch set, the first merge will set it. After
3700
that, you can omit the branch to use the default. To change the
3701
default, use --remember. The value will only be saved if the remote
3702
location can be accessed.
3704
The results of the merge are placed into the destination working
3705
directory, where they can be reviewed (with bzr diff), tested, and then
3706
committed to record the result of the merge.
3708
merge refuses to run if there are any uncommitted changes, unless
3709
--force is given. The --force option can also be used to create a
3710
merge revision which has more than two parents.
3712
If one would like to merge changes from the working tree of the other
3713
branch without merging any committed revisions, the --uncommitted option
3716
To select only some changes to merge, use "merge -i", which will prompt
3717
you to apply each diff hunk and file change, similar to "shelve".
3720
To merge the latest revision from bzr.dev::
3722
bzr merge ../bzr.dev
3724
To merge changes up to and including revision 82 from bzr.dev::
3726
bzr merge -r 82 ../bzr.dev
3728
To merge the changes introduced by 82, without previous changes::
3730
bzr merge -r 81..82 ../bzr.dev
3732
To apply a merge directive contained in /tmp/merge::
3734
bzr merge /tmp/merge
3736
To create a merge revision with three parents from two branches
3737
feature1a and feature1b:
3739
bzr merge ../feature1a
3740
bzr merge ../feature1b --force
3741
bzr commit -m 'revision with three parents'
3744
encoding_type = 'exact'
3745
_see_also = ['update', 'remerge', 'status-flags', 'send']
3746
takes_args = ['location?']
3751
help='Merge even if the destination tree has uncommitted changes.'),
3755
Option('show-base', help="Show base revision text in "
3757
Option('uncommitted', help='Apply uncommitted changes'
3758
' from a working copy, instead of branch changes.'),
3759
Option('pull', help='If the destination is already'
3760
' completely merged into the source, pull from the'
3761
' source rather than merging. When this happens,'
3762
' you do not need to commit the result.'),
3763
custom_help('directory',
3764
help='Branch to merge into, '
3765
'rather than the one containing the working directory.'),
3766
Option('preview', help='Instead of merging, show a diff of the'
3768
Option('interactive', help='Select changes interactively.',
3772
def run(self, location=None, revision=None, force=False,
3773
merge_type=None, show_base=False, reprocess=None, remember=False,
3774
uncommitted=False, pull=False,
3779
if merge_type is None:
3780
merge_type = _mod_merge.Merge3Merger
3782
if directory is None: directory = u'.'
3783
possible_transports = []
3785
allow_pending = True
3786
verified = 'inapplicable'
3787
tree = WorkingTree.open_containing(directory)[0]
3790
basis_tree = tree.revision_tree(tree.last_revision())
3791
except errors.NoSuchRevision:
3792
basis_tree = tree.basis_tree()
3794
# die as quickly as possible if there are uncommitted changes
3796
if tree.has_changes():
3797
raise errors.UncommittedChanges(tree)
3799
view_info = _get_view_info_for_change_reporter(tree)
3800
change_reporter = delta._ChangeReporter(
3801
unversioned_filter=tree.is_ignored, view_info=view_info)
3802
pb = ui.ui_factory.nested_progress_bar()
3803
self.add_cleanup(pb.finished)
3804
self.add_cleanup(tree.lock_write().unlock)
3805
if location is not None:
3807
mergeable = bundle.read_mergeable_from_url(location,
3808
possible_transports=possible_transports)
3809
except errors.NotABundle:
3813
raise errors.BzrCommandError('Cannot use --uncommitted'
3814
' with bundles or merge directives.')
3816
if revision is not None:
3817
raise errors.BzrCommandError(
3818
'Cannot use -r with merge directives or bundles')
3819
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3822
if merger is None and uncommitted:
3823
if revision is not None and len(revision) > 0:
3824
raise errors.BzrCommandError('Cannot use --uncommitted and'
3825
' --revision at the same time.')
3826
merger = self.get_merger_from_uncommitted(tree, location, None)
3827
allow_pending = False
3830
merger, allow_pending = self._get_merger_from_branch(tree,
3831
location, revision, remember, possible_transports, None)
3833
merger.merge_type = merge_type
3834
merger.reprocess = reprocess
3835
merger.show_base = show_base
3836
self.sanity_check_merger(merger)
3837
if (merger.base_rev_id == merger.other_rev_id and
3838
merger.other_rev_id is not None):
3839
note('Nothing to do.')
3842
if merger.interesting_files is not None:
3843
raise errors.BzrCommandError('Cannot pull individual files')
3844
if (merger.base_rev_id == tree.last_revision()):
3845
result = tree.pull(merger.other_branch, False,
3846
merger.other_rev_id)
3847
result.report(self.outf)
3849
if merger.this_basis is None:
3850
raise errors.BzrCommandError(
3851
"This branch has no commits."
3852
" (perhaps you would prefer 'bzr pull')")
3854
return self._do_preview(merger)
3856
return self._do_interactive(merger)
3858
return self._do_merge(merger, change_reporter, allow_pending,
3861
def _get_preview(self, merger):
3862
tree_merger = merger.make_merger()
3863
tt = tree_merger.make_preview_transform()
3864
self.add_cleanup(tt.finalize)
3865
result_tree = tt.get_preview_tree()
3868
def _do_preview(self, merger):
3869
from bzrlib.diff import show_diff_trees
3870
result_tree = self._get_preview(merger)
3871
path_encoding = osutils.get_diff_header_encoding()
3872
show_diff_trees(merger.this_tree, result_tree, self.outf,
3873
old_label='', new_label='',
3874
path_encoding=path_encoding)
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):
4033
__doc__ = """Redo a merge.
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
from bzrlib.conflicts import restore
4065
if merge_type is None:
4066
merge_type = _mod_merge.Merge3Merger
4067
tree, file_list = WorkingTree.open_containing_paths(file_list)
4068
self.add_cleanup(tree.lock_write().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
__doc__ = """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 = WorkingTree.open_containing_paths(file_list)
4184
self.add_cleanup(tree.lock_tree_write().unlock)
4186
tree.set_parent_ids(tree.get_parent_ids()[:1])
4188
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4191
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4192
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4193
tree.revert(file_list, rev_tree, not no_backup, None,
4194
report_changes=True)
4197
class cmd_assert_fail(Command):
4198
__doc__ = """Test reporting of assertion failures"""
4199
# intended just for use in testing
4204
raise AssertionError("always fails")
4207
class cmd_help(Command):
4208
__doc__ = """Show help on a command or other topic.
4211
_see_also = ['topics']
4213
Option('long', 'Show help on all commands.'),
4215
takes_args = ['topic?']
4216
aliases = ['?', '--help', '-?', '-h']
4219
def run(self, topic=None, long=False):
4221
if topic is None and long:
4223
bzrlib.help.help(topic)
4226
class cmd_shell_complete(Command):
4227
__doc__ = """Show appropriate completions for context.
4229
For a list of all available commands, say 'bzr shell-complete'.
4231
takes_args = ['context?']
4236
def run(self, context=None):
4237
import shellcomplete
4238
shellcomplete.shellcomplete(context)
4241
class cmd_missing(Command):
4242
__doc__ = """Show unmerged/unpulled revisions between two branches.
4244
OTHER_BRANCH may be local or remote.
4246
To filter on a range of revisions, you can use the command -r begin..end
4247
-r revision requests a specific revision, -r ..end or -r begin.. are
4251
1 - some missing revisions
4252
0 - no missing revisions
4256
Determine the missing revisions between this and the branch at the
4257
remembered pull location::
4261
Determine the missing revisions between this and another branch::
4263
bzr missing http://server/branch
4265
Determine the missing revisions up to a specific revision on the other
4268
bzr missing -r ..-10
4270
Determine the missing revisions up to a specific revision on this
4273
bzr missing --my-revision ..-10
4276
_see_also = ['merge', 'pull']
4277
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,
4309
from bzrlib.missing import find_unmerged, iter_log_revisions
4318
# TODO: We should probably check that we don't have mine-only and
4319
# theirs-only set, but it gets complicated because we also have
4320
# this and other which could be used.
4327
local_branch = Branch.open_containing(directory)[0]
4328
self.add_cleanup(local_branch.lock_read().unlock)
4330
parent = local_branch.get_parent()
4331
if other_branch is None:
4332
other_branch = parent
4333
if other_branch is None:
4334
raise errors.BzrCommandError("No peer location known"
4336
display_url = urlutils.unescape_for_display(parent,
4338
message("Using saved parent location: "
4339
+ display_url + "\n")
4341
remote_branch = Branch.open(other_branch)
4342
if remote_branch.base == local_branch.base:
4343
remote_branch = local_branch
4345
self.add_cleanup(remote_branch.lock_read().unlock)
4347
local_revid_range = _revision_range_to_revid_range(
4348
_get_revision_range(my_revision, local_branch,
4351
remote_revid_range = _revision_range_to_revid_range(
4352
_get_revision_range(revision,
4353
remote_branch, self.name()))
4355
local_extra, remote_extra = find_unmerged(
4356
local_branch, remote_branch, restrict,
4357
backward=not reverse,
4358
include_merges=include_merges,
4359
local_revid_range=local_revid_range,
4360
remote_revid_range=remote_revid_range)
4362
if log_format is None:
4363
registry = log.log_formatter_registry
4364
log_format = registry.get_default(local_branch)
4365
lf = log_format(to_file=self.outf,
4367
show_timezone='original')
4370
if local_extra and not theirs_only:
4371
message("You have %d extra revision(s):\n" %
4373
for revision in iter_log_revisions(local_extra,
4374
local_branch.repository,
4376
lf.log_revision(revision)
4377
printed_local = True
4380
printed_local = False
4382
if remote_extra and not mine_only:
4383
if printed_local is True:
4385
message("You are missing %d revision(s):\n" %
4387
for revision in iter_log_revisions(remote_extra,
4388
remote_branch.repository,
4390
lf.log_revision(revision)
4393
if mine_only and not local_extra:
4394
# We checked local, and found nothing extra
4395
message('This branch is up to date.\n')
4396
elif theirs_only and not remote_extra:
4397
# We checked remote, and found nothing extra
4398
message('Other branch is up to date.\n')
4399
elif not (mine_only or theirs_only or local_extra or
4401
# We checked both branches, and neither one had extra
4403
message("Branches are up to date.\n")
4405
if not status_code and parent is None and other_branch is not None:
4406
self.add_cleanup(local_branch.lock_write().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
__doc__ = """Compress the data within a repository.
4416
This operation compresses the data within a bazaar repository. As
4417
bazaar supports automatic packing of repository, this operation is
4418
normally not required to be done manually.
4420
During the pack operation, bazaar takes a backup of existing repository
4421
data, i.e. pack files. This backup is eventually removed by bazaar
4422
automatically when it is safe to do so. To save disk space by removing
4423
the backed up pack files, the --clean-obsolete-packs option may be
4426
Warning: If you use --clean-obsolete-packs and your machine crashes
4427
during or immediately after repacking, you may be left with a state
4428
where the deletion has been written to disk but the new packs have not
4429
been. In this case the repository may be unusable.
4432
_see_also = ['repositories']
4433
takes_args = ['branch_or_repo?']
4435
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4438
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4439
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4441
branch = dir.open_branch()
4442
repository = branch.repository
4443
except errors.NotBranchError:
4444
repository = dir.open_repository()
4445
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4448
class cmd_plugins(Command):
4449
__doc__ = """List the installed plugins.
4451
This command displays the list of installed plugins including
4452
version of plugin and a short description of each.
4454
--verbose shows the path where each plugin is located.
4456
A plugin is an external component for Bazaar that extends the
4457
revision control system, by adding or replacing code in Bazaar.
4458
Plugins can do a variety of things, including overriding commands,
4459
adding new commands, providing additional network transports and
4460
customizing log output.
4462
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4463
for further information on plugins including where to find them and how to
4464
install them. Instructions are also provided there on how to write new
4465
plugins using the Python programming language.
4467
takes_options = ['verbose']
4470
def run(self, verbose=False):
4471
import bzrlib.plugin
4472
from inspect import getdoc
4474
for name, plugin in bzrlib.plugin.plugins().items():
4475
version = plugin.__version__
4476
if version == 'unknown':
4478
name_ver = '%s %s' % (name, version)
4479
d = getdoc(plugin.module)
4481
doc = d.split('\n')[0]
4483
doc = '(no description)'
4484
result.append((name_ver, doc, plugin.path()))
4485
for name_ver, doc, path in sorted(result):
4486
self.outf.write("%s\n" % name_ver)
4487
self.outf.write(" %s\n" % doc)
4489
self.outf.write(" %s\n" % path)
4490
self.outf.write("\n")
4493
class cmd_testament(Command):
4494
__doc__ = """Show testament (signing-form) of a revision."""
4497
Option('long', help='Produce long-format testament.'),
4499
help='Produce a strict-format testament.')]
4500
takes_args = ['branch?']
4502
def run(self, branch=u'.', revision=None, long=False, strict=False):
4503
from bzrlib.testament import Testament, StrictTestament
4505
testament_class = StrictTestament
4507
testament_class = Testament
4509
b = Branch.open_containing(branch)[0]
4511
b = Branch.open(branch)
4512
self.add_cleanup(b.lock_read().unlock)
4513
if revision is None:
4514
rev_id = b.last_revision()
4516
rev_id = revision[0].as_revision_id(b)
4517
t = testament_class.from_revision(b.repository, rev_id)
4519
sys.stdout.writelines(t.as_text_lines())
4521
sys.stdout.write(t.as_short_text())
4524
class cmd_annotate(Command):
4525
__doc__ = """Show the origin of each line in a file.
4527
This prints out the given file with an annotation on the left side
4528
indicating which revision, author and date introduced the change.
4530
If the origin is the same for a run of consecutive lines, it is
4531
shown only at the top, unless the --all option is given.
4533
# TODO: annotate directories; showing when each file was last changed
4534
# TODO: if the working copy is modified, show annotations on that
4535
# with new uncommitted lines marked
4536
aliases = ['ann', 'blame', 'praise']
4537
takes_args = ['filename']
4538
takes_options = [Option('all', help='Show annotations on all lines.'),
4539
Option('long', help='Show commit date in annotations.'),
4544
encoding_type = 'exact'
4547
def run(self, filename, all=False, long=False, revision=None,
4548
show_ids=False, directory=None):
4549
from bzrlib.annotate import annotate_file, annotate_file_tree
4550
wt, branch, relpath = \
4551
_open_directory_or_containing_tree_or_branch(filename, directory)
4553
self.add_cleanup(wt.lock_read().unlock)
4555
self.add_cleanup(branch.lock_read().unlock)
4556
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4557
self.add_cleanup(tree.lock_read().unlock)
4559
file_id = wt.path2id(relpath)
4561
file_id = tree.path2id(relpath)
4563
raise errors.NotVersionedError(filename)
4564
file_version = tree.inventory[file_id].revision
4565
if wt is not None and revision is None:
4566
# If there is a tree and we're not annotating historical
4567
# versions, annotate the working tree's content.
4568
annotate_file_tree(wt, file_id, self.outf, long, all,
4571
annotate_file(branch, file_version, file_id, long, all, self.outf,
4575
class cmd_re_sign(Command):
4576
__doc__ = """Create a digital signature for an existing revision."""
4577
# TODO be able to replace existing ones.
4579
hidden = True # is this right ?
4580
takes_args = ['revision_id*']
4581
takes_options = ['directory', 'revision']
4583
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4584
if revision_id_list is not None and revision is not None:
4585
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4586
if revision_id_list is None and revision is None:
4587
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4588
b = WorkingTree.open_containing(directory)[0].branch
4589
self.add_cleanup(b.lock_write().unlock)
4590
return self._run(b, revision_id_list, revision)
4592
def _run(self, b, revision_id_list, revision):
4593
import bzrlib.gpg as gpg
4594
gpg_strategy = gpg.GPGStrategy(b.get_config())
4595
if revision_id_list is not None:
4596
b.repository.start_write_group()
4598
for revision_id in revision_id_list:
4599
b.repository.sign_revision(revision_id, gpg_strategy)
4601
b.repository.abort_write_group()
4604
b.repository.commit_write_group()
4605
elif revision is not None:
4606
if len(revision) == 1:
4607
revno, rev_id = revision[0].in_history(b)
4608
b.repository.start_write_group()
4610
b.repository.sign_revision(rev_id, gpg_strategy)
4612
b.repository.abort_write_group()
4615
b.repository.commit_write_group()
4616
elif len(revision) == 2:
4617
# are they both on rh- if so we can walk between them
4618
# might be nice to have a range helper for arbitrary
4619
# revision paths. hmm.
4620
from_revno, from_revid = revision[0].in_history(b)
4621
to_revno, to_revid = revision[1].in_history(b)
4622
if to_revid is None:
4623
to_revno = b.revno()
4624
if from_revno is None or to_revno is None:
4625
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4626
b.repository.start_write_group()
4628
for revno in range(from_revno, to_revno + 1):
4629
b.repository.sign_revision(b.get_rev_id(revno),
4632
b.repository.abort_write_group()
4635
b.repository.commit_write_group()
4637
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4640
class cmd_bind(Command):
4641
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4642
If no branch is supplied, rebind to the last bound location.
4644
Once converted into a checkout, commits must succeed on the master branch
4645
before they will be applied to the local branch.
4647
Bound branches use the nickname of its master branch unless it is set
4648
locally, in which case binding will update the local nickname to be
4652
_see_also = ['checkouts', 'unbind']
4653
takes_args = ['location?']
4654
takes_options = ['directory']
4656
def run(self, location=None, directory=u'.'):
4657
b, relpath = Branch.open_containing(directory)
4658
if location is None:
4660
location = b.get_old_bound_location()
4661
except errors.UpgradeRequired:
4662
raise errors.BzrCommandError('No location supplied. '
4663
'This format does not remember old locations.')
4665
if location is None:
4666
if b.get_bound_location() is not None:
4667
raise errors.BzrCommandError('Branch is already bound')
4669
raise errors.BzrCommandError('No location supplied '
4670
'and no previous location known')
4671
b_other = Branch.open(location)
4674
except errors.DivergedBranches:
4675
raise errors.BzrCommandError('These branches have diverged.'
4676
' Try merging, and then bind again.')
4677
if b.get_config().has_explicit_nickname():
4678
b.nick = b_other.nick
4681
class cmd_unbind(Command):
4682
__doc__ = """Convert the current checkout into a regular branch.
4684
After unbinding, the local branch is considered independent and subsequent
4685
commits will be local only.
4688
_see_also = ['checkouts', 'bind']
4690
takes_options = ['directory']
4692
def run(self, directory=u'.'):
4693
b, relpath = Branch.open_containing(directory)
4695
raise errors.BzrCommandError('Local branch is not bound')
4698
class cmd_uncommit(Command):
4699
__doc__ = """Remove the last committed revision.
4701
--verbose will print out what is being removed.
4702
--dry-run will go through all the motions, but not actually
4705
If --revision is specified, uncommit revisions to leave the branch at the
4706
specified revision. For example, "bzr uncommit -r 15" will leave the
4707
branch at revision 15.
4709
Uncommit leaves the working tree ready for a new commit. The only change
4710
it may make is to restore any pending merges that were present before
4714
# TODO: jam 20060108 Add an option to allow uncommit to remove
4715
# unreferenced information in 'branch-as-repository' branches.
4716
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4717
# information in shared branches as well.
4718
_see_also = ['commit']
4719
takes_options = ['verbose', 'revision',
4720
Option('dry-run', help='Don\'t actually make changes.'),
4721
Option('force', help='Say yes to all questions.'),
4723
help="Only remove the commits from the local branch"
4724
" when in a checkout."
4727
takes_args = ['location?']
4729
encoding_type = 'replace'
4731
def run(self, location=None,
4732
dry_run=False, verbose=False,
4733
revision=None, force=False, local=False):
4734
if location is None:
4736
control, relpath = bzrdir.BzrDir.open_containing(location)
4738
tree = control.open_workingtree()
4740
except (errors.NoWorkingTree, errors.NotLocalUrl):
4742
b = control.open_branch()
4744
if tree is not None:
4745
self.add_cleanup(tree.lock_write().unlock)
4747
self.add_cleanup(b.lock_write().unlock)
4748
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4750
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4751
from bzrlib.log import log_formatter, show_log
4752
from bzrlib.uncommit import uncommit
4754
last_revno, last_rev_id = b.last_revision_info()
4757
if revision is None:
4759
rev_id = last_rev_id
4761
# 'bzr uncommit -r 10' actually means uncommit
4762
# so that the final tree is at revno 10.
4763
# but bzrlib.uncommit.uncommit() actually uncommits
4764
# the revisions that are supplied.
4765
# So we need to offset it by one
4766
revno = revision[0].in_history(b).revno + 1
4767
if revno <= last_revno:
4768
rev_id = b.get_rev_id(revno)
4770
if rev_id is None or _mod_revision.is_null(rev_id):
4771
self.outf.write('No revisions to uncommit.\n')
4774
lf = log_formatter('short',
4776
show_timezone='original')
4781
direction='forward',
4782
start_revision=revno,
4783
end_revision=last_revno)
4786
self.outf.write('Dry-run, pretending to remove'
4787
' the above revisions.\n')
4789
self.outf.write('The above revision(s) will be removed.\n')
4792
if not ui.ui_factory.get_boolean('Are you sure'):
4793
self.outf.write('Canceled')
4796
mutter('Uncommitting from {%s} to {%s}',
4797
last_rev_id, rev_id)
4798
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4799
revno=revno, local=local)
4800
self.outf.write('You can restore the old tip by running:\n'
4801
' bzr pull . -r revid:%s\n' % last_rev_id)
4804
class cmd_break_lock(Command):
4805
__doc__ = """Break a dead lock on a repository, branch or working directory.
4807
CAUTION: Locks should only be broken when you are sure that the process
4808
holding the lock has been stopped.
4810
You can get information on what locks are open via the 'bzr info
4811
[location]' command.
4815
bzr break-lock bzr+ssh://example.com/bzr/foo
4817
takes_args = ['location?']
4819
def run(self, location=None, show=False):
4820
if location is None:
4822
control, relpath = bzrdir.BzrDir.open_containing(location)
4824
control.break_lock()
4825
except NotImplementedError:
4829
class cmd_wait_until_signalled(Command):
4830
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4832
This just prints a line to signal when it is ready, then blocks on stdin.
4838
sys.stdout.write("running\n")
4840
sys.stdin.readline()
4843
class cmd_serve(Command):
4844
__doc__ = """Run the bzr server."""
4846
aliases = ['server']
4850
help='Serve on stdin/out for use from inetd or sshd.'),
4851
RegistryOption('protocol',
4852
help="Protocol to serve.",
4853
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4854
value_switches=True),
4856
help='Listen for connections on nominated port of the form '
4857
'[hostname:]portnumber. Passing 0 as the port number will '
4858
'result in a dynamically allocated port. The default port '
4859
'depends on the protocol.',
4861
custom_help('directory',
4862
help='Serve contents of this directory.'),
4863
Option('allow-writes',
4864
help='By default the server is a readonly server. Supplying '
4865
'--allow-writes enables write access to the contents of '
4866
'the served directory and below. Note that ``bzr serve`` '
4867
'does not perform authentication, so unless some form of '
4868
'external authentication is arranged supplying this '
4869
'option leads to global uncontrolled write access to your '
4874
def get_host_and_port(self, port):
4875
"""Return the host and port to run the smart server on.
4877
If 'port' is None, None will be returned for the host and port.
4879
If 'port' has a colon in it, the string before the colon will be
4880
interpreted as the host.
4882
:param port: A string of the port to run the server on.
4883
:return: A tuple of (host, port), where 'host' is a host name or IP,
4884
and port is an integer TCP/IP port.
4887
if port is not None:
4889
host, port = port.split(':')
4893
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4895
from bzrlib import transport
4896
if directory is None:
4897
directory = os.getcwd()
4898
if protocol is None:
4899
protocol = transport.transport_server_registry.get()
4900
host, port = self.get_host_and_port(port)
4901
url = urlutils.local_path_to_url(directory)
4902
if not allow_writes:
4903
url = 'readonly+' + url
4904
t = transport.get_transport(url)
4905
protocol(t, host, port, inet)
4908
class cmd_join(Command):
4909
__doc__ = """Combine a tree into its containing tree.
4911
This command requires the target tree to be in a rich-root format.
4913
The TREE argument should be an independent tree, inside another tree, but
4914
not part of it. (Such trees can be produced by "bzr split", but also by
4915
running "bzr branch" with the target inside a tree.)
4917
The result is a combined tree, with the subtree no longer an independant
4918
part. This is marked as a merge of the subtree into the containing tree,
4919
and all history is preserved.
4922
_see_also = ['split']
4923
takes_args = ['tree']
4925
Option('reference', help='Join by reference.', hidden=True),
4928
def run(self, tree, reference=False):
4929
sub_tree = WorkingTree.open(tree)
4930
parent_dir = osutils.dirname(sub_tree.basedir)
4931
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4932
repo = containing_tree.branch.repository
4933
if not repo.supports_rich_root():
4934
raise errors.BzrCommandError(
4935
"Can't join trees because %s doesn't support rich root data.\n"
4936
"You can use bzr upgrade on the repository."
4940
containing_tree.add_reference(sub_tree)
4941
except errors.BadReferenceTarget, e:
4942
# XXX: Would be better to just raise a nicely printable
4943
# exception from the real origin. Also below. mbp 20070306
4944
raise errors.BzrCommandError("Cannot join %s. %s" %
4948
containing_tree.subsume(sub_tree)
4949
except errors.BadSubsumeSource, e:
4950
raise errors.BzrCommandError("Cannot join %s. %s" %
4954
class cmd_split(Command):
4955
__doc__ = """Split a subdirectory of a tree into a separate tree.
4957
This command will produce a target tree in a format that supports
4958
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4959
converted into earlier formats like 'dirstate-tags'.
4961
The TREE argument should be a subdirectory of a working tree. That
4962
subdirectory will be converted into an independent tree, with its own
4963
branch. Commits in the top-level tree will not apply to the new subtree.
4966
_see_also = ['join']
4967
takes_args = ['tree']
4969
def run(self, tree):
4970
containing_tree, subdir = WorkingTree.open_containing(tree)
4971
sub_id = containing_tree.path2id(subdir)
4973
raise errors.NotVersionedError(subdir)
4975
containing_tree.extract(sub_id)
4976
except errors.RootNotRich:
4977
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4980
class cmd_merge_directive(Command):
4981
__doc__ = """Generate a merge directive for auto-merge tools.
4983
A directive requests a merge to be performed, and also provides all the
4984
information necessary to do so. This means it must either include a
4985
revision bundle, or the location of a branch containing the desired
4988
A submit branch (the location to merge into) must be supplied the first
4989
time the command is issued. After it has been supplied once, it will
4990
be remembered as the default.
4992
A public branch is optional if a revision bundle is supplied, but required
4993
if --diff or --plain is specified. It will be remembered as the default
4994
after the first use.
4997
takes_args = ['submit_branch?', 'public_branch?']
5001
_see_also = ['send']
5005
RegistryOption.from_kwargs('patch-type',
5006
'The type of patch to include in the directive.',
5008
value_switches=True,
5010
bundle='Bazaar revision bundle (default).',
5011
diff='Normal unified diff.',
5012
plain='No patch, just directive.'),
5013
Option('sign', help='GPG-sign the directive.'), 'revision',
5014
Option('mail-to', type=str,
5015
help='Instead of printing the directive, email to this address.'),
5016
Option('message', type=str, short_name='m',
5017
help='Message to use when committing this merge.')
5020
encoding_type = 'exact'
5022
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5023
sign=False, revision=None, mail_to=None, message=None,
5025
from bzrlib.revision import ensure_null, NULL_REVISION
5026
include_patch, include_bundle = {
5027
'plain': (False, False),
5028
'diff': (True, False),
5029
'bundle': (True, True),
5031
branch = Branch.open(directory)
5032
stored_submit_branch = branch.get_submit_branch()
5033
if submit_branch is None:
5034
submit_branch = stored_submit_branch
5036
if stored_submit_branch is None:
5037
branch.set_submit_branch(submit_branch)
5038
if submit_branch is None:
5039
submit_branch = branch.get_parent()
5040
if submit_branch is None:
5041
raise errors.BzrCommandError('No submit branch specified or known')
5043
stored_public_branch = branch.get_public_branch()
5044
if public_branch is None:
5045
public_branch = stored_public_branch
5046
elif stored_public_branch is None:
5047
branch.set_public_branch(public_branch)
5048
if not include_bundle and public_branch is None:
5049
raise errors.BzrCommandError('No public branch specified or'
5051
base_revision_id = None
5052
if revision is not None:
5053
if len(revision) > 2:
5054
raise errors.BzrCommandError('bzr merge-directive takes '
5055
'at most two one revision identifiers')
5056
revision_id = revision[-1].as_revision_id(branch)
5057
if len(revision) == 2:
5058
base_revision_id = revision[0].as_revision_id(branch)
5060
revision_id = branch.last_revision()
5061
revision_id = ensure_null(revision_id)
5062
if revision_id == NULL_REVISION:
5063
raise errors.BzrCommandError('No revisions to bundle.')
5064
directive = merge_directive.MergeDirective2.from_objects(
5065
branch.repository, revision_id, time.time(),
5066
osutils.local_time_offset(), submit_branch,
5067
public_branch=public_branch, include_patch=include_patch,
5068
include_bundle=include_bundle, message=message,
5069
base_revision_id=base_revision_id)
5072
self.outf.write(directive.to_signed(branch))
5074
self.outf.writelines(directive.to_lines())
5076
message = directive.to_email(mail_to, branch, sign)
5077
s = SMTPConnection(branch.get_config())
5078
s.send_email(message)
5081
class cmd_send(Command):
5082
__doc__ = """Mail or create a merge-directive for submitting changes.
5084
A merge directive provides many things needed for requesting merges:
5086
* A machine-readable description of the merge to perform
5088
* An optional patch that is a preview of the changes requested
5090
* An optional bundle of revision data, so that the changes can be applied
5091
directly from the merge directive, without retrieving data from a
5094
`bzr send` creates a compact data set that, when applied using bzr
5095
merge, has the same effect as merging from the source branch.
5097
By default the merge directive is self-contained and can be applied to any
5098
branch containing submit_branch in its ancestory without needing access to
5101
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5102
revisions, but only a structured request to merge from the
5103
public_location. In that case the public_branch is needed and it must be
5104
up-to-date and accessible to the recipient. The public_branch is always
5105
included if known, so that people can check it later.
5107
The submit branch defaults to the parent of the source branch, but can be
5108
overridden. Both submit branch and public branch will be remembered in
5109
branch.conf the first time they are used for a particular branch. The
5110
source branch defaults to that containing the working directory, but can
5111
be changed using --from.
5113
In order to calculate those changes, bzr must analyse the submit branch.
5114
Therefore it is most efficient for the submit branch to be a local mirror.
5115
If a public location is known for the submit_branch, that location is used
5116
in the merge directive.
5118
The default behaviour is to send the merge directive by mail, unless -o is
5119
given, in which case it is sent to a file.
5121
Mail is sent using your preferred mail program. This should be transparent
5122
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5123
If the preferred client can't be found (or used), your editor will be used.
5125
To use a specific mail program, set the mail_client configuration option.
5126
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5127
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5128
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5129
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5132
If mail is being sent, a to address is required. This can be supplied
5133
either on the commandline, by setting the submit_to configuration
5134
option in the branch itself or the child_submit_to configuration option
5135
in the submit branch.
5137
Two formats are currently supported: "4" uses revision bundle format 4 and
5138
merge directive format 2. It is significantly faster and smaller than
5139
older formats. It is compatible with Bazaar 0.19 and later. It is the
5140
default. "0.9" uses revision bundle format 0.9 and merge directive
5141
format 1. It is compatible with Bazaar 0.12 - 0.18.
5143
The merge directives created by bzr send may be applied using bzr merge or
5144
bzr pull by specifying a file containing a merge directive as the location.
5146
bzr send makes extensive use of public locations to map local locations into
5147
URLs that can be used by other people. See `bzr help configuration` to
5148
set them, and use `bzr info` to display them.
5151
encoding_type = 'exact'
5153
_see_also = ['merge', 'pull']
5155
takes_args = ['submit_branch?', 'public_branch?']
5159
help='Do not include a bundle in the merge directive.'),
5160
Option('no-patch', help='Do not include a preview patch in the merge'
5163
help='Remember submit and public branch.'),
5165
help='Branch to generate the submission from, '
5166
'rather than the one containing the working directory.',
5169
Option('output', short_name='o',
5170
help='Write merge directive to this file or directory; '
5171
'use - for stdout.',
5174
help='Refuse to send if there are uncommitted changes in'
5175
' the working tree, --no-strict disables the check.'),
5176
Option('mail-to', help='Mail the request to this address.',
5180
Option('body', help='Body for the email.', type=unicode),
5181
RegistryOption('format',
5182
help='Use the specified output format.',
5183
lazy_registry=('bzrlib.send', 'format_registry')),
5186
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5187
no_patch=False, revision=None, remember=False, output=None,
5188
format=None, mail_to=None, message=None, body=None,
5189
strict=None, **kwargs):
5190
from bzrlib.send import send
5191
return send(submit_branch, revision, public_branch, remember,
5192
format, no_bundle, no_patch, output,
5193
kwargs.get('from', '.'), mail_to, message, body,
5198
class cmd_bundle_revisions(cmd_send):
5199
__doc__ = """Create a merge-directive for submitting changes.
5201
A merge directive provides many things needed for requesting merges:
5203
* A machine-readable description of the merge to perform
5205
* An optional patch that is a preview of the changes requested
5207
* An optional bundle of revision data, so that the changes can be applied
5208
directly from the merge directive, without retrieving data from a
5211
If --no-bundle is specified, then public_branch is needed (and must be
5212
up-to-date), so that the receiver can perform the merge using the
5213
public_branch. The public_branch is always included if known, so that
5214
people can check it later.
5216
The submit branch defaults to the parent, but can be overridden. Both
5217
submit branch and public branch will be remembered if supplied.
5219
If a public_branch is known for the submit_branch, that public submit
5220
branch is used in the merge instructions. This means that a local mirror
5221
can be used as your actual submit branch, once you have set public_branch
5224
Two formats are currently supported: "4" uses revision bundle format 4 and
5225
merge directive format 2. It is significantly faster and smaller than
5226
older formats. It is compatible with Bazaar 0.19 and later. It is the
5227
default. "0.9" uses revision bundle format 0.9 and merge directive
5228
format 1. It is compatible with Bazaar 0.12 - 0.18.
5233
help='Do not include a bundle in the merge directive.'),
5234
Option('no-patch', help='Do not include a preview patch in the merge'
5237
help='Remember submit and public branch.'),
5239
help='Branch to generate the submission from, '
5240
'rather than the one containing the working directory.',
5243
Option('output', short_name='o', help='Write directive to this file.',
5246
help='Refuse to bundle revisions if there are uncommitted'
5247
' changes in the working tree, --no-strict disables the check.'),
5249
RegistryOption('format',
5250
help='Use the specified output format.',
5251
lazy_registry=('bzrlib.send', 'format_registry')),
5253
aliases = ['bundle']
5255
_see_also = ['send', 'merge']
5259
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5260
no_patch=False, revision=None, remember=False, output=None,
5261
format=None, strict=None, **kwargs):
5264
from bzrlib.send import send
5265
return send(submit_branch, revision, public_branch, remember,
5266
format, no_bundle, no_patch, output,
5267
kwargs.get('from', '.'), None, None, None,
5268
self.outf, strict=strict)
5271
class cmd_tag(Command):
5272
__doc__ = """Create, remove or modify a tag naming a revision.
5274
Tags give human-meaningful names to revisions. Commands that take a -r
5275
(--revision) option can be given -rtag:X, where X is any previously
5278
Tags are stored in the branch. Tags are copied from one branch to another
5279
along when you branch, push, pull or merge.
5281
It is an error to give a tag name that already exists unless you pass
5282
--force, in which case the tag is moved to point to the new revision.
5284
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5285
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5287
If no tag name is specified it will be determined through the
5288
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5289
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5293
_see_also = ['commit', 'tags']
5294
takes_args = ['tag_name?']
5297
help='Delete this tag rather than placing it.',
5299
custom_help('directory',
5300
help='Branch in which to place the tag.'),
5302
help='Replace existing tags.',
5307
def run(self, tag_name=None,
5313
branch, relpath = Branch.open_containing(directory)
5314
self.add_cleanup(branch.lock_write().unlock)
5316
if tag_name is None:
5317
raise errors.BzrCommandError("No tag specified to delete.")
5318
branch.tags.delete_tag(tag_name)
5319
self.outf.write('Deleted tag %s.\n' % tag_name)
5322
if len(revision) != 1:
5323
raise errors.BzrCommandError(
5324
"Tags can only be placed on a single revision, "
5326
revision_id = revision[0].as_revision_id(branch)
5328
revision_id = branch.last_revision()
5329
if tag_name is None:
5330
tag_name = branch.automatic_tag_name(revision_id)
5331
if tag_name is None:
5332
raise errors.BzrCommandError(
5333
"Please specify a tag name.")
5334
if (not force) and branch.tags.has_tag(tag_name):
5335
raise errors.TagAlreadyExists(tag_name)
5336
branch.tags.set_tag(tag_name, revision_id)
5337
self.outf.write('Created tag %s.\n' % tag_name)
5340
class cmd_tags(Command):
5341
__doc__ = """List tags.
5343
This command shows a table of tag names and the revisions they reference.
5348
custom_help('directory',
5349
help='Branch whose tags should be displayed.'),
5350
RegistryOption.from_kwargs('sort',
5351
'Sort tags by different criteria.', title='Sorting',
5352
alpha='Sort tags lexicographically (default).',
5353
time='Sort tags chronologically.',
5366
branch, relpath = Branch.open_containing(directory)
5368
tags = branch.tags.get_tag_dict().items()
5372
self.add_cleanup(branch.lock_read().unlock)
5374
graph = branch.repository.get_graph()
5375
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5376
revid1, revid2 = rev1.rev_id, rev2.rev_id
5377
# only show revisions between revid1 and revid2 (inclusive)
5378
tags = [(tag, revid) for tag, revid in tags if
5379
graph.is_between(revid, revid1, revid2)]
5382
elif sort == 'time':
5384
for tag, revid in tags:
5386
revobj = branch.repository.get_revision(revid)
5387
except errors.NoSuchRevision:
5388
timestamp = sys.maxint # place them at the end
5390
timestamp = revobj.timestamp
5391
timestamps[revid] = timestamp
5392
tags.sort(key=lambda x: timestamps[x[1]])
5394
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5395
for index, (tag, revid) in enumerate(tags):
5397
revno = branch.revision_id_to_dotted_revno(revid)
5398
if isinstance(revno, tuple):
5399
revno = '.'.join(map(str, revno))
5400
except errors.NoSuchRevision:
5401
# Bad tag data/merges can lead to tagged revisions
5402
# which are not in this branch. Fail gracefully ...
5404
tags[index] = (tag, revno)
5406
for tag, revspec in tags:
5407
self.outf.write('%-20s %s\n' % (tag, revspec))
5410
class cmd_reconfigure(Command):
5411
__doc__ = """Reconfigure the type of a bzr directory.
5413
A target configuration must be specified.
5415
For checkouts, the bind-to location will be auto-detected if not specified.
5416
The order of preference is
5417
1. For a lightweight checkout, the current bound location.
5418
2. For branches that used to be checkouts, the previously-bound location.
5419
3. The push location.
5420
4. The parent location.
5421
If none of these is available, --bind-to must be specified.
5424
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5425
takes_args = ['location?']
5427
RegistryOption.from_kwargs(
5429
title='Target type',
5430
help='The type to reconfigure the directory to.',
5431
value_switches=True, enum_switch=False,
5432
branch='Reconfigure to be an unbound branch with no working tree.',
5433
tree='Reconfigure to be an unbound branch with a working tree.',
5434
checkout='Reconfigure to be a bound branch with a working tree.',
5435
lightweight_checkout='Reconfigure to be a lightweight'
5436
' checkout (with no local history).',
5437
standalone='Reconfigure to be a standalone branch '
5438
'(i.e. stop using shared repository).',
5439
use_shared='Reconfigure to use a shared repository.',
5440
with_trees='Reconfigure repository to create '
5441
'working trees on branches by default.',
5442
with_no_trees='Reconfigure repository to not create '
5443
'working trees on branches by default.'
5445
Option('bind-to', help='Branch to bind checkout to.', type=str),
5447
help='Perform reconfiguration even if local changes'
5449
Option('stacked-on',
5450
help='Reconfigure a branch to be stacked on another branch.',
5454
help='Reconfigure a branch to be unstacked. This '
5455
'may require copying substantial data into it.',
5459
def run(self, location=None, target_type=None, bind_to=None, force=False,
5462
directory = bzrdir.BzrDir.open(location)
5463
if stacked_on and unstacked:
5464
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5465
elif stacked_on is not None:
5466
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5468
reconfigure.ReconfigureUnstacked().apply(directory)
5469
# At the moment you can use --stacked-on and a different
5470
# reconfiguration shape at the same time; there seems no good reason
5472
if target_type is None:
5473
if stacked_on or unstacked:
5476
raise errors.BzrCommandError('No target configuration '
5478
elif target_type == 'branch':
5479
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5480
elif target_type == 'tree':
5481
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5482
elif target_type == 'checkout':
5483
reconfiguration = reconfigure.Reconfigure.to_checkout(
5485
elif target_type == 'lightweight-checkout':
5486
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5488
elif target_type == 'use-shared':
5489
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5490
elif target_type == 'standalone':
5491
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5492
elif target_type == 'with-trees':
5493
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5495
elif target_type == 'with-no-trees':
5496
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5498
reconfiguration.apply(force)
5501
class cmd_switch(Command):
5502
__doc__ = """Set the branch of a checkout and update.
5504
For lightweight checkouts, this changes the branch being referenced.
5505
For heavyweight checkouts, this checks that there are no local commits
5506
versus the current bound branch, then it makes the local branch a mirror
5507
of the new location and binds to it.
5509
In both cases, the working tree is updated and uncommitted changes
5510
are merged. The user can commit or revert these as they desire.
5512
Pending merges need to be committed or reverted before using switch.
5514
The path to the branch to switch to can be specified relative to the parent
5515
directory of the current branch. For example, if you are currently in a
5516
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5519
Bound branches use the nickname of its master branch unless it is set
5520
locally, in which case switching will update the local nickname to be
5524
takes_args = ['to_location?']
5525
takes_options = ['directory',
5527
help='Switch even if local commits will be lost.'),
5529
Option('create-branch', short_name='b',
5530
help='Create the target branch from this one before'
5531
' switching to it.'),
5534
def run(self, to_location=None, force=False, create_branch=False,
5535
revision=None, directory=u'.'):
5536
from bzrlib import switch
5537
tree_location = directory
5538
revision = _get_one_revision('switch', revision)
5539
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5540
if to_location is None:
5541
if revision is None:
5542
raise errors.BzrCommandError('You must supply either a'
5543
' revision or a location')
5544
to_location = tree_location
5546
branch = control_dir.open_branch()
5547
had_explicit_nick = branch.get_config().has_explicit_nickname()
5548
except errors.NotBranchError:
5550
had_explicit_nick = False
5553
raise errors.BzrCommandError('cannot create branch without'
5555
to_location = directory_service.directories.dereference(
5557
if '/' not in to_location and '\\' not in to_location:
5558
# This path is meant to be relative to the existing branch
5559
this_url = self._get_branch_location(control_dir)
5560
to_location = urlutils.join(this_url, '..', to_location)
5561
to_branch = branch.bzrdir.sprout(to_location,
5562
possible_transports=[branch.bzrdir.root_transport],
5563
source_branch=branch).open_branch()
5566
to_branch = Branch.open(to_location)
5567
except errors.NotBranchError:
5568
this_url = self._get_branch_location(control_dir)
5569
to_branch = Branch.open(
5570
urlutils.join(this_url, '..', to_location))
5571
if revision is not None:
5572
revision = revision.as_revision_id(to_branch)
5573
switch.switch(control_dir, to_branch, force, revision_id=revision)
5574
if had_explicit_nick:
5575
branch = control_dir.open_branch() #get the new branch!
5576
branch.nick = to_branch.nick
5577
note('Switched to branch: %s',
5578
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5580
def _get_branch_location(self, control_dir):
5581
"""Return location of branch for this control dir."""
5583
this_branch = control_dir.open_branch()
5584
# This may be a heavy checkout, where we want the master branch
5585
master_location = this_branch.get_bound_location()
5586
if master_location is not None:
5587
return master_location
5588
# If not, use a local sibling
5589
return this_branch.base
5590
except errors.NotBranchError:
5591
format = control_dir.find_branch_format()
5592
if getattr(format, 'get_reference', None) is not None:
5593
return format.get_reference(control_dir)
5595
return control_dir.root_transport.base
5598
class cmd_view(Command):
5599
__doc__ = """Manage filtered views.
5601
Views provide a mask over the tree so that users can focus on
5602
a subset of a tree when doing their work. After creating a view,
5603
commands that support a list of files - status, diff, commit, etc -
5604
effectively have that list of files implicitly given each time.
5605
An explicit list of files can still be given but those files
5606
must be within the current view.
5608
In most cases, a view has a short life-span: it is created to make
5609
a selected change and is deleted once that change is committed.
5610
At other times, you may wish to create one or more named views
5611
and switch between them.
5613
To disable the current view without deleting it, you can switch to
5614
the pseudo view called ``off``. This can be useful when you need
5615
to see the whole tree for an operation or two (e.g. merge) but
5616
want to switch back to your view after that.
5619
To define the current view::
5621
bzr view file1 dir1 ...
5623
To list the current view::
5627
To delete the current view::
5631
To disable the current view without deleting it::
5633
bzr view --switch off
5635
To define a named view and switch to it::
5637
bzr view --name view-name file1 dir1 ...
5639
To list a named view::
5641
bzr view --name view-name
5643
To delete a named view::
5645
bzr view --name view-name --delete
5647
To switch to a named view::
5649
bzr view --switch view-name
5651
To list all views defined::
5655
To delete all views::
5657
bzr view --delete --all
5661
takes_args = ['file*']
5664
help='Apply list or delete action to all views.',
5667
help='Delete the view.',
5670
help='Name of the view to define, list or delete.',
5674
help='Name of the view to switch to.',
5679
def run(self, file_list,
5685
tree, file_list = WorkingTree.open_containing_paths(file_list,
5687
current_view, view_dict = tree.views.get_view_info()
5692
raise errors.BzrCommandError(
5693
"Both --delete and a file list specified")
5695
raise errors.BzrCommandError(
5696
"Both --delete and --switch specified")
5698
tree.views.set_view_info(None, {})
5699
self.outf.write("Deleted all views.\n")
5701
raise errors.BzrCommandError("No current view to delete")
5703
tree.views.delete_view(name)
5704
self.outf.write("Deleted '%s' view.\n" % name)
5707
raise errors.BzrCommandError(
5708
"Both --switch and a file list specified")
5710
raise errors.BzrCommandError(
5711
"Both --switch and --all specified")
5712
elif switch == 'off':
5713
if current_view is None:
5714
raise errors.BzrCommandError("No current view to disable")
5715
tree.views.set_view_info(None, view_dict)
5716
self.outf.write("Disabled '%s' view.\n" % (current_view))
5718
tree.views.set_view_info(switch, view_dict)
5719
view_str = views.view_display_str(tree.views.lookup_view())
5720
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5723
self.outf.write('Views defined:\n')
5724
for view in sorted(view_dict):
5725
if view == current_view:
5729
view_str = views.view_display_str(view_dict[view])
5730
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5732
self.outf.write('No views defined.\n')
5735
# No name given and no current view set
5738
raise errors.BzrCommandError(
5739
"Cannot change the 'off' pseudo view")
5740
tree.views.set_view(name, sorted(file_list))
5741
view_str = views.view_display_str(tree.views.lookup_view())
5742
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5746
# No name given and no current view set
5747
self.outf.write('No current view.\n')
5749
view_str = views.view_display_str(tree.views.lookup_view(name))
5750
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5753
class cmd_hooks(Command):
5754
__doc__ = """Show hooks."""
5759
for hook_key in sorted(hooks.known_hooks.keys()):
5760
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5761
self.outf.write("%s:\n" % type(some_hooks).__name__)
5762
for hook_name, hook_point in sorted(some_hooks.items()):
5763
self.outf.write(" %s:\n" % (hook_name,))
5764
found_hooks = list(hook_point)
5766
for hook in found_hooks:
5767
self.outf.write(" %s\n" %
5768
(some_hooks.get_hook_name(hook),))
5770
self.outf.write(" <no hooks installed>\n")
5773
class cmd_remove_branch(Command):
5774
__doc__ = """Remove a branch.
5776
This will remove the branch from the specified location but
5777
will keep any working tree or repository in place.
5781
Remove the branch at repo/trunk::
5783
bzr remove-branch repo/trunk
5787
takes_args = ["location?"]
5789
aliases = ["rmbranch"]
5791
def run(self, location=None):
5792
if location is None:
5794
branch = Branch.open_containing(location)[0]
5795
branch.bzrdir.destroy_branch()
5798
class cmd_shelve(Command):
5799
__doc__ = """Temporarily set aside some changes from the current tree.
5801
Shelve allows you to temporarily put changes you've made "on the shelf",
5802
ie. out of the way, until a later time when you can bring them back from
5803
the shelf with the 'unshelve' command. The changes are stored alongside
5804
your working tree, and so they aren't propagated along with your branch nor
5805
will they survive its deletion.
5807
If shelve --list is specified, previously-shelved changes are listed.
5809
Shelve is intended to help separate several sets of changes that have
5810
been inappropriately mingled. If you just want to get rid of all changes
5811
and you don't need to restore them later, use revert. If you want to
5812
shelve all text changes at once, use shelve --all.
5814
If filenames are specified, only the changes to those files will be
5815
shelved. Other files will be left untouched.
5817
If a revision is specified, changes since that revision will be shelved.
5819
You can put multiple items on the shelf, and by default, 'unshelve' will
5820
restore the most recently shelved changes.
5823
takes_args = ['file*']
5828
Option('all', help='Shelve all changes.'),
5830
RegistryOption('writer', 'Method to use for writing diffs.',
5831
bzrlib.option.diff_writer_registry,
5832
value_switches=True, enum_switch=False),
5834
Option('list', help='List shelved changes.'),
5836
help='Destroy removed changes instead of shelving them.'),
5838
_see_also = ['unshelve']
5840
def run(self, revision=None, all=False, file_list=None, message=None,
5841
writer=None, list=False, destroy=False, directory=u'.'):
5843
return self.run_for_list()
5844
from bzrlib.shelf_ui import Shelver
5846
writer = bzrlib.option.diff_writer_registry.get()
5848
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5849
file_list, message, destroy=destroy, directory=directory)
5854
except errors.UserAbort:
5857
def run_for_list(self):
5858
tree = WorkingTree.open_containing('.')[0]
5859
self.add_cleanup(tree.lock_read().unlock)
5860
manager = tree.get_shelf_manager()
5861
shelves = manager.active_shelves()
5862
if len(shelves) == 0:
5863
note('No shelved changes.')
5865
for shelf_id in reversed(shelves):
5866
message = manager.get_metadata(shelf_id).get('message')
5868
message = '<no message>'
5869
self.outf.write('%3d: %s\n' % (shelf_id, message))
5873
class cmd_unshelve(Command):
5874
__doc__ = """Restore shelved changes.
5876
By default, the most recently shelved changes are restored. However if you
5877
specify a shelf by id those changes will be restored instead. This works
5878
best when the changes don't depend on each other.
5881
takes_args = ['shelf_id?']
5884
RegistryOption.from_kwargs(
5885
'action', help="The action to perform.",
5886
enum_switch=False, value_switches=True,
5887
apply="Apply changes and remove from the shelf.",
5888
dry_run="Show changes, but do not apply or remove them.",
5889
preview="Instead of unshelving the changes, show the diff that "
5890
"would result from unshelving.",
5891
delete_only="Delete changes without applying them.",
5892
keep="Apply changes but don't delete them.",
5895
_see_also = ['shelve']
5897
def run(self, shelf_id=None, action='apply', directory=u'.'):
5898
from bzrlib.shelf_ui import Unshelver
5899
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5903
unshelver.tree.unlock()
5906
class cmd_clean_tree(Command):
5907
__doc__ = """Remove unwanted files from working tree.
5909
By default, only unknown files, not ignored files, are deleted. Versioned
5910
files are never deleted.
5912
Another class is 'detritus', which includes files emitted by bzr during
5913
normal operations and selftests. (The value of these files decreases with
5916
If no options are specified, unknown files are deleted. Otherwise, option
5917
flags are respected, and may be combined.
5919
To check what clean-tree will do, use --dry-run.
5921
takes_options = ['directory',
5922
Option('ignored', help='Delete all ignored files.'),
5923
Option('detritus', help='Delete conflict files, merge'
5924
' backups, and failed selftest dirs.'),
5926
help='Delete files unknown to bzr (default).'),
5927
Option('dry-run', help='Show files to delete instead of'
5929
Option('force', help='Do not prompt before deleting.')]
5930
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5931
force=False, directory=u'.'):
5932
from bzrlib.clean_tree import clean_tree
5933
if not (unknown or ignored or detritus):
5937
clean_tree(directory, unknown=unknown, ignored=ignored,
5938
detritus=detritus, dry_run=dry_run, no_prompt=force)
5941
class cmd_reference(Command):
5942
__doc__ = """list, view and set branch locations for nested trees.
5944
If no arguments are provided, lists the branch locations for nested trees.
5945
If one argument is provided, display the branch location for that tree.
5946
If two arguments are provided, set the branch location for that tree.
5951
takes_args = ['path?', 'location?']
5953
def run(self, path=None, location=None):
5955
if path is not None:
5957
tree, branch, relpath =(
5958
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5959
if path is not None:
5962
tree = branch.basis_tree()
5964
info = branch._get_all_reference_info().iteritems()
5965
self._display_reference_info(tree, branch, info)
5967
file_id = tree.path2id(path)
5969
raise errors.NotVersionedError(path)
5970
if location is None:
5971
info = [(file_id, branch.get_reference_info(file_id))]
5972
self._display_reference_info(tree, branch, info)
5974
branch.set_reference_info(file_id, path, location)
5976
def _display_reference_info(self, tree, branch, info):
5978
for file_id, (path, location) in info:
5980
path = tree.id2path(file_id)
5981
except errors.NoSuchId:
5983
ref_list.append((path, location))
5984
for path, location in sorted(ref_list):
5985
self.outf.write('%s %s\n' % (path, location))
5988
def _register_lazy_builtins():
5989
# register lazy builtins from other modules; called at startup and should
5990
# be only called once.
5991
for (name, aliases, module_name) in [
5992
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5993
('cmd_dpush', [], 'bzrlib.foreign'),
5994
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5995
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5996
('cmd_conflicts', [], 'bzrlib.conflicts'),
5997
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
5999
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
