1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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(), """
45
revision as _mod_revision,
53
from bzrlib.branch import Branch
54
from bzrlib.conflicts import ConflictList
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
from bzrlib.smtp_connection import SMTPConnection
57
from bzrlib.workingtree import WorkingTree
60
from bzrlib.commands import Command, display_command
61
from bzrlib.option import (
68
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
71
def tree_files(file_list, default_branch=u'.', canonicalize=True,
74
return internal_tree_files(file_list, default_branch, canonicalize,
76
except errors.FileInWrongBranch, e:
77
raise errors.BzrCommandError("%s is not in the same branch as %s" %
78
(e.path, file_list[0]))
81
def tree_files_for_add(file_list):
82
"""Add handles files a bit differently so it a custom implementation."""
84
tree = WorkingTree.open_containing(file_list[0])[0]
85
if tree.supports_views():
86
view_files = tree.views.lookup_view()
88
for filename in file_list:
89
if not osutils.is_inside_any(view_files, filename):
90
raise errors.FileOutsideView(filename, view_files)
92
tree = WorkingTree.open_containing(u'.')[0]
93
if tree.supports_views():
94
view_files = tree.views.lookup_view()
96
file_list = view_files
97
view_str = views.view_display_str(view_files)
98
note("Ignoring files outside view. View is %s" % view_str)
99
return tree, file_list
102
def _get_one_revision(command_name, revisions):
103
if revisions is None:
105
if len(revisions) != 1:
106
raise errors.BzrCommandError(
107
'bzr %s --revision takes exactly one revision identifier' % (
112
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
115
if revisions is None:
117
rev_tree = tree.basis_tree()
119
rev_tree = branch.basis_tree()
121
revision = _get_one_revision(command_name, revisions)
122
rev_tree = revision.as_tree(branch)
126
# XXX: Bad function name; should possibly also be a class method of
127
# WorkingTree rather than a function.
128
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
130
"""Convert command-line paths to a WorkingTree and relative paths.
132
This is typically used for command-line processors that take one or
133
more filenames, and infer the workingtree that contains them.
135
The filenames given are not required to exist.
137
:param file_list: Filenames to convert.
139
:param default_branch: Fallback tree path to use if file_list is empty or
142
:param apply_view: if True and a view is set, apply it or check that
143
specified files are within it
145
:return: workingtree, [relative_paths]
147
if file_list is None or len(file_list) == 0:
148
tree = WorkingTree.open_containing(default_branch)[0]
149
if tree.supports_views() and apply_view:
150
view_files = tree.views.lookup_view()
152
file_list = view_files
153
view_str = views.view_display_str(view_files)
154
note("Ignoring files outside view. View is %s" % view_str)
155
return tree, file_list
156
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
157
return tree, safe_relpath_files(tree, file_list, canonicalize,
158
apply_view=apply_view)
161
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
162
"""Convert file_list into a list of relpaths in tree.
164
:param tree: A tree to operate on.
165
:param file_list: A list of user provided paths or None.
166
:param apply_view: if True and a view is set, apply it or check that
167
specified files are within it
168
:return: A list of relative paths.
169
:raises errors.PathNotChild: When a provided path is in a different tree
172
if file_list is None:
174
if tree.supports_views() and apply_view:
175
view_files = tree.views.lookup_view()
179
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
180
# doesn't - fix that up here before we enter the loop.
182
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
185
for filename in file_list:
187
relpath = fixer(osutils.dereference_path(filename))
188
if view_files and not osutils.is_inside_any(view_files, relpath):
189
raise errors.FileOutsideView(filename, view_files)
190
new_list.append(relpath)
191
except errors.PathNotChild:
192
raise errors.FileInWrongBranch(tree.branch, filename)
196
def _get_view_info_for_change_reporter(tree):
197
"""Get the view information from a tree for change reporting."""
200
current_view = tree.views.get_view_info()[0]
201
if current_view is not None:
202
view_info = (current_view, tree.views.lookup_view())
203
except errors.ViewsNotSupported:
208
# TODO: Make sure no commands unconditionally use the working directory as a
209
# branch. If a filename argument is used, the first of them should be used to
210
# specify the branch. (Perhaps this can be factored out into some kind of
211
# Argument class, representing a file in a branch, where the first occurrence
214
class cmd_status(Command):
215
"""Display status summary.
217
This reports on versioned and unknown files, reporting them
218
grouped by state. Possible states are:
221
Versioned in the working copy but not in the previous revision.
224
Versioned in the previous revision but removed or deleted
228
Path of this file changed from the previous revision;
229
the text may also have changed. This includes files whose
230
parent directory was renamed.
233
Text has changed since the previous revision.
236
File kind has been changed (e.g. from file to directory).
239
Not versioned and not matching an ignore pattern.
241
To see ignored files use 'bzr ignored'. For details on the
242
changes to file texts, use 'bzr diff'.
244
Note that --short or -S gives status flags for each item, similar
245
to Subversion's status command. To get output similar to svn -q,
248
If no arguments are specified, the status of the entire working
249
directory is shown. Otherwise, only the status of the specified
250
files or directories is reported. If a directory is given, status
251
is reported for everything inside that directory.
253
Before merges are committed, the pending merge tip revisions are
254
shown. To see all pending merge revisions, use the -v option.
255
To skip the display of pending merge information altogether, use
256
the no-pending option or specify a file/directory.
258
If a revision argument is given, the status is calculated against
259
that revision, or between two revisions if two are provided.
262
# TODO: --no-recurse, --recurse options
264
takes_args = ['file*']
265
takes_options = ['show-ids', 'revision', 'change', 'verbose',
266
Option('short', help='Use short status indicators.',
268
Option('versioned', help='Only show versioned files.',
270
Option('no-pending', help='Don\'t show pending merges.',
273
aliases = ['st', 'stat']
275
encoding_type = 'replace'
276
_see_also = ['diff', 'revert', 'status-flags']
279
def run(self, show_ids=False, file_list=None, revision=None, short=False,
280
versioned=False, no_pending=False, verbose=False):
281
from bzrlib.status import show_tree_status
283
if revision and len(revision) > 2:
284
raise errors.BzrCommandError('bzr status --revision takes exactly'
285
' one or two revision specifiers')
287
tree, relfile_list = tree_files(file_list)
288
# Avoid asking for specific files when that is not needed.
289
if relfile_list == ['']:
291
# Don't disable pending merges for full trees other than '.'.
292
if file_list == ['.']:
294
# A specific path within a tree was given.
295
elif relfile_list is not None:
297
show_tree_status(tree, show_ids=show_ids,
298
specific_files=relfile_list, revision=revision,
299
to_file=self.outf, short=short, versioned=versioned,
300
show_pending=(not no_pending), verbose=verbose)
303
class cmd_cat_revision(Command):
304
"""Write out metadata for a revision.
306
The revision to print can either be specified by a specific
307
revision identifier, or you can use --revision.
311
takes_args = ['revision_id?']
312
takes_options = ['revision']
313
# cat-revision is more for frontends so should be exact
317
def run(self, revision_id=None, revision=None):
318
if revision_id is not None and revision is not None:
319
raise errors.BzrCommandError('You can only supply one of'
320
' revision_id or --revision')
321
if revision_id is None and revision is None:
322
raise errors.BzrCommandError('You must supply either'
323
' --revision or a revision_id')
324
b = WorkingTree.open_containing(u'.')[0].branch
326
# TODO: jam 20060112 should cat-revision always output utf-8?
327
if revision_id is not None:
328
revision_id = osutils.safe_revision_id(revision_id, warn=False)
330
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
331
except errors.NoSuchRevision:
332
msg = "The repository %s contains no revision %s." % (b.repository.base,
334
raise errors.BzrCommandError(msg)
335
elif revision is not None:
338
raise errors.BzrCommandError('You cannot specify a NULL'
340
rev_id = rev.as_revision_id(b)
341
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
344
class cmd_dump_btree(Command):
345
"""Dump the contents of a btree index file to stdout.
347
PATH is a btree index file, it can be any URL. This includes things like
348
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
350
By default, the tuples stored in the index file will be displayed. With
351
--raw, we will uncompress the pages, but otherwise display the raw bytes
355
# TODO: Do we want to dump the internal nodes as well?
356
# TODO: It would be nice to be able to dump the un-parsed information,
357
# rather than only going through iter_all_entries. However, this is
358
# good enough for a start
360
encoding_type = 'exact'
361
takes_args = ['path']
362
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
363
' rather than the parsed tuples.'),
366
def run(self, path, raw=False):
367
dirname, basename = osutils.split(path)
368
t = transport.get_transport(dirname)
370
self._dump_raw_bytes(t, basename)
372
self._dump_entries(t, basename)
374
def _get_index_and_bytes(self, trans, basename):
375
"""Create a BTreeGraphIndex and raw bytes."""
376
bt = btree_index.BTreeGraphIndex(trans, basename, None)
377
bytes = trans.get_bytes(basename)
378
bt._file = cStringIO.StringIO(bytes)
379
bt._size = len(bytes)
382
def _dump_raw_bytes(self, trans, basename):
385
# We need to parse at least the root node.
386
# This is because the first page of every row starts with an
387
# uncompressed header.
388
bt, bytes = self._get_index_and_bytes(trans, basename)
389
for page_idx, page_start in enumerate(xrange(0, len(bytes),
390
btree_index._PAGE_SIZE)):
391
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
392
page_bytes = bytes[page_start:page_end]
394
self.outf.write('Root node:\n')
395
header_end, data = bt._parse_header_from_bytes(page_bytes)
396
self.outf.write(page_bytes[:header_end])
398
self.outf.write('\nPage %d\n' % (page_idx,))
399
decomp_bytes = zlib.decompress(page_bytes)
400
self.outf.write(decomp_bytes)
401
self.outf.write('\n')
403
def _dump_entries(self, trans, basename):
405
st = trans.stat(basename)
406
except errors.TransportNotPossible:
407
# We can't stat, so we'll fake it because we have to do the 'get()'
409
bt, _ = self._get_index_and_bytes(trans, basename)
411
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
412
for node in bt.iter_all_entries():
413
# Node is made up of:
414
# (index, key, value, [references])
415
self.outf.write('%s\n' % (node[1:],))
418
class cmd_remove_tree(Command):
419
"""Remove the working tree from a given branch/checkout.
421
Since a lightweight checkout is little more than a working tree
422
this will refuse to run against one.
424
To re-create the working tree, use "bzr checkout".
426
_see_also = ['checkout', 'working-trees']
427
takes_args = ['location?']
430
help='Remove the working tree even if it has '
431
'uncommitted changes.'),
434
def run(self, location='.', force=False):
435
d = bzrdir.BzrDir.open(location)
438
working = d.open_workingtree()
439
except errors.NoWorkingTree:
440
raise errors.BzrCommandError("No working tree to remove")
441
except errors.NotLocalUrl:
442
raise errors.BzrCommandError("You cannot remove the working tree of a "
445
changes = working.changes_from(working.basis_tree())
446
if changes.has_changed():
447
raise errors.UncommittedChanges(working)
449
working_path = working.bzrdir.root_transport.base
450
branch_path = working.branch.bzrdir.root_transport.base
451
if working_path != branch_path:
452
raise errors.BzrCommandError("You cannot remove the working tree from "
453
"a lightweight checkout")
455
d.destroy_workingtree()
458
class cmd_revno(Command):
459
"""Show current revision number.
461
This is equal to the number of revisions on this branch.
465
takes_args = ['location?']
468
def run(self, location=u'.'):
469
self.outf.write(str(Branch.open_containing(location)[0].revno()))
470
self.outf.write('\n')
473
class cmd_revision_info(Command):
474
"""Show revision number and revision id for a given revision identifier.
477
takes_args = ['revision_info*']
481
help='Branch to examine, '
482
'rather than the one containing the working directory.',
489
def run(self, revision=None, directory=u'.', revision_info_list=[]):
492
if revision is not None:
493
revs.extend(revision)
494
if revision_info_list is not None:
495
for rev in revision_info_list:
496
revs.append(RevisionSpec.from_string(rev))
498
b = Branch.open_containing(directory)[0]
501
revs.append(RevisionSpec.from_string('-1'))
504
revision_id = rev.as_revision_id(b)
506
revno = '%4d' % (b.revision_id_to_revno(revision_id))
507
except errors.NoSuchRevision:
508
dotted_map = b.get_revision_id_to_revno_map()
509
revno = '.'.join(str(i) for i in dotted_map[revision_id])
510
print '%s %s' % (revno, revision_id)
513
class cmd_add(Command):
514
"""Add specified files or directories.
516
In non-recursive mode, all the named items are added, regardless
517
of whether they were previously ignored. A warning is given if
518
any of the named files are already versioned.
520
In recursive mode (the default), files are treated the same way
521
but the behaviour for directories is different. Directories that
522
are already versioned do not give a warning. All directories,
523
whether already versioned or not, are searched for files or
524
subdirectories that are neither versioned or ignored, and these
525
are added. This search proceeds recursively into versioned
526
directories. If no names are given '.' is assumed.
528
Therefore simply saying 'bzr add' will version all files that
529
are currently unknown.
531
Adding a file whose parent directory is not versioned will
532
implicitly add the parent, and so on up to the root. This means
533
you should never need to explicitly add a directory, they'll just
534
get added when you add a file in the directory.
536
--dry-run will show which files would be added, but not actually
539
--file-ids-from will try to use the file ids from the supplied path.
540
It looks up ids trying to find a matching parent directory with the
541
same filename, and then by pure path. This option is rarely needed
542
but can be useful when adding the same logical file into two
543
branches that will be merged later (without showing the two different
544
adds as a conflict). It is also useful when merging another project
545
into a subdirectory of this one.
547
takes_args = ['file*']
550
help="Don't recursively add the contents of directories."),
552
help="Show what would be done, but don't actually do anything."),
554
Option('file-ids-from',
556
help='Lookup file ids from this tree.'),
558
encoding_type = 'replace'
559
_see_also = ['remove']
561
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
566
if file_ids_from is not None:
568
base_tree, base_path = WorkingTree.open_containing(
570
except errors.NoWorkingTree:
571
base_branch, base_path = Branch.open_containing(
573
base_tree = base_branch.basis_tree()
575
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
576
to_file=self.outf, should_print=(not is_quiet()))
578
action = bzrlib.add.AddAction(to_file=self.outf,
579
should_print=(not is_quiet()))
582
base_tree.lock_read()
584
file_list = self._maybe_expand_globs(file_list)
585
tree, file_list = tree_files_for_add(file_list)
586
added, ignored = tree.smart_add(file_list, not
587
no_recurse, action=action, save=not dry_run)
589
if base_tree is not None:
593
for glob in sorted(ignored.keys()):
594
for path in ignored[glob]:
595
self.outf.write("ignored %s matching \"%s\"\n"
599
for glob, paths in ignored.items():
600
match_len += len(paths)
601
self.outf.write("ignored %d file(s).\n" % match_len)
602
self.outf.write("If you wish to add some of these files,"
603
" please add them by name.\n")
606
class cmd_mkdir(Command):
607
"""Create a new versioned directory.
609
This is equivalent to creating the directory and then adding it.
612
takes_args = ['dir+']
613
encoding_type = 'replace'
615
def run(self, dir_list):
618
wt, dd = WorkingTree.open_containing(d)
620
self.outf.write('added %s\n' % d)
623
class cmd_relpath(Command):
624
"""Show path of a file relative to root"""
626
takes_args = ['filename']
630
def run(self, filename):
631
# TODO: jam 20050106 Can relpath return a munged path if
632
# sys.stdout encoding cannot represent it?
633
tree, relpath = WorkingTree.open_containing(filename)
634
self.outf.write(relpath)
635
self.outf.write('\n')
638
class cmd_inventory(Command):
639
"""Show inventory of the current working copy or a revision.
641
It is possible to limit the output to a particular entry
642
type using the --kind option. For example: --kind file.
644
It is also possible to restrict the list of files to a specific
645
set. For example: bzr inventory --show-ids this/file
654
help='List entries of a particular kind: file, directory, symlink.',
657
takes_args = ['file*']
660
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
661
if kind and kind not in ['file', 'directory', 'symlink']:
662
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
664
revision = _get_one_revision('inventory', revision)
665
work_tree, file_list = tree_files(file_list)
666
work_tree.lock_read()
668
if revision is not None:
669
tree = revision.as_tree(work_tree.branch)
671
extra_trees = [work_tree]
677
if file_list is not None:
678
file_ids = tree.paths2ids(file_list, trees=extra_trees,
679
require_versioned=True)
680
# find_ids_across_trees may include some paths that don't
682
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
683
for file_id in file_ids if file_id in tree)
685
entries = tree.inventory.entries()
688
if tree is not work_tree:
691
for path, entry in entries:
692
if kind and kind != entry.kind:
695
self.outf.write('%-50s %s\n' % (path, entry.file_id))
697
self.outf.write(path)
698
self.outf.write('\n')
701
class cmd_mv(Command):
702
"""Move or rename a file.
705
bzr mv OLDNAME NEWNAME
707
bzr mv SOURCE... DESTINATION
709
If the last argument is a versioned directory, all the other names
710
are moved into it. Otherwise, there must be exactly two arguments
711
and the file is changed to a new name.
713
If OLDNAME does not exist on the filesystem but is versioned and
714
NEWNAME does exist on the filesystem but is not versioned, mv
715
assumes that the file has been manually moved and only updates
716
its internal inventory to reflect that change.
717
The same is valid when moving many SOURCE files to a DESTINATION.
719
Files cannot be moved between branches.
722
takes_args = ['names*']
723
takes_options = [Option("after", help="Move only the bzr identifier"
724
" of the file, because the file has already been moved."),
725
Option('auto', help='Automatically guess renames.'),
726
Option('dry-run', help='Avoid making changes when guessing renames.'),
728
aliases = ['move', 'rename']
729
encoding_type = 'replace'
731
def run(self, names_list, after=False, auto=False, dry_run=False):
733
return self.run_auto(names_list, after, dry_run)
735
raise errors.BzrCommandError('--dry-run requires --auto.')
736
if names_list is None:
738
if len(names_list) < 2:
739
raise errors.BzrCommandError("missing file argument")
740
tree, rel_names = tree_files(names_list, canonicalize=False)
743
self._run(tree, names_list, rel_names, after)
747
def run_auto(self, names_list, after, dry_run):
748
if names_list is not None and len(names_list) > 1:
749
raise errors.BzrCommandError('Only one path may be specified to'
752
raise errors.BzrCommandError('--after cannot be specified with'
754
work_tree, file_list = tree_files(names_list, default_branch='.')
755
work_tree.lock_write()
757
rename_map.RenameMap.guess_renames(work_tree, dry_run)
761
def _run(self, tree, names_list, rel_names, after):
762
into_existing = osutils.isdir(names_list[-1])
763
if into_existing and len(names_list) == 2:
765
# a. case-insensitive filesystem and change case of dir
766
# b. move directory after the fact (if the source used to be
767
# a directory, but now doesn't exist in the working tree
768
# and the target is an existing directory, just rename it)
769
if (not tree.case_sensitive
770
and rel_names[0].lower() == rel_names[1].lower()):
771
into_existing = False
774
# 'fix' the case of a potential 'from'
775
from_id = tree.path2id(
776
tree.get_canonical_inventory_path(rel_names[0]))
777
if (not osutils.lexists(names_list[0]) and
778
from_id and inv.get_file_kind(from_id) == "directory"):
779
into_existing = False
782
# move into existing directory
783
# All entries reference existing inventory items, so fix them up
784
# for cicp file-systems.
785
rel_names = tree.get_canonical_inventory_paths(rel_names)
786
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
787
self.outf.write("%s => %s\n" % pair)
789
if len(names_list) != 2:
790
raise errors.BzrCommandError('to mv multiple files the'
791
' destination must be a versioned'
794
# for cicp file-systems: the src references an existing inventory
796
src = tree.get_canonical_inventory_path(rel_names[0])
797
# Find the canonical version of the destination: In all cases, the
798
# parent of the target must be in the inventory, so we fetch the
799
# canonical version from there (we do not always *use* the
800
# canonicalized tail portion - we may be attempting to rename the
802
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
803
dest_parent = osutils.dirname(canon_dest)
804
spec_tail = osutils.basename(rel_names[1])
805
# For a CICP file-system, we need to avoid creating 2 inventory
806
# entries that differ only by case. So regardless of the case
807
# we *want* to use (ie, specified by the user or the file-system),
808
# we must always choose to use the case of any existing inventory
809
# items. The only exception to this is when we are attempting a
810
# case-only rename (ie, canonical versions of src and dest are
812
dest_id = tree.path2id(canon_dest)
813
if dest_id is None or tree.path2id(src) == dest_id:
814
# No existing item we care about, so work out what case we
815
# are actually going to use.
817
# If 'after' is specified, the tail must refer to a file on disk.
819
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
821
# pathjoin with an empty tail adds a slash, which breaks
823
dest_parent_fq = tree.basedir
825
dest_tail = osutils.canonical_relpath(
827
osutils.pathjoin(dest_parent_fq, spec_tail))
829
# not 'after', so case as specified is used
830
dest_tail = spec_tail
832
# Use the existing item so 'mv' fails with AlreadyVersioned.
833
dest_tail = os.path.basename(canon_dest)
834
dest = osutils.pathjoin(dest_parent, dest_tail)
835
mutter("attempting to move %s => %s", src, dest)
836
tree.rename_one(src, dest, after=after)
837
self.outf.write("%s => %s\n" % (src, dest))
840
class cmd_pull(Command):
841
"""Turn this branch into a mirror of another branch.
843
This command only works on branches that have not diverged. Branches are
844
considered diverged if the destination branch's most recent commit is one
845
that has not been merged (directly or indirectly) into the parent.
847
If branches have diverged, you can use 'bzr merge' to integrate the changes
848
from one into the other. Once one branch has merged, the other should
849
be able to pull it again.
851
If you want to forget your local changes and just update your branch to
852
match the remote one, use pull --overwrite.
854
If there is no default location set, the first pull will set it. After
855
that, you can omit the location to use the default. To change the
856
default, use --remember. The value will only be saved if the remote
857
location can be accessed.
859
Note: The location can be specified either in the form of a branch,
860
or in the form of a path to a file containing a merge directive generated
864
_see_also = ['push', 'update', 'status-flags', 'send']
865
takes_options = ['remember', 'overwrite', 'revision',
866
custom_help('verbose',
867
help='Show logs of pulled revisions.'),
869
help='Branch to pull into, '
870
'rather than the one containing the working directory.',
875
takes_args = ['location?']
876
encoding_type = 'replace'
878
def run(self, location=None, remember=False, overwrite=False,
879
revision=None, verbose=False,
881
# FIXME: too much stuff is in the command class
884
if directory is None:
887
tree_to = WorkingTree.open_containing(directory)[0]
888
branch_to = tree_to.branch
889
except errors.NoWorkingTree:
891
branch_to = Branch.open_containing(directory)[0]
893
possible_transports = []
894
if location is not None:
896
mergeable = bundle.read_mergeable_from_url(location,
897
possible_transports=possible_transports)
898
except errors.NotABundle:
901
stored_loc = branch_to.get_parent()
903
if stored_loc is None:
904
raise errors.BzrCommandError("No pull location known or"
907
display_url = urlutils.unescape_for_display(stored_loc,
910
self.outf.write("Using saved parent location: %s\n" % display_url)
911
location = stored_loc
913
revision = _get_one_revision('pull', revision)
914
if mergeable is not None:
915
if revision is not None:
916
raise errors.BzrCommandError(
917
'Cannot use -r with merge directives or bundles')
918
mergeable.install_revisions(branch_to.repository)
919
base_revision_id, revision_id, verified = \
920
mergeable.get_merge_request(branch_to.repository)
921
branch_from = branch_to
923
branch_from = Branch.open(location,
924
possible_transports=possible_transports)
926
if branch_to.get_parent() is None or remember:
927
branch_to.set_parent(branch_from.base)
929
if revision is not None:
930
revision_id = revision.as_revision_id(branch_from)
932
branch_to.lock_write()
934
if tree_to is not None:
935
view_info = _get_view_info_for_change_reporter(tree_to)
936
change_reporter = delta._ChangeReporter(
937
unversioned_filter=tree_to.is_ignored, view_info=view_info)
938
result = tree_to.pull(branch_from, overwrite, revision_id,
940
possible_transports=possible_transports)
942
result = branch_to.pull(branch_from, overwrite, revision_id)
944
result.report(self.outf)
945
if verbose and result.old_revid != result.new_revid:
946
log.show_branch_change(branch_to, self.outf, result.old_revno,
952
class cmd_push(Command):
953
"""Update a mirror of this branch.
955
The target branch will not have its working tree populated because this
956
is both expensive, and is not supported on remote file systems.
958
Some smart servers or protocols *may* put the working tree in place in
961
This command only works on branches that have not diverged. Branches are
962
considered diverged if the destination branch's most recent commit is one
963
that has not been merged (directly or indirectly) by the source branch.
965
If branches have diverged, you can use 'bzr push --overwrite' to replace
966
the other branch completely, discarding its unmerged changes.
968
If you want to ensure you have the different changes in the other branch,
969
do a merge (see bzr help merge) from the other branch, and commit that.
970
After that you will be able to do a push without '--overwrite'.
972
If there is no default push location set, the first push will set it.
973
After that, you can omit the location to use the default. To change the
974
default, use --remember. The value will only be saved if the remote
975
location can be accessed.
978
_see_also = ['pull', 'update', 'working-trees']
979
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
980
Option('create-prefix',
981
help='Create the path leading up to the branch '
982
'if it does not already exist.'),
984
help='Branch to push from, '
985
'rather than the one containing the working directory.',
989
Option('use-existing-dir',
990
help='By default push will fail if the target'
991
' directory exists, but does not already'
992
' have a control directory. This flag will'
993
' allow push to proceed.'),
995
help='Create a stacked branch that references the public location '
996
'of the parent branch.'),
998
help='Create a stacked branch that refers to another branch '
999
'for the commit history. Only the work not present in the '
1000
'referenced branch is included in the branch created.',
1003
takes_args = ['location?']
1004
encoding_type = 'replace'
1006
def run(self, location=None, remember=False, overwrite=False,
1007
create_prefix=False, verbose=False, revision=None,
1008
use_existing_dir=False, directory=None, stacked_on=None,
1010
from bzrlib.push import _show_push_branch
1012
# Get the source branch and revision_id
1013
if directory is None:
1015
br_from = Branch.open_containing(directory)[0]
1016
revision = _get_one_revision('push', revision)
1017
if revision is not None:
1018
revision_id = revision.in_history(br_from).rev_id
1020
revision_id = br_from.last_revision()
1022
# Get the stacked_on branch, if any
1023
if stacked_on is not None:
1024
stacked_on = urlutils.normalize_url(stacked_on)
1026
parent_url = br_from.get_parent()
1028
parent = Branch.open(parent_url)
1029
stacked_on = parent.get_public_branch()
1031
# I considered excluding non-http url's here, thus forcing
1032
# 'public' branches only, but that only works for some
1033
# users, so it's best to just depend on the user spotting an
1034
# error by the feedback given to them. RBC 20080227.
1035
stacked_on = parent_url
1037
raise errors.BzrCommandError(
1038
"Could not determine branch to refer to.")
1040
# Get the destination location
1041
if location is None:
1042
stored_loc = br_from.get_push_location()
1043
if stored_loc is None:
1044
raise errors.BzrCommandError(
1045
"No push location known or specified.")
1047
display_url = urlutils.unescape_for_display(stored_loc,
1049
self.outf.write("Using saved push location: %s\n" % display_url)
1050
location = stored_loc
1052
_show_push_branch(br_from, revision_id, location, self.outf,
1053
verbose=verbose, overwrite=overwrite, remember=remember,
1054
stacked_on=stacked_on, create_prefix=create_prefix,
1055
use_existing_dir=use_existing_dir)
1058
class cmd_branch(Command):
1059
"""Create a new copy of a branch.
1061
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1062
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1063
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1064
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1065
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1068
To retrieve the branch as of a particular revision, supply the --revision
1069
parameter, as in "branch foo/bar -r 5".
1072
_see_also = ['checkout']
1073
takes_args = ['from_location', 'to_location?']
1074
takes_options = ['revision', Option('hardlink',
1075
help='Hard-link working tree files where possible.'),
1077
help="Create a branch without a working-tree."),
1079
help='Create a stacked branch referring to the source branch. '
1080
'The new branch will depend on the availability of the source '
1081
'branch for all operations.'),
1082
Option('standalone',
1083
help='Do not use a shared repository, even if available.'),
1085
aliases = ['get', 'clone']
1087
def run(self, from_location, to_location=None, revision=None,
1088
hardlink=False, stacked=False, standalone=False, no_tree=False):
1089
from bzrlib.tag import _merge_tags_if_possible
1091
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1093
revision = _get_one_revision('branch', revision)
1096
if revision is not None:
1097
revision_id = revision.as_revision_id(br_from)
1099
# FIXME - wt.last_revision, fallback to branch, fall back to
1100
# None or perhaps NULL_REVISION to mean copy nothing
1102
revision_id = br_from.last_revision()
1103
if to_location is None:
1104
to_location = urlutils.derive_to_location(from_location)
1105
to_transport = transport.get_transport(to_location)
1107
to_transport.mkdir('.')
1108
except errors.FileExists:
1109
raise errors.BzrCommandError('Target directory "%s" already'
1110
' exists.' % to_location)
1111
except errors.NoSuchFile:
1112
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1115
# preserve whatever source format we have.
1116
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1117
possible_transports=[to_transport],
1118
accelerator_tree=accelerator_tree,
1119
hardlink=hardlink, stacked=stacked,
1120
force_new_repo=standalone,
1121
create_tree_if_local=not no_tree,
1122
source_branch=br_from)
1123
branch = dir.open_branch()
1124
except errors.NoSuchRevision:
1125
to_transport.delete_tree('.')
1126
msg = "The branch %s has no revision %s." % (from_location,
1128
raise errors.BzrCommandError(msg)
1129
_merge_tags_if_possible(br_from, branch)
1130
# If the source branch is stacked, the new branch may
1131
# be stacked whether we asked for that explicitly or not.
1132
# We therefore need a try/except here and not just 'if stacked:'
1134
note('Created new stacked branch referring to %s.' %
1135
branch.get_stacked_on_url())
1136
except (errors.NotStacked, errors.UnstackableBranchFormat,
1137
errors.UnstackableRepositoryFormat), e:
1138
note('Branched %d revision(s).' % branch.revno())
1143
class cmd_checkout(Command):
1144
"""Create a new checkout of an existing branch.
1146
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1147
the branch found in '.'. This is useful if you have removed the working tree
1148
or if it was never created - i.e. if you pushed the branch to its current
1149
location using SFTP.
1151
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1152
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1153
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1154
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1155
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1158
To retrieve the branch as of a particular revision, supply the --revision
1159
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1160
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1164
_see_also = ['checkouts', 'branch']
1165
takes_args = ['branch_location?', 'to_location?']
1166
takes_options = ['revision',
1167
Option('lightweight',
1168
help="Perform a lightweight checkout. Lightweight "
1169
"checkouts depend on access to the branch for "
1170
"every operation. Normal checkouts can perform "
1171
"common operations like diff and status without "
1172
"such access, and also support local commits."
1174
Option('files-from', type=str,
1175
help="Get file contents from this tree."),
1177
help='Hard-link working tree files where possible.'
1182
def run(self, branch_location=None, to_location=None, revision=None,
1183
lightweight=False, files_from=None, hardlink=False):
1184
if branch_location is None:
1185
branch_location = osutils.getcwd()
1186
to_location = branch_location
1187
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1189
revision = _get_one_revision('checkout', revision)
1190
if files_from is not None:
1191
accelerator_tree = WorkingTree.open(files_from)
1192
if revision is not None:
1193
revision_id = revision.as_revision_id(source)
1196
if to_location is None:
1197
to_location = urlutils.derive_to_location(branch_location)
1198
# if the source and to_location are the same,
1199
# and there is no working tree,
1200
# then reconstitute a branch
1201
if (osutils.abspath(to_location) ==
1202
osutils.abspath(branch_location)):
1204
source.bzrdir.open_workingtree()
1205
except errors.NoWorkingTree:
1206
source.bzrdir.create_workingtree(revision_id)
1208
source.create_checkout(to_location, revision_id, lightweight,
1209
accelerator_tree, hardlink)
1212
class cmd_renames(Command):
1213
"""Show list of renamed files.
1215
# TODO: Option to show renames between two historical versions.
1217
# TODO: Only show renames under dir, rather than in the whole branch.
1218
_see_also = ['status']
1219
takes_args = ['dir?']
1222
def run(self, dir=u'.'):
1223
tree = WorkingTree.open_containing(dir)[0]
1226
new_inv = tree.inventory
1227
old_tree = tree.basis_tree()
1228
old_tree.lock_read()
1230
old_inv = old_tree.inventory
1232
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1233
for f, paths, c, v, p, n, k, e in iterator:
1234
if paths[0] == paths[1]:
1238
renames.append(paths)
1240
for old_name, new_name in renames:
1241
self.outf.write("%s => %s\n" % (old_name, new_name))
1248
class cmd_update(Command):
1249
"""Update a tree to have the latest code committed to its branch.
1251
This will perform a merge into the working tree, and may generate
1252
conflicts. If you have any local changes, you will still
1253
need to commit them after the update for the update to be complete.
1255
If you want to discard your local changes, you can just do a
1256
'bzr revert' instead of 'bzr commit' after the update.
1259
_see_also = ['pull', 'working-trees', 'status-flags']
1260
takes_args = ['dir?']
1263
def run(self, dir='.'):
1264
tree = WorkingTree.open_containing(dir)[0]
1265
possible_transports = []
1266
master = tree.branch.get_master_branch(
1267
possible_transports=possible_transports)
1268
if master is not None:
1271
tree.lock_tree_write()
1273
existing_pending_merges = tree.get_parent_ids()[1:]
1274
last_rev = _mod_revision.ensure_null(tree.last_revision())
1275
if last_rev == _mod_revision.ensure_null(
1276
tree.branch.last_revision()):
1277
# may be up to date, check master too.
1278
if master is None or last_rev == _mod_revision.ensure_null(
1279
master.last_revision()):
1280
revno = tree.branch.revision_id_to_revno(last_rev)
1281
note("Tree is up to date at revision %d." % (revno,))
1283
view_info = _get_view_info_for_change_reporter(tree)
1284
conflicts = tree.update(
1285
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1286
view_info=view_info), possible_transports=possible_transports)
1287
revno = tree.branch.revision_id_to_revno(
1288
_mod_revision.ensure_null(tree.last_revision()))
1289
note('Updated to revision %d.' % (revno,))
1290
if tree.get_parent_ids()[1:] != existing_pending_merges:
1291
note('Your local commits will now show as pending merges with '
1292
"'bzr status', and can be committed with 'bzr commit'.")
1301
class cmd_info(Command):
1302
"""Show information about a working tree, branch or repository.
1304
This command will show all known locations and formats associated to the
1305
tree, branch or repository.
1307
In verbose mode, statistical information is included with each report.
1308
To see extended statistic information, use a verbosity level of 2 or
1309
higher by specifying the verbose option multiple times, e.g. -vv.
1311
Branches and working trees will also report any missing revisions.
1315
Display information on the format and related locations:
1319
Display the above together with extended format information and
1320
basic statistics (like the number of files in the working tree and
1321
number of revisions in the branch and repository):
1325
Display the above together with number of committers to the branch:
1329
_see_also = ['revno', 'working-trees', 'repositories']
1330
takes_args = ['location?']
1331
takes_options = ['verbose']
1332
encoding_type = 'replace'
1335
def run(self, location=None, verbose=False):
1337
noise_level = get_verbosity_level()
1340
from bzrlib.info import show_bzrdir_info
1341
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1342
verbose=noise_level, outfile=self.outf)
1345
class cmd_remove(Command):
1346
"""Remove files or directories.
1348
This makes bzr stop tracking changes to the specified files. bzr will delete
1349
them if they can easily be recovered using revert. If no options or
1350
parameters are given bzr will scan for files that are being tracked by bzr
1351
but missing in your tree and stop tracking them for you.
1353
takes_args = ['file*']
1354
takes_options = ['verbose',
1355
Option('new', help='Only remove files that have never been committed.'),
1356
RegistryOption.from_kwargs('file-deletion-strategy',
1357
'The file deletion mode to be used.',
1358
title='Deletion Strategy', value_switches=True, enum_switch=False,
1359
safe='Only delete files if they can be'
1360
' safely recovered (default).',
1361
keep="Don't delete any files.",
1362
force='Delete all the specified files, even if they can not be '
1363
'recovered and even if they are non-empty directories.')]
1364
aliases = ['rm', 'del']
1365
encoding_type = 'replace'
1367
def run(self, file_list, verbose=False, new=False,
1368
file_deletion_strategy='safe'):
1369
tree, file_list = tree_files(file_list)
1371
if file_list is not None:
1372
file_list = [f for f in file_list]
1376
# Heuristics should probably all move into tree.remove_smart or
1379
added = tree.changes_from(tree.basis_tree(),
1380
specific_files=file_list).added
1381
file_list = sorted([f[0] for f in added], reverse=True)
1382
if len(file_list) == 0:
1383
raise errors.BzrCommandError('No matching files.')
1384
elif file_list is None:
1385
# missing files show up in iter_changes(basis) as
1386
# versioned-with-no-kind.
1388
for change in tree.iter_changes(tree.basis_tree()):
1389
# Find paths in the working tree that have no kind:
1390
if change[1][1] is not None and change[6][1] is None:
1391
missing.append(change[1][1])
1392
file_list = sorted(missing, reverse=True)
1393
file_deletion_strategy = 'keep'
1394
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1395
keep_files=file_deletion_strategy=='keep',
1396
force=file_deletion_strategy=='force')
1401
class cmd_file_id(Command):
1402
"""Print file_id of a particular file or directory.
1404
The file_id is assigned when the file is first added and remains the
1405
same through all revisions where the file exists, even when it is
1410
_see_also = ['inventory', 'ls']
1411
takes_args = ['filename']
1414
def run(self, filename):
1415
tree, relpath = WorkingTree.open_containing(filename)
1416
i = tree.path2id(relpath)
1418
raise errors.NotVersionedError(filename)
1420
self.outf.write(i + '\n')
1423
class cmd_file_path(Command):
1424
"""Print path of file_ids to a file or directory.
1426
This prints one line for each directory down to the target,
1427
starting at the branch root.
1431
takes_args = ['filename']
1434
def run(self, filename):
1435
tree, relpath = WorkingTree.open_containing(filename)
1436
fid = tree.path2id(relpath)
1438
raise errors.NotVersionedError(filename)
1439
segments = osutils.splitpath(relpath)
1440
for pos in range(1, len(segments) + 1):
1441
path = osutils.joinpath(segments[:pos])
1442
self.outf.write("%s\n" % tree.path2id(path))
1445
class cmd_reconcile(Command):
1446
"""Reconcile bzr metadata in a branch.
1448
This can correct data mismatches that may have been caused by
1449
previous ghost operations or bzr upgrades. You should only
1450
need to run this command if 'bzr check' or a bzr developer
1451
advises you to run it.
1453
If a second branch is provided, cross-branch reconciliation is
1454
also attempted, which will check that data like the tree root
1455
id which was not present in very early bzr versions is represented
1456
correctly in both branches.
1458
At the same time it is run it may recompress data resulting in
1459
a potential saving in disk space or performance gain.
1461
The branch *MUST* be on a listable system such as local disk or sftp.
1464
_see_also = ['check']
1465
takes_args = ['branch?']
1467
def run(self, branch="."):
1468
from bzrlib.reconcile import reconcile
1469
dir = bzrdir.BzrDir.open(branch)
1473
class cmd_revision_history(Command):
1474
"""Display the list of revision ids on a branch."""
1477
takes_args = ['location?']
1482
def run(self, location="."):
1483
branch = Branch.open_containing(location)[0]
1484
for revid in branch.revision_history():
1485
self.outf.write(revid)
1486
self.outf.write('\n')
1489
class cmd_ancestry(Command):
1490
"""List all revisions merged into this branch."""
1492
_see_also = ['log', 'revision-history']
1493
takes_args = ['location?']
1498
def run(self, location="."):
1500
wt = WorkingTree.open_containing(location)[0]
1501
except errors.NoWorkingTree:
1502
b = Branch.open(location)
1503
last_revision = b.last_revision()
1506
last_revision = wt.last_revision()
1508
revision_ids = b.repository.get_ancestry(last_revision)
1510
for revision_id in revision_ids:
1511
self.outf.write(revision_id + '\n')
1514
class cmd_init(Command):
1515
"""Make a directory into a versioned branch.
1517
Use this to create an empty branch, or before importing an
1520
If there is a repository in a parent directory of the location, then
1521
the history of the branch will be stored in the repository. Otherwise
1522
init creates a standalone branch which carries its own history
1523
in the .bzr directory.
1525
If there is already a branch at the location but it has no working tree,
1526
the tree can be populated with 'bzr checkout'.
1528
Recipe for importing a tree of files::
1534
bzr commit -m "imported project"
1537
_see_also = ['init-repository', 'branch', 'checkout']
1538
takes_args = ['location?']
1540
Option('create-prefix',
1541
help='Create the path leading up to the branch '
1542
'if it does not already exist.'),
1543
RegistryOption('format',
1544
help='Specify a format for this branch. '
1545
'See "help formats".',
1546
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1547
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1548
value_switches=True,
1549
title="Branch Format",
1551
Option('append-revisions-only',
1552
help='Never change revnos or the existing log.'
1553
' Append revisions to it only.')
1555
def run(self, location=None, format=None, append_revisions_only=False,
1556
create_prefix=False):
1558
format = bzrdir.format_registry.make_bzrdir('default')
1559
if location is None:
1562
to_transport = transport.get_transport(location)
1564
# The path has to exist to initialize a
1565
# branch inside of it.
1566
# Just using os.mkdir, since I don't
1567
# believe that we want to create a bunch of
1568
# locations if the user supplies an extended path
1570
to_transport.ensure_base()
1571
except errors.NoSuchFile:
1572
if not create_prefix:
1573
raise errors.BzrCommandError("Parent directory of %s"
1575
"\nYou may supply --create-prefix to create all"
1576
" leading parent directories."
1578
_create_prefix(to_transport)
1581
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1582
except errors.NotBranchError:
1583
# really a NotBzrDir error...
1584
create_branch = bzrdir.BzrDir.create_branch_convenience
1585
branch = create_branch(to_transport.base, format=format,
1586
possible_transports=[to_transport])
1587
a_bzrdir = branch.bzrdir
1589
from bzrlib.transport.local import LocalTransport
1590
if a_bzrdir.has_branch():
1591
if (isinstance(to_transport, LocalTransport)
1592
and not a_bzrdir.has_workingtree()):
1593
raise errors.BranchExistsWithoutWorkingTree(location)
1594
raise errors.AlreadyBranchError(location)
1595
branch = a_bzrdir.create_branch()
1596
a_bzrdir.create_workingtree()
1597
if append_revisions_only:
1599
branch.set_append_revisions_only(True)
1600
except errors.UpgradeRequired:
1601
raise errors.BzrCommandError('This branch format cannot be set'
1602
' to append-revisions-only. Try --experimental-branch6')
1604
from bzrlib.info import describe_layout, describe_format
1606
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1607
except (errors.NoWorkingTree, errors.NotLocalUrl):
1609
repository = branch.repository
1610
layout = describe_layout(repository, branch, tree).lower()
1611
format = describe_format(a_bzrdir, repository, branch, tree)
1612
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1613
if repository.is_shared():
1614
#XXX: maybe this can be refactored into transport.path_or_url()
1615
url = repository.bzrdir.root_transport.external_url()
1617
url = urlutils.local_path_from_url(url)
1618
except errors.InvalidURL:
1620
self.outf.write("Using shared repository: %s\n" % url)
1623
class cmd_init_repository(Command):
1624
"""Create a shared repository to hold branches.
1626
New branches created under the repository directory will store their
1627
revisions in the repository, not in the branch directory.
1629
If the --no-trees option is used then the branches in the repository
1630
will not have working trees by default.
1633
Create a shared repositories holding just branches::
1635
bzr init-repo --no-trees repo
1638
Make a lightweight checkout elsewhere::
1640
bzr checkout --lightweight repo/trunk trunk-checkout
1645
_see_also = ['init', 'branch', 'checkout', 'repositories']
1646
takes_args = ["location"]
1647
takes_options = [RegistryOption('format',
1648
help='Specify a format for this repository. See'
1649
' "bzr help formats" for details.',
1650
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1651
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1652
value_switches=True, title='Repository format'),
1654
help='Branches in the repository will default to'
1655
' not having a working tree.'),
1657
aliases = ["init-repo"]
1659
def run(self, location, format=None, no_trees=False):
1661
format = bzrdir.format_registry.make_bzrdir('default')
1663
if location is None:
1666
to_transport = transport.get_transport(location)
1667
to_transport.ensure_base()
1669
newdir = format.initialize_on_transport(to_transport)
1670
repo = newdir.create_repository(shared=True)
1671
repo.set_make_working_trees(not no_trees)
1673
from bzrlib.info import show_bzrdir_info
1674
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1677
class cmd_diff(Command):
1678
"""Show differences in the working tree, between revisions or branches.
1680
If no arguments are given, all changes for the current tree are listed.
1681
If files are given, only the changes in those files are listed.
1682
Remote and multiple branches can be compared by using the --old and
1683
--new options. If not provided, the default for both is derived from
1684
the first argument, if any, or the current tree if no arguments are
1687
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1688
produces patches suitable for "patch -p1".
1692
2 - unrepresentable changes
1697
Shows the difference in the working tree versus the last commit::
1701
Difference between the working tree and revision 1::
1705
Difference between revision 2 and revision 1::
1709
Difference between revision 2 and revision 1 for branch xxx::
1713
Show just the differences for file NEWS::
1717
Show the differences in working tree xxx for file NEWS::
1721
Show the differences from branch xxx to this working tree:
1725
Show the differences between two branches for file NEWS::
1727
bzr diff --old xxx --new yyy NEWS
1729
Same as 'bzr diff' but prefix paths with old/ and new/::
1731
bzr diff --prefix old/:new/
1733
_see_also = ['status']
1734
takes_args = ['file*']
1736
Option('diff-options', type=str,
1737
help='Pass these options to the external diff program.'),
1738
Option('prefix', type=str,
1740
help='Set prefixes added to old and new filenames, as '
1741
'two values separated by a colon. (eg "old/:new/").'),
1743
help='Branch/tree to compare from.',
1747
help='Branch/tree to compare to.',
1753
help='Use this command to compare files.',
1757
aliases = ['di', 'dif']
1758
encoding_type = 'exact'
1761
def run(self, revision=None, file_list=None, diff_options=None,
1762
prefix=None, old=None, new=None, using=None):
1763
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1765
if (prefix is None) or (prefix == '0'):
1773
old_label, new_label = prefix.split(":")
1775
raise errors.BzrCommandError(
1776
'--prefix expects two values separated by a colon'
1777
' (eg "old/:new/")')
1779
if revision and len(revision) > 2:
1780
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1781
' one or two revision specifiers')
1783
old_tree, new_tree, specific_files, extra_trees = \
1784
_get_trees_to_diff(file_list, revision, old, new,
1786
return show_diff_trees(old_tree, new_tree, sys.stdout,
1787
specific_files=specific_files,
1788
external_diff_options=diff_options,
1789
old_label=old_label, new_label=new_label,
1790
extra_trees=extra_trees, using=using)
1793
class cmd_deleted(Command):
1794
"""List files deleted in the working tree.
1796
# TODO: Show files deleted since a previous revision, or
1797
# between two revisions.
1798
# TODO: Much more efficient way to do this: read in new
1799
# directories with readdir, rather than stating each one. Same
1800
# level of effort but possibly much less IO. (Or possibly not,
1801
# if the directories are very large...)
1802
_see_also = ['status', 'ls']
1803
takes_options = ['show-ids']
1806
def run(self, show_ids=False):
1807
tree = WorkingTree.open_containing(u'.')[0]
1810
old = tree.basis_tree()
1813
for path, ie in old.inventory.iter_entries():
1814
if not tree.has_id(ie.file_id):
1815
self.outf.write(path)
1817
self.outf.write(' ')
1818
self.outf.write(ie.file_id)
1819
self.outf.write('\n')
1826
class cmd_modified(Command):
1827
"""List files modified in working tree.
1831
_see_also = ['status', 'ls']
1834
help='Write an ascii NUL (\\0) separator '
1835
'between files rather than a newline.')
1839
def run(self, null=False):
1840
tree = WorkingTree.open_containing(u'.')[0]
1841
td = tree.changes_from(tree.basis_tree())
1842
for path, id, kind, text_modified, meta_modified in td.modified:
1844
self.outf.write(path + '\0')
1846
self.outf.write(osutils.quotefn(path) + '\n')
1849
class cmd_added(Command):
1850
"""List files added in working tree.
1854
_see_also = ['status', 'ls']
1857
help='Write an ascii NUL (\\0) separator '
1858
'between files rather than a newline.')
1862
def run(self, null=False):
1863
wt = WorkingTree.open_containing(u'.')[0]
1866
basis = wt.basis_tree()
1869
basis_inv = basis.inventory
1872
if file_id in basis_inv:
1874
if inv.is_root(file_id) and len(basis_inv) == 0:
1876
path = inv.id2path(file_id)
1877
if not os.access(osutils.abspath(path), os.F_OK):
1880
self.outf.write(path + '\0')
1882
self.outf.write(osutils.quotefn(path) + '\n')
1889
class cmd_root(Command):
1890
"""Show the tree root directory.
1892
The root is the nearest enclosing directory with a .bzr control
1895
takes_args = ['filename?']
1897
def run(self, filename=None):
1898
"""Print the branch root."""
1899
tree = WorkingTree.open_containing(filename)[0]
1900
self.outf.write(tree.basedir + '\n')
1903
def _parse_limit(limitstring):
1905
return int(limitstring)
1907
msg = "The limit argument must be an integer."
1908
raise errors.BzrCommandError(msg)
1911
def _parse_levels(s):
1915
msg = "The levels argument must be an integer."
1916
raise errors.BzrCommandError(msg)
1919
class cmd_log(Command):
1920
"""Show historical log for a branch or subset of a branch.
1922
log is bzr's default tool for exploring the history of a branch.
1923
The branch to use is taken from the first parameter. If no parameters
1924
are given, the branch containing the working directory is logged.
1925
Here are some simple examples::
1927
bzr log log the current branch
1928
bzr log foo.py log a file in its branch
1929
bzr log http://server/branch log a branch on a server
1931
The filtering, ordering and information shown for each revision can
1932
be controlled as explained below. By default, all revisions are
1933
shown sorted (topologically) so that newer revisions appear before
1934
older ones and descendants always appear before ancestors. If displayed,
1935
merged revisions are shown indented under the revision in which they
1940
The log format controls how information about each revision is
1941
displayed. The standard log formats are called ``long``, ``short``
1942
and ``line``. The default is long. See ``bzr help log-formats``
1943
for more details on log formats.
1945
The following options can be used to control what information is
1948
-l N display a maximum of N revisions
1949
-n N display N levels of revisions (0 for all, 1 for collapsed)
1950
-v display a status summary (delta) for each revision
1951
-p display a diff (patch) for each revision
1952
--show-ids display revision-ids (and file-ids), not just revnos
1954
Note that the default number of levels to display is a function of the
1955
log format. If the -n option is not used, the standard log formats show
1956
just the top level (mainline).
1958
Status summaries are shown using status flags like A, M, etc. To see
1959
the changes explained using words like ``added`` and ``modified``
1960
instead, use the -vv option.
1964
To display revisions from oldest to newest, use the --forward option.
1965
In most cases, using this option will have little impact on the total
1966
time taken to produce a log, though --forward does not incrementally
1967
display revisions like --reverse does when it can.
1969
:Revision filtering:
1971
The -r option can be used to specify what revision or range of revisions
1972
to filter against. The various forms are shown below::
1974
-rX display revision X
1975
-rX.. display revision X and later
1976
-r..Y display up to and including revision Y
1977
-rX..Y display from X to Y inclusive
1979
See ``bzr help revisionspec`` for details on how to specify X and Y.
1980
Some common examples are given below::
1982
-r-1 show just the tip
1983
-r-10.. show the last 10 mainline revisions
1984
-rsubmit:.. show what's new on this branch
1985
-rancestor:path.. show changes since the common ancestor of this
1986
branch and the one at location path
1987
-rdate:yesterday.. show changes since yesterday
1989
When logging a range of revisions using -rX..Y, log starts at
1990
revision Y and searches back in history through the primary
1991
("left-hand") parents until it finds X. When logging just the
1992
top level (using -n1), an error is reported if X is not found
1993
along the way. If multi-level logging is used (-n0), X may be
1994
a nested merge revision and the log will be truncated accordingly.
1998
If parameters are given and the first one is not a branch, the log
1999
will be filtered to show only those revisions that changed the
2000
nominated files or directories.
2002
Filenames are interpreted within their historical context. To log a
2003
deleted file, specify a revision range so that the file existed at
2004
the end or start of the range.
2006
Historical context is also important when interpreting pathnames of
2007
renamed files/directories. Consider the following example:
2009
* revision 1: add tutorial.txt
2010
* revision 2: modify tutorial.txt
2011
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2015
* ``bzr log guide.txt`` will log the file added in revision 1
2017
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2019
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2020
the original file in revision 2.
2022
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2023
was no file called guide.txt in revision 2.
2025
Renames are always followed by log. By design, there is no need to
2026
explicitly ask for this (and no way to stop logging a file back
2027
until it was last renamed).
2031
The --message option can be used for finding revisions that match a
2032
regular expression in a commit message.
2036
GUI tools and IDEs are often better at exploring history than command
2037
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2038
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2039
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2041
Web interfaces are often better at exploring history than command line
2042
tools, particularly for branches on servers. You may prefer Loggerhead
2043
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2045
You may find it useful to add the aliases below to ``bazaar.conf``::
2049
top = log -l10 --line
2052
``bzr tip`` will then show the latest revision while ``bzr top``
2053
will show the last 10 mainline revisions. To see the details of a
2054
particular revision X, ``bzr show -rX``.
2056
If you are interested in looking deeper into a particular merge X,
2057
use ``bzr log -n0 -rX``.
2059
``bzr log -v`` on a branch with lots of history is currently
2060
very slow. A fix for this issue is currently under development.
2061
With or without that fix, it is recommended that a revision range
2062
be given when using the -v option.
2064
bzr has a generic full-text matching plugin, bzr-search, that can be
2065
used to find revisions matching user names, commit messages, etc.
2066
Among other features, this plugin can find all revisions containing
2067
a list of words but not others.
2069
When exploring non-mainline history on large projects with deep
2070
history, the performance of log can be greatly improved by installing
2071
the revnocache plugin. This plugin buffers historical information
2072
trading disk space for faster speed.
2074
takes_args = ['file*']
2075
_see_also = ['log-formats', 'revisionspec']
2078
help='Show from oldest to newest.'),
2080
custom_help('verbose',
2081
help='Show files changed in each revision.'),
2085
type=bzrlib.option._parse_revision_str,
2087
help='Show just the specified revision.'
2088
' See also "help revisionspec".'),
2092
help='Number of levels to display - 0 for all, 1 for flat.',
2094
type=_parse_levels),
2097
help='Show revisions whose message matches this '
2098
'regular expression.',
2102
help='Limit the output to the first N revisions.',
2107
help='Show changes made in each revision as a patch.'),
2109
encoding_type = 'replace'
2112
def run(self, file_list=None, timezone='original',
2123
from bzrlib.log import (
2125
make_log_request_dict,
2126
_get_info_for_log_files,
2128
direction = (forward and 'forward') or 'reverse'
2130
if change is not None:
2132
raise errors.RangeInChangeOption()
2133
if revision is not None:
2134
raise errors.BzrCommandError(
2135
'--revision and --change are mutually exclusive')
2140
filter_by_dir = False
2142
# find the file ids to log and check for directory filtering
2143
b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2145
for relpath, file_id, kind in file_info_list:
2147
raise errors.BzrCommandError(
2148
"Path unknown at end or start of revision range: %s" %
2150
# If the relpath is the top of the tree, we log everything
2155
file_ids.append(file_id)
2156
filter_by_dir = filter_by_dir or (
2157
kind in ['directory', 'tree-reference'])
2160
# FIXME ? log the current subdir only RBC 20060203
2161
if revision is not None \
2162
and len(revision) > 0 and revision[0].get_branch():
2163
location = revision[0].get_branch()
2166
dir, relpath = bzrdir.BzrDir.open_containing(location)
2167
b = dir.open_branch()
2168
rev1, rev2 = _get_revision_range(revision, b, self.name())
2170
# Decide on the type of delta & diff filtering to use
2171
# TODO: add an --all-files option to make this configurable & consistent
2179
diff_type = 'partial'
2185
# Build the log formatter
2186
if log_format is None:
2187
log_format = log.log_formatter_registry.get_default(b)
2188
lf = log_format(show_ids=show_ids, to_file=self.outf,
2189
show_timezone=timezone,
2190
delta_format=get_verbosity_level(),
2193
# Choose the algorithm for doing the logging. It's annoying
2194
# having multiple code paths like this but necessary until
2195
# the underlying repository format is faster at generating
2196
# deltas or can provide everything we need from the indices.
2197
# The default algorithm - match-using-deltas - works for
2198
# multiple files and directories and is faster for small
2199
# amounts of history (200 revisions say). However, it's too
2200
# slow for logging a single file in a repository with deep
2201
# history, i.e. > 10K revisions. In the spirit of "do no
2202
# evil when adding features", we continue to use the
2203
# original algorithm - per-file-graph - for the "single
2204
# file that isn't a directory without showing a delta" case.
2205
partial_history = revision and b.repository._format.supports_chks
2206
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2207
or delta_type or partial_history)
2209
# Build the LogRequest and execute it
2210
if len(file_ids) == 0:
2212
rqst = make_log_request_dict(
2213
direction=direction, specific_fileids=file_ids,
2214
start_revision=rev1, end_revision=rev2, limit=limit,
2215
message_search=message, delta_type=delta_type,
2216
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2217
Logger(b, rqst).show(lf)
2222
def _get_revision_range(revisionspec_list, branch, command_name):
2223
"""Take the input of a revision option and turn it into a revision range.
2225
It returns RevisionInfo objects which can be used to obtain the rev_id's
2226
of the desired revisions. It does some user input validations.
2228
if revisionspec_list is None:
2231
elif len(revisionspec_list) == 1:
2232
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2233
elif len(revisionspec_list) == 2:
2234
start_spec = revisionspec_list[0]
2235
end_spec = revisionspec_list[1]
2236
if end_spec.get_branch() != start_spec.get_branch():
2237
# b is taken from revision[0].get_branch(), and
2238
# show_log will use its revision_history. Having
2239
# different branches will lead to weird behaviors.
2240
raise errors.BzrCommandError(
2241
"bzr %s doesn't accept two revisions in different"
2242
" branches." % command_name)
2243
rev1 = start_spec.in_history(branch)
2244
# Avoid loading all of history when we know a missing
2245
# end of range means the last revision ...
2246
if end_spec.spec is None:
2247
last_revno, last_revision_id = branch.last_revision_info()
2248
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2250
rev2 = end_spec.in_history(branch)
2252
raise errors.BzrCommandError(
2253
'bzr %s --revision takes one or two values.' % command_name)
2257
def _revision_range_to_revid_range(revision_range):
2260
if revision_range[0] is not None:
2261
rev_id1 = revision_range[0].rev_id
2262
if revision_range[1] is not None:
2263
rev_id2 = revision_range[1].rev_id
2264
return rev_id1, rev_id2
2266
def get_log_format(long=False, short=False, line=False, default='long'):
2267
log_format = default
2271
log_format = 'short'
2277
class cmd_touching_revisions(Command):
2278
"""Return revision-ids which affected a particular file.
2280
A more user-friendly interface is "bzr log FILE".
2284
takes_args = ["filename"]
2287
def run(self, filename):
2288
tree, relpath = WorkingTree.open_containing(filename)
2290
file_id = tree.path2id(relpath)
2291
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2292
self.outf.write("%6d %s\n" % (revno, what))
2295
class cmd_ls(Command):
2296
"""List files in a tree.
2299
_see_also = ['status', 'cat']
2300
takes_args = ['path?']
2304
Option('recursive', short_name='R',
2305
help='Recurse into subdirectories.'),
2307
help='Print paths relative to the root of the branch.'),
2308
Option('unknown', help='Print unknown files.'),
2309
Option('versioned', help='Print versioned files.',
2311
Option('ignored', help='Print ignored files.'),
2313
help='Write an ascii NUL (\\0) separator '
2314
'between files rather than a newline.'),
2316
help='List entries of a particular kind: file, directory, symlink.',
2321
def run(self, revision=None, verbose=False,
2322
recursive=False, from_root=False,
2323
unknown=False, versioned=False, ignored=False,
2324
null=False, kind=None, show_ids=False, path=None):
2326
if kind and kind not in ('file', 'directory', 'symlink'):
2327
raise errors.BzrCommandError('invalid kind specified')
2329
if verbose and null:
2330
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2331
all = not (unknown or versioned or ignored)
2333
selection = {'I':ignored, '?':unknown, 'V':versioned}
2340
raise errors.BzrCommandError('cannot specify both --from-root'
2344
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2350
if revision is not None or tree is None:
2351
tree = _get_one_revision_tree('ls', revision, branch=branch)
2354
if isinstance(tree, WorkingTree) and tree.supports_views():
2355
view_files = tree.views.lookup_view()
2358
view_str = views.view_display_str(view_files)
2359
note("Ignoring files outside view. View is %s" % view_str)
2363
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2364
if fp.startswith(relpath):
2365
fp = osutils.pathjoin(prefix, fp[len(relpath):])
2366
if not recursive and '/' in fp:
2368
if not all and not selection[fc]:
2370
if kind is not None and fkind != kind:
2374
views.check_path_in_view(tree, fp)
2375
except errors.FileOutsideView:
2377
kindch = entry.kind_character()
2378
outstring = fp + kindch
2380
outstring = '%-8s %s' % (fc, outstring)
2381
if show_ids and fid is not None:
2382
outstring = "%-50s %s" % (outstring, fid)
2383
self.outf.write(outstring + '\n')
2385
self.outf.write(fp + '\0')
2388
self.outf.write(fid)
2389
self.outf.write('\0')
2397
self.outf.write('%-50s %s\n' % (outstring, my_id))
2399
self.outf.write(outstring + '\n')
2404
class cmd_unknowns(Command):
2405
"""List unknown files.
2413
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2414
self.outf.write(osutils.quotefn(f) + '\n')
2417
class cmd_ignore(Command):
2418
"""Ignore specified files or patterns.
2420
See ``bzr help patterns`` for details on the syntax of patterns.
2422
To remove patterns from the ignore list, edit the .bzrignore file.
2423
After adding, editing or deleting that file either indirectly by
2424
using this command or directly by using an editor, be sure to commit
2427
Note: ignore patterns containing shell wildcards must be quoted from
2431
Ignore the top level Makefile::
2433
bzr ignore ./Makefile
2435
Ignore class files in all directories::
2437
bzr ignore "*.class"
2439
Ignore .o files under the lib directory::
2441
bzr ignore "lib/**/*.o"
2443
Ignore .o files under the lib directory::
2445
bzr ignore "RE:lib/.*\.o"
2447
Ignore everything but the "debian" toplevel directory::
2449
bzr ignore "RE:(?!debian/).*"
2452
_see_also = ['status', 'ignored', 'patterns']
2453
takes_args = ['name_pattern*']
2455
Option('old-default-rules',
2456
help='Write out the ignore rules bzr < 0.9 always used.')
2459
def run(self, name_pattern_list=None, old_default_rules=None):
2460
from bzrlib import ignores
2461
if old_default_rules is not None:
2462
# dump the rules and exit
2463
for pattern in ignores.OLD_DEFAULTS:
2466
if not name_pattern_list:
2467
raise errors.BzrCommandError("ignore requires at least one "
2468
"NAME_PATTERN or --old-default-rules")
2469
name_pattern_list = [globbing.normalize_pattern(p)
2470
for p in name_pattern_list]
2471
for name_pattern in name_pattern_list:
2472
if (name_pattern[0] == '/' or
2473
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2474
raise errors.BzrCommandError(
2475
"NAME_PATTERN should not be an absolute path")
2476
tree, relpath = WorkingTree.open_containing(u'.')
2477
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2478
ignored = globbing.Globster(name_pattern_list)
2481
for entry in tree.list_files():
2485
if ignored.match(filename):
2486
matches.append(filename.encode('utf-8'))
2488
if len(matches) > 0:
2489
print "Warning: the following files are version controlled and" \
2490
" match your ignore pattern:\n%s" \
2491
"\nThese files will continue to be version controlled" \
2492
" unless you 'bzr remove' them." % ("\n".join(matches),)
2495
class cmd_ignored(Command):
2496
"""List ignored files and the patterns that matched them.
2498
List all the ignored files and the ignore pattern that caused the file to
2501
Alternatively, to list just the files::
2506
encoding_type = 'replace'
2507
_see_also = ['ignore', 'ls']
2511
tree = WorkingTree.open_containing(u'.')[0]
2514
for path, file_class, kind, file_id, entry in tree.list_files():
2515
if file_class != 'I':
2517
## XXX: Slightly inefficient since this was already calculated
2518
pat = tree.is_ignored(path)
2519
self.outf.write('%-50s %s\n' % (path, pat))
2524
class cmd_lookup_revision(Command):
2525
"""Lookup the revision-id from a revision-number
2528
bzr lookup-revision 33
2531
takes_args = ['revno']
2534
def run(self, revno):
2538
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2540
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2543
class cmd_export(Command):
2544
"""Export current or past revision to a destination directory or archive.
2546
If no revision is specified this exports the last committed revision.
2548
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2549
given, try to find the format with the extension. If no extension
2550
is found exports to a directory (equivalent to --format=dir).
2552
If root is supplied, it will be used as the root directory inside
2553
container formats (tar, zip, etc). If it is not supplied it will default
2554
to the exported filename. The root option has no effect for 'dir' format.
2556
If branch is omitted then the branch containing the current working
2557
directory will be used.
2559
Note: Export of tree with non-ASCII filenames to zip is not supported.
2561
================= =========================
2562
Supported formats Autodetected by extension
2563
================= =========================
2566
tbz2 .tar.bz2, .tbz2
2569
================= =========================
2571
takes_args = ['dest', 'branch_or_subdir?']
2574
help="Type of file to export to.",
2577
Option('filters', help='Apply content filters to export the '
2578
'convenient form.'),
2581
help="Name of the root directory inside the exported file."),
2583
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2584
root=None, filters=False):
2585
from bzrlib.export import export
2587
if branch_or_subdir is None:
2588
tree = WorkingTree.open_containing(u'.')[0]
2592
b, subdir = Branch.open_containing(branch_or_subdir)
2595
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2597
export(rev_tree, dest, format, root, subdir, filtered=filters)
2598
except errors.NoSuchExportFormat, e:
2599
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2602
class cmd_cat(Command):
2603
"""Write the contents of a file as of a given revision to standard output.
2605
If no revision is nominated, the last revision is used.
2607
Note: Take care to redirect standard output when using this command on a
2613
Option('name-from-revision', help='The path name in the old tree.'),
2614
Option('filters', help='Apply content filters to display the '
2615
'convenience form.'),
2618
takes_args = ['filename']
2619
encoding_type = 'exact'
2622
def run(self, filename, revision=None, name_from_revision=False,
2624
if revision is not None and len(revision) != 1:
2625
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2626
" one revision specifier")
2627
tree, branch, relpath = \
2628
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2631
return self._run(tree, branch, relpath, filename, revision,
2632
name_from_revision, filters)
2636
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2639
tree = b.basis_tree()
2640
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2642
old_file_id = rev_tree.path2id(relpath)
2644
if name_from_revision:
2645
# Try in revision if requested
2646
if old_file_id is None:
2647
raise errors.BzrCommandError(
2648
"%r is not present in revision %s" % (
2649
filename, rev_tree.get_revision_id()))
2651
content = rev_tree.get_file_text(old_file_id)
2653
cur_file_id = tree.path2id(relpath)
2655
if cur_file_id is not None:
2656
# Then try with the actual file id
2658
content = rev_tree.get_file_text(cur_file_id)
2660
except errors.NoSuchId:
2661
# The actual file id didn't exist at that time
2663
if not found and old_file_id is not None:
2664
# Finally try with the old file id
2665
content = rev_tree.get_file_text(old_file_id)
2668
# Can't be found anywhere
2669
raise errors.BzrCommandError(
2670
"%r is not present in revision %s" % (
2671
filename, rev_tree.get_revision_id()))
2673
from bzrlib.filters import (
2674
ContentFilterContext,
2675
filtered_output_bytes,
2677
filters = rev_tree._content_filter_stack(relpath)
2678
chunks = content.splitlines(True)
2679
content = filtered_output_bytes(chunks, filters,
2680
ContentFilterContext(relpath, rev_tree))
2681
self.outf.writelines(content)
2683
self.outf.write(content)
2686
class cmd_local_time_offset(Command):
2687
"""Show the offset in seconds from GMT to local time."""
2691
print osutils.local_time_offset()
2695
class cmd_commit(Command):
2696
"""Commit changes into a new revision.
2698
If no arguments are given, the entire tree is committed.
2700
If selected files are specified, only changes to those files are
2701
committed. If a directory is specified then the directory and everything
2702
within it is committed.
2704
When excludes are given, they take precedence over selected files.
2705
For example, too commit only changes within foo, but not changes within
2708
bzr commit foo -x foo/bar
2710
If author of the change is not the same person as the committer, you can
2711
specify the author's name using the --author option. The name should be
2712
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2713
If there is more than one author of the change you can specify the option
2714
multiple times, once for each author.
2716
A selected-file commit may fail in some cases where the committed
2717
tree would be invalid. Consider::
2722
bzr commit foo -m "committing foo"
2723
bzr mv foo/bar foo/baz
2726
bzr commit foo/bar -m "committing bar but not baz"
2728
In the example above, the last commit will fail by design. This gives
2729
the user the opportunity to decide whether they want to commit the
2730
rename at the same time, separately first, or not at all. (As a general
2731
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2733
Note: A selected-file commit after a merge is not yet supported.
2735
# TODO: Run hooks on tree to-be-committed, and after commit.
2737
# TODO: Strict commit that fails if there are deleted files.
2738
# (what does "deleted files" mean ??)
2740
# TODO: Give better message for -s, --summary, used by tla people
2742
# XXX: verbose currently does nothing
2744
_see_also = ['bugs', 'uncommit']
2745
takes_args = ['selected*']
2747
ListOption('exclude', type=str, short_name='x',
2748
help="Do not consider changes made to a given path."),
2749
Option('message', type=unicode,
2751
help="Description of the new revision."),
2754
help='Commit even if nothing has changed.'),
2755
Option('file', type=str,
2758
help='Take commit message from this file.'),
2760
help="Refuse to commit if there are unknown "
2761
"files in the working tree."),
2762
ListOption('fixes', type=str,
2763
help="Mark a bug as being fixed by this revision "
2764
"(see \"bzr help bugs\")."),
2765
ListOption('author', type=unicode,
2766
help="Set the author's name, if it's different "
2767
"from the committer."),
2769
help="Perform a local commit in a bound "
2770
"branch. Local commits are not pushed to "
2771
"the master branch until a normal commit "
2775
help='When no message is supplied, show the diff along'
2776
' with the status summary in the message editor.'),
2778
aliases = ['ci', 'checkin']
2780
def _iter_bug_fix_urls(self, fixes, branch):
2781
# Configure the properties for bug fixing attributes.
2782
for fixed_bug in fixes:
2783
tokens = fixed_bug.split(':')
2784
if len(tokens) != 2:
2785
raise errors.BzrCommandError(
2786
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2787
"See \"bzr help bugs\" for more information on this "
2788
"feature.\nCommit refused." % fixed_bug)
2789
tag, bug_id = tokens
2791
yield bugtracker.get_bug_url(tag, branch, bug_id)
2792
except errors.UnknownBugTrackerAbbreviation:
2793
raise errors.BzrCommandError(
2794
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2795
except errors.MalformedBugIdentifier, e:
2796
raise errors.BzrCommandError(
2797
"%s\nCommit refused." % (str(e),))
2799
def run(self, message=None, file=None, verbose=False, selected_list=None,
2800
unchanged=False, strict=False, local=False, fixes=None,
2801
author=None, show_diff=False, exclude=None):
2802
from bzrlib.errors import (
2807
from bzrlib.msgeditor import (
2808
edit_commit_message_encoded,
2809
generate_commit_message_template,
2810
make_commit_message_template_encoded
2813
# TODO: Need a blackbox test for invoking the external editor; may be
2814
# slightly problematic to run this cross-platform.
2816
# TODO: do more checks that the commit will succeed before
2817
# spending the user's valuable time typing a commit message.
2821
tree, selected_list = tree_files(selected_list)
2822
if selected_list == ['']:
2823
# workaround - commit of root of tree should be exactly the same
2824
# as just default commit in that tree, and succeed even though
2825
# selected-file merge commit is not done yet
2830
bug_property = bugtracker.encode_fixes_bug_urls(
2831
self._iter_bug_fix_urls(fixes, tree.branch))
2833
properties['bugs'] = bug_property
2835
if local and not tree.branch.get_bound_location():
2836
raise errors.LocalRequiresBoundBranch()
2838
def get_message(commit_obj):
2839
"""Callback to get commit message"""
2840
my_message = message
2841
if my_message is None and not file:
2842
t = make_commit_message_template_encoded(tree,
2843
selected_list, diff=show_diff,
2844
output_encoding=osutils.get_user_encoding())
2845
start_message = generate_commit_message_template(commit_obj)
2846
my_message = edit_commit_message_encoded(t,
2847
start_message=start_message)
2848
if my_message is None:
2849
raise errors.BzrCommandError("please specify a commit"
2850
" message with either --message or --file")
2851
elif my_message and file:
2852
raise errors.BzrCommandError(
2853
"please specify either --message or --file")
2855
my_message = codecs.open(file, 'rt',
2856
osutils.get_user_encoding()).read()
2857
if my_message == "":
2858
raise errors.BzrCommandError("empty commit message specified")
2862
tree.commit(message_callback=get_message,
2863
specific_files=selected_list,
2864
allow_pointless=unchanged, strict=strict, local=local,
2865
reporter=None, verbose=verbose, revprops=properties,
2867
exclude=safe_relpath_files(tree, exclude))
2868
except PointlessCommit:
2869
# FIXME: This should really happen before the file is read in;
2870
# perhaps prepare the commit; get the message; then actually commit
2871
raise errors.BzrCommandError("no changes to commit."
2872
" use --unchanged to commit anyhow")
2873
except ConflictsInTree:
2874
raise errors.BzrCommandError('Conflicts detected in working '
2875
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2877
except StrictCommitFailed:
2878
raise errors.BzrCommandError("Commit refused because there are"
2879
" unknown files in the working tree.")
2880
except errors.BoundBranchOutOfDate, e:
2881
raise errors.BzrCommandError(str(e) + "\n"
2882
'To commit to master branch, run update and then commit.\n'
2883
'You can also pass --local to commit to continue working '
2887
class cmd_check(Command):
2888
"""Validate working tree structure, branch consistency and repository history.
2890
This command checks various invariants about branch and repository storage
2891
to detect data corruption or bzr bugs.
2893
The working tree and branch checks will only give output if a problem is
2894
detected. The output fields of the repository check are:
2896
revisions: This is just the number of revisions checked. It doesn't
2898
versionedfiles: This is just the number of versionedfiles checked. It
2899
doesn't indicate a problem.
2900
unreferenced ancestors: Texts that are ancestors of other texts, but
2901
are not properly referenced by the revision ancestry. This is a
2902
subtle problem that Bazaar can work around.
2903
unique file texts: This is the total number of unique file contents
2904
seen in the checked revisions. It does not indicate a problem.
2905
repeated file texts: This is the total number of repeated texts seen
2906
in the checked revisions. Texts can be repeated when their file
2907
entries are modified, but the file contents are not. It does not
2910
If no restrictions are specified, all Bazaar data that is found at the given
2911
location will be checked.
2915
Check the tree and branch at 'foo'::
2917
bzr check --tree --branch foo
2919
Check only the repository at 'bar'::
2921
bzr check --repo bar
2923
Check everything at 'baz'::
2928
_see_also = ['reconcile']
2929
takes_args = ['path?']
2930
takes_options = ['verbose',
2931
Option('branch', help="Check the branch related to the"
2932
" current directory."),
2933
Option('repo', help="Check the repository related to the"
2934
" current directory."),
2935
Option('tree', help="Check the working tree related to"
2936
" the current directory.")]
2938
def run(self, path=None, verbose=False, branch=False, repo=False,
2940
from bzrlib.check import check_dwim
2943
if not branch and not repo and not tree:
2944
branch = repo = tree = True
2945
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2948
class cmd_upgrade(Command):
2949
"""Upgrade branch storage to current format.
2951
The check command or bzr developers may sometimes advise you to run
2952
this command. When the default format has changed you may also be warned
2953
during other operations to upgrade.
2956
_see_also = ['check']
2957
takes_args = ['url?']
2959
RegistryOption('format',
2960
help='Upgrade to a specific format. See "bzr help'
2961
' formats" for details.',
2962
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2963
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2964
value_switches=True, title='Branch format'),
2967
def run(self, url='.', format=None):
2968
from bzrlib.upgrade import upgrade
2969
upgrade(url, format)
2972
class cmd_whoami(Command):
2973
"""Show or set bzr user id.
2976
Show the email of the current user::
2980
Set the current user::
2982
bzr whoami "Frank Chu <fchu@example.com>"
2984
takes_options = [ Option('email',
2985
help='Display email address only.'),
2987
help='Set identity for the current branch instead of '
2990
takes_args = ['name?']
2991
encoding_type = 'replace'
2994
def run(self, email=False, branch=False, name=None):
2996
# use branch if we're inside one; otherwise global config
2998
c = Branch.open_containing('.')[0].get_config()
2999
except errors.NotBranchError:
3000
c = config.GlobalConfig()
3002
self.outf.write(c.user_email() + '\n')
3004
self.outf.write(c.username() + '\n')
3007
# display a warning if an email address isn't included in the given name.
3009
config.extract_email_address(name)
3010
except errors.NoEmailInUsername, e:
3011
warning('"%s" does not seem to contain an email address. '
3012
'This is allowed, but not recommended.', name)
3014
# use global config unless --branch given
3016
c = Branch.open_containing('.')[0].get_config()
3018
c = config.GlobalConfig()
3019
c.set_user_option('email', name)
3022
class cmd_nick(Command):
3023
"""Print or set the branch nickname.
3025
If unset, the tree root directory name is used as the nickname.
3026
To print the current nickname, execute with no argument.
3028
Bound branches use the nickname of its master branch unless it is set
3032
_see_also = ['info']
3033
takes_args = ['nickname?']
3034
def run(self, nickname=None):
3035
branch = Branch.open_containing(u'.')[0]
3036
if nickname is None:
3037
self.printme(branch)
3039
branch.nick = nickname
3042
def printme(self, branch):
3046
class cmd_alias(Command):
3047
"""Set/unset and display aliases.
3050
Show the current aliases::
3054
Show the alias specified for 'll'::
3058
Set an alias for 'll'::
3060
bzr alias ll="log --line -r-10..-1"
3062
To remove an alias for 'll'::
3064
bzr alias --remove ll
3067
takes_args = ['name?']
3069
Option('remove', help='Remove the alias.'),
3072
def run(self, name=None, remove=False):
3074
self.remove_alias(name)
3076
self.print_aliases()
3078
equal_pos = name.find('=')
3080
self.print_alias(name)
3082
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3084
def remove_alias(self, alias_name):
3085
if alias_name is None:
3086
raise errors.BzrCommandError(
3087
'bzr alias --remove expects an alias to remove.')
3088
# If alias is not found, print something like:
3089
# unalias: foo: not found
3090
c = config.GlobalConfig()
3091
c.unset_alias(alias_name)
3094
def print_aliases(self):
3095
"""Print out the defined aliases in a similar format to bash."""
3096
aliases = config.GlobalConfig().get_aliases()
3097
for key, value in sorted(aliases.iteritems()):
3098
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3101
def print_alias(self, alias_name):
3102
from bzrlib.commands import get_alias
3103
alias = get_alias(alias_name)
3105
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3108
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3110
def set_alias(self, alias_name, alias_command):
3111
"""Save the alias in the global config."""
3112
c = config.GlobalConfig()
3113
c.set_alias(alias_name, alias_command)
3116
class cmd_selftest(Command):
3117
"""Run internal test suite.
3119
If arguments are given, they are regular expressions that say which tests
3120
should run. Tests matching any expression are run, and other tests are
3123
Alternatively if --first is given, matching tests are run first and then
3124
all other tests are run. This is useful if you have been working in a
3125
particular area, but want to make sure nothing else was broken.
3127
If --exclude is given, tests that match that regular expression are
3128
excluded, regardless of whether they match --first or not.
3130
To help catch accidential dependencies between tests, the --randomize
3131
option is useful. In most cases, the argument used is the word 'now'.
3132
Note that the seed used for the random number generator is displayed
3133
when this option is used. The seed can be explicitly passed as the
3134
argument to this option if required. This enables reproduction of the
3135
actual ordering used if and when an order sensitive problem is encountered.
3137
If --list-only is given, the tests that would be run are listed. This is
3138
useful when combined with --first, --exclude and/or --randomize to
3139
understand their impact. The test harness reports "Listed nn tests in ..."
3140
instead of "Ran nn tests in ..." when list mode is enabled.
3142
If the global option '--no-plugins' is given, plugins are not loaded
3143
before running the selftests. This has two effects: features provided or
3144
modified by plugins will not be tested, and tests provided by plugins will
3147
Tests that need working space on disk use a common temporary directory,
3148
typically inside $TMPDIR or /tmp.
3151
Run only tests relating to 'ignore'::
3155
Disable plugins and list tests as they're run::
3157
bzr --no-plugins selftest -v
3159
# NB: this is used from the class without creating an instance, which is
3160
# why it does not have a self parameter.
3161
def get_transport_type(typestring):
3162
"""Parse and return a transport specifier."""
3163
if typestring == "sftp":
3164
from bzrlib.transport.sftp import SFTPAbsoluteServer
3165
return SFTPAbsoluteServer
3166
if typestring == "memory":
3167
from bzrlib.transport.memory import MemoryServer
3169
if typestring == "fakenfs":
3170
from bzrlib.transport.fakenfs import FakeNFSServer
3171
return FakeNFSServer
3172
msg = "No known transport type %s. Supported types are: sftp\n" %\
3174
raise errors.BzrCommandError(msg)
3177
takes_args = ['testspecs*']
3178
takes_options = ['verbose',
3180
help='Stop when one test fails.',
3184
help='Use a different transport by default '
3185
'throughout the test suite.',
3186
type=get_transport_type),
3188
help='Run the benchmarks rather than selftests.'),
3189
Option('lsprof-timed',
3190
help='Generate lsprof output for benchmarked'
3191
' sections of code.'),
3192
Option('cache-dir', type=str,
3193
help='Cache intermediate benchmark output in this '
3196
help='Run all tests, but run specified tests first.',
3200
help='List the tests instead of running them.'),
3201
RegistryOption('parallel',
3202
help="Run the test suite in parallel.",
3203
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3204
value_switches=False,
3206
Option('randomize', type=str, argname="SEED",
3207
help='Randomize the order of tests using the given'
3208
' seed or "now" for the current time.'),
3209
Option('exclude', type=str, argname="PATTERN",
3211
help='Exclude tests that match this regular'
3214
help='Output test progress via subunit.'),
3215
Option('strict', help='Fail on missing dependencies or '
3217
Option('load-list', type=str, argname='TESTLISTFILE',
3218
help='Load a test id list from a text file.'),
3219
ListOption('debugflag', type=str, short_name='E',
3220
help='Turn on a selftest debug flag.'),
3221
ListOption('starting-with', type=str, argname='TESTID',
3222
param_name='starting_with', short_name='s',
3224
'Load only the tests starting with TESTID.'),
3226
encoding_type = 'replace'
3229
Command.__init__(self)
3230
self.additional_selftest_args = {}
3232
def run(self, testspecs_list=None, verbose=False, one=False,
3233
transport=None, benchmark=None,
3234
lsprof_timed=None, cache_dir=None,
3235
first=False, list_only=False,
3236
randomize=None, exclude=None, strict=False,
3237
load_list=None, debugflag=None, starting_with=None, subunit=False,
3239
from bzrlib.tests import selftest
3240
import bzrlib.benchmarks as benchmarks
3241
from bzrlib.benchmarks import tree_creator
3243
# Make deprecation warnings visible, unless -Werror is set
3244
symbol_versioning.activate_deprecation_warnings(override=False)
3246
if cache_dir is not None:
3247
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3248
if testspecs_list is not None:
3249
pattern = '|'.join(testspecs_list)
3254
from bzrlib.tests import SubUnitBzrRunner
3256
raise errors.BzrCommandError("subunit not available. subunit "
3257
"needs to be installed to use --subunit.")
3258
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3260
self.additional_selftest_args.setdefault(
3261
'suite_decorators', []).append(parallel)
3263
test_suite_factory = benchmarks.test_suite
3264
# Unless user explicitly asks for quiet, be verbose in benchmarks
3265
verbose = not is_quiet()
3266
# TODO: should possibly lock the history file...
3267
benchfile = open(".perf_history", "at", buffering=1)
3269
test_suite_factory = None
3272
selftest_kwargs = {"verbose": verbose,
3274
"stop_on_failure": one,
3275
"transport": transport,
3276
"test_suite_factory": test_suite_factory,
3277
"lsprof_timed": lsprof_timed,
3278
"bench_history": benchfile,
3279
"matching_tests_first": first,
3280
"list_only": list_only,
3281
"random_seed": randomize,
3282
"exclude_pattern": exclude,
3284
"load_list": load_list,
3285
"debug_flags": debugflag,
3286
"starting_with": starting_with
3288
selftest_kwargs.update(self.additional_selftest_args)
3289
result = selftest(**selftest_kwargs)
3291
if benchfile is not None:
3293
return int(not result)
3296
class cmd_version(Command):
3297
"""Show version of bzr."""
3299
encoding_type = 'replace'
3301
Option("short", help="Print just the version number."),
3305
def run(self, short=False):
3306
from bzrlib.version import show_version
3308
self.outf.write(bzrlib.version_string + '\n')
3310
show_version(to_file=self.outf)
3313
class cmd_rocks(Command):
3314
"""Statement of optimism."""
3320
print "It sure does!"
3323
class cmd_find_merge_base(Command):
3324
"""Find and print a base revision for merging two branches."""
3325
# TODO: Options to specify revisions on either side, as if
3326
# merging only part of the history.
3327
takes_args = ['branch', 'other']
3331
def run(self, branch, other):
3332
from bzrlib.revision import ensure_null
3334
branch1 = Branch.open_containing(branch)[0]
3335
branch2 = Branch.open_containing(other)[0]
3340
last1 = ensure_null(branch1.last_revision())
3341
last2 = ensure_null(branch2.last_revision())
3343
graph = branch1.repository.get_graph(branch2.repository)
3344
base_rev_id = graph.find_unique_lca(last1, last2)
3346
print 'merge base is revision %s' % base_rev_id
3353
class cmd_merge(Command):
3354
"""Perform a three-way merge.
3356
The source of the merge can be specified either in the form of a branch,
3357
or in the form of a path to a file containing a merge directive generated
3358
with bzr send. If neither is specified, the default is the upstream branch
3359
or the branch most recently merged using --remember.
3361
When merging a branch, by default the tip will be merged. To pick a different
3362
revision, pass --revision. If you specify two values, the first will be used as
3363
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3364
available revisions, like this is commonly referred to as "cherrypicking".
3366
Revision numbers are always relative to the branch being merged.
3368
By default, bzr will try to merge in all new work from the other
3369
branch, automatically determining an appropriate base. If this
3370
fails, you may need to give an explicit base.
3372
Merge will do its best to combine the changes in two branches, but there
3373
are some kinds of problems only a human can fix. When it encounters those,
3374
it will mark a conflict. A conflict means that you need to fix something,
3375
before you should commit.
3377
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3379
If there is no default branch set, the first merge will set it. After
3380
that, you can omit the branch to use the default. To change the
3381
default, use --remember. The value will only be saved if the remote
3382
location can be accessed.
3384
The results of the merge are placed into the destination working
3385
directory, where they can be reviewed (with bzr diff), tested, and then
3386
committed to record the result of the merge.
3388
merge refuses to run if there are any uncommitted changes, unless
3392
To merge the latest revision from bzr.dev::
3394
bzr merge ../bzr.dev
3396
To merge changes up to and including revision 82 from bzr.dev::
3398
bzr merge -r 82 ../bzr.dev
3400
To merge the changes introduced by 82, without previous changes::
3402
bzr merge -r 81..82 ../bzr.dev
3404
To apply a merge directive contained in /tmp/merge:
3406
bzr merge /tmp/merge
3409
encoding_type = 'exact'
3410
_see_also = ['update', 'remerge', 'status-flags', 'send']
3411
takes_args = ['location?']
3416
help='Merge even if the destination tree has uncommitted changes.'),
3420
Option('show-base', help="Show base revision text in "
3422
Option('uncommitted', help='Apply uncommitted changes'
3423
' from a working copy, instead of branch changes.'),
3424
Option('pull', help='If the destination is already'
3425
' completely merged into the source, pull from the'
3426
' source rather than merging. When this happens,'
3427
' you do not need to commit the result.'),
3429
help='Branch to merge into, '
3430
'rather than the one containing the working directory.',
3434
Option('preview', help='Instead of merging, show a diff of the merge.')
3437
def run(self, location=None, revision=None, force=False,
3438
merge_type=None, show_base=False, reprocess=None, remember=False,
3439
uncommitted=False, pull=False,
3443
if merge_type is None:
3444
merge_type = _mod_merge.Merge3Merger
3446
if directory is None: directory = u'.'
3447
possible_transports = []
3449
allow_pending = True
3450
verified = 'inapplicable'
3451
tree = WorkingTree.open_containing(directory)[0]
3453
# die as quickly as possible if there are uncommitted changes
3455
basis_tree = tree.revision_tree(tree.last_revision())
3456
except errors.NoSuchRevision:
3457
basis_tree = tree.basis_tree()
3459
changes = tree.changes_from(basis_tree)
3460
if changes.has_changed():
3461
raise errors.UncommittedChanges(tree)
3463
view_info = _get_view_info_for_change_reporter(tree)
3464
change_reporter = delta._ChangeReporter(
3465
unversioned_filter=tree.is_ignored, view_info=view_info)
3468
pb = ui.ui_factory.nested_progress_bar()
3469
cleanups.append(pb.finished)
3471
cleanups.append(tree.unlock)
3472
if location is not None:
3474
mergeable = bundle.read_mergeable_from_url(location,
3475
possible_transports=possible_transports)
3476
except errors.NotABundle:
3480
raise errors.BzrCommandError('Cannot use --uncommitted'
3481
' with bundles or merge directives.')
3483
if revision is not None:
3484
raise errors.BzrCommandError(
3485
'Cannot use -r with merge directives or bundles')
3486
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3489
if merger is None and uncommitted:
3490
if revision is not None and len(revision) > 0:
3491
raise errors.BzrCommandError('Cannot use --uncommitted and'
3492
' --revision at the same time.')
3493
location = self._select_branch_location(tree, location)[0]
3494
other_tree, other_path = WorkingTree.open_containing(location)
3495
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3497
allow_pending = False
3498
if other_path != '':
3499
merger.interesting_files = [other_path]
3502
merger, allow_pending = self._get_merger_from_branch(tree,
3503
location, revision, remember, possible_transports, pb)
3505
merger.merge_type = merge_type
3506
merger.reprocess = reprocess
3507
merger.show_base = show_base
3508
self.sanity_check_merger(merger)
3509
if (merger.base_rev_id == merger.other_rev_id and
3510
merger.other_rev_id is not None):
3511
note('Nothing to do.')
3514
if merger.interesting_files is not None:
3515
raise errors.BzrCommandError('Cannot pull individual files')
3516
if (merger.base_rev_id == tree.last_revision()):
3517
result = tree.pull(merger.other_branch, False,
3518
merger.other_rev_id)
3519
result.report(self.outf)
3521
merger.check_basis(False)
3523
return self._do_preview(merger)
3525
return self._do_merge(merger, change_reporter, allow_pending,
3528
for cleanup in reversed(cleanups):
3531
def _do_preview(self, merger):
3532
from bzrlib.diff import show_diff_trees
3533
tree_merger = merger.make_merger()
3534
tt = tree_merger.make_preview_transform()
3536
result_tree = tt.get_preview_tree()
3537
show_diff_trees(merger.this_tree, result_tree, self.outf,
3538
old_label='', new_label='')
3542
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3543
merger.change_reporter = change_reporter
3544
conflict_count = merger.do_merge()
3546
merger.set_pending()
3547
if verified == 'failed':
3548
warning('Preview patch does not match changes')
3549
if conflict_count != 0:
3554
def sanity_check_merger(self, merger):
3555
if (merger.show_base and
3556
not merger.merge_type is _mod_merge.Merge3Merger):
3557
raise errors.BzrCommandError("Show-base is not supported for this"
3558
" merge type. %s" % merger.merge_type)
3559
if merger.reprocess is None:
3560
if merger.show_base:
3561
merger.reprocess = False
3563
# Use reprocess if the merger supports it
3564
merger.reprocess = merger.merge_type.supports_reprocess
3565
if merger.reprocess and not merger.merge_type.supports_reprocess:
3566
raise errors.BzrCommandError("Conflict reduction is not supported"
3567
" for merge type %s." %
3569
if merger.reprocess and merger.show_base:
3570
raise errors.BzrCommandError("Cannot do conflict reduction and"
3573
def _get_merger_from_branch(self, tree, location, revision, remember,
3574
possible_transports, pb):
3575
"""Produce a merger from a location, assuming it refers to a branch."""
3576
from bzrlib.tag import _merge_tags_if_possible
3577
# find the branch locations
3578
other_loc, user_location = self._select_branch_location(tree, location,
3580
if revision is not None and len(revision) == 2:
3581
base_loc, _unused = self._select_branch_location(tree,
3582
location, revision, 0)
3584
base_loc = other_loc
3586
other_branch, other_path = Branch.open_containing(other_loc,
3587
possible_transports)
3588
if base_loc == other_loc:
3589
base_branch = other_branch
3591
base_branch, base_path = Branch.open_containing(base_loc,
3592
possible_transports)
3593
# Find the revision ids
3594
if revision is None or len(revision) < 1 or revision[-1] is None:
3595
other_revision_id = _mod_revision.ensure_null(
3596
other_branch.last_revision())
3598
other_revision_id = revision[-1].as_revision_id(other_branch)
3599
if (revision is not None and len(revision) == 2
3600
and revision[0] is not None):
3601
base_revision_id = revision[0].as_revision_id(base_branch)
3603
base_revision_id = None
3604
# Remember where we merge from
3605
if ((remember or tree.branch.get_submit_branch() is None) and
3606
user_location is not None):
3607
tree.branch.set_submit_branch(other_branch.base)
3608
_merge_tags_if_possible(other_branch, tree.branch)
3609
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3610
other_revision_id, base_revision_id, other_branch, base_branch)
3611
if other_path != '':
3612
allow_pending = False
3613
merger.interesting_files = [other_path]
3615
allow_pending = True
3616
return merger, allow_pending
3618
def _select_branch_location(self, tree, user_location, revision=None,
3620
"""Select a branch location, according to possible inputs.
3622
If provided, branches from ``revision`` are preferred. (Both
3623
``revision`` and ``index`` must be supplied.)
3625
Otherwise, the ``location`` parameter is used. If it is None, then the
3626
``submit`` or ``parent`` location is used, and a note is printed.
3628
:param tree: The working tree to select a branch for merging into
3629
:param location: The location entered by the user
3630
:param revision: The revision parameter to the command
3631
:param index: The index to use for the revision parameter. Negative
3632
indices are permitted.
3633
:return: (selected_location, user_location). The default location
3634
will be the user-entered location.
3636
if (revision is not None and index is not None
3637
and revision[index] is not None):
3638
branch = revision[index].get_branch()
3639
if branch is not None:
3640
return branch, branch
3641
if user_location is None:
3642
location = self._get_remembered(tree, 'Merging from')
3644
location = user_location
3645
return location, user_location
3647
def _get_remembered(self, tree, verb_string):
3648
"""Use tree.branch's parent if none was supplied.
3650
Report if the remembered location was used.
3652
stored_location = tree.branch.get_submit_branch()
3653
stored_location_type = "submit"
3654
if stored_location is None:
3655
stored_location = tree.branch.get_parent()
3656
stored_location_type = "parent"
3657
mutter("%s", stored_location)
3658
if stored_location is None:
3659
raise errors.BzrCommandError("No location specified or remembered")
3660
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3661
note(u"%s remembered %s location %s", verb_string,
3662
stored_location_type, display_url)
3663
return stored_location
3666
class cmd_remerge(Command):
3669
Use this if you want to try a different merge technique while resolving
3670
conflicts. Some merge techniques are better than others, and remerge
3671
lets you try different ones on different files.
3673
The options for remerge have the same meaning and defaults as the ones for
3674
merge. The difference is that remerge can (only) be run when there is a
3675
pending merge, and it lets you specify particular files.
3678
Re-do the merge of all conflicted files, and show the base text in
3679
conflict regions, in addition to the usual THIS and OTHER texts::
3681
bzr remerge --show-base
3683
Re-do the merge of "foobar", using the weave merge algorithm, with
3684
additional processing to reduce the size of conflict regions::
3686
bzr remerge --merge-type weave --reprocess foobar
3688
takes_args = ['file*']
3693
help="Show base revision text in conflicts."),
3696
def run(self, file_list=None, merge_type=None, show_base=False,
3698
if merge_type is None:
3699
merge_type = _mod_merge.Merge3Merger
3700
tree, file_list = tree_files(file_list)
3703
parents = tree.get_parent_ids()
3704
if len(parents) != 2:
3705
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3706
" merges. Not cherrypicking or"
3708
repository = tree.branch.repository
3709
interesting_ids = None
3711
conflicts = tree.conflicts()
3712
if file_list is not None:
3713
interesting_ids = set()
3714
for filename in file_list:
3715
file_id = tree.path2id(filename)
3717
raise errors.NotVersionedError(filename)
3718
interesting_ids.add(file_id)
3719
if tree.kind(file_id) != "directory":
3722
for name, ie in tree.inventory.iter_entries(file_id):
3723
interesting_ids.add(ie.file_id)
3724
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3726
# Remerge only supports resolving contents conflicts
3727
allowed_conflicts = ('text conflict', 'contents conflict')
3728
restore_files = [c.path for c in conflicts
3729
if c.typestring in allowed_conflicts]
3730
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3731
tree.set_conflicts(ConflictList(new_conflicts))
3732
if file_list is not None:
3733
restore_files = file_list
3734
for filename in restore_files:
3736
restore(tree.abspath(filename))
3737
except errors.NotConflicted:
3739
# Disable pending merges, because the file texts we are remerging
3740
# have not had those merges performed. If we use the wrong parents
3741
# list, we imply that the working tree text has seen and rejected
3742
# all the changes from the other tree, when in fact those changes
3743
# have not yet been seen.
3744
pb = ui.ui_factory.nested_progress_bar()
3745
tree.set_parent_ids(parents[:1])
3747
merger = _mod_merge.Merger.from_revision_ids(pb,
3749
merger.interesting_ids = interesting_ids
3750
merger.merge_type = merge_type
3751
merger.show_base = show_base
3752
merger.reprocess = reprocess
3753
conflicts = merger.do_merge()
3755
tree.set_parent_ids(parents)
3765
class cmd_revert(Command):
3766
"""Revert files to a previous revision.
3768
Giving a list of files will revert only those files. Otherwise, all files
3769
will be reverted. If the revision is not specified with '--revision', the
3770
last committed revision is used.
3772
To remove only some changes, without reverting to a prior version, use
3773
merge instead. For example, "merge . --revision -2..-3" will remove the
3774
changes introduced by -2, without affecting the changes introduced by -1.
3775
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3777
By default, any files that have been manually changed will be backed up
3778
first. (Files changed only by merge are not backed up.) Backup files have
3779
'.~#~' appended to their name, where # is a number.
3781
When you provide files, you can use their current pathname or the pathname
3782
from the target revision. So you can use revert to "undelete" a file by
3783
name. If you name a directory, all the contents of that directory will be
3786
Any files that have been newly added since that revision will be deleted,
3787
with a backup kept if appropriate. Directories containing unknown files
3788
will not be deleted.
3790
The working tree contains a list of pending merged revisions, which will
3791
be included as parents in the next commit. Normally, revert clears that
3792
list as well as reverting the files. If any files are specified, revert
3793
leaves the pending merge list alone and reverts only the files. Use "bzr
3794
revert ." in the tree root to revert all files but keep the merge record,
3795
and "bzr revert --forget-merges" to clear the pending merge list without
3796
reverting any files.
3799
_see_also = ['cat', 'export']
3802
Option('no-backup', "Do not save backups of reverted files."),
3803
Option('forget-merges',
3804
'Remove pending merge marker, without changing any files.'),
3806
takes_args = ['file*']
3808
def run(self, revision=None, no_backup=False, file_list=None,
3809
forget_merges=None):
3810
tree, file_list = tree_files(file_list)
3814
tree.set_parent_ids(tree.get_parent_ids()[:1])
3816
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3821
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3822
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3823
pb = ui.ui_factory.nested_progress_bar()
3825
tree.revert(file_list, rev_tree, not no_backup, pb,
3826
report_changes=True)
3831
class cmd_assert_fail(Command):
3832
"""Test reporting of assertion failures"""
3833
# intended just for use in testing
3838
raise AssertionError("always fails")
3841
class cmd_help(Command):
3842
"""Show help on a command or other topic.
3845
_see_also = ['topics']
3847
Option('long', 'Show help on all commands.'),
3849
takes_args = ['topic?']
3850
aliases = ['?', '--help', '-?', '-h']
3853
def run(self, topic=None, long=False):
3855
if topic is None and long:
3857
bzrlib.help.help(topic)
3860
class cmd_shell_complete(Command):
3861
"""Show appropriate completions for context.
3863
For a list of all available commands, say 'bzr shell-complete'.
3865
takes_args = ['context?']
3870
def run(self, context=None):
3871
import shellcomplete
3872
shellcomplete.shellcomplete(context)
3875
class cmd_missing(Command):
3876
"""Show unmerged/unpulled revisions between two branches.
3878
OTHER_BRANCH may be local or remote.
3880
To filter on a range of revisions, you can use the command -r begin..end
3881
-r revision requests a specific revision, -r ..end or -r begin.. are
3886
Determine the missing revisions between this and the branch at the
3887
remembered pull location::
3891
Determine the missing revisions between this and another branch::
3893
bzr missing http://server/branch
3895
Determine the missing revisions up to a specific revision on the other
3898
bzr missing -r ..-10
3900
Determine the missing revisions up to a specific revision on this
3903
bzr missing --my-revision ..-10
3906
_see_also = ['merge', 'pull']
3907
takes_args = ['other_branch?']
3909
Option('reverse', 'Reverse the order of revisions.'),
3911
'Display changes in the local branch only.'),
3912
Option('this' , 'Same as --mine-only.'),
3913
Option('theirs-only',
3914
'Display changes in the remote branch only.'),
3915
Option('other', 'Same as --theirs-only.'),
3919
custom_help('revision',
3920
help='Filter on other branch revisions (inclusive). '
3921
'See "help revisionspec" for details.'),
3922
Option('my-revision',
3923
type=_parse_revision_str,
3924
help='Filter on local branch revisions (inclusive). '
3925
'See "help revisionspec" for details.'),
3926
Option('include-merges',
3927
'Show all revisions in addition to the mainline ones.'),
3929
encoding_type = 'replace'
3932
def run(self, other_branch=None, reverse=False, mine_only=False,
3934
log_format=None, long=False, short=False, line=False,
3935
show_ids=False, verbose=False, this=False, other=False,
3936
include_merges=False, revision=None, my_revision=None):
3937
from bzrlib.missing import find_unmerged, iter_log_revisions
3946
# TODO: We should probably check that we don't have mine-only and
3947
# theirs-only set, but it gets complicated because we also have
3948
# this and other which could be used.
3955
local_branch = Branch.open_containing(u".")[0]
3956
parent = local_branch.get_parent()
3957
if other_branch is None:
3958
other_branch = parent
3959
if other_branch is None:
3960
raise errors.BzrCommandError("No peer location known"
3962
display_url = urlutils.unescape_for_display(parent,
3964
message("Using saved parent location: "
3965
+ display_url + "\n")
3967
remote_branch = Branch.open(other_branch)
3968
if remote_branch.base == local_branch.base:
3969
remote_branch = local_branch
3971
local_revid_range = _revision_range_to_revid_range(
3972
_get_revision_range(my_revision, local_branch,
3975
remote_revid_range = _revision_range_to_revid_range(
3976
_get_revision_range(revision,
3977
remote_branch, self.name()))
3979
local_branch.lock_read()
3981
remote_branch.lock_read()
3983
local_extra, remote_extra = find_unmerged(
3984
local_branch, remote_branch, restrict,
3985
backward=not reverse,
3986
include_merges=include_merges,
3987
local_revid_range=local_revid_range,
3988
remote_revid_range=remote_revid_range)
3990
if log_format is None:
3991
registry = log.log_formatter_registry
3992
log_format = registry.get_default(local_branch)
3993
lf = log_format(to_file=self.outf,
3995
show_timezone='original')
3998
if local_extra and not theirs_only:
3999
message("You have %d extra revision(s):\n" %
4001
for revision in iter_log_revisions(local_extra,
4002
local_branch.repository,
4004
lf.log_revision(revision)
4005
printed_local = True
4008
printed_local = False
4010
if remote_extra and not mine_only:
4011
if printed_local is True:
4013
message("You are missing %d revision(s):\n" %
4015
for revision in iter_log_revisions(remote_extra,
4016
remote_branch.repository,
4018
lf.log_revision(revision)
4021
if mine_only and not local_extra:
4022
# We checked local, and found nothing extra
4023
message('This branch is up to date.\n')
4024
elif theirs_only and not remote_extra:
4025
# We checked remote, and found nothing extra
4026
message('Other branch is up to date.\n')
4027
elif not (mine_only or theirs_only or local_extra or
4029
# We checked both branches, and neither one had extra
4031
message("Branches are up to date.\n")
4033
remote_branch.unlock()
4035
local_branch.unlock()
4036
if not status_code and parent is None and other_branch is not None:
4037
local_branch.lock_write()
4039
# handle race conditions - a parent might be set while we run.
4040
if local_branch.get_parent() is None:
4041
local_branch.set_parent(remote_branch.base)
4043
local_branch.unlock()
4047
class cmd_pack(Command):
4048
"""Compress the data within a repository."""
4050
_see_also = ['repositories']
4051
takes_args = ['branch_or_repo?']
4053
def run(self, branch_or_repo='.'):
4054
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4056
branch = dir.open_branch()
4057
repository = branch.repository
4058
except errors.NotBranchError:
4059
repository = dir.open_repository()
4063
class cmd_plugins(Command):
4064
"""List the installed plugins.
4066
This command displays the list of installed plugins including
4067
version of plugin and a short description of each.
4069
--verbose shows the path where each plugin is located.
4071
A plugin is an external component for Bazaar that extends the
4072
revision control system, by adding or replacing code in Bazaar.
4073
Plugins can do a variety of things, including overriding commands,
4074
adding new commands, providing additional network transports and
4075
customizing log output.
4077
See the Bazaar web site, http://bazaar-vcs.org, for further
4078
information on plugins including where to find them and how to
4079
install them. Instructions are also provided there on how to
4080
write new plugins using the Python programming language.
4082
takes_options = ['verbose']
4085
def run(self, verbose=False):
4086
import bzrlib.plugin
4087
from inspect import getdoc
4089
for name, plugin in bzrlib.plugin.plugins().items():
4090
version = plugin.__version__
4091
if version == 'unknown':
4093
name_ver = '%s %s' % (name, version)
4094
d = getdoc(plugin.module)
4096
doc = d.split('\n')[0]
4098
doc = '(no description)'
4099
result.append((name_ver, doc, plugin.path()))
4100
for name_ver, doc, path in sorted(result):
4108
class cmd_testament(Command):
4109
"""Show testament (signing-form) of a revision."""
4112
Option('long', help='Produce long-format testament.'),
4114
help='Produce a strict-format testament.')]
4115
takes_args = ['branch?']
4117
def run(self, branch=u'.', revision=None, long=False, strict=False):
4118
from bzrlib.testament import Testament, StrictTestament
4120
testament_class = StrictTestament
4122
testament_class = Testament
4124
b = Branch.open_containing(branch)[0]
4126
b = Branch.open(branch)
4129
if revision is None:
4130
rev_id = b.last_revision()
4132
rev_id = revision[0].as_revision_id(b)
4133
t = testament_class.from_revision(b.repository, rev_id)
4135
sys.stdout.writelines(t.as_text_lines())
4137
sys.stdout.write(t.as_short_text())
4142
class cmd_annotate(Command):
4143
"""Show the origin of each line in a file.
4145
This prints out the given file with an annotation on the left side
4146
indicating which revision, author and date introduced the change.
4148
If the origin is the same for a run of consecutive lines, it is
4149
shown only at the top, unless the --all option is given.
4151
# TODO: annotate directories; showing when each file was last changed
4152
# TODO: if the working copy is modified, show annotations on that
4153
# with new uncommitted lines marked
4154
aliases = ['ann', 'blame', 'praise']
4155
takes_args = ['filename']
4156
takes_options = [Option('all', help='Show annotations on all lines.'),
4157
Option('long', help='Show commit date in annotations.'),
4161
encoding_type = 'exact'
4164
def run(self, filename, all=False, long=False, revision=None,
4166
from bzrlib.annotate import annotate_file, annotate_file_tree
4167
wt, branch, relpath = \
4168
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4174
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4176
file_id = wt.path2id(relpath)
4178
file_id = tree.path2id(relpath)
4180
raise errors.NotVersionedError(filename)
4181
file_version = tree.inventory[file_id].revision
4182
if wt is not None and revision is None:
4183
# If there is a tree and we're not annotating historical
4184
# versions, annotate the working tree's content.
4185
annotate_file_tree(wt, file_id, self.outf, long, all,
4188
annotate_file(branch, file_version, file_id, long, all, self.outf,
4197
class cmd_re_sign(Command):
4198
"""Create a digital signature for an existing revision."""
4199
# TODO be able to replace existing ones.
4201
hidden = True # is this right ?
4202
takes_args = ['revision_id*']
4203
takes_options = ['revision']
4205
def run(self, revision_id_list=None, revision=None):
4206
if revision_id_list is not None and revision is not None:
4207
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4208
if revision_id_list is None and revision is None:
4209
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4210
b = WorkingTree.open_containing(u'.')[0].branch
4213
return self._run(b, revision_id_list, revision)
4217
def _run(self, b, revision_id_list, revision):
4218
import bzrlib.gpg as gpg
4219
gpg_strategy = gpg.GPGStrategy(b.get_config())
4220
if revision_id_list is not None:
4221
b.repository.start_write_group()
4223
for revision_id in revision_id_list:
4224
b.repository.sign_revision(revision_id, gpg_strategy)
4226
b.repository.abort_write_group()
4229
b.repository.commit_write_group()
4230
elif revision is not None:
4231
if len(revision) == 1:
4232
revno, rev_id = revision[0].in_history(b)
4233
b.repository.start_write_group()
4235
b.repository.sign_revision(rev_id, gpg_strategy)
4237
b.repository.abort_write_group()
4240
b.repository.commit_write_group()
4241
elif len(revision) == 2:
4242
# are they both on rh- if so we can walk between them
4243
# might be nice to have a range helper for arbitrary
4244
# revision paths. hmm.
4245
from_revno, from_revid = revision[0].in_history(b)
4246
to_revno, to_revid = revision[1].in_history(b)
4247
if to_revid is None:
4248
to_revno = b.revno()
4249
if from_revno is None or to_revno is None:
4250
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4251
b.repository.start_write_group()
4253
for revno in range(from_revno, to_revno + 1):
4254
b.repository.sign_revision(b.get_rev_id(revno),
4257
b.repository.abort_write_group()
4260
b.repository.commit_write_group()
4262
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4265
class cmd_bind(Command):
4266
"""Convert the current branch into a checkout of the supplied branch.
4268
Once converted into a checkout, commits must succeed on the master branch
4269
before they will be applied to the local branch.
4271
Bound branches use the nickname of its master branch unless it is set
4272
locally, in which case binding will update the the local nickname to be
4276
_see_also = ['checkouts', 'unbind']
4277
takes_args = ['location?']
4280
def run(self, location=None):
4281
b, relpath = Branch.open_containing(u'.')
4282
if location is None:
4284
location = b.get_old_bound_location()
4285
except errors.UpgradeRequired:
4286
raise errors.BzrCommandError('No location supplied. '
4287
'This format does not remember old locations.')
4289
if location is None:
4290
raise errors.BzrCommandError('No location supplied and no '
4291
'previous location known')
4292
b_other = Branch.open(location)
4295
except errors.DivergedBranches:
4296
raise errors.BzrCommandError('These branches have diverged.'
4297
' Try merging, and then bind again.')
4298
if b.get_config().has_explicit_nickname():
4299
b.nick = b_other.nick
4302
class cmd_unbind(Command):
4303
"""Convert the current checkout into a regular branch.
4305
After unbinding, the local branch is considered independent and subsequent
4306
commits will be local only.
4309
_see_also = ['checkouts', 'bind']
4314
b, relpath = Branch.open_containing(u'.')
4316
raise errors.BzrCommandError('Local branch is not bound')
4319
class cmd_uncommit(Command):
4320
"""Remove the last committed revision.
4322
--verbose will print out what is being removed.
4323
--dry-run will go through all the motions, but not actually
4326
If --revision is specified, uncommit revisions to leave the branch at the
4327
specified revision. For example, "bzr uncommit -r 15" will leave the
4328
branch at revision 15.
4330
Uncommit leaves the working tree ready for a new commit. The only change
4331
it may make is to restore any pending merges that were present before
4335
# TODO: jam 20060108 Add an option to allow uncommit to remove
4336
# unreferenced information in 'branch-as-repository' branches.
4337
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4338
# information in shared branches as well.
4339
_see_also = ['commit']
4340
takes_options = ['verbose', 'revision',
4341
Option('dry-run', help='Don\'t actually make changes.'),
4342
Option('force', help='Say yes to all questions.'),
4344
help="Only remove the commits from the local branch"
4345
" when in a checkout."
4348
takes_args = ['location?']
4350
encoding_type = 'replace'
4352
def run(self, location=None,
4353
dry_run=False, verbose=False,
4354
revision=None, force=False, local=False):
4355
if location is None:
4357
control, relpath = bzrdir.BzrDir.open_containing(location)
4359
tree = control.open_workingtree()
4361
except (errors.NoWorkingTree, errors.NotLocalUrl):
4363
b = control.open_branch()
4365
if tree is not None:
4370
return self._run(b, tree, dry_run, verbose, revision, force,
4373
if tree is not None:
4378
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4379
from bzrlib.log import log_formatter, show_log
4380
from bzrlib.uncommit import uncommit
4382
last_revno, last_rev_id = b.last_revision_info()
4385
if revision is None:
4387
rev_id = last_rev_id
4389
# 'bzr uncommit -r 10' actually means uncommit
4390
# so that the final tree is at revno 10.
4391
# but bzrlib.uncommit.uncommit() actually uncommits
4392
# the revisions that are supplied.
4393
# So we need to offset it by one
4394
revno = revision[0].in_history(b).revno + 1
4395
if revno <= last_revno:
4396
rev_id = b.get_rev_id(revno)
4398
if rev_id is None or _mod_revision.is_null(rev_id):
4399
self.outf.write('No revisions to uncommit.\n')
4402
lf = log_formatter('short',
4404
show_timezone='original')
4409
direction='forward',
4410
start_revision=revno,
4411
end_revision=last_revno)
4414
print 'Dry-run, pretending to remove the above revisions.'
4416
val = raw_input('Press <enter> to continue')
4418
print 'The above revision(s) will be removed.'
4420
val = raw_input('Are you sure [y/N]? ')
4421
if val.lower() not in ('y', 'yes'):
4425
mutter('Uncommitting from {%s} to {%s}',
4426
last_rev_id, rev_id)
4427
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4428
revno=revno, local=local)
4429
note('You can restore the old tip by running:\n'
4430
' bzr pull . -r revid:%s', last_rev_id)
4433
class cmd_break_lock(Command):
4434
"""Break a dead lock on a repository, branch or working directory.
4436
CAUTION: Locks should only be broken when you are sure that the process
4437
holding the lock has been stopped.
4439
You can get information on what locks are open via the 'bzr info' command.
4444
takes_args = ['location?']
4446
def run(self, location=None, show=False):
4447
if location is None:
4449
control, relpath = bzrdir.BzrDir.open_containing(location)
4451
control.break_lock()
4452
except NotImplementedError:
4456
class cmd_wait_until_signalled(Command):
4457
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4459
This just prints a line to signal when it is ready, then blocks on stdin.
4465
sys.stdout.write("running\n")
4467
sys.stdin.readline()
4470
class cmd_serve(Command):
4471
"""Run the bzr server."""
4473
aliases = ['server']
4477
help='Serve on stdin/out for use from inetd or sshd.'),
4479
help='Listen for connections on nominated port of the form '
4480
'[hostname:]portnumber. Passing 0 as the port number will '
4481
'result in a dynamically allocated port. The default port is '
4485
help='Serve contents of this directory.',
4487
Option('allow-writes',
4488
help='By default the server is a readonly server. Supplying '
4489
'--allow-writes enables write access to the contents of '
4490
'the served directory and below.'
4494
def run_smart_server(self, smart_server):
4495
"""Run 'smart_server' forever, with no UI output at all."""
4496
# For the duration of this server, no UI output is permitted. note
4497
# that this may cause problems with blackbox tests. This should be
4498
# changed with care though, as we dont want to use bandwidth sending
4499
# progress over stderr to smart server clients!
4500
from bzrlib import lockdir
4501
old_factory = ui.ui_factory
4502
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4504
ui.ui_factory = ui.SilentUIFactory()
4505
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4506
smart_server.serve()
4508
ui.ui_factory = old_factory
4509
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4511
def get_host_and_port(self, port):
4512
"""Return the host and port to run the smart server on.
4514
If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4515
and port (`medium.BZR_DEFAULT_PORT`) will be used.
4517
If 'port' has a colon in it, the string before the colon will be
4518
interpreted as the host.
4520
:param port: A string of the port to run the server on.
4521
:return: A tuple of (host, port), where 'host' is a host name or IP,
4522
and port is an integer TCP/IP port.
4524
from bzrlib.smart import medium
4525
host = medium.BZR_DEFAULT_INTERFACE
4527
port = medium.BZR_DEFAULT_PORT
4530
host, port = port.split(':')
4534
def get_smart_server(self, transport, inet, port):
4535
"""Construct a smart server.
4537
:param transport: The base transport from which branches will be
4539
:param inet: If True, serve over stdin and stdout. Used for running
4541
:param port: The port to listen on. By default, it's `
4542
medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4544
:return: A smart server.
4546
from bzrlib.smart import medium, server
4548
smart_server = medium.SmartServerPipeStreamMedium(
4549
sys.stdin, sys.stdout, transport)
4551
host, port = self.get_host_and_port(port)
4552
smart_server = server.SmartTCPServer(
4553
transport, host=host, port=port)
4554
note('listening on port: %s' % smart_server.port)
4557
def run(self, port=None, inet=False, directory=None, allow_writes=False):
4558
from bzrlib.transport import get_transport
4559
from bzrlib.transport.chroot import ChrootServer
4560
if directory is None:
4561
directory = os.getcwd()
4562
url = urlutils.local_path_to_url(directory)
4563
if not allow_writes:
4564
url = 'readonly+' + url
4565
chroot_server = ChrootServer(get_transport(url))
4566
chroot_server.setUp()
4567
t = get_transport(chroot_server.get_url())
4568
smart_server = self.get_smart_server(t, inet, port)
4569
self.run_smart_server(smart_server)
4572
class cmd_join(Command):
4573
"""Combine a tree into its containing tree.
4575
This command requires the target tree to be in a rich-root format.
4577
The TREE argument should be an independent tree, inside another tree, but
4578
not part of it. (Such trees can be produced by "bzr split", but also by
4579
running "bzr branch" with the target inside a tree.)
4581
The result is a combined tree, with the subtree no longer an independant
4582
part. This is marked as a merge of the subtree into the containing tree,
4583
and all history is preserved.
4586
_see_also = ['split']
4587
takes_args = ['tree']
4589
Option('reference', help='Join by reference.', hidden=True),
4592
def run(self, tree, reference=False):
4593
sub_tree = WorkingTree.open(tree)
4594
parent_dir = osutils.dirname(sub_tree.basedir)
4595
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4596
repo = containing_tree.branch.repository
4597
if not repo.supports_rich_root():
4598
raise errors.BzrCommandError(
4599
"Can't join trees because %s doesn't support rich root data.\n"
4600
"You can use bzr upgrade on the repository."
4604
containing_tree.add_reference(sub_tree)
4605
except errors.BadReferenceTarget, e:
4606
# XXX: Would be better to just raise a nicely printable
4607
# exception from the real origin. Also below. mbp 20070306
4608
raise errors.BzrCommandError("Cannot join %s. %s" %
4612
containing_tree.subsume(sub_tree)
4613
except errors.BadSubsumeSource, e:
4614
raise errors.BzrCommandError("Cannot join %s. %s" %
4618
class cmd_split(Command):
4619
"""Split a subdirectory of a tree into a separate tree.
4621
This command will produce a target tree in a format that supports
4622
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4623
converted into earlier formats like 'dirstate-tags'.
4625
The TREE argument should be a subdirectory of a working tree. That
4626
subdirectory will be converted into an independent tree, with its own
4627
branch. Commits in the top-level tree will not apply to the new subtree.
4630
_see_also = ['join']
4631
takes_args = ['tree']
4633
def run(self, tree):
4634
containing_tree, subdir = WorkingTree.open_containing(tree)
4635
sub_id = containing_tree.path2id(subdir)
4637
raise errors.NotVersionedError(subdir)
4639
containing_tree.extract(sub_id)
4640
except errors.RootNotRich:
4641
raise errors.UpgradeRequired(containing_tree.branch.base)
4644
class cmd_merge_directive(Command):
4645
"""Generate a merge directive for auto-merge tools.
4647
A directive requests a merge to be performed, and also provides all the
4648
information necessary to do so. This means it must either include a
4649
revision bundle, or the location of a branch containing the desired
4652
A submit branch (the location to merge into) must be supplied the first
4653
time the command is issued. After it has been supplied once, it will
4654
be remembered as the default.
4656
A public branch is optional if a revision bundle is supplied, but required
4657
if --diff or --plain is specified. It will be remembered as the default
4658
after the first use.
4661
takes_args = ['submit_branch?', 'public_branch?']
4665
_see_also = ['send']
4668
RegistryOption.from_kwargs('patch-type',
4669
'The type of patch to include in the directive.',
4671
value_switches=True,
4673
bundle='Bazaar revision bundle (default).',
4674
diff='Normal unified diff.',
4675
plain='No patch, just directive.'),
4676
Option('sign', help='GPG-sign the directive.'), 'revision',
4677
Option('mail-to', type=str,
4678
help='Instead of printing the directive, email to this address.'),
4679
Option('message', type=str, short_name='m',
4680
help='Message to use when committing this merge.')
4683
encoding_type = 'exact'
4685
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4686
sign=False, revision=None, mail_to=None, message=None):
4687
from bzrlib.revision import ensure_null, NULL_REVISION
4688
include_patch, include_bundle = {
4689
'plain': (False, False),
4690
'diff': (True, False),
4691
'bundle': (True, True),
4693
branch = Branch.open('.')
4694
stored_submit_branch = branch.get_submit_branch()
4695
if submit_branch is None:
4696
submit_branch = stored_submit_branch
4698
if stored_submit_branch is None:
4699
branch.set_submit_branch(submit_branch)
4700
if submit_branch is None:
4701
submit_branch = branch.get_parent()
4702
if submit_branch is None:
4703
raise errors.BzrCommandError('No submit branch specified or known')
4705
stored_public_branch = branch.get_public_branch()
4706
if public_branch is None:
4707
public_branch = stored_public_branch
4708
elif stored_public_branch is None:
4709
branch.set_public_branch(public_branch)
4710
if not include_bundle and public_branch is None:
4711
raise errors.BzrCommandError('No public branch specified or'
4713
base_revision_id = None
4714
if revision is not None:
4715
if len(revision) > 2:
4716
raise errors.BzrCommandError('bzr merge-directive takes '
4717
'at most two one revision identifiers')
4718
revision_id = revision[-1].as_revision_id(branch)
4719
if len(revision) == 2:
4720
base_revision_id = revision[0].as_revision_id(branch)
4722
revision_id = branch.last_revision()
4723
revision_id = ensure_null(revision_id)
4724
if revision_id == NULL_REVISION:
4725
raise errors.BzrCommandError('No revisions to bundle.')
4726
directive = merge_directive.MergeDirective2.from_objects(
4727
branch.repository, revision_id, time.time(),
4728
osutils.local_time_offset(), submit_branch,
4729
public_branch=public_branch, include_patch=include_patch,
4730
include_bundle=include_bundle, message=message,
4731
base_revision_id=base_revision_id)
4734
self.outf.write(directive.to_signed(branch))
4736
self.outf.writelines(directive.to_lines())
4738
message = directive.to_email(mail_to, branch, sign)
4739
s = SMTPConnection(branch.get_config())
4740
s.send_email(message)
4743
class cmd_send(Command):
4744
"""Mail or create a merge-directive for submitting changes.
4746
A merge directive provides many things needed for requesting merges:
4748
* A machine-readable description of the merge to perform
4750
* An optional patch that is a preview of the changes requested
4752
* An optional bundle of revision data, so that the changes can be applied
4753
directly from the merge directive, without retrieving data from a
4756
If --no-bundle is specified, then public_branch is needed (and must be
4757
up-to-date), so that the receiver can perform the merge using the
4758
public_branch. The public_branch is always included if known, so that
4759
people can check it later.
4761
The submit branch defaults to the parent, but can be overridden. Both
4762
submit branch and public branch will be remembered if supplied.
4764
If a public_branch is known for the submit_branch, that public submit
4765
branch is used in the merge instructions. This means that a local mirror
4766
can be used as your actual submit branch, once you have set public_branch
4769
Mail is sent using your preferred mail program. This should be transparent
4770
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4771
If the preferred client can't be found (or used), your editor will be used.
4773
To use a specific mail program, set the mail_client configuration option.
4774
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4775
specific clients are "claws", "evolution", "kmail", "mutt", and
4776
"thunderbird"; generic options are "default", "editor", "emacsclient",
4777
"mapi", and "xdg-email". Plugins may also add supported clients.
4779
If mail is being sent, a to address is required. This can be supplied
4780
either on the commandline, by setting the submit_to configuration
4781
option in the branch itself or the child_submit_to configuration option
4782
in the submit branch.
4784
Two formats are currently supported: "4" uses revision bundle format 4 and
4785
merge directive format 2. It is significantly faster and smaller than
4786
older formats. It is compatible with Bazaar 0.19 and later. It is the
4787
default. "0.9" uses revision bundle format 0.9 and merge directive
4788
format 1. It is compatible with Bazaar 0.12 - 0.18.
4790
The merge directives created by bzr send may be applied using bzr merge or
4791
bzr pull by specifying a file containing a merge directive as the location.
4794
encoding_type = 'exact'
4796
_see_also = ['merge', 'pull']
4798
takes_args = ['submit_branch?', 'public_branch?']
4802
help='Do not include a bundle in the merge directive.'),
4803
Option('no-patch', help='Do not include a preview patch in the merge'
4806
help='Remember submit and public branch.'),
4808
help='Branch to generate the submission from, '
4809
'rather than the one containing the working directory.',
4812
Option('output', short_name='o',
4813
help='Write merge directive to this file; '
4814
'use - for stdout.',
4816
Option('mail-to', help='Mail the request to this address.',
4820
Option('body', help='Body for the email.', type=unicode),
4821
RegistryOption.from_kwargs('format',
4822
'Use the specified output format.',
4823
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4824
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4827
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4828
no_patch=False, revision=None, remember=False, output=None,
4829
format='4', mail_to=None, message=None, body=None, **kwargs):
4830
return self._run(submit_branch, revision, public_branch, remember,
4831
format, no_bundle, no_patch, output,
4832
kwargs.get('from', '.'), mail_to, message, body)
4834
def _run(self, submit_branch, revision, public_branch, remember, format,
4835
no_bundle, no_patch, output, from_, mail_to, message, body):
4836
from bzrlib.revision import NULL_REVISION
4837
branch = Branch.open_containing(from_)[0]
4839
outfile = cStringIO.StringIO()
4843
outfile = open(output, 'wb')
4844
# we may need to write data into branch's repository to calculate
4849
config = branch.get_config()
4851
mail_to = config.get_user_option('submit_to')
4852
mail_client = config.get_mail_client()
4853
if (not getattr(mail_client, 'supports_body', False)
4854
and body is not None):
4855
raise errors.BzrCommandError(
4856
'Mail client "%s" does not support specifying body' %
4857
mail_client.__class__.__name__)
4858
if remember and submit_branch is None:
4859
raise errors.BzrCommandError(
4860
'--remember requires a branch to be specified.')
4861
stored_submit_branch = branch.get_submit_branch()
4862
remembered_submit_branch = None
4863
if submit_branch is None:
4864
submit_branch = stored_submit_branch
4865
remembered_submit_branch = "submit"
4867
if stored_submit_branch is None or remember:
4868
branch.set_submit_branch(submit_branch)
4869
if submit_branch is None:
4870
submit_branch = branch.get_parent()
4871
remembered_submit_branch = "parent"
4872
if submit_branch is None:
4873
raise errors.BzrCommandError('No submit branch known or'
4875
if remembered_submit_branch is not None:
4876
note('Using saved %s location "%s" to determine what '
4877
'changes to submit.', remembered_submit_branch,
4881
submit_config = Branch.open(submit_branch).get_config()
4882
mail_to = submit_config.get_user_option("child_submit_to")
4884
stored_public_branch = branch.get_public_branch()
4885
if public_branch is None:
4886
public_branch = stored_public_branch
4887
elif stored_public_branch is None or remember:
4888
branch.set_public_branch(public_branch)
4889
if no_bundle and public_branch is None:
4890
raise errors.BzrCommandError('No public branch specified or'
4892
base_revision_id = None
4894
if revision is not None:
4895
if len(revision) > 2:
4896
raise errors.BzrCommandError('bzr send takes '
4897
'at most two one revision identifiers')
4898
revision_id = revision[-1].as_revision_id(branch)
4899
if len(revision) == 2:
4900
base_revision_id = revision[0].as_revision_id(branch)
4901
if revision_id is None:
4902
revision_id = branch.last_revision()
4903
if revision_id == NULL_REVISION:
4904
raise errors.BzrCommandError('No revisions to submit.')
4906
directive = merge_directive.MergeDirective2.from_objects(
4907
branch.repository, revision_id, time.time(),
4908
osutils.local_time_offset(), submit_branch,
4909
public_branch=public_branch, include_patch=not no_patch,
4910
include_bundle=not no_bundle, message=message,
4911
base_revision_id=base_revision_id)
4912
elif format == '0.9':
4915
patch_type = 'bundle'
4917
raise errors.BzrCommandError('Format 0.9 does not'
4918
' permit bundle with no patch')
4924
directive = merge_directive.MergeDirective.from_objects(
4925
branch.repository, revision_id, time.time(),
4926
osutils.local_time_offset(), submit_branch,
4927
public_branch=public_branch, patch_type=patch_type,
4930
outfile.writelines(directive.to_lines())
4932
subject = '[MERGE] '
4933
if message is not None:
4936
revision = branch.repository.get_revision(revision_id)
4937
subject += revision.get_summary()
4938
basename = directive.get_disk_name(branch)
4939
mail_client.compose_merge_request(mail_to, subject,
4948
class cmd_bundle_revisions(cmd_send):
4950
"""Create a merge-directive for submitting changes.
4952
A merge directive provides many things needed for requesting merges:
4954
* A machine-readable description of the merge to perform
4956
* An optional patch that is a preview of the changes requested
4958
* An optional bundle of revision data, so that the changes can be applied
4959
directly from the merge directive, without retrieving data from a
4962
If --no-bundle is specified, then public_branch is needed (and must be
4963
up-to-date), so that the receiver can perform the merge using the
4964
public_branch. The public_branch is always included if known, so that
4965
people can check it later.
4967
The submit branch defaults to the parent, but can be overridden. Both
4968
submit branch and public branch will be remembered if supplied.
4970
If a public_branch is known for the submit_branch, that public submit
4971
branch is used in the merge instructions. This means that a local mirror
4972
can be used as your actual submit branch, once you have set public_branch
4975
Two formats are currently supported: "4" uses revision bundle format 4 and
4976
merge directive format 2. It is significantly faster and smaller than
4977
older formats. It is compatible with Bazaar 0.19 and later. It is the
4978
default. "0.9" uses revision bundle format 0.9 and merge directive
4979
format 1. It is compatible with Bazaar 0.12 - 0.18.
4984
help='Do not include a bundle in the merge directive.'),
4985
Option('no-patch', help='Do not include a preview patch in the merge'
4988
help='Remember submit and public branch.'),
4990
help='Branch to generate the submission from, '
4991
'rather than the one containing the working directory.',
4994
Option('output', short_name='o', help='Write directive to this file.',
4997
RegistryOption.from_kwargs('format',
4998
'Use the specified output format.',
4999
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
5000
'0.9': 'Bundle format 0.9, Merge Directive 1',})
5002
aliases = ['bundle']
5004
_see_also = ['send', 'merge']
5008
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5009
no_patch=False, revision=None, remember=False, output=None,
5010
format='4', **kwargs):
5013
return self._run(submit_branch, revision, public_branch, remember,
5014
format, no_bundle, no_patch, output,
5015
kwargs.get('from', '.'), None, None, None)
5018
class cmd_tag(Command):
5019
"""Create, remove or modify a tag naming a revision.
5021
Tags give human-meaningful names to revisions. Commands that take a -r
5022
(--revision) option can be given -rtag:X, where X is any previously
5025
Tags are stored in the branch. Tags are copied from one branch to another
5026
along when you branch, push, pull or merge.
5028
It is an error to give a tag name that already exists unless you pass
5029
--force, in which case the tag is moved to point to the new revision.
5031
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5032
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5035
_see_also = ['commit', 'tags']
5036
takes_args = ['tag_name']
5039
help='Delete this tag rather than placing it.',
5042
help='Branch in which to place the tag.',
5047
help='Replace existing tags.',
5052
def run(self, tag_name,
5058
branch, relpath = Branch.open_containing(directory)
5062
branch.tags.delete_tag(tag_name)
5063
self.outf.write('Deleted tag %s.\n' % tag_name)
5066
if len(revision) != 1:
5067
raise errors.BzrCommandError(
5068
"Tags can only be placed on a single revision, "
5070
revision_id = revision[0].as_revision_id(branch)
5072
revision_id = branch.last_revision()
5073
if (not force) and branch.tags.has_tag(tag_name):
5074
raise errors.TagAlreadyExists(tag_name)
5075
branch.tags.set_tag(tag_name, revision_id)
5076
self.outf.write('Created tag %s.\n' % tag_name)
5081
class cmd_tags(Command):
5084
This command shows a table of tag names and the revisions they reference.
5090
help='Branch whose tags should be displayed.',
5094
RegistryOption.from_kwargs('sort',
5095
'Sort tags by different criteria.', title='Sorting',
5096
alpha='Sort tags lexicographically (default).',
5097
time='Sort tags chronologically.',
5110
branch, relpath = Branch.open_containing(directory)
5112
tags = branch.tags.get_tag_dict().items()
5119
graph = branch.repository.get_graph()
5120
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5121
revid1, revid2 = rev1.rev_id, rev2.rev_id
5122
# only show revisions between revid1 and revid2 (inclusive)
5123
tags = [(tag, revid) for tag, revid in tags if
5124
graph.is_between(revid, revid1, revid2)]
5129
elif sort == 'time':
5131
for tag, revid in tags:
5133
revobj = branch.repository.get_revision(revid)
5134
except errors.NoSuchRevision:
5135
timestamp = sys.maxint # place them at the end
5137
timestamp = revobj.timestamp
5138
timestamps[revid] = timestamp
5139
tags.sort(key=lambda x: timestamps[x[1]])
5141
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5142
revno_map = branch.get_revision_id_to_revno_map()
5143
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
5144
for tag, revid in tags ]
5145
for tag, revspec in tags:
5146
self.outf.write('%-20s %s\n' % (tag, revspec))
5149
class cmd_reconfigure(Command):
5150
"""Reconfigure the type of a bzr directory.
5152
A target configuration must be specified.
5154
For checkouts, the bind-to location will be auto-detected if not specified.
5155
The order of preference is
5156
1. For a lightweight checkout, the current bound location.
5157
2. For branches that used to be checkouts, the previously-bound location.
5158
3. The push location.
5159
4. The parent location.
5160
If none of these is available, --bind-to must be specified.
5163
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5164
takes_args = ['location?']
5166
RegistryOption.from_kwargs(
5168
title='Target type',
5169
help='The type to reconfigure the directory to.',
5170
value_switches=True, enum_switch=False,
5171
branch='Reconfigure to be an unbound branch with no working tree.',
5172
tree='Reconfigure to be an unbound branch with a working tree.',
5173
checkout='Reconfigure to be a bound branch with a working tree.',
5174
lightweight_checkout='Reconfigure to be a lightweight'
5175
' checkout (with no local history).',
5176
standalone='Reconfigure to be a standalone branch '
5177
'(i.e. stop using shared repository).',
5178
use_shared='Reconfigure to use a shared repository.',
5179
with_trees='Reconfigure repository to create '
5180
'working trees on branches by default.',
5181
with_no_trees='Reconfigure repository to not create '
5182
'working trees on branches by default.'
5184
Option('bind-to', help='Branch to bind checkout to.', type=str),
5186
help='Perform reconfiguration even if local changes'
5190
def run(self, location=None, target_type=None, bind_to=None, force=False):
5191
directory = bzrdir.BzrDir.open(location)
5192
if target_type is None:
5193
raise errors.BzrCommandError('No target configuration specified')
5194
elif target_type == 'branch':
5195
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5196
elif target_type == 'tree':
5197
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5198
elif target_type == 'checkout':
5199
reconfiguration = reconfigure.Reconfigure.to_checkout(
5201
elif target_type == 'lightweight-checkout':
5202
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5204
elif target_type == 'use-shared':
5205
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5206
elif target_type == 'standalone':
5207
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5208
elif target_type == 'with-trees':
5209
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5211
elif target_type == 'with-no-trees':
5212
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5214
reconfiguration.apply(force)
5217
class cmd_switch(Command):
5218
"""Set the branch of a checkout and update.
5220
For lightweight checkouts, this changes the branch being referenced.
5221
For heavyweight checkouts, this checks that there are no local commits
5222
versus the current bound branch, then it makes the local branch a mirror
5223
of the new location and binds to it.
5225
In both cases, the working tree is updated and uncommitted changes
5226
are merged. The user can commit or revert these as they desire.
5228
Pending merges need to be committed or reverted before using switch.
5230
The path to the branch to switch to can be specified relative to the parent
5231
directory of the current branch. For example, if you are currently in a
5232
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5235
Bound branches use the nickname of its master branch unless it is set
5236
locally, in which case switching will update the the local nickname to be
5240
takes_args = ['to_location']
5241
takes_options = [Option('force',
5242
help='Switch even if local commits will be lost.')
5245
def run(self, to_location, force=False):
5246
from bzrlib import switch
5248
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5249
branch = control_dir.open_branch()
5251
to_branch = Branch.open(to_location)
5252
except errors.NotBranchError:
5253
this_branch = control_dir.open_branch()
5254
# This may be a heavy checkout, where we want the master branch
5255
this_url = this_branch.get_bound_location()
5256
# If not, use a local sibling
5257
if this_url is None:
5258
this_url = this_branch.base
5259
to_branch = Branch.open(
5260
urlutils.join(this_url, '..', to_location))
5261
switch.switch(control_dir, to_branch, force)
5262
if branch.get_config().has_explicit_nickname():
5263
branch = control_dir.open_branch() #get the new branch!
5264
branch.nick = to_branch.nick
5265
note('Switched to branch: %s',
5266
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5269
class cmd_view(Command):
5270
"""Manage filtered views.
5272
Views provide a mask over the tree so that users can focus on
5273
a subset of a tree when doing their work. After creating a view,
5274
commands that support a list of files - status, diff, commit, etc -
5275
effectively have that list of files implicitly given each time.
5276
An explicit list of files can still be given but those files
5277
must be within the current view.
5279
In most cases, a view has a short life-span: it is created to make
5280
a selected change and is deleted once that change is committed.
5281
At other times, you may wish to create one or more named views
5282
and switch between them.
5284
To disable the current view without deleting it, you can switch to
5285
the pseudo view called ``off``. This can be useful when you need
5286
to see the whole tree for an operation or two (e.g. merge) but
5287
want to switch back to your view after that.
5290
To define the current view::
5292
bzr view file1 dir1 ...
5294
To list the current view::
5298
To delete the current view::
5302
To disable the current view without deleting it::
5304
bzr view --switch off
5306
To define a named view and switch to it::
5308
bzr view --name view-name file1 dir1 ...
5310
To list a named view::
5312
bzr view --name view-name
5314
To delete a named view::
5316
bzr view --name view-name --delete
5318
To switch to a named view::
5320
bzr view --switch view-name
5322
To list all views defined::
5326
To delete all views::
5328
bzr view --delete --all
5332
takes_args = ['file*']
5335
help='Apply list or delete action to all views.',
5338
help='Delete the view.',
5341
help='Name of the view to define, list or delete.',
5345
help='Name of the view to switch to.',
5350
def run(self, file_list,
5356
tree, file_list = tree_files(file_list, apply_view=False)
5357
current_view, view_dict = tree.views.get_view_info()
5362
raise errors.BzrCommandError(
5363
"Both --delete and a file list specified")
5365
raise errors.BzrCommandError(
5366
"Both --delete and --switch specified")
5368
tree.views.set_view_info(None, {})
5369
self.outf.write("Deleted all views.\n")
5371
raise errors.BzrCommandError("No current view to delete")
5373
tree.views.delete_view(name)
5374
self.outf.write("Deleted '%s' view.\n" % name)
5377
raise errors.BzrCommandError(
5378
"Both --switch and a file list specified")
5380
raise errors.BzrCommandError(
5381
"Both --switch and --all specified")
5382
elif switch == 'off':
5383
if current_view is None:
5384
raise errors.BzrCommandError("No current view to disable")
5385
tree.views.set_view_info(None, view_dict)
5386
self.outf.write("Disabled '%s' view.\n" % (current_view))
5388
tree.views.set_view_info(switch, view_dict)
5389
view_str = views.view_display_str(tree.views.lookup_view())
5390
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5393
self.outf.write('Views defined:\n')
5394
for view in sorted(view_dict):
5395
if view == current_view:
5399
view_str = views.view_display_str(view_dict[view])
5400
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5402
self.outf.write('No views defined.\n')
5405
# No name given and no current view set
5408
raise errors.BzrCommandError(
5409
"Cannot change the 'off' pseudo view")
5410
tree.views.set_view(name, sorted(file_list))
5411
view_str = views.view_display_str(tree.views.lookup_view())
5412
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5416
# No name given and no current view set
5417
self.outf.write('No current view.\n')
5419
view_str = views.view_display_str(tree.views.lookup_view(name))
5420
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5423
class cmd_hooks(Command):
5429
for hook_key in sorted(hooks.known_hooks.keys()):
5430
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5431
self.outf.write("%s:\n" % type(some_hooks).__name__)
5432
for hook_name, hook_point in sorted(some_hooks.items()):
5433
self.outf.write(" %s:\n" % (hook_name,))
5434
found_hooks = list(hook_point)
5436
for hook in found_hooks:
5437
self.outf.write(" %s\n" %
5438
(some_hooks.get_hook_name(hook),))
5440
self.outf.write(" <no hooks installed>\n")
5443
class cmd_shelve(Command):
5444
"""Temporarily set aside some changes from the current tree.
5446
Shelve allows you to temporarily put changes you've made "on the shelf",
5447
ie. out of the way, until a later time when you can bring them back from
5448
the shelf with the 'unshelve' command. The changes are stored alongside
5449
your working tree, and so they aren't propagated along with your branch nor
5450
will they survive its deletion.
5452
If shelve --list is specified, previously-shelved changes are listed.
5454
Shelve is intended to help separate several sets of changes that have
5455
been inappropriately mingled. If you just want to get rid of all changes
5456
and you don't need to restore them later, use revert. If you want to
5457
shelve all text changes at once, use shelve --all.
5459
If filenames are specified, only the changes to those files will be
5460
shelved. Other files will be left untouched.
5462
If a revision is specified, changes since that revision will be shelved.
5464
You can put multiple items on the shelf, and by default, 'unshelve' will
5465
restore the most recently shelved changes.
5468
takes_args = ['file*']
5472
Option('all', help='Shelve all changes.'),
5474
RegistryOption('writer', 'Method to use for writing diffs.',
5475
bzrlib.option.diff_writer_registry,
5476
value_switches=True, enum_switch=False),
5478
Option('list', help='List shelved changes.'),
5480
help='Destroy removed changes instead of shelving them.'),
5482
_see_also = ['unshelve']
5484
def run(self, revision=None, all=False, file_list=None, message=None,
5485
writer=None, list=False, destroy=False):
5487
return self.run_for_list()
5488
from bzrlib.shelf_ui import Shelver
5490
writer = bzrlib.option.diff_writer_registry.get()
5492
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5493
message, destroy=destroy).run()
5494
except errors.UserAbort:
5497
def run_for_list(self):
5498
tree = WorkingTree.open_containing('.')[0]
5501
manager = tree.get_shelf_manager()
5502
shelves = manager.active_shelves()
5503
if len(shelves) == 0:
5504
note('No shelved changes.')
5506
for shelf_id in reversed(shelves):
5507
message = manager.get_metadata(shelf_id).get('message')
5509
message = '<no message>'
5510
self.outf.write('%3d: %s\n' % (shelf_id, message))
5516
class cmd_unshelve(Command):
5517
"""Restore shelved changes.
5519
By default, the most recently shelved changes are restored. However if you
5520
specify a shelf by id those changes will be restored instead. This works
5521
best when the changes don't depend on each other.
5524
takes_args = ['shelf_id?']
5526
RegistryOption.from_kwargs(
5527
'action', help="The action to perform.",
5528
enum_switch=False, value_switches=True,
5529
apply="Apply changes and remove from the shelf.",
5530
dry_run="Show changes, but do not apply or remove them.",
5531
delete_only="Delete changes without applying them."
5534
_see_also = ['shelve']
5536
def run(self, shelf_id=None, action='apply'):
5537
from bzrlib.shelf_ui import Unshelver
5538
Unshelver.from_args(shelf_id, action).run()
5541
class cmd_clean_tree(Command):
5542
"""Remove unwanted files from working tree.
5544
By default, only unknown files, not ignored files, are deleted. Versioned
5545
files are never deleted.
5547
Another class is 'detritus', which includes files emitted by bzr during
5548
normal operations and selftests. (The value of these files decreases with
5551
If no options are specified, unknown files are deleted. Otherwise, option
5552
flags are respected, and may be combined.
5554
To check what clean-tree will do, use --dry-run.
5556
takes_options = [Option('ignored', help='Delete all ignored files.'),
5557
Option('detritus', help='Delete conflict files, merge'
5558
' backups, and failed selftest dirs.'),
5560
help='Delete files unknown to bzr (default).'),
5561
Option('dry-run', help='Show files to delete instead of'
5563
Option('force', help='Do not prompt before deleting.')]
5564
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5566
from bzrlib.clean_tree import clean_tree
5567
if not (unknown or ignored or detritus):
5571
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5572
dry_run=dry_run, no_prompt=force)
5575
def _create_prefix(cur_transport):
5576
needed = [cur_transport]
5577
# Recurse upwards until we can create a directory successfully
5579
new_transport = cur_transport.clone('..')
5580
if new_transport.base == cur_transport.base:
5581
raise errors.BzrCommandError(
5582
"Failed to create path prefix for %s."
5583
% cur_transport.base)
5585
new_transport.mkdir('.')
5586
except errors.NoSuchFile:
5587
needed.append(new_transport)
5588
cur_transport = new_transport
5591
# Now we only need to create child directories
5593
cur_transport = needed.pop()
5594
cur_transport.ensure_base()
5597
# these get imported and then picked up by the scan for cmd_*
5598
# TODO: Some more consistent way to split command definitions across files;
5599
# we do need to load at least some information about them to know of
5600
# aliases. ideally we would avoid loading the implementation until the
5601
# details were needed.
5602
from bzrlib.cmd_version_info import cmd_version_info
5603
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5604
from bzrlib.bundle.commands import (
5607
from bzrlib.sign_my_commits import cmd_sign_my_commits
5608
from bzrlib.weave_commands import cmd_versionedfile_list, \
5609
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
