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,
52
from bzrlib.branch import Branch
53
from bzrlib.conflicts import ConflictList
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
55
from bzrlib.smtp_connection import SMTPConnection
56
from bzrlib.workingtree import WorkingTree
59
from bzrlib.commands import Command, display_command
60
from bzrlib.option import (
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
73
return internal_tree_files(file_list, default_branch, canonicalize,
75
except errors.FileInWrongBranch, e:
76
raise errors.BzrCommandError("%s is not in the same branch as %s" %
77
(e.path, file_list[0]))
80
def tree_files_for_add(file_list):
82
Return a tree and list of absolute paths from a file list.
84
Similar to tree_files, but add handles files a bit differently, so it a
85
custom implementation. In particular, MutableTreeTree.smart_add expects
86
absolute paths, which it immediately converts to relative paths.
88
# FIXME Would be nice to just return the relative paths like
89
# internal_tree_files does, but there are a large number of unit tests
90
# that assume the current interface to mutabletree.smart_add
92
tree, relpath = WorkingTree.open_containing(file_list[0])
93
if tree.supports_views():
94
view_files = tree.views.lookup_view()
96
for filename in file_list:
97
if not osutils.is_inside_any(view_files, filename):
98
raise errors.FileOutsideView(filename, view_files)
99
file_list = file_list[:]
100
file_list[0] = tree.abspath(relpath)
102
tree = WorkingTree.open_containing(u'.')[0]
103
if tree.supports_views():
104
view_files = tree.views.lookup_view()
106
file_list = view_files
107
view_str = views.view_display_str(view_files)
108
note("Ignoring files outside view. View is %s" % view_str)
109
return tree, file_list
112
def _get_one_revision(command_name, revisions):
113
if revisions is None:
115
if len(revisions) != 1:
116
raise errors.BzrCommandError(
117
'bzr %s --revision takes exactly one revision identifier' % (
122
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
125
if revisions is None:
127
rev_tree = tree.basis_tree()
129
rev_tree = branch.basis_tree()
131
revision = _get_one_revision(command_name, revisions)
132
rev_tree = revision.as_tree(branch)
136
# XXX: Bad function name; should possibly also be a class method of
137
# WorkingTree rather than a function.
138
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
140
"""Convert command-line paths to a WorkingTree and relative paths.
142
This is typically used for command-line processors that take one or
143
more filenames, and infer the workingtree that contains them.
145
The filenames given are not required to exist.
147
:param file_list: Filenames to convert.
149
:param default_branch: Fallback tree path to use if file_list is empty or
152
:param apply_view: if True and a view is set, apply it or check that
153
specified files are within it
155
:return: workingtree, [relative_paths]
157
if file_list is None or len(file_list) == 0:
158
tree = WorkingTree.open_containing(default_branch)[0]
159
if tree.supports_views() and apply_view:
160
view_files = tree.views.lookup_view()
162
file_list = view_files
163
view_str = views.view_display_str(view_files)
164
note("Ignoring files outside view. View is %s" % view_str)
165
return tree, file_list
166
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
167
return tree, safe_relpath_files(tree, file_list, canonicalize,
168
apply_view=apply_view)
171
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
172
"""Convert file_list into a list of relpaths in tree.
174
:param tree: A tree to operate on.
175
:param file_list: A list of user provided paths or None.
176
:param apply_view: if True and a view is set, apply it or check that
177
specified files are within it
178
:return: A list of relative paths.
179
:raises errors.PathNotChild: When a provided path is in a different tree
182
if file_list is None:
184
if tree.supports_views() and apply_view:
185
view_files = tree.views.lookup_view()
189
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
190
# doesn't - fix that up here before we enter the loop.
192
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
195
for filename in file_list:
197
relpath = fixer(osutils.dereference_path(filename))
198
if view_files and not osutils.is_inside_any(view_files, relpath):
199
raise errors.FileOutsideView(filename, view_files)
200
new_list.append(relpath)
201
except errors.PathNotChild:
202
raise errors.FileInWrongBranch(tree.branch, filename)
206
def _get_view_info_for_change_reporter(tree):
207
"""Get the view information from a tree for change reporting."""
210
current_view = tree.views.get_view_info()[0]
211
if current_view is not None:
212
view_info = (current_view, tree.views.lookup_view())
213
except errors.ViewsNotSupported:
218
# TODO: Make sure no commands unconditionally use the working directory as a
219
# branch. If a filename argument is used, the first of them should be used to
220
# specify the branch. (Perhaps this can be factored out into some kind of
221
# Argument class, representing a file in a branch, where the first occurrence
224
class cmd_status(Command):
225
"""Display status summary.
227
This reports on versioned and unknown files, reporting them
228
grouped by state. Possible states are:
231
Versioned in the working copy but not in the previous revision.
234
Versioned in the previous revision but removed or deleted
238
Path of this file changed from the previous revision;
239
the text may also have changed. This includes files whose
240
parent directory was renamed.
243
Text has changed since the previous revision.
246
File kind has been changed (e.g. from file to directory).
249
Not versioned and not matching an ignore pattern.
251
To see ignored files use 'bzr ignored'. For details on the
252
changes to file texts, use 'bzr diff'.
254
Note that --short or -S gives status flags for each item, similar
255
to Subversion's status command. To get output similar to svn -q,
258
If no arguments are specified, the status of the entire working
259
directory is shown. Otherwise, only the status of the specified
260
files or directories is reported. If a directory is given, status
261
is reported for everything inside that directory.
263
Before merges are committed, the pending merge tip revisions are
264
shown. To see all pending merge revisions, use the -v option.
265
To skip the display of pending merge information altogether, use
266
the no-pending option or specify a file/directory.
268
If a revision argument is given, the status is calculated against
269
that revision, or between two revisions if two are provided.
272
# TODO: --no-recurse, --recurse options
274
takes_args = ['file*']
275
takes_options = ['show-ids', 'revision', 'change', 'verbose',
276
Option('short', help='Use short status indicators.',
278
Option('versioned', help='Only show versioned files.',
280
Option('no-pending', help='Don\'t show pending merges.',
283
aliases = ['st', 'stat']
285
encoding_type = 'replace'
286
_see_also = ['diff', 'revert', 'status-flags']
289
def run(self, show_ids=False, file_list=None, revision=None, short=False,
290
versioned=False, no_pending=False, verbose=False):
291
from bzrlib.status import show_tree_status
293
if revision and len(revision) > 2:
294
raise errors.BzrCommandError('bzr status --revision takes exactly'
295
' one or two revision specifiers')
297
tree, relfile_list = tree_files(file_list)
298
# Avoid asking for specific files when that is not needed.
299
if relfile_list == ['']:
301
# Don't disable pending merges for full trees other than '.'.
302
if file_list == ['.']:
304
# A specific path within a tree was given.
305
elif relfile_list is not None:
307
show_tree_status(tree, show_ids=show_ids,
308
specific_files=relfile_list, revision=revision,
309
to_file=self.outf, short=short, versioned=versioned,
310
show_pending=(not no_pending), verbose=verbose)
313
class cmd_cat_revision(Command):
314
"""Write out metadata for a revision.
316
The revision to print can either be specified by a specific
317
revision identifier, or you can use --revision.
321
takes_args = ['revision_id?']
322
takes_options = ['revision']
323
# cat-revision is more for frontends so should be exact
327
def run(self, revision_id=None, revision=None):
328
if revision_id is not None and revision is not None:
329
raise errors.BzrCommandError('You can only supply one of'
330
' revision_id or --revision')
331
if revision_id is None and revision is None:
332
raise errors.BzrCommandError('You must supply either'
333
' --revision or a revision_id')
334
b = WorkingTree.open_containing(u'.')[0].branch
336
# TODO: jam 20060112 should cat-revision always output utf-8?
337
if revision_id is not None:
338
revision_id = osutils.safe_revision_id(revision_id, warn=False)
340
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
341
except errors.NoSuchRevision:
342
msg = "The repository %s contains no revision %s." % (b.repository.base,
344
raise errors.BzrCommandError(msg)
345
elif revision is not None:
348
raise errors.BzrCommandError('You cannot specify a NULL'
350
rev_id = rev.as_revision_id(b)
351
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
354
class cmd_dump_btree(Command):
355
"""Dump the contents of a btree index file to stdout.
357
PATH is a btree index file, it can be any URL. This includes things like
358
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
360
By default, the tuples stored in the index file will be displayed. With
361
--raw, we will uncompress the pages, but otherwise display the raw bytes
365
# TODO: Do we want to dump the internal nodes as well?
366
# TODO: It would be nice to be able to dump the un-parsed information,
367
# rather than only going through iter_all_entries. However, this is
368
# good enough for a start
370
encoding_type = 'exact'
371
takes_args = ['path']
372
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
373
' rather than the parsed tuples.'),
376
def run(self, path, raw=False):
377
dirname, basename = osutils.split(path)
378
t = transport.get_transport(dirname)
380
self._dump_raw_bytes(t, basename)
382
self._dump_entries(t, basename)
384
def _get_index_and_bytes(self, trans, basename):
385
"""Create a BTreeGraphIndex and raw bytes."""
386
bt = btree_index.BTreeGraphIndex(trans, basename, None)
387
bytes = trans.get_bytes(basename)
388
bt._file = cStringIO.StringIO(bytes)
389
bt._size = len(bytes)
392
def _dump_raw_bytes(self, trans, basename):
395
# We need to parse at least the root node.
396
# This is because the first page of every row starts with an
397
# uncompressed header.
398
bt, bytes = self._get_index_and_bytes(trans, basename)
399
for page_idx, page_start in enumerate(xrange(0, len(bytes),
400
btree_index._PAGE_SIZE)):
401
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
402
page_bytes = bytes[page_start:page_end]
404
self.outf.write('Root node:\n')
405
header_end, data = bt._parse_header_from_bytes(page_bytes)
406
self.outf.write(page_bytes[:header_end])
408
self.outf.write('\nPage %d\n' % (page_idx,))
409
decomp_bytes = zlib.decompress(page_bytes)
410
self.outf.write(decomp_bytes)
411
self.outf.write('\n')
413
def _dump_entries(self, trans, basename):
415
st = trans.stat(basename)
416
except errors.TransportNotPossible:
417
# We can't stat, so we'll fake it because we have to do the 'get()'
419
bt, _ = self._get_index_and_bytes(trans, basename)
421
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
422
for node in bt.iter_all_entries():
423
# Node is made up of:
424
# (index, key, value, [references])
425
self.outf.write('%s\n' % (node[1:],))
428
class cmd_remove_tree(Command):
429
"""Remove the working tree from a given branch/checkout.
431
Since a lightweight checkout is little more than a working tree
432
this will refuse to run against one.
434
To re-create the working tree, use "bzr checkout".
436
_see_also = ['checkout', 'working-trees']
437
takes_args = ['location?']
440
help='Remove the working tree even if it has '
441
'uncommitted changes.'),
444
def run(self, location='.', force=False):
445
d = bzrdir.BzrDir.open(location)
448
working = d.open_workingtree()
449
except errors.NoWorkingTree:
450
raise errors.BzrCommandError("No working tree to remove")
451
except errors.NotLocalUrl:
452
raise errors.BzrCommandError("You cannot remove the working tree of a "
455
changes = working.changes_from(working.basis_tree())
456
if changes.has_changed():
457
raise errors.UncommittedChanges(working)
459
working_path = working.bzrdir.root_transport.base
460
branch_path = working.branch.bzrdir.root_transport.base
461
if working_path != branch_path:
462
raise errors.BzrCommandError("You cannot remove the working tree from "
463
"a lightweight checkout")
465
d.destroy_workingtree()
468
class cmd_revno(Command):
469
"""Show current revision number.
471
This is equal to the number of revisions on this branch.
475
takes_args = ['location?']
477
Option('tree', help='Show revno of working tree'),
481
def run(self, tree=False, location=u'.'):
484
wt = WorkingTree.open_containing(location)[0]
486
except (errors.NoWorkingTree, errors.NotLocalUrl):
487
raise errors.NoWorkingTree(location)
489
revid = wt.last_revision()
491
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
492
except errors.NoSuchRevision:
494
revno = ".".join(str(n) for n in revno_t)
498
b = Branch.open_containing(location)[0]
505
self.outf.write(str(revno) + '\n')
508
class cmd_revision_info(Command):
509
"""Show revision number and revision id for a given revision identifier.
512
takes_args = ['revision_info*']
516
help='Branch to examine, '
517
'rather than the one containing the working directory.',
521
Option('tree', help='Show revno of working tree'),
525
def run(self, revision=None, directory=u'.', tree=False,
526
revision_info_list=[]):
529
wt = WorkingTree.open_containing(directory)[0]
532
except (errors.NoWorkingTree, errors.NotLocalUrl):
534
b = Branch.open_containing(directory)[0]
538
if revision is not None:
539
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
540
if revision_info_list is not None:
541
for rev_str in revision_info_list:
542
rev_spec = RevisionSpec.from_string(rev_str)
543
revision_ids.append(rev_spec.as_revision_id(b))
544
# No arguments supplied, default to the last revision
545
if len(revision_ids) == 0:
548
raise errors.NoWorkingTree(directory)
549
revision_ids.append(wt.last_revision())
551
revision_ids.append(b.last_revision())
555
for revision_id in revision_ids:
557
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
558
revno = '.'.join(str(i) for i in dotted_revno)
559
except errors.NoSuchRevision:
561
maxlen = max(maxlen, len(revno))
562
revinfos.append([revno, revision_id])
570
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
573
class cmd_add(Command):
574
"""Add specified files or directories.
576
In non-recursive mode, all the named items are added, regardless
577
of whether they were previously ignored. A warning is given if
578
any of the named files are already versioned.
580
In recursive mode (the default), files are treated the same way
581
but the behaviour for directories is different. Directories that
582
are already versioned do not give a warning. All directories,
583
whether already versioned or not, are searched for files or
584
subdirectories that are neither versioned or ignored, and these
585
are added. This search proceeds recursively into versioned
586
directories. If no names are given '.' is assumed.
588
Therefore simply saying 'bzr add' will version all files that
589
are currently unknown.
591
Adding a file whose parent directory is not versioned will
592
implicitly add the parent, and so on up to the root. This means
593
you should never need to explicitly add a directory, they'll just
594
get added when you add a file in the directory.
596
--dry-run will show which files would be added, but not actually
599
--file-ids-from will try to use the file ids from the supplied path.
600
It looks up ids trying to find a matching parent directory with the
601
same filename, and then by pure path. This option is rarely needed
602
but can be useful when adding the same logical file into two
603
branches that will be merged later (without showing the two different
604
adds as a conflict). It is also useful when merging another project
605
into a subdirectory of this one.
607
takes_args = ['file*']
610
help="Don't recursively add the contents of directories."),
612
help="Show what would be done, but don't actually do anything."),
614
Option('file-ids-from',
616
help='Lookup file ids from this tree.'),
618
encoding_type = 'replace'
619
_see_also = ['remove']
621
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
626
if file_ids_from is not None:
628
base_tree, base_path = WorkingTree.open_containing(
630
except errors.NoWorkingTree:
631
base_branch, base_path = Branch.open_containing(
633
base_tree = base_branch.basis_tree()
635
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
636
to_file=self.outf, should_print=(not is_quiet()))
638
action = bzrlib.add.AddAction(to_file=self.outf,
639
should_print=(not is_quiet()))
642
base_tree.lock_read()
644
file_list = self._maybe_expand_globs(file_list)
645
tree, file_list = tree_files_for_add(file_list)
646
added, ignored = tree.smart_add(file_list, not
647
no_recurse, action=action, save=not dry_run)
649
if base_tree is not None:
653
for glob in sorted(ignored.keys()):
654
for path in ignored[glob]:
655
self.outf.write("ignored %s matching \"%s\"\n"
659
for glob, paths in ignored.items():
660
match_len += len(paths)
661
self.outf.write("ignored %d file(s).\n" % match_len)
662
self.outf.write("If you wish to add ignored files, "
663
"please add them explicitly by name. "
664
"(\"bzr ignored\" gives a list)\n")
667
class cmd_mkdir(Command):
668
"""Create a new versioned directory.
670
This is equivalent to creating the directory and then adding it.
673
takes_args = ['dir+']
674
encoding_type = 'replace'
676
def run(self, dir_list):
679
wt, dd = WorkingTree.open_containing(d)
681
self.outf.write('added %s\n' % d)
684
class cmd_relpath(Command):
685
"""Show path of a file relative to root"""
687
takes_args = ['filename']
691
def run(self, filename):
692
# TODO: jam 20050106 Can relpath return a munged path if
693
# sys.stdout encoding cannot represent it?
694
tree, relpath = WorkingTree.open_containing(filename)
695
self.outf.write(relpath)
696
self.outf.write('\n')
699
class cmd_inventory(Command):
700
"""Show inventory of the current working copy or a revision.
702
It is possible to limit the output to a particular entry
703
type using the --kind option. For example: --kind file.
705
It is also possible to restrict the list of files to a specific
706
set. For example: bzr inventory --show-ids this/file
715
help='List entries of a particular kind: file, directory, symlink.',
718
takes_args = ['file*']
721
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
722
if kind and kind not in ['file', 'directory', 'symlink']:
723
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
725
revision = _get_one_revision('inventory', revision)
726
work_tree, file_list = tree_files(file_list)
727
work_tree.lock_read()
729
if revision is not None:
730
tree = revision.as_tree(work_tree.branch)
732
extra_trees = [work_tree]
738
if file_list is not None:
739
file_ids = tree.paths2ids(file_list, trees=extra_trees,
740
require_versioned=True)
741
# find_ids_across_trees may include some paths that don't
743
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
744
for file_id in file_ids if file_id in tree)
746
entries = tree.inventory.entries()
749
if tree is not work_tree:
752
for path, entry in entries:
753
if kind and kind != entry.kind:
756
self.outf.write('%-50s %s\n' % (path, entry.file_id))
758
self.outf.write(path)
759
self.outf.write('\n')
762
class cmd_mv(Command):
763
"""Move or rename a file.
766
bzr mv OLDNAME NEWNAME
768
bzr mv SOURCE... DESTINATION
770
If the last argument is a versioned directory, all the other names
771
are moved into it. Otherwise, there must be exactly two arguments
772
and the file is changed to a new name.
774
If OLDNAME does not exist on the filesystem but is versioned and
775
NEWNAME does exist on the filesystem but is not versioned, mv
776
assumes that the file has been manually moved and only updates
777
its internal inventory to reflect that change.
778
The same is valid when moving many SOURCE files to a DESTINATION.
780
Files cannot be moved between branches.
783
takes_args = ['names*']
784
takes_options = [Option("after", help="Move only the bzr identifier"
785
" of the file, because the file has already been moved."),
786
Option('auto', help='Automatically guess renames.'),
787
Option('dry-run', help='Avoid making changes when guessing renames.'),
789
aliases = ['move', 'rename']
790
encoding_type = 'replace'
792
def run(self, names_list, after=False, auto=False, dry_run=False):
794
return self.run_auto(names_list, after, dry_run)
796
raise errors.BzrCommandError('--dry-run requires --auto.')
797
if names_list is None:
799
if len(names_list) < 2:
800
raise errors.BzrCommandError("missing file argument")
801
tree, rel_names = tree_files(names_list, canonicalize=False)
804
self._run(tree, names_list, rel_names, after)
808
def run_auto(self, names_list, after, dry_run):
809
if names_list is not None and len(names_list) > 1:
810
raise errors.BzrCommandError('Only one path may be specified to'
813
raise errors.BzrCommandError('--after cannot be specified with'
815
work_tree, file_list = tree_files(names_list, default_branch='.')
816
work_tree.lock_write()
818
rename_map.RenameMap.guess_renames(work_tree, dry_run)
822
def _run(self, tree, names_list, rel_names, after):
823
into_existing = osutils.isdir(names_list[-1])
824
if into_existing and len(names_list) == 2:
826
# a. case-insensitive filesystem and change case of dir
827
# b. move directory after the fact (if the source used to be
828
# a directory, but now doesn't exist in the working tree
829
# and the target is an existing directory, just rename it)
830
if (not tree.case_sensitive
831
and rel_names[0].lower() == rel_names[1].lower()):
832
into_existing = False
835
# 'fix' the case of a potential 'from'
836
from_id = tree.path2id(
837
tree.get_canonical_inventory_path(rel_names[0]))
838
if (not osutils.lexists(names_list[0]) and
839
from_id and inv.get_file_kind(from_id) == "directory"):
840
into_existing = False
843
# move into existing directory
844
# All entries reference existing inventory items, so fix them up
845
# for cicp file-systems.
846
rel_names = tree.get_canonical_inventory_paths(rel_names)
847
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
848
self.outf.write("%s => %s\n" % pair)
850
if len(names_list) != 2:
851
raise errors.BzrCommandError('to mv multiple files the'
852
' destination must be a versioned'
855
# for cicp file-systems: the src references an existing inventory
857
src = tree.get_canonical_inventory_path(rel_names[0])
858
# Find the canonical version of the destination: In all cases, the
859
# parent of the target must be in the inventory, so we fetch the
860
# canonical version from there (we do not always *use* the
861
# canonicalized tail portion - we may be attempting to rename the
863
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
864
dest_parent = osutils.dirname(canon_dest)
865
spec_tail = osutils.basename(rel_names[1])
866
# For a CICP file-system, we need to avoid creating 2 inventory
867
# entries that differ only by case. So regardless of the case
868
# we *want* to use (ie, specified by the user or the file-system),
869
# we must always choose to use the case of any existing inventory
870
# items. The only exception to this is when we are attempting a
871
# case-only rename (ie, canonical versions of src and dest are
873
dest_id = tree.path2id(canon_dest)
874
if dest_id is None or tree.path2id(src) == dest_id:
875
# No existing item we care about, so work out what case we
876
# are actually going to use.
878
# If 'after' is specified, the tail must refer to a file on disk.
880
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
882
# pathjoin with an empty tail adds a slash, which breaks
884
dest_parent_fq = tree.basedir
886
dest_tail = osutils.canonical_relpath(
888
osutils.pathjoin(dest_parent_fq, spec_tail))
890
# not 'after', so case as specified is used
891
dest_tail = spec_tail
893
# Use the existing item so 'mv' fails with AlreadyVersioned.
894
dest_tail = os.path.basename(canon_dest)
895
dest = osutils.pathjoin(dest_parent, dest_tail)
896
mutter("attempting to move %s => %s", src, dest)
897
tree.rename_one(src, dest, after=after)
898
self.outf.write("%s => %s\n" % (src, dest))
901
class cmd_pull(Command):
902
"""Turn this branch into a mirror of another branch.
904
This command only works on branches that have not diverged. Branches are
905
considered diverged if the destination branch's most recent commit is one
906
that has not been merged (directly or indirectly) into the parent.
908
If branches have diverged, you can use 'bzr merge' to integrate the changes
909
from one into the other. Once one branch has merged, the other should
910
be able to pull it again.
912
If you want to forget your local changes and just update your branch to
913
match the remote one, use pull --overwrite.
915
If there is no default location set, the first pull will set it. After
916
that, you can omit the location to use the default. To change the
917
default, use --remember. The value will only be saved if the remote
918
location can be accessed.
920
Note: The location can be specified either in the form of a branch,
921
or in the form of a path to a file containing a merge directive generated
925
_see_also = ['push', 'update', 'status-flags', 'send']
926
takes_options = ['remember', 'overwrite', 'revision',
927
custom_help('verbose',
928
help='Show logs of pulled revisions.'),
930
help='Branch to pull into, '
931
'rather than the one containing the working directory.',
936
help="Perform a local pull in a bound "
937
"branch. Local pulls are not applied to "
941
takes_args = ['location?']
942
encoding_type = 'replace'
944
def run(self, location=None, remember=False, overwrite=False,
945
revision=None, verbose=False,
946
directory=None, local=False):
947
# FIXME: too much stuff is in the command class
950
if directory is None:
953
tree_to = WorkingTree.open_containing(directory)[0]
954
branch_to = tree_to.branch
955
except errors.NoWorkingTree:
957
branch_to = Branch.open_containing(directory)[0]
959
if local and not branch_to.get_bound_location():
960
raise errors.LocalRequiresBoundBranch()
962
possible_transports = []
963
if location is not None:
965
mergeable = bundle.read_mergeable_from_url(location,
966
possible_transports=possible_transports)
967
except errors.NotABundle:
970
stored_loc = branch_to.get_parent()
972
if stored_loc is None:
973
raise errors.BzrCommandError("No pull location known or"
976
display_url = urlutils.unescape_for_display(stored_loc,
979
self.outf.write("Using saved parent location: %s\n" % display_url)
980
location = stored_loc
982
revision = _get_one_revision('pull', revision)
983
if mergeable is not None:
984
if revision is not None:
985
raise errors.BzrCommandError(
986
'Cannot use -r with merge directives or bundles')
987
mergeable.install_revisions(branch_to.repository)
988
base_revision_id, revision_id, verified = \
989
mergeable.get_merge_request(branch_to.repository)
990
branch_from = branch_to
992
branch_from = Branch.open(location,
993
possible_transports=possible_transports)
995
if branch_to.get_parent() is None or remember:
996
branch_to.set_parent(branch_from.base)
998
if branch_from is not branch_to:
999
branch_from.lock_read()
1001
if revision is not None:
1002
revision_id = revision.as_revision_id(branch_from)
1004
branch_to.lock_write()
1006
if tree_to is not None:
1007
view_info = _get_view_info_for_change_reporter(tree_to)
1008
change_reporter = delta._ChangeReporter(
1009
unversioned_filter=tree_to.is_ignored,
1010
view_info=view_info)
1011
result = tree_to.pull(
1012
branch_from, overwrite, revision_id, change_reporter,
1013
possible_transports=possible_transports, local=local)
1015
result = branch_to.pull(
1016
branch_from, overwrite, revision_id, local=local)
1018
result.report(self.outf)
1019
if verbose and result.old_revid != result.new_revid:
1020
log.show_branch_change(
1021
branch_to, self.outf, result.old_revno,
1026
if branch_from is not branch_to:
1027
branch_from.unlock()
1030
class cmd_push(Command):
1031
"""Update a mirror of this branch.
1033
The target branch will not have its working tree populated because this
1034
is both expensive, and is not supported on remote file systems.
1036
Some smart servers or protocols *may* put the working tree in place in
1039
This command only works on branches that have not diverged. Branches are
1040
considered diverged if the destination branch's most recent commit is one
1041
that has not been merged (directly or indirectly) by the source branch.
1043
If branches have diverged, you can use 'bzr push --overwrite' to replace
1044
the other branch completely, discarding its unmerged changes.
1046
If you want to ensure you have the different changes in the other branch,
1047
do a merge (see bzr help merge) from the other branch, and commit that.
1048
After that you will be able to do a push without '--overwrite'.
1050
If there is no default push location set, the first push will set it.
1051
After that, you can omit the location to use the default. To change the
1052
default, use --remember. The value will only be saved if the remote
1053
location can be accessed.
1056
_see_also = ['pull', 'update', 'working-trees']
1057
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1058
Option('create-prefix',
1059
help='Create the path leading up to the branch '
1060
'if it does not already exist.'),
1062
help='Branch to push from, '
1063
'rather than the one containing the working directory.',
1067
Option('use-existing-dir',
1068
help='By default push will fail if the target'
1069
' directory exists, but does not already'
1070
' have a control directory. This flag will'
1071
' allow push to proceed.'),
1073
help='Create a stacked branch that references the public location '
1074
'of the parent branch.'),
1075
Option('stacked-on',
1076
help='Create a stacked branch that refers to another branch '
1077
'for the commit history. Only the work not present in the '
1078
'referenced branch is included in the branch created.',
1081
help='Refuse to push if there are uncommitted changes in'
1082
' the working tree.'),
1084
takes_args = ['location?']
1085
encoding_type = 'replace'
1087
def run(self, location=None, remember=False, overwrite=False,
1088
create_prefix=False, verbose=False, revision=None,
1089
use_existing_dir=False, directory=None, stacked_on=None,
1090
stacked=False, strict=None):
1091
from bzrlib.push import _show_push_branch
1093
if directory is None:
1095
# Get the source branch
1097
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1099
strict = br_from.get_config().get_user_option('push_strict')
1100
if strict is not None:
1101
# FIXME: This should be better supported by config
1103
bools = dict(yes=True, no=False, on=True, off=False,
1104
true=True, false=False)
1106
strict = bools[strict.lower()]
1109
# Get the tip's revision_id
1110
revision = _get_one_revision('push', revision)
1111
if revision is not None:
1112
revision_id = revision.in_history(br_from).rev_id
1115
if (tree is not None and revision_id is None
1116
and (strict is None or strict)): # Default to True:
1117
changes = tree.changes_from(tree.basis_tree())
1118
if changes.has_changed() or len(tree.get_parent_ids()) > 1:
1119
raise errors.UncommittedChanges(tree)
1121
# Get the stacked_on branch, if any
1122
if stacked_on is not None:
1123
stacked_on = urlutils.normalize_url(stacked_on)
1125
parent_url = br_from.get_parent()
1127
parent = Branch.open(parent_url)
1128
stacked_on = parent.get_public_branch()
1130
# I considered excluding non-http url's here, thus forcing
1131
# 'public' branches only, but that only works for some
1132
# users, so it's best to just depend on the user spotting an
1133
# error by the feedback given to them. RBC 20080227.
1134
stacked_on = parent_url
1136
raise errors.BzrCommandError(
1137
"Could not determine branch to refer to.")
1139
# Get the destination location
1140
if location is None:
1141
stored_loc = br_from.get_push_location()
1142
if stored_loc is None:
1143
raise errors.BzrCommandError(
1144
"No push location known or specified.")
1146
display_url = urlutils.unescape_for_display(stored_loc,
1148
self.outf.write("Using saved push location: %s\n" % display_url)
1149
location = stored_loc
1151
_show_push_branch(br_from, revision_id, location, self.outf,
1152
verbose=verbose, overwrite=overwrite, remember=remember,
1153
stacked_on=stacked_on, create_prefix=create_prefix,
1154
use_existing_dir=use_existing_dir)
1157
class cmd_branch(Command):
1158
"""Create a new branch that is a copy of an existing branch.
1160
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1161
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1162
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1163
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1164
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1167
To retrieve the branch as of a particular revision, supply the --revision
1168
parameter, as in "branch foo/bar -r 5".
1171
_see_also = ['checkout']
1172
takes_args = ['from_location', 'to_location?']
1173
takes_options = ['revision', Option('hardlink',
1174
help='Hard-link working tree files where possible.'),
1176
help="Create a branch without a working-tree."),
1178
help='Create a stacked branch referring to the source branch. '
1179
'The new branch will depend on the availability of the source '
1180
'branch for all operations.'),
1181
Option('standalone',
1182
help='Do not use a shared repository, even if available.'),
1184
aliases = ['get', 'clone']
1186
def run(self, from_location, to_location=None, revision=None,
1187
hardlink=False, stacked=False, standalone=False, no_tree=False):
1188
from bzrlib.tag import _merge_tags_if_possible
1190
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1192
if (accelerator_tree is not None and
1193
accelerator_tree.supports_content_filtering()):
1194
accelerator_tree = None
1195
revision = _get_one_revision('branch', revision)
1198
if revision is not None:
1199
revision_id = revision.as_revision_id(br_from)
1201
# FIXME - wt.last_revision, fallback to branch, fall back to
1202
# None or perhaps NULL_REVISION to mean copy nothing
1204
revision_id = br_from.last_revision()
1205
if to_location is None:
1206
to_location = urlutils.derive_to_location(from_location)
1207
to_transport = transport.get_transport(to_location)
1209
to_transport.mkdir('.')
1210
except errors.FileExists:
1211
raise errors.BzrCommandError('Target directory "%s" already'
1212
' exists.' % to_location)
1213
except errors.NoSuchFile:
1214
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1217
# preserve whatever source format we have.
1218
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1219
possible_transports=[to_transport],
1220
accelerator_tree=accelerator_tree,
1221
hardlink=hardlink, stacked=stacked,
1222
force_new_repo=standalone,
1223
create_tree_if_local=not no_tree,
1224
source_branch=br_from)
1225
branch = dir.open_branch()
1226
except errors.NoSuchRevision:
1227
to_transport.delete_tree('.')
1228
msg = "The branch %s has no revision %s." % (from_location,
1230
raise errors.BzrCommandError(msg)
1231
_merge_tags_if_possible(br_from, branch)
1232
# If the source branch is stacked, the new branch may
1233
# be stacked whether we asked for that explicitly or not.
1234
# We therefore need a try/except here and not just 'if stacked:'
1236
note('Created new stacked branch referring to %s.' %
1237
branch.get_stacked_on_url())
1238
except (errors.NotStacked, errors.UnstackableBranchFormat,
1239
errors.UnstackableRepositoryFormat), e:
1240
note('Branched %d revision(s).' % branch.revno())
1245
class cmd_checkout(Command):
1246
"""Create a new checkout of an existing branch.
1248
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1249
the branch found in '.'. This is useful if you have removed the working tree
1250
or if it was never created - i.e. if you pushed the branch to its current
1251
location using SFTP.
1253
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1254
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1255
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1256
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1257
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1260
To retrieve the branch as of a particular revision, supply the --revision
1261
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1262
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1266
_see_also = ['checkouts', 'branch']
1267
takes_args = ['branch_location?', 'to_location?']
1268
takes_options = ['revision',
1269
Option('lightweight',
1270
help="Perform a lightweight checkout. Lightweight "
1271
"checkouts depend on access to the branch for "
1272
"every operation. Normal checkouts can perform "
1273
"common operations like diff and status without "
1274
"such access, and also support local commits."
1276
Option('files-from', type=str,
1277
help="Get file contents from this tree."),
1279
help='Hard-link working tree files where possible.'
1284
def run(self, branch_location=None, to_location=None, revision=None,
1285
lightweight=False, files_from=None, hardlink=False):
1286
if branch_location is None:
1287
branch_location = osutils.getcwd()
1288
to_location = branch_location
1289
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1291
revision = _get_one_revision('checkout', revision)
1292
if files_from is not None:
1293
accelerator_tree = WorkingTree.open(files_from)
1294
if revision is not None:
1295
revision_id = revision.as_revision_id(source)
1298
if to_location is None:
1299
to_location = urlutils.derive_to_location(branch_location)
1300
# if the source and to_location are the same,
1301
# and there is no working tree,
1302
# then reconstitute a branch
1303
if (osutils.abspath(to_location) ==
1304
osutils.abspath(branch_location)):
1306
source.bzrdir.open_workingtree()
1307
except errors.NoWorkingTree:
1308
source.bzrdir.create_workingtree(revision_id)
1310
source.create_checkout(to_location, revision_id, lightweight,
1311
accelerator_tree, hardlink)
1314
class cmd_renames(Command):
1315
"""Show list of renamed files.
1317
# TODO: Option to show renames between two historical versions.
1319
# TODO: Only show renames under dir, rather than in the whole branch.
1320
_see_also = ['status']
1321
takes_args = ['dir?']
1324
def run(self, dir=u'.'):
1325
tree = WorkingTree.open_containing(dir)[0]
1328
new_inv = tree.inventory
1329
old_tree = tree.basis_tree()
1330
old_tree.lock_read()
1332
old_inv = old_tree.inventory
1334
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1335
for f, paths, c, v, p, n, k, e in iterator:
1336
if paths[0] == paths[1]:
1340
renames.append(paths)
1342
for old_name, new_name in renames:
1343
self.outf.write("%s => %s\n" % (old_name, new_name))
1350
class cmd_update(Command):
1351
"""Update a tree to have the latest code committed to its branch.
1353
This will perform a merge into the working tree, and may generate
1354
conflicts. If you have any local changes, you will still
1355
need to commit them after the update for the update to be complete.
1357
If you want to discard your local changes, you can just do a
1358
'bzr revert' instead of 'bzr commit' after the update.
1361
_see_also = ['pull', 'working-trees', 'status-flags']
1362
takes_args = ['dir?']
1365
def run(self, dir='.'):
1366
tree = WorkingTree.open_containing(dir)[0]
1367
possible_transports = []
1368
master = tree.branch.get_master_branch(
1369
possible_transports=possible_transports)
1370
if master is not None:
1373
tree.lock_tree_write()
1375
existing_pending_merges = tree.get_parent_ids()[1:]
1376
last_rev = _mod_revision.ensure_null(tree.last_revision())
1377
if last_rev == _mod_revision.ensure_null(
1378
tree.branch.last_revision()):
1379
# may be up to date, check master too.
1380
if master is None or last_rev == _mod_revision.ensure_null(
1381
master.last_revision()):
1382
revno = tree.branch.revision_id_to_revno(last_rev)
1383
note("Tree is up to date at revision %d." % (revno,))
1385
view_info = _get_view_info_for_change_reporter(tree)
1386
conflicts = tree.update(
1387
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1388
view_info=view_info), possible_transports=possible_transports)
1389
revno = tree.branch.revision_id_to_revno(
1390
_mod_revision.ensure_null(tree.last_revision()))
1391
note('Updated to revision %d.' % (revno,))
1392
if tree.get_parent_ids()[1:] != existing_pending_merges:
1393
note('Your local commits will now show as pending merges with '
1394
"'bzr status', and can be committed with 'bzr commit'.")
1403
class cmd_info(Command):
1404
"""Show information about a working tree, branch or repository.
1406
This command will show all known locations and formats associated to the
1407
tree, branch or repository.
1409
In verbose mode, statistical information is included with each report.
1410
To see extended statistic information, use a verbosity level of 2 or
1411
higher by specifying the verbose option multiple times, e.g. -vv.
1413
Branches and working trees will also report any missing revisions.
1417
Display information on the format and related locations:
1421
Display the above together with extended format information and
1422
basic statistics (like the number of files in the working tree and
1423
number of revisions in the branch and repository):
1427
Display the above together with number of committers to the branch:
1431
_see_also = ['revno', 'working-trees', 'repositories']
1432
takes_args = ['location?']
1433
takes_options = ['verbose']
1434
encoding_type = 'replace'
1437
def run(self, location=None, verbose=False):
1439
noise_level = get_verbosity_level()
1442
from bzrlib.info import show_bzrdir_info
1443
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1444
verbose=noise_level, outfile=self.outf)
1447
class cmd_remove(Command):
1448
"""Remove files or directories.
1450
This makes bzr stop tracking changes to the specified files. bzr will delete
1451
them if they can easily be recovered using revert. If no options or
1452
parameters are given bzr will scan for files that are being tracked by bzr
1453
but missing in your tree and stop tracking them for you.
1455
takes_args = ['file*']
1456
takes_options = ['verbose',
1457
Option('new', help='Only remove files that have never been committed.'),
1458
RegistryOption.from_kwargs('file-deletion-strategy',
1459
'The file deletion mode to be used.',
1460
title='Deletion Strategy', value_switches=True, enum_switch=False,
1461
safe='Only delete files if they can be'
1462
' safely recovered (default).',
1463
keep="Don't delete any files.",
1464
force='Delete all the specified files, even if they can not be '
1465
'recovered and even if they are non-empty directories.')]
1466
aliases = ['rm', 'del']
1467
encoding_type = 'replace'
1469
def run(self, file_list, verbose=False, new=False,
1470
file_deletion_strategy='safe'):
1471
tree, file_list = tree_files(file_list)
1473
if file_list is not None:
1474
file_list = [f for f in file_list]
1478
# Heuristics should probably all move into tree.remove_smart or
1481
added = tree.changes_from(tree.basis_tree(),
1482
specific_files=file_list).added
1483
file_list = sorted([f[0] for f in added], reverse=True)
1484
if len(file_list) == 0:
1485
raise errors.BzrCommandError('No matching files.')
1486
elif file_list is None:
1487
# missing files show up in iter_changes(basis) as
1488
# versioned-with-no-kind.
1490
for change in tree.iter_changes(tree.basis_tree()):
1491
# Find paths in the working tree that have no kind:
1492
if change[1][1] is not None and change[6][1] is None:
1493
missing.append(change[1][1])
1494
file_list = sorted(missing, reverse=True)
1495
file_deletion_strategy = 'keep'
1496
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1497
keep_files=file_deletion_strategy=='keep',
1498
force=file_deletion_strategy=='force')
1503
class cmd_file_id(Command):
1504
"""Print file_id of a particular file or directory.
1506
The file_id is assigned when the file is first added and remains the
1507
same through all revisions where the file exists, even when it is
1512
_see_also = ['inventory', 'ls']
1513
takes_args = ['filename']
1516
def run(self, filename):
1517
tree, relpath = WorkingTree.open_containing(filename)
1518
i = tree.path2id(relpath)
1520
raise errors.NotVersionedError(filename)
1522
self.outf.write(i + '\n')
1525
class cmd_file_path(Command):
1526
"""Print path of file_ids to a file or directory.
1528
This prints one line for each directory down to the target,
1529
starting at the branch root.
1533
takes_args = ['filename']
1536
def run(self, filename):
1537
tree, relpath = WorkingTree.open_containing(filename)
1538
fid = tree.path2id(relpath)
1540
raise errors.NotVersionedError(filename)
1541
segments = osutils.splitpath(relpath)
1542
for pos in range(1, len(segments) + 1):
1543
path = osutils.joinpath(segments[:pos])
1544
self.outf.write("%s\n" % tree.path2id(path))
1547
class cmd_reconcile(Command):
1548
"""Reconcile bzr metadata in a branch.
1550
This can correct data mismatches that may have been caused by
1551
previous ghost operations or bzr upgrades. You should only
1552
need to run this command if 'bzr check' or a bzr developer
1553
advises you to run it.
1555
If a second branch is provided, cross-branch reconciliation is
1556
also attempted, which will check that data like the tree root
1557
id which was not present in very early bzr versions is represented
1558
correctly in both branches.
1560
At the same time it is run it may recompress data resulting in
1561
a potential saving in disk space or performance gain.
1563
The branch *MUST* be on a listable system such as local disk or sftp.
1566
_see_also = ['check']
1567
takes_args = ['branch?']
1569
def run(self, branch="."):
1570
from bzrlib.reconcile import reconcile
1571
dir = bzrdir.BzrDir.open(branch)
1575
class cmd_revision_history(Command):
1576
"""Display the list of revision ids on a branch."""
1579
takes_args = ['location?']
1584
def run(self, location="."):
1585
branch = Branch.open_containing(location)[0]
1586
for revid in branch.revision_history():
1587
self.outf.write(revid)
1588
self.outf.write('\n')
1591
class cmd_ancestry(Command):
1592
"""List all revisions merged into this branch."""
1594
_see_also = ['log', 'revision-history']
1595
takes_args = ['location?']
1600
def run(self, location="."):
1602
wt = WorkingTree.open_containing(location)[0]
1603
except errors.NoWorkingTree:
1604
b = Branch.open(location)
1605
last_revision = b.last_revision()
1608
last_revision = wt.last_revision()
1610
revision_ids = b.repository.get_ancestry(last_revision)
1612
for revision_id in revision_ids:
1613
self.outf.write(revision_id + '\n')
1616
class cmd_init(Command):
1617
"""Make a directory into a versioned branch.
1619
Use this to create an empty branch, or before importing an
1622
If there is a repository in a parent directory of the location, then
1623
the history of the branch will be stored in the repository. Otherwise
1624
init creates a standalone branch which carries its own history
1625
in the .bzr directory.
1627
If there is already a branch at the location but it has no working tree,
1628
the tree can be populated with 'bzr checkout'.
1630
Recipe for importing a tree of files::
1636
bzr commit -m "imported project"
1639
_see_also = ['init-repository', 'branch', 'checkout']
1640
takes_args = ['location?']
1642
Option('create-prefix',
1643
help='Create the path leading up to the branch '
1644
'if it does not already exist.'),
1645
RegistryOption('format',
1646
help='Specify a format for this branch. '
1647
'See "help formats".',
1648
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1649
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1650
value_switches=True,
1651
title="Branch Format",
1653
Option('append-revisions-only',
1654
help='Never change revnos or the existing log.'
1655
' Append revisions to it only.')
1657
def run(self, location=None, format=None, append_revisions_only=False,
1658
create_prefix=False):
1660
format = bzrdir.format_registry.make_bzrdir('default')
1661
if location is None:
1664
to_transport = transport.get_transport(location)
1666
# The path has to exist to initialize a
1667
# branch inside of it.
1668
# Just using os.mkdir, since I don't
1669
# believe that we want to create a bunch of
1670
# locations if the user supplies an extended path
1672
to_transport.ensure_base()
1673
except errors.NoSuchFile:
1674
if not create_prefix:
1675
raise errors.BzrCommandError("Parent directory of %s"
1677
"\nYou may supply --create-prefix to create all"
1678
" leading parent directories."
1680
to_transport.create_prefix()
1683
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1684
except errors.NotBranchError:
1685
# really a NotBzrDir error...
1686
create_branch = bzrdir.BzrDir.create_branch_convenience
1687
branch = create_branch(to_transport.base, format=format,
1688
possible_transports=[to_transport])
1689
a_bzrdir = branch.bzrdir
1691
from bzrlib.transport.local import LocalTransport
1692
if a_bzrdir.has_branch():
1693
if (isinstance(to_transport, LocalTransport)
1694
and not a_bzrdir.has_workingtree()):
1695
raise errors.BranchExistsWithoutWorkingTree(location)
1696
raise errors.AlreadyBranchError(location)
1697
branch = a_bzrdir.create_branch()
1698
a_bzrdir.create_workingtree()
1699
if append_revisions_only:
1701
branch.set_append_revisions_only(True)
1702
except errors.UpgradeRequired:
1703
raise errors.BzrCommandError('This branch format cannot be set'
1704
' to append-revisions-only. Try --default.')
1706
from bzrlib.info import describe_layout, describe_format
1708
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1709
except (errors.NoWorkingTree, errors.NotLocalUrl):
1711
repository = branch.repository
1712
layout = describe_layout(repository, branch, tree).lower()
1713
format = describe_format(a_bzrdir, repository, branch, tree)
1714
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1715
if repository.is_shared():
1716
#XXX: maybe this can be refactored into transport.path_or_url()
1717
url = repository.bzrdir.root_transport.external_url()
1719
url = urlutils.local_path_from_url(url)
1720
except errors.InvalidURL:
1722
self.outf.write("Using shared repository: %s\n" % url)
1725
class cmd_init_repository(Command):
1726
"""Create a shared repository to hold branches.
1728
New branches created under the repository directory will store their
1729
revisions in the repository, not in the branch directory.
1731
If the --no-trees option is used then the branches in the repository
1732
will not have working trees by default.
1735
Create a shared repositories holding just branches::
1737
bzr init-repo --no-trees repo
1740
Make a lightweight checkout elsewhere::
1742
bzr checkout --lightweight repo/trunk trunk-checkout
1747
_see_also = ['init', 'branch', 'checkout', 'repositories']
1748
takes_args = ["location"]
1749
takes_options = [RegistryOption('format',
1750
help='Specify a format for this repository. See'
1751
' "bzr help formats" for details.',
1752
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1753
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1754
value_switches=True, title='Repository format'),
1756
help='Branches in the repository will default to'
1757
' not having a working tree.'),
1759
aliases = ["init-repo"]
1761
def run(self, location, format=None, no_trees=False):
1763
format = bzrdir.format_registry.make_bzrdir('default')
1765
if location is None:
1768
to_transport = transport.get_transport(location)
1769
to_transport.ensure_base()
1771
newdir = format.initialize_on_transport(to_transport)
1772
repo = newdir.create_repository(shared=True)
1773
repo.set_make_working_trees(not no_trees)
1775
from bzrlib.info import show_bzrdir_info
1776
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1779
class cmd_diff(Command):
1780
"""Show differences in the working tree, between revisions or branches.
1782
If no arguments are given, all changes for the current tree are listed.
1783
If files are given, only the changes in those files are listed.
1784
Remote and multiple branches can be compared by using the --old and
1785
--new options. If not provided, the default for both is derived from
1786
the first argument, if any, or the current tree if no arguments are
1789
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1790
produces patches suitable for "patch -p1".
1794
2 - unrepresentable changes
1799
Shows the difference in the working tree versus the last commit::
1803
Difference between the working tree and revision 1::
1807
Difference between revision 2 and revision 1::
1811
Difference between revision 2 and revision 1 for branch xxx::
1815
Show just the differences for file NEWS::
1819
Show the differences in working tree xxx for file NEWS::
1823
Show the differences from branch xxx to this working tree:
1827
Show the differences between two branches for file NEWS::
1829
bzr diff --old xxx --new yyy NEWS
1831
Same as 'bzr diff' but prefix paths with old/ and new/::
1833
bzr diff --prefix old/:new/
1835
_see_also = ['status']
1836
takes_args = ['file*']
1838
Option('diff-options', type=str,
1839
help='Pass these options to the external diff program.'),
1840
Option('prefix', type=str,
1842
help='Set prefixes added to old and new filenames, as '
1843
'two values separated by a colon. (eg "old/:new/").'),
1845
help='Branch/tree to compare from.',
1849
help='Branch/tree to compare to.',
1855
help='Use this command to compare files.',
1859
aliases = ['di', 'dif']
1860
encoding_type = 'exact'
1863
def run(self, revision=None, file_list=None, diff_options=None,
1864
prefix=None, old=None, new=None, using=None):
1865
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1867
if (prefix is None) or (prefix == '0'):
1875
old_label, new_label = prefix.split(":")
1877
raise errors.BzrCommandError(
1878
'--prefix expects two values separated by a colon'
1879
' (eg "old/:new/")')
1881
if revision and len(revision) > 2:
1882
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1883
' one or two revision specifiers')
1885
old_tree, new_tree, specific_files, extra_trees = \
1886
_get_trees_to_diff(file_list, revision, old, new,
1888
return show_diff_trees(old_tree, new_tree, sys.stdout,
1889
specific_files=specific_files,
1890
external_diff_options=diff_options,
1891
old_label=old_label, new_label=new_label,
1892
extra_trees=extra_trees, using=using)
1895
class cmd_deleted(Command):
1896
"""List files deleted in the working tree.
1898
# TODO: Show files deleted since a previous revision, or
1899
# between two revisions.
1900
# TODO: Much more efficient way to do this: read in new
1901
# directories with readdir, rather than stating each one. Same
1902
# level of effort but possibly much less IO. (Or possibly not,
1903
# if the directories are very large...)
1904
_see_also = ['status', 'ls']
1905
takes_options = ['show-ids']
1908
def run(self, show_ids=False):
1909
tree = WorkingTree.open_containing(u'.')[0]
1912
old = tree.basis_tree()
1915
for path, ie in old.inventory.iter_entries():
1916
if not tree.has_id(ie.file_id):
1917
self.outf.write(path)
1919
self.outf.write(' ')
1920
self.outf.write(ie.file_id)
1921
self.outf.write('\n')
1928
class cmd_modified(Command):
1929
"""List files modified in working tree.
1933
_see_also = ['status', 'ls']
1936
help='Write an ascii NUL (\\0) separator '
1937
'between files rather than a newline.')
1941
def run(self, null=False):
1942
tree = WorkingTree.open_containing(u'.')[0]
1943
td = tree.changes_from(tree.basis_tree())
1944
for path, id, kind, text_modified, meta_modified in td.modified:
1946
self.outf.write(path + '\0')
1948
self.outf.write(osutils.quotefn(path) + '\n')
1951
class cmd_added(Command):
1952
"""List files added in working tree.
1956
_see_also = ['status', 'ls']
1959
help='Write an ascii NUL (\\0) separator '
1960
'between files rather than a newline.')
1964
def run(self, null=False):
1965
wt = WorkingTree.open_containing(u'.')[0]
1968
basis = wt.basis_tree()
1971
basis_inv = basis.inventory
1974
if file_id in basis_inv:
1976
if inv.is_root(file_id) and len(basis_inv) == 0:
1978
path = inv.id2path(file_id)
1979
if not os.access(osutils.abspath(path), os.F_OK):
1982
self.outf.write(path + '\0')
1984
self.outf.write(osutils.quotefn(path) + '\n')
1991
class cmd_root(Command):
1992
"""Show the tree root directory.
1994
The root is the nearest enclosing directory with a .bzr control
1997
takes_args = ['filename?']
1999
def run(self, filename=None):
2000
"""Print the branch root."""
2001
tree = WorkingTree.open_containing(filename)[0]
2002
self.outf.write(tree.basedir + '\n')
2005
def _parse_limit(limitstring):
2007
return int(limitstring)
2009
msg = "The limit argument must be an integer."
2010
raise errors.BzrCommandError(msg)
2013
def _parse_levels(s):
2017
msg = "The levels argument must be an integer."
2018
raise errors.BzrCommandError(msg)
2021
class cmd_log(Command):
2022
"""Show historical log for a branch or subset of a branch.
2024
log is bzr's default tool for exploring the history of a branch.
2025
The branch to use is taken from the first parameter. If no parameters
2026
are given, the branch containing the working directory is logged.
2027
Here are some simple examples::
2029
bzr log log the current branch
2030
bzr log foo.py log a file in its branch
2031
bzr log http://server/branch log a branch on a server
2033
The filtering, ordering and information shown for each revision can
2034
be controlled as explained below. By default, all revisions are
2035
shown sorted (topologically) so that newer revisions appear before
2036
older ones and descendants always appear before ancestors. If displayed,
2037
merged revisions are shown indented under the revision in which they
2042
The log format controls how information about each revision is
2043
displayed. The standard log formats are called ``long``, ``short``
2044
and ``line``. The default is long. See ``bzr help log-formats``
2045
for more details on log formats.
2047
The following options can be used to control what information is
2050
-l N display a maximum of N revisions
2051
-n N display N levels of revisions (0 for all, 1 for collapsed)
2052
-v display a status summary (delta) for each revision
2053
-p display a diff (patch) for each revision
2054
--show-ids display revision-ids (and file-ids), not just revnos
2056
Note that the default number of levels to display is a function of the
2057
log format. If the -n option is not used, the standard log formats show
2058
just the top level (mainline).
2060
Status summaries are shown using status flags like A, M, etc. To see
2061
the changes explained using words like ``added`` and ``modified``
2062
instead, use the -vv option.
2066
To display revisions from oldest to newest, use the --forward option.
2067
In most cases, using this option will have little impact on the total
2068
time taken to produce a log, though --forward does not incrementally
2069
display revisions like --reverse does when it can.
2071
:Revision filtering:
2073
The -r option can be used to specify what revision or range of revisions
2074
to filter against. The various forms are shown below::
2076
-rX display revision X
2077
-rX.. display revision X and later
2078
-r..Y display up to and including revision Y
2079
-rX..Y display from X to Y inclusive
2081
See ``bzr help revisionspec`` for details on how to specify X and Y.
2082
Some common examples are given below::
2084
-r-1 show just the tip
2085
-r-10.. show the last 10 mainline revisions
2086
-rsubmit:.. show what's new on this branch
2087
-rancestor:path.. show changes since the common ancestor of this
2088
branch and the one at location path
2089
-rdate:yesterday.. show changes since yesterday
2091
When logging a range of revisions using -rX..Y, log starts at
2092
revision Y and searches back in history through the primary
2093
("left-hand") parents until it finds X. When logging just the
2094
top level (using -n1), an error is reported if X is not found
2095
along the way. If multi-level logging is used (-n0), X may be
2096
a nested merge revision and the log will be truncated accordingly.
2100
If parameters are given and the first one is not a branch, the log
2101
will be filtered to show only those revisions that changed the
2102
nominated files or directories.
2104
Filenames are interpreted within their historical context. To log a
2105
deleted file, specify a revision range so that the file existed at
2106
the end or start of the range.
2108
Historical context is also important when interpreting pathnames of
2109
renamed files/directories. Consider the following example:
2111
* revision 1: add tutorial.txt
2112
* revision 2: modify tutorial.txt
2113
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2117
* ``bzr log guide.txt`` will log the file added in revision 1
2119
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2121
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2122
the original file in revision 2.
2124
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2125
was no file called guide.txt in revision 2.
2127
Renames are always followed by log. By design, there is no need to
2128
explicitly ask for this (and no way to stop logging a file back
2129
until it was last renamed).
2133
The --message option can be used for finding revisions that match a
2134
regular expression in a commit message.
2138
GUI tools and IDEs are often better at exploring history than command
2139
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2140
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2141
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2143
Web interfaces are often better at exploring history than command line
2144
tools, particularly for branches on servers. You may prefer Loggerhead
2145
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2147
You may find it useful to add the aliases below to ``bazaar.conf``::
2151
top = log -l10 --line
2154
``bzr tip`` will then show the latest revision while ``bzr top``
2155
will show the last 10 mainline revisions. To see the details of a
2156
particular revision X, ``bzr show -rX``.
2158
If you are interested in looking deeper into a particular merge X,
2159
use ``bzr log -n0 -rX``.
2161
``bzr log -v`` on a branch with lots of history is currently
2162
very slow. A fix for this issue is currently under development.
2163
With or without that fix, it is recommended that a revision range
2164
be given when using the -v option.
2166
bzr has a generic full-text matching plugin, bzr-search, that can be
2167
used to find revisions matching user names, commit messages, etc.
2168
Among other features, this plugin can find all revisions containing
2169
a list of words but not others.
2171
When exploring non-mainline history on large projects with deep
2172
history, the performance of log can be greatly improved by installing
2173
the historycache plugin. This plugin buffers historical information
2174
trading disk space for faster speed.
2176
takes_args = ['file*']
2177
_see_also = ['log-formats', 'revisionspec']
2180
help='Show from oldest to newest.'),
2182
custom_help('verbose',
2183
help='Show files changed in each revision.'),
2187
type=bzrlib.option._parse_revision_str,
2189
help='Show just the specified revision.'
2190
' See also "help revisionspec".'),
2194
help='Number of levels to display - 0 for all, 1 for flat.',
2196
type=_parse_levels),
2199
help='Show revisions whose message matches this '
2200
'regular expression.',
2204
help='Limit the output to the first N revisions.',
2209
help='Show changes made in each revision as a patch.'),
2210
Option('include-merges',
2211
help='Show merged revisions like --levels 0 does.'),
2213
encoding_type = 'replace'
2216
def run(self, file_list=None, timezone='original',
2227
include_merges=False):
2228
from bzrlib.log import (
2230
make_log_request_dict,
2231
_get_info_for_log_files,
2233
direction = (forward and 'forward') or 'reverse'
2238
raise errors.BzrCommandError(
2239
'--levels and --include-merges are mutually exclusive')
2241
if change is not None:
2243
raise errors.RangeInChangeOption()
2244
if revision is not None:
2245
raise errors.BzrCommandError(
2246
'--revision and --change are mutually exclusive')
2251
filter_by_dir = False
2253
# find the file ids to log and check for directory filtering
2254
b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2256
for relpath, file_id, kind in file_info_list:
2258
raise errors.BzrCommandError(
2259
"Path unknown at end or start of revision range: %s" %
2261
# If the relpath is the top of the tree, we log everything
2266
file_ids.append(file_id)
2267
filter_by_dir = filter_by_dir or (
2268
kind in ['directory', 'tree-reference'])
2271
# FIXME ? log the current subdir only RBC 20060203
2272
if revision is not None \
2273
and len(revision) > 0 and revision[0].get_branch():
2274
location = revision[0].get_branch()
2277
dir, relpath = bzrdir.BzrDir.open_containing(location)
2278
b = dir.open_branch()
2279
rev1, rev2 = _get_revision_range(revision, b, self.name())
2281
# Decide on the type of delta & diff filtering to use
2282
# TODO: add an --all-files option to make this configurable & consistent
2290
diff_type = 'partial'
2296
# Build the log formatter
2297
if log_format is None:
2298
log_format = log.log_formatter_registry.get_default(b)
2299
lf = log_format(show_ids=show_ids, to_file=self.outf,
2300
show_timezone=timezone,
2301
delta_format=get_verbosity_level(),
2303
show_advice=levels is None)
2305
# Choose the algorithm for doing the logging. It's annoying
2306
# having multiple code paths like this but necessary until
2307
# the underlying repository format is faster at generating
2308
# deltas or can provide everything we need from the indices.
2309
# The default algorithm - match-using-deltas - works for
2310
# multiple files and directories and is faster for small
2311
# amounts of history (200 revisions say). However, it's too
2312
# slow for logging a single file in a repository with deep
2313
# history, i.e. > 10K revisions. In the spirit of "do no
2314
# evil when adding features", we continue to use the
2315
# original algorithm - per-file-graph - for the "single
2316
# file that isn't a directory without showing a delta" case.
2317
partial_history = revision and b.repository._format.supports_chks
2318
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2319
or delta_type or partial_history)
2321
# Build the LogRequest and execute it
2322
if len(file_ids) == 0:
2324
rqst = make_log_request_dict(
2325
direction=direction, specific_fileids=file_ids,
2326
start_revision=rev1, end_revision=rev2, limit=limit,
2327
message_search=message, delta_type=delta_type,
2328
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2329
Logger(b, rqst).show(lf)
2334
def _get_revision_range(revisionspec_list, branch, command_name):
2335
"""Take the input of a revision option and turn it into a revision range.
2337
It returns RevisionInfo objects which can be used to obtain the rev_id's
2338
of the desired revisions. It does some user input validations.
2340
if revisionspec_list is None:
2343
elif len(revisionspec_list) == 1:
2344
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2345
elif len(revisionspec_list) == 2:
2346
start_spec = revisionspec_list[0]
2347
end_spec = revisionspec_list[1]
2348
if end_spec.get_branch() != start_spec.get_branch():
2349
# b is taken from revision[0].get_branch(), and
2350
# show_log will use its revision_history. Having
2351
# different branches will lead to weird behaviors.
2352
raise errors.BzrCommandError(
2353
"bzr %s doesn't accept two revisions in different"
2354
" branches." % command_name)
2355
rev1 = start_spec.in_history(branch)
2356
# Avoid loading all of history when we know a missing
2357
# end of range means the last revision ...
2358
if end_spec.spec is None:
2359
last_revno, last_revision_id = branch.last_revision_info()
2360
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2362
rev2 = end_spec.in_history(branch)
2364
raise errors.BzrCommandError(
2365
'bzr %s --revision takes one or two values.' % command_name)
2369
def _revision_range_to_revid_range(revision_range):
2372
if revision_range[0] is not None:
2373
rev_id1 = revision_range[0].rev_id
2374
if revision_range[1] is not None:
2375
rev_id2 = revision_range[1].rev_id
2376
return rev_id1, rev_id2
2378
def get_log_format(long=False, short=False, line=False, default='long'):
2379
log_format = default
2383
log_format = 'short'
2389
class cmd_touching_revisions(Command):
2390
"""Return revision-ids which affected a particular file.
2392
A more user-friendly interface is "bzr log FILE".
2396
takes_args = ["filename"]
2399
def run(self, filename):
2400
tree, relpath = WorkingTree.open_containing(filename)
2402
file_id = tree.path2id(relpath)
2403
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2404
self.outf.write("%6d %s\n" % (revno, what))
2407
class cmd_ls(Command):
2408
"""List files in a tree.
2411
_see_also = ['status', 'cat']
2412
takes_args = ['path?']
2416
Option('recursive', short_name='R',
2417
help='Recurse into subdirectories.'),
2419
help='Print paths relative to the root of the branch.'),
2420
Option('unknown', help='Print unknown files.'),
2421
Option('versioned', help='Print versioned files.',
2423
Option('ignored', help='Print ignored files.'),
2425
help='Write an ascii NUL (\\0) separator '
2426
'between files rather than a newline.'),
2428
help='List entries of a particular kind: file, directory, symlink.',
2433
def run(self, revision=None, verbose=False,
2434
recursive=False, from_root=False,
2435
unknown=False, versioned=False, ignored=False,
2436
null=False, kind=None, show_ids=False, path=None):
2438
if kind and kind not in ('file', 'directory', 'symlink'):
2439
raise errors.BzrCommandError('invalid kind specified')
2441
if verbose and null:
2442
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2443
all = not (unknown or versioned or ignored)
2445
selection = {'I':ignored, '?':unknown, 'V':versioned}
2451
raise errors.BzrCommandError('cannot specify both --from-root'
2454
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2457
# Calculate the prefix to use
2461
prefix = relpath + '/'
2462
elif fs_path != '.':
2463
prefix = fs_path + '/'
2465
if revision is not None or tree is None:
2466
tree = _get_one_revision_tree('ls', revision, branch=branch)
2469
if isinstance(tree, WorkingTree) and tree.supports_views():
2470
view_files = tree.views.lookup_view()
2473
view_str = views.view_display_str(view_files)
2474
note("Ignoring files outside view. View is %s" % view_str)
2478
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2479
from_dir=relpath, recursive=recursive):
2480
# Apply additional masking
2481
if not all and not selection[fc]:
2483
if kind is not None and fkind != kind:
2488
fullpath = osutils.pathjoin(relpath, fp)
2491
views.check_path_in_view(tree, fullpath)
2492
except errors.FileOutsideView:
2497
fp = osutils.pathjoin(prefix, fp)
2498
kindch = entry.kind_character()
2499
outstring = fp + kindch
2500
ui.ui_factory.clear_term()
2502
outstring = '%-8s %s' % (fc, outstring)
2503
if show_ids and fid is not None:
2504
outstring = "%-50s %s" % (outstring, fid)
2505
self.outf.write(outstring + '\n')
2507
self.outf.write(fp + '\0')
2510
self.outf.write(fid)
2511
self.outf.write('\0')
2519
self.outf.write('%-50s %s\n' % (outstring, my_id))
2521
self.outf.write(outstring + '\n')
2526
class cmd_unknowns(Command):
2527
"""List unknown files.
2535
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2536
self.outf.write(osutils.quotefn(f) + '\n')
2539
class cmd_ignore(Command):
2540
"""Ignore specified files or patterns.
2542
See ``bzr help patterns`` for details on the syntax of patterns.
2544
To remove patterns from the ignore list, edit the .bzrignore file.
2545
After adding, editing or deleting that file either indirectly by
2546
using this command or directly by using an editor, be sure to commit
2549
Note: ignore patterns containing shell wildcards must be quoted from
2553
Ignore the top level Makefile::
2555
bzr ignore ./Makefile
2557
Ignore class files in all directories::
2559
bzr ignore "*.class"
2561
Ignore .o files under the lib directory::
2563
bzr ignore "lib/**/*.o"
2565
Ignore .o files under the lib directory::
2567
bzr ignore "RE:lib/.*\.o"
2569
Ignore everything but the "debian" toplevel directory::
2571
bzr ignore "RE:(?!debian/).*"
2574
_see_also = ['status', 'ignored', 'patterns']
2575
takes_args = ['name_pattern*']
2577
Option('old-default-rules',
2578
help='Write out the ignore rules bzr < 0.9 always used.')
2581
def run(self, name_pattern_list=None, old_default_rules=None):
2582
from bzrlib import ignores
2583
if old_default_rules is not None:
2584
# dump the rules and exit
2585
for pattern in ignores.OLD_DEFAULTS:
2588
if not name_pattern_list:
2589
raise errors.BzrCommandError("ignore requires at least one "
2590
"NAME_PATTERN or --old-default-rules")
2591
name_pattern_list = [globbing.normalize_pattern(p)
2592
for p in name_pattern_list]
2593
for name_pattern in name_pattern_list:
2594
if (name_pattern[0] == '/' or
2595
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2596
raise errors.BzrCommandError(
2597
"NAME_PATTERN should not be an absolute path")
2598
tree, relpath = WorkingTree.open_containing(u'.')
2599
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2600
ignored = globbing.Globster(name_pattern_list)
2603
for entry in tree.list_files():
2607
if ignored.match(filename):
2608
matches.append(filename.encode('utf-8'))
2610
if len(matches) > 0:
2611
print "Warning: the following files are version controlled and" \
2612
" match your ignore pattern:\n%s" \
2613
"\nThese files will continue to be version controlled" \
2614
" unless you 'bzr remove' them." % ("\n".join(matches),)
2617
class cmd_ignored(Command):
2618
"""List ignored files and the patterns that matched them.
2620
List all the ignored files and the ignore pattern that caused the file to
2623
Alternatively, to list just the files::
2628
encoding_type = 'replace'
2629
_see_also = ['ignore', 'ls']
2633
tree = WorkingTree.open_containing(u'.')[0]
2636
for path, file_class, kind, file_id, entry in tree.list_files():
2637
if file_class != 'I':
2639
## XXX: Slightly inefficient since this was already calculated
2640
pat = tree.is_ignored(path)
2641
self.outf.write('%-50s %s\n' % (path, pat))
2646
class cmd_lookup_revision(Command):
2647
"""Lookup the revision-id from a revision-number
2650
bzr lookup-revision 33
2653
takes_args = ['revno']
2656
def run(self, revno):
2660
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2662
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2665
class cmd_export(Command):
2666
"""Export current or past revision to a destination directory or archive.
2668
If no revision is specified this exports the last committed revision.
2670
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2671
given, try to find the format with the extension. If no extension
2672
is found exports to a directory (equivalent to --format=dir).
2674
If root is supplied, it will be used as the root directory inside
2675
container formats (tar, zip, etc). If it is not supplied it will default
2676
to the exported filename. The root option has no effect for 'dir' format.
2678
If branch is omitted then the branch containing the current working
2679
directory will be used.
2681
Note: Export of tree with non-ASCII filenames to zip is not supported.
2683
================= =========================
2684
Supported formats Autodetected by extension
2685
================= =========================
2688
tbz2 .tar.bz2, .tbz2
2691
================= =========================
2693
takes_args = ['dest', 'branch_or_subdir?']
2696
help="Type of file to export to.",
2699
Option('filters', help='Apply content filters to export the '
2700
'convenient form.'),
2703
help="Name of the root directory inside the exported file."),
2705
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2706
root=None, filters=False):
2707
from bzrlib.export import export
2709
if branch_or_subdir is None:
2710
tree = WorkingTree.open_containing(u'.')[0]
2714
b, subdir = Branch.open_containing(branch_or_subdir)
2717
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2719
export(rev_tree, dest, format, root, subdir, filtered=filters)
2720
except errors.NoSuchExportFormat, e:
2721
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2724
class cmd_cat(Command):
2725
"""Write the contents of a file as of a given revision to standard output.
2727
If no revision is nominated, the last revision is used.
2729
Note: Take care to redirect standard output when using this command on a
2735
Option('name-from-revision', help='The path name in the old tree.'),
2736
Option('filters', help='Apply content filters to display the '
2737
'convenience form.'),
2740
takes_args = ['filename']
2741
encoding_type = 'exact'
2744
def run(self, filename, revision=None, name_from_revision=False,
2746
if revision is not None and len(revision) != 1:
2747
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2748
" one revision specifier")
2749
tree, branch, relpath = \
2750
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2753
return self._run(tree, branch, relpath, filename, revision,
2754
name_from_revision, filters)
2758
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2761
tree = b.basis_tree()
2762
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2764
old_file_id = rev_tree.path2id(relpath)
2766
if name_from_revision:
2767
# Try in revision if requested
2768
if old_file_id is None:
2769
raise errors.BzrCommandError(
2770
"%r is not present in revision %s" % (
2771
filename, rev_tree.get_revision_id()))
2773
content = rev_tree.get_file_text(old_file_id)
2775
cur_file_id = tree.path2id(relpath)
2777
if cur_file_id is not None:
2778
# Then try with the actual file id
2780
content = rev_tree.get_file_text(cur_file_id)
2782
except errors.NoSuchId:
2783
# The actual file id didn't exist at that time
2785
if not found and old_file_id is not None:
2786
# Finally try with the old file id
2787
content = rev_tree.get_file_text(old_file_id)
2790
# Can't be found anywhere
2791
raise errors.BzrCommandError(
2792
"%r is not present in revision %s" % (
2793
filename, rev_tree.get_revision_id()))
2795
from bzrlib.filters import (
2796
ContentFilterContext,
2797
filtered_output_bytes,
2799
filters = rev_tree._content_filter_stack(relpath)
2800
chunks = content.splitlines(True)
2801
content = filtered_output_bytes(chunks, filters,
2802
ContentFilterContext(relpath, rev_tree))
2803
self.outf.writelines(content)
2805
self.outf.write(content)
2808
class cmd_local_time_offset(Command):
2809
"""Show the offset in seconds from GMT to local time."""
2813
print osutils.local_time_offset()
2817
class cmd_commit(Command):
2818
"""Commit changes into a new revision.
2820
An explanatory message needs to be given for each commit. This is
2821
often done by using the --message option (getting the message from the
2822
command line) or by using the --file option (getting the message from
2823
a file). If neither of these options is given, an editor is opened for
2824
the user to enter the message. To see the changed files in the
2825
boilerplate text loaded into the editor, use the --show-diff option.
2827
By default, the entire tree is committed and the person doing the
2828
commit is assumed to be the author. These defaults can be overridden
2833
If selected files are specified, only changes to those files are
2834
committed. If a directory is specified then the directory and
2835
everything within it is committed.
2837
When excludes are given, they take precedence over selected files.
2838
For example, to commit only changes within foo, but not changes
2841
bzr commit foo -x foo/bar
2843
A selective commit after a merge is not yet supported.
2847
If the author of the change is not the same person as the committer,
2848
you can specify the author's name using the --author option. The
2849
name should be in the same format as a committer-id, e.g.
2850
"John Doe <jdoe@example.com>". If there is more than one author of
2851
the change you can specify the option multiple times, once for each
2856
A common mistake is to forget to add a new file or directory before
2857
running the commit command. The --strict option checks for unknown
2858
files and aborts the commit if any are found. More advanced pre-commit
2859
checks can be implemented by defining hooks. See ``bzr help hooks``
2864
If you accidentially commit the wrong changes or make a spelling
2865
mistake in the commit message say, you can use the uncommit command
2866
to undo it. See ``bzr help uncommit`` for details.
2868
Hooks can also be configured to run after a commit. This allows you
2869
to trigger updates to external systems like bug trackers. The --fixes
2870
option can be used to record the association between a revision and
2871
one or more bugs. See ``bzr help bugs`` for details.
2873
A selective commit may fail in some cases where the committed
2874
tree would be invalid. Consider::
2879
bzr commit foo -m "committing foo"
2880
bzr mv foo/bar foo/baz
2883
bzr commit foo/bar -m "committing bar but not baz"
2885
In the example above, the last commit will fail by design. This gives
2886
the user the opportunity to decide whether they want to commit the
2887
rename at the same time, separately first, or not at all. (As a general
2888
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2890
# TODO: Run hooks on tree to-be-committed, and after commit.
2892
# TODO: Strict commit that fails if there are deleted files.
2893
# (what does "deleted files" mean ??)
2895
# TODO: Give better message for -s, --summary, used by tla people
2897
# XXX: verbose currently does nothing
2899
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2900
takes_args = ['selected*']
2902
ListOption('exclude', type=str, short_name='x',
2903
help="Do not consider changes made to a given path."),
2904
Option('message', type=unicode,
2906
help="Description of the new revision."),
2909
help='Commit even if nothing has changed.'),
2910
Option('file', type=str,
2913
help='Take commit message from this file.'),
2915
help="Refuse to commit if there are unknown "
2916
"files in the working tree."),
2917
ListOption('fixes', type=str,
2918
help="Mark a bug as being fixed by this revision "
2919
"(see \"bzr help bugs\")."),
2920
ListOption('author', type=unicode,
2921
help="Set the author's name, if it's different "
2922
"from the committer."),
2924
help="Perform a local commit in a bound "
2925
"branch. Local commits are not pushed to "
2926
"the master branch until a normal commit "
2930
help='When no message is supplied, show the diff along'
2931
' with the status summary in the message editor.'),
2933
aliases = ['ci', 'checkin']
2935
def _iter_bug_fix_urls(self, fixes, branch):
2936
# Configure the properties for bug fixing attributes.
2937
for fixed_bug in fixes:
2938
tokens = fixed_bug.split(':')
2939
if len(tokens) != 2:
2940
raise errors.BzrCommandError(
2941
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2942
"See \"bzr help bugs\" for more information on this "
2943
"feature.\nCommit refused." % fixed_bug)
2944
tag, bug_id = tokens
2946
yield bugtracker.get_bug_url(tag, branch, bug_id)
2947
except errors.UnknownBugTrackerAbbreviation:
2948
raise errors.BzrCommandError(
2949
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2950
except errors.MalformedBugIdentifier, e:
2951
raise errors.BzrCommandError(
2952
"%s\nCommit refused." % (str(e),))
2954
def run(self, message=None, file=None, verbose=False, selected_list=None,
2955
unchanged=False, strict=False, local=False, fixes=None,
2956
author=None, show_diff=False, exclude=None):
2957
from bzrlib.errors import (
2962
from bzrlib.msgeditor import (
2963
edit_commit_message_encoded,
2964
generate_commit_message_template,
2965
make_commit_message_template_encoded
2968
# TODO: Need a blackbox test for invoking the external editor; may be
2969
# slightly problematic to run this cross-platform.
2971
# TODO: do more checks that the commit will succeed before
2972
# spending the user's valuable time typing a commit message.
2976
tree, selected_list = tree_files(selected_list)
2977
if selected_list == ['']:
2978
# workaround - commit of root of tree should be exactly the same
2979
# as just default commit in that tree, and succeed even though
2980
# selected-file merge commit is not done yet
2985
bug_property = bugtracker.encode_fixes_bug_urls(
2986
self._iter_bug_fix_urls(fixes, tree.branch))
2988
properties['bugs'] = bug_property
2990
if local and not tree.branch.get_bound_location():
2991
raise errors.LocalRequiresBoundBranch()
2993
def get_message(commit_obj):
2994
"""Callback to get commit message"""
2995
my_message = message
2996
if my_message is None and not file:
2997
t = make_commit_message_template_encoded(tree,
2998
selected_list, diff=show_diff,
2999
output_encoding=osutils.get_user_encoding())
3000
start_message = generate_commit_message_template(commit_obj)
3001
my_message = edit_commit_message_encoded(t,
3002
start_message=start_message)
3003
if my_message is None:
3004
raise errors.BzrCommandError("please specify a commit"
3005
" message with either --message or --file")
3006
elif my_message and file:
3007
raise errors.BzrCommandError(
3008
"please specify either --message or --file")
3010
my_message = codecs.open(file, 'rt',
3011
osutils.get_user_encoding()).read()
3012
if my_message == "":
3013
raise errors.BzrCommandError("empty commit message specified")
3017
tree.commit(message_callback=get_message,
3018
specific_files=selected_list,
3019
allow_pointless=unchanged, strict=strict, local=local,
3020
reporter=None, verbose=verbose, revprops=properties,
3022
exclude=safe_relpath_files(tree, exclude))
3023
except PointlessCommit:
3024
# FIXME: This should really happen before the file is read in;
3025
# perhaps prepare the commit; get the message; then actually commit
3026
raise errors.BzrCommandError("No changes to commit."
3027
" Use --unchanged to commit anyhow.")
3028
except ConflictsInTree:
3029
raise errors.BzrCommandError('Conflicts detected in working '
3030
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3032
except StrictCommitFailed:
3033
raise errors.BzrCommandError("Commit refused because there are"
3034
" unknown files in the working tree.")
3035
except errors.BoundBranchOutOfDate, e:
3036
raise errors.BzrCommandError(str(e) + "\n"
3037
'To commit to master branch, run update and then commit.\n'
3038
'You can also pass --local to commit to continue working '
3042
class cmd_check(Command):
3043
"""Validate working tree structure, branch consistency and repository history.
3045
This command checks various invariants about branch and repository storage
3046
to detect data corruption or bzr bugs.
3048
The working tree and branch checks will only give output if a problem is
3049
detected. The output fields of the repository check are:
3052
This is just the number of revisions checked. It doesn't
3056
This is just the number of versionedfiles checked. It
3057
doesn't indicate a problem.
3059
unreferenced ancestors
3060
Texts that are ancestors of other texts, but
3061
are not properly referenced by the revision ancestry. This is a
3062
subtle problem that Bazaar can work around.
3065
This is the total number of unique file contents
3066
seen in the checked revisions. It does not indicate a problem.
3069
This is the total number of repeated texts seen
3070
in the checked revisions. Texts can be repeated when their file
3071
entries are modified, but the file contents are not. It does not
3074
If no restrictions are specified, all Bazaar data that is found at the given
3075
location will be checked.
3079
Check the tree and branch at 'foo'::
3081
bzr check --tree --branch foo
3083
Check only the repository at 'bar'::
3085
bzr check --repo bar
3087
Check everything at 'baz'::
3092
_see_also = ['reconcile']
3093
takes_args = ['path?']
3094
takes_options = ['verbose',
3095
Option('branch', help="Check the branch related to the"
3096
" current directory."),
3097
Option('repo', help="Check the repository related to the"
3098
" current directory."),
3099
Option('tree', help="Check the working tree related to"
3100
" the current directory.")]
3102
def run(self, path=None, verbose=False, branch=False, repo=False,
3104
from bzrlib.check import check_dwim
3107
if not branch and not repo and not tree:
3108
branch = repo = tree = True
3109
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3112
class cmd_upgrade(Command):
3113
"""Upgrade branch storage to current format.
3115
The check command or bzr developers may sometimes advise you to run
3116
this command. When the default format has changed you may also be warned
3117
during other operations to upgrade.
3120
_see_also = ['check']
3121
takes_args = ['url?']
3123
RegistryOption('format',
3124
help='Upgrade to a specific format. See "bzr help'
3125
' formats" for details.',
3126
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3127
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3128
value_switches=True, title='Branch format'),
3131
def run(self, url='.', format=None):
3132
from bzrlib.upgrade import upgrade
3133
upgrade(url, format)
3136
class cmd_whoami(Command):
3137
"""Show or set bzr user id.
3140
Show the email of the current user::
3144
Set the current user::
3146
bzr whoami "Frank Chu <fchu@example.com>"
3148
takes_options = [ Option('email',
3149
help='Display email address only.'),
3151
help='Set identity for the current branch instead of '
3154
takes_args = ['name?']
3155
encoding_type = 'replace'
3158
def run(self, email=False, branch=False, name=None):
3160
# use branch if we're inside one; otherwise global config
3162
c = Branch.open_containing('.')[0].get_config()
3163
except errors.NotBranchError:
3164
c = config.GlobalConfig()
3166
self.outf.write(c.user_email() + '\n')
3168
self.outf.write(c.username() + '\n')
3171
# display a warning if an email address isn't included in the given name.
3173
config.extract_email_address(name)
3174
except errors.NoEmailInUsername, e:
3175
warning('"%s" does not seem to contain an email address. '
3176
'This is allowed, but not recommended.', name)
3178
# use global config unless --branch given
3180
c = Branch.open_containing('.')[0].get_config()
3182
c = config.GlobalConfig()
3183
c.set_user_option('email', name)
3186
class cmd_nick(Command):
3187
"""Print or set the branch nickname.
3189
If unset, the tree root directory name is used as the nickname.
3190
To print the current nickname, execute with no argument.
3192
Bound branches use the nickname of its master branch unless it is set
3196
_see_also = ['info']
3197
takes_args = ['nickname?']
3198
def run(self, nickname=None):
3199
branch = Branch.open_containing(u'.')[0]
3200
if nickname is None:
3201
self.printme(branch)
3203
branch.nick = nickname
3206
def printme(self, branch):
3210
class cmd_alias(Command):
3211
"""Set/unset and display aliases.
3214
Show the current aliases::
3218
Show the alias specified for 'll'::
3222
Set an alias for 'll'::
3224
bzr alias ll="log --line -r-10..-1"
3226
To remove an alias for 'll'::
3228
bzr alias --remove ll
3231
takes_args = ['name?']
3233
Option('remove', help='Remove the alias.'),
3236
def run(self, name=None, remove=False):
3238
self.remove_alias(name)
3240
self.print_aliases()
3242
equal_pos = name.find('=')
3244
self.print_alias(name)
3246
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3248
def remove_alias(self, alias_name):
3249
if alias_name is None:
3250
raise errors.BzrCommandError(
3251
'bzr alias --remove expects an alias to remove.')
3252
# If alias is not found, print something like:
3253
# unalias: foo: not found
3254
c = config.GlobalConfig()
3255
c.unset_alias(alias_name)
3258
def print_aliases(self):
3259
"""Print out the defined aliases in a similar format to bash."""
3260
aliases = config.GlobalConfig().get_aliases()
3261
for key, value in sorted(aliases.iteritems()):
3262
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3265
def print_alias(self, alias_name):
3266
from bzrlib.commands import get_alias
3267
alias = get_alias(alias_name)
3269
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3272
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3274
def set_alias(self, alias_name, alias_command):
3275
"""Save the alias in the global config."""
3276
c = config.GlobalConfig()
3277
c.set_alias(alias_name, alias_command)
3280
class cmd_selftest(Command):
3281
"""Run internal test suite.
3283
If arguments are given, they are regular expressions that say which tests
3284
should run. Tests matching any expression are run, and other tests are
3287
Alternatively if --first is given, matching tests are run first and then
3288
all other tests are run. This is useful if you have been working in a
3289
particular area, but want to make sure nothing else was broken.
3291
If --exclude is given, tests that match that regular expression are
3292
excluded, regardless of whether they match --first or not.
3294
To help catch accidential dependencies between tests, the --randomize
3295
option is useful. In most cases, the argument used is the word 'now'.
3296
Note that the seed used for the random number generator is displayed
3297
when this option is used. The seed can be explicitly passed as the
3298
argument to this option if required. This enables reproduction of the
3299
actual ordering used if and when an order sensitive problem is encountered.
3301
If --list-only is given, the tests that would be run are listed. This is
3302
useful when combined with --first, --exclude and/or --randomize to
3303
understand their impact. The test harness reports "Listed nn tests in ..."
3304
instead of "Ran nn tests in ..." when list mode is enabled.
3306
If the global option '--no-plugins' is given, plugins are not loaded
3307
before running the selftests. This has two effects: features provided or
3308
modified by plugins will not be tested, and tests provided by plugins will
3311
Tests that need working space on disk use a common temporary directory,
3312
typically inside $TMPDIR or /tmp.
3315
Run only tests relating to 'ignore'::
3319
Disable plugins and list tests as they're run::
3321
bzr --no-plugins selftest -v
3323
# NB: this is used from the class without creating an instance, which is
3324
# why it does not have a self parameter.
3325
def get_transport_type(typestring):
3326
"""Parse and return a transport specifier."""
3327
if typestring == "sftp":
3328
from bzrlib.transport.sftp import SFTPAbsoluteServer
3329
return SFTPAbsoluteServer
3330
if typestring == "memory":
3331
from bzrlib.transport.memory import MemoryServer
3333
if typestring == "fakenfs":
3334
from bzrlib.transport.fakenfs import FakeNFSServer
3335
return FakeNFSServer
3336
msg = "No known transport type %s. Supported types are: sftp\n" %\
3338
raise errors.BzrCommandError(msg)
3341
takes_args = ['testspecs*']
3342
takes_options = ['verbose',
3344
help='Stop when one test fails.',
3348
help='Use a different transport by default '
3349
'throughout the test suite.',
3350
type=get_transport_type),
3352
help='Run the benchmarks rather than selftests.'),
3353
Option('lsprof-timed',
3354
help='Generate lsprof output for benchmarked'
3355
' sections of code.'),
3356
Option('cache-dir', type=str,
3357
help='Cache intermediate benchmark output in this '
3360
help='Run all tests, but run specified tests first.',
3364
help='List the tests instead of running them.'),
3365
RegistryOption('parallel',
3366
help="Run the test suite in parallel.",
3367
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3368
value_switches=False,
3370
Option('randomize', type=str, argname="SEED",
3371
help='Randomize the order of tests using the given'
3372
' seed or "now" for the current time.'),
3373
Option('exclude', type=str, argname="PATTERN",
3375
help='Exclude tests that match this regular'
3378
help='Output test progress via subunit.'),
3379
Option('strict', help='Fail on missing dependencies or '
3381
Option('load-list', type=str, argname='TESTLISTFILE',
3382
help='Load a test id list from a text file.'),
3383
ListOption('debugflag', type=str, short_name='E',
3384
help='Turn on a selftest debug flag.'),
3385
ListOption('starting-with', type=str, argname='TESTID',
3386
param_name='starting_with', short_name='s',
3388
'Load only the tests starting with TESTID.'),
3390
encoding_type = 'replace'
3393
Command.__init__(self)
3394
self.additional_selftest_args = {}
3396
def run(self, testspecs_list=None, verbose=False, one=False,
3397
transport=None, benchmark=None,
3398
lsprof_timed=None, cache_dir=None,
3399
first=False, list_only=False,
3400
randomize=None, exclude=None, strict=False,
3401
load_list=None, debugflag=None, starting_with=None, subunit=False,
3403
from bzrlib.tests import selftest
3404
import bzrlib.benchmarks as benchmarks
3405
from bzrlib.benchmarks import tree_creator
3407
# Make deprecation warnings visible, unless -Werror is set
3408
symbol_versioning.activate_deprecation_warnings(override=False)
3410
if cache_dir is not None:
3411
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3412
if testspecs_list is not None:
3413
pattern = '|'.join(testspecs_list)
3418
from bzrlib.tests import SubUnitBzrRunner
3420
raise errors.BzrCommandError("subunit not available. subunit "
3421
"needs to be installed to use --subunit.")
3422
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3424
self.additional_selftest_args.setdefault(
3425
'suite_decorators', []).append(parallel)
3427
test_suite_factory = benchmarks.test_suite
3428
# Unless user explicitly asks for quiet, be verbose in benchmarks
3429
verbose = not is_quiet()
3430
# TODO: should possibly lock the history file...
3431
benchfile = open(".perf_history", "at", buffering=1)
3433
test_suite_factory = None
3436
selftest_kwargs = {"verbose": verbose,
3438
"stop_on_failure": one,
3439
"transport": transport,
3440
"test_suite_factory": test_suite_factory,
3441
"lsprof_timed": lsprof_timed,
3442
"bench_history": benchfile,
3443
"matching_tests_first": first,
3444
"list_only": list_only,
3445
"random_seed": randomize,
3446
"exclude_pattern": exclude,
3448
"load_list": load_list,
3449
"debug_flags": debugflag,
3450
"starting_with": starting_with
3452
selftest_kwargs.update(self.additional_selftest_args)
3453
result = selftest(**selftest_kwargs)
3455
if benchfile is not None:
3457
return int(not result)
3460
class cmd_version(Command):
3461
"""Show version of bzr."""
3463
encoding_type = 'replace'
3465
Option("short", help="Print just the version number."),
3469
def run(self, short=False):
3470
from bzrlib.version import show_version
3472
self.outf.write(bzrlib.version_string + '\n')
3474
show_version(to_file=self.outf)
3477
class cmd_rocks(Command):
3478
"""Statement of optimism."""
3484
print "It sure does!"
3487
class cmd_find_merge_base(Command):
3488
"""Find and print a base revision for merging two branches."""
3489
# TODO: Options to specify revisions on either side, as if
3490
# merging only part of the history.
3491
takes_args = ['branch', 'other']
3495
def run(self, branch, other):
3496
from bzrlib.revision import ensure_null
3498
branch1 = Branch.open_containing(branch)[0]
3499
branch2 = Branch.open_containing(other)[0]
3504
last1 = ensure_null(branch1.last_revision())
3505
last2 = ensure_null(branch2.last_revision())
3507
graph = branch1.repository.get_graph(branch2.repository)
3508
base_rev_id = graph.find_unique_lca(last1, last2)
3510
print 'merge base is revision %s' % base_rev_id
3517
class cmd_merge(Command):
3518
"""Perform a three-way merge.
3520
The source of the merge can be specified either in the form of a branch,
3521
or in the form of a path to a file containing a merge directive generated
3522
with bzr send. If neither is specified, the default is the upstream branch
3523
or the branch most recently merged using --remember.
3525
When merging a branch, by default the tip will be merged. To pick a different
3526
revision, pass --revision. If you specify two values, the first will be used as
3527
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3528
available revisions, like this is commonly referred to as "cherrypicking".
3530
Revision numbers are always relative to the branch being merged.
3532
By default, bzr will try to merge in all new work from the other
3533
branch, automatically determining an appropriate base. If this
3534
fails, you may need to give an explicit base.
3536
Merge will do its best to combine the changes in two branches, but there
3537
are some kinds of problems only a human can fix. When it encounters those,
3538
it will mark a conflict. A conflict means that you need to fix something,
3539
before you should commit.
3541
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3543
If there is no default branch set, the first merge will set it. After
3544
that, you can omit the branch to use the default. To change the
3545
default, use --remember. The value will only be saved if the remote
3546
location can be accessed.
3548
The results of the merge are placed into the destination working
3549
directory, where they can be reviewed (with bzr diff), tested, and then
3550
committed to record the result of the merge.
3552
merge refuses to run if there are any uncommitted changes, unless
3556
To merge the latest revision from bzr.dev::
3558
bzr merge ../bzr.dev
3560
To merge changes up to and including revision 82 from bzr.dev::
3562
bzr merge -r 82 ../bzr.dev
3564
To merge the changes introduced by 82, without previous changes::
3566
bzr merge -r 81..82 ../bzr.dev
3568
To apply a merge directive contained in /tmp/merge:
3570
bzr merge /tmp/merge
3573
encoding_type = 'exact'
3574
_see_also = ['update', 'remerge', 'status-flags', 'send']
3575
takes_args = ['location?']
3580
help='Merge even if the destination tree has uncommitted changes.'),
3584
Option('show-base', help="Show base revision text in "
3586
Option('uncommitted', help='Apply uncommitted changes'
3587
' from a working copy, instead of branch changes.'),
3588
Option('pull', help='If the destination is already'
3589
' completely merged into the source, pull from the'
3590
' source rather than merging. When this happens,'
3591
' you do not need to commit the result.'),
3593
help='Branch to merge into, '
3594
'rather than the one containing the working directory.',
3598
Option('preview', help='Instead of merging, show a diff of the merge.')
3601
def run(self, location=None, revision=None, force=False,
3602
merge_type=None, show_base=False, reprocess=None, remember=False,
3603
uncommitted=False, pull=False,
3607
if merge_type is None:
3608
merge_type = _mod_merge.Merge3Merger
3610
if directory is None: directory = u'.'
3611
possible_transports = []
3613
allow_pending = True
3614
verified = 'inapplicable'
3615
tree = WorkingTree.open_containing(directory)[0]
3617
# die as quickly as possible if there are uncommitted changes
3619
basis_tree = tree.revision_tree(tree.last_revision())
3620
except errors.NoSuchRevision:
3621
basis_tree = tree.basis_tree()
3623
changes = tree.changes_from(basis_tree)
3624
if changes.has_changed():
3625
raise errors.UncommittedChanges(tree)
3627
view_info = _get_view_info_for_change_reporter(tree)
3628
change_reporter = delta._ChangeReporter(
3629
unversioned_filter=tree.is_ignored, view_info=view_info)
3632
pb = ui.ui_factory.nested_progress_bar()
3633
cleanups.append(pb.finished)
3635
cleanups.append(tree.unlock)
3636
if location is not None:
3638
mergeable = bundle.read_mergeable_from_url(location,
3639
possible_transports=possible_transports)
3640
except errors.NotABundle:
3644
raise errors.BzrCommandError('Cannot use --uncommitted'
3645
' with bundles or merge directives.')
3647
if revision is not None:
3648
raise errors.BzrCommandError(
3649
'Cannot use -r with merge directives or bundles')
3650
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3653
if merger is None and uncommitted:
3654
if revision is not None and len(revision) > 0:
3655
raise errors.BzrCommandError('Cannot use --uncommitted and'
3656
' --revision at the same time.')
3657
merger = self.get_merger_from_uncommitted(tree, location, pb,
3659
allow_pending = False
3662
merger, allow_pending = self._get_merger_from_branch(tree,
3663
location, revision, remember, possible_transports, pb)
3665
merger.merge_type = merge_type
3666
merger.reprocess = reprocess
3667
merger.show_base = show_base
3668
self.sanity_check_merger(merger)
3669
if (merger.base_rev_id == merger.other_rev_id and
3670
merger.other_rev_id is not None):
3671
note('Nothing to do.')
3674
if merger.interesting_files is not None:
3675
raise errors.BzrCommandError('Cannot pull individual files')
3676
if (merger.base_rev_id == tree.last_revision()):
3677
result = tree.pull(merger.other_branch, False,
3678
merger.other_rev_id)
3679
result.report(self.outf)
3681
merger.check_basis(False)
3683
return self._do_preview(merger)
3685
return self._do_merge(merger, change_reporter, allow_pending,
3688
for cleanup in reversed(cleanups):
3691
def _do_preview(self, merger):
3692
from bzrlib.diff import show_diff_trees
3693
tree_merger = merger.make_merger()
3694
tt = tree_merger.make_preview_transform()
3696
result_tree = tt.get_preview_tree()
3697
show_diff_trees(merger.this_tree, result_tree, self.outf,
3698
old_label='', new_label='')
3702
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3703
merger.change_reporter = change_reporter
3704
conflict_count = merger.do_merge()
3706
merger.set_pending()
3707
if verified == 'failed':
3708
warning('Preview patch does not match changes')
3709
if conflict_count != 0:
3714
def sanity_check_merger(self, merger):
3715
if (merger.show_base and
3716
not merger.merge_type is _mod_merge.Merge3Merger):
3717
raise errors.BzrCommandError("Show-base is not supported for this"
3718
" merge type. %s" % merger.merge_type)
3719
if merger.reprocess is None:
3720
if merger.show_base:
3721
merger.reprocess = False
3723
# Use reprocess if the merger supports it
3724
merger.reprocess = merger.merge_type.supports_reprocess
3725
if merger.reprocess and not merger.merge_type.supports_reprocess:
3726
raise errors.BzrCommandError("Conflict reduction is not supported"
3727
" for merge type %s." %
3729
if merger.reprocess and merger.show_base:
3730
raise errors.BzrCommandError("Cannot do conflict reduction and"
3733
def _get_merger_from_branch(self, tree, location, revision, remember,
3734
possible_transports, pb):
3735
"""Produce a merger from a location, assuming it refers to a branch."""
3736
from bzrlib.tag import _merge_tags_if_possible
3737
# find the branch locations
3738
other_loc, user_location = self._select_branch_location(tree, location,
3740
if revision is not None and len(revision) == 2:
3741
base_loc, _unused = self._select_branch_location(tree,
3742
location, revision, 0)
3744
base_loc = other_loc
3746
other_branch, other_path = Branch.open_containing(other_loc,
3747
possible_transports)
3748
if base_loc == other_loc:
3749
base_branch = other_branch
3751
base_branch, base_path = Branch.open_containing(base_loc,
3752
possible_transports)
3753
# Find the revision ids
3754
if revision is None or len(revision) < 1 or revision[-1] is None:
3755
other_revision_id = _mod_revision.ensure_null(
3756
other_branch.last_revision())
3758
other_revision_id = revision[-1].as_revision_id(other_branch)
3759
if (revision is not None and len(revision) == 2
3760
and revision[0] is not None):
3761
base_revision_id = revision[0].as_revision_id(base_branch)
3763
base_revision_id = None
3764
# Remember where we merge from
3765
if ((remember or tree.branch.get_submit_branch() is None) and
3766
user_location is not None):
3767
tree.branch.set_submit_branch(other_branch.base)
3768
_merge_tags_if_possible(other_branch, tree.branch)
3769
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3770
other_revision_id, base_revision_id, other_branch, base_branch)
3771
if other_path != '':
3772
allow_pending = False
3773
merger.interesting_files = [other_path]
3775
allow_pending = True
3776
return merger, allow_pending
3778
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3779
"""Get a merger for uncommitted changes.
3781
:param tree: The tree the merger should apply to.
3782
:param location: The location containing uncommitted changes.
3783
:param pb: The progress bar to use for showing progress.
3784
:param cleanups: A list of operations to perform to clean up the
3785
temporary directories, unfinalized objects, etc.
3787
location = self._select_branch_location(tree, location)[0]
3788
other_tree, other_path = WorkingTree.open_containing(location)
3789
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3790
if other_path != '':
3791
merger.interesting_files = [other_path]
3794
def _select_branch_location(self, tree, user_location, revision=None,
3796
"""Select a branch location, according to possible inputs.
3798
If provided, branches from ``revision`` are preferred. (Both
3799
``revision`` and ``index`` must be supplied.)
3801
Otherwise, the ``location`` parameter is used. If it is None, then the
3802
``submit`` or ``parent`` location is used, and a note is printed.
3804
:param tree: The working tree to select a branch for merging into
3805
:param location: The location entered by the user
3806
:param revision: The revision parameter to the command
3807
:param index: The index to use for the revision parameter. Negative
3808
indices are permitted.
3809
:return: (selected_location, user_location). The default location
3810
will be the user-entered location.
3812
if (revision is not None and index is not None
3813
and revision[index] is not None):
3814
branch = revision[index].get_branch()
3815
if branch is not None:
3816
return branch, branch
3817
if user_location is None:
3818
location = self._get_remembered(tree, 'Merging from')
3820
location = user_location
3821
return location, user_location
3823
def _get_remembered(self, tree, verb_string):
3824
"""Use tree.branch's parent if none was supplied.
3826
Report if the remembered location was used.
3828
stored_location = tree.branch.get_submit_branch()
3829
stored_location_type = "submit"
3830
if stored_location is None:
3831
stored_location = tree.branch.get_parent()
3832
stored_location_type = "parent"
3833
mutter("%s", stored_location)
3834
if stored_location is None:
3835
raise errors.BzrCommandError("No location specified or remembered")
3836
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3837
note(u"%s remembered %s location %s", verb_string,
3838
stored_location_type, display_url)
3839
return stored_location
3842
class cmd_remerge(Command):
3845
Use this if you want to try a different merge technique while resolving
3846
conflicts. Some merge techniques are better than others, and remerge
3847
lets you try different ones on different files.
3849
The options for remerge have the same meaning and defaults as the ones for
3850
merge. The difference is that remerge can (only) be run when there is a
3851
pending merge, and it lets you specify particular files.
3854
Re-do the merge of all conflicted files, and show the base text in
3855
conflict regions, in addition to the usual THIS and OTHER texts::
3857
bzr remerge --show-base
3859
Re-do the merge of "foobar", using the weave merge algorithm, with
3860
additional processing to reduce the size of conflict regions::
3862
bzr remerge --merge-type weave --reprocess foobar
3864
takes_args = ['file*']
3869
help="Show base revision text in conflicts."),
3872
def run(self, file_list=None, merge_type=None, show_base=False,
3874
if merge_type is None:
3875
merge_type = _mod_merge.Merge3Merger
3876
tree, file_list = tree_files(file_list)
3879
parents = tree.get_parent_ids()
3880
if len(parents) != 2:
3881
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3882
" merges. Not cherrypicking or"
3884
repository = tree.branch.repository
3885
interesting_ids = None
3887
conflicts = tree.conflicts()
3888
if file_list is not None:
3889
interesting_ids = set()
3890
for filename in file_list:
3891
file_id = tree.path2id(filename)
3893
raise errors.NotVersionedError(filename)
3894
interesting_ids.add(file_id)
3895
if tree.kind(file_id) != "directory":
3898
for name, ie in tree.inventory.iter_entries(file_id):
3899
interesting_ids.add(ie.file_id)
3900
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3902
# Remerge only supports resolving contents conflicts
3903
allowed_conflicts = ('text conflict', 'contents conflict')
3904
restore_files = [c.path for c in conflicts
3905
if c.typestring in allowed_conflicts]
3906
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3907
tree.set_conflicts(ConflictList(new_conflicts))
3908
if file_list is not None:
3909
restore_files = file_list
3910
for filename in restore_files:
3912
restore(tree.abspath(filename))
3913
except errors.NotConflicted:
3915
# Disable pending merges, because the file texts we are remerging
3916
# have not had those merges performed. If we use the wrong parents
3917
# list, we imply that the working tree text has seen and rejected
3918
# all the changes from the other tree, when in fact those changes
3919
# have not yet been seen.
3920
pb = ui.ui_factory.nested_progress_bar()
3921
tree.set_parent_ids(parents[:1])
3923
merger = _mod_merge.Merger.from_revision_ids(pb,
3925
merger.interesting_ids = interesting_ids
3926
merger.merge_type = merge_type
3927
merger.show_base = show_base
3928
merger.reprocess = reprocess
3929
conflicts = merger.do_merge()
3931
tree.set_parent_ids(parents)
3941
class cmd_revert(Command):
3942
"""Revert files to a previous revision.
3944
Giving a list of files will revert only those files. Otherwise, all files
3945
will be reverted. If the revision is not specified with '--revision', the
3946
last committed revision is used.
3948
To remove only some changes, without reverting to a prior version, use
3949
merge instead. For example, "merge . --revision -2..-3" will remove the
3950
changes introduced by -2, without affecting the changes introduced by -1.
3951
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3953
By default, any files that have been manually changed will be backed up
3954
first. (Files changed only by merge are not backed up.) Backup files have
3955
'.~#~' appended to their name, where # is a number.
3957
When you provide files, you can use their current pathname or the pathname
3958
from the target revision. So you can use revert to "undelete" a file by
3959
name. If you name a directory, all the contents of that directory will be
3962
Any files that have been newly added since that revision will be deleted,
3963
with a backup kept if appropriate. Directories containing unknown files
3964
will not be deleted.
3966
The working tree contains a list of pending merged revisions, which will
3967
be included as parents in the next commit. Normally, revert clears that
3968
list as well as reverting the files. If any files are specified, revert
3969
leaves the pending merge list alone and reverts only the files. Use "bzr
3970
revert ." in the tree root to revert all files but keep the merge record,
3971
and "bzr revert --forget-merges" to clear the pending merge list without
3972
reverting any files.
3975
_see_also = ['cat', 'export']
3978
Option('no-backup', "Do not save backups of reverted files."),
3979
Option('forget-merges',
3980
'Remove pending merge marker, without changing any files.'),
3982
takes_args = ['file*']
3984
def run(self, revision=None, no_backup=False, file_list=None,
3985
forget_merges=None):
3986
tree, file_list = tree_files(file_list)
3990
tree.set_parent_ids(tree.get_parent_ids()[:1])
3992
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3997
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3998
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3999
pb = ui.ui_factory.nested_progress_bar()
4001
tree.revert(file_list, rev_tree, not no_backup, pb,
4002
report_changes=True)
4007
class cmd_assert_fail(Command):
4008
"""Test reporting of assertion failures"""
4009
# intended just for use in testing
4014
raise AssertionError("always fails")
4017
class cmd_help(Command):
4018
"""Show help on a command or other topic.
4021
_see_also = ['topics']
4023
Option('long', 'Show help on all commands.'),
4025
takes_args = ['topic?']
4026
aliases = ['?', '--help', '-?', '-h']
4029
def run(self, topic=None, long=False):
4031
if topic is None and long:
4033
bzrlib.help.help(topic)
4036
class cmd_shell_complete(Command):
4037
"""Show appropriate completions for context.
4039
For a list of all available commands, say 'bzr shell-complete'.
4041
takes_args = ['context?']
4046
def run(self, context=None):
4047
import shellcomplete
4048
shellcomplete.shellcomplete(context)
4051
class cmd_missing(Command):
4052
"""Show unmerged/unpulled revisions between two branches.
4054
OTHER_BRANCH may be local or remote.
4056
To filter on a range of revisions, you can use the command -r begin..end
4057
-r revision requests a specific revision, -r ..end or -r begin.. are
4062
Determine the missing revisions between this and the branch at the
4063
remembered pull location::
4067
Determine the missing revisions between this and another branch::
4069
bzr missing http://server/branch
4071
Determine the missing revisions up to a specific revision on the other
4074
bzr missing -r ..-10
4076
Determine the missing revisions up to a specific revision on this
4079
bzr missing --my-revision ..-10
4082
_see_also = ['merge', 'pull']
4083
takes_args = ['other_branch?']
4085
Option('reverse', 'Reverse the order of revisions.'),
4087
'Display changes in the local branch only.'),
4088
Option('this' , 'Same as --mine-only.'),
4089
Option('theirs-only',
4090
'Display changes in the remote branch only.'),
4091
Option('other', 'Same as --theirs-only.'),
4095
custom_help('revision',
4096
help='Filter on other branch revisions (inclusive). '
4097
'See "help revisionspec" for details.'),
4098
Option('my-revision',
4099
type=_parse_revision_str,
4100
help='Filter on local branch revisions (inclusive). '
4101
'See "help revisionspec" for details.'),
4102
Option('include-merges',
4103
'Show all revisions in addition to the mainline ones.'),
4105
encoding_type = 'replace'
4108
def run(self, other_branch=None, reverse=False, mine_only=False,
4110
log_format=None, long=False, short=False, line=False,
4111
show_ids=False, verbose=False, this=False, other=False,
4112
include_merges=False, revision=None, my_revision=None):
4113
from bzrlib.missing import find_unmerged, iter_log_revisions
4122
# TODO: We should probably check that we don't have mine-only and
4123
# theirs-only set, but it gets complicated because we also have
4124
# this and other which could be used.
4131
local_branch = Branch.open_containing(u".")[0]
4132
parent = local_branch.get_parent()
4133
if other_branch is None:
4134
other_branch = parent
4135
if other_branch is None:
4136
raise errors.BzrCommandError("No peer location known"
4138
display_url = urlutils.unescape_for_display(parent,
4140
message("Using saved parent location: "
4141
+ display_url + "\n")
4143
remote_branch = Branch.open(other_branch)
4144
if remote_branch.base == local_branch.base:
4145
remote_branch = local_branch
4147
local_revid_range = _revision_range_to_revid_range(
4148
_get_revision_range(my_revision, local_branch,
4151
remote_revid_range = _revision_range_to_revid_range(
4152
_get_revision_range(revision,
4153
remote_branch, self.name()))
4155
local_branch.lock_read()
4157
remote_branch.lock_read()
4159
local_extra, remote_extra = find_unmerged(
4160
local_branch, remote_branch, restrict,
4161
backward=not reverse,
4162
include_merges=include_merges,
4163
local_revid_range=local_revid_range,
4164
remote_revid_range=remote_revid_range)
4166
if log_format is None:
4167
registry = log.log_formatter_registry
4168
log_format = registry.get_default(local_branch)
4169
lf = log_format(to_file=self.outf,
4171
show_timezone='original')
4174
if local_extra and not theirs_only:
4175
message("You have %d extra revision(s):\n" %
4177
for revision in iter_log_revisions(local_extra,
4178
local_branch.repository,
4180
lf.log_revision(revision)
4181
printed_local = True
4184
printed_local = False
4186
if remote_extra and not mine_only:
4187
if printed_local is True:
4189
message("You are missing %d revision(s):\n" %
4191
for revision in iter_log_revisions(remote_extra,
4192
remote_branch.repository,
4194
lf.log_revision(revision)
4197
if mine_only and not local_extra:
4198
# We checked local, and found nothing extra
4199
message('This branch is up to date.\n')
4200
elif theirs_only and not remote_extra:
4201
# We checked remote, and found nothing extra
4202
message('Other branch is up to date.\n')
4203
elif not (mine_only or theirs_only or local_extra or
4205
# We checked both branches, and neither one had extra
4207
message("Branches are up to date.\n")
4209
remote_branch.unlock()
4211
local_branch.unlock()
4212
if not status_code and parent is None and other_branch is not None:
4213
local_branch.lock_write()
4215
# handle race conditions - a parent might be set while we run.
4216
if local_branch.get_parent() is None:
4217
local_branch.set_parent(remote_branch.base)
4219
local_branch.unlock()
4223
class cmd_pack(Command):
4224
"""Compress the data within a repository."""
4226
_see_also = ['repositories']
4227
takes_args = ['branch_or_repo?']
4229
def run(self, branch_or_repo='.'):
4230
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4232
branch = dir.open_branch()
4233
repository = branch.repository
4234
except errors.NotBranchError:
4235
repository = dir.open_repository()
4239
class cmd_plugins(Command):
4240
"""List the installed plugins.
4242
This command displays the list of installed plugins including
4243
version of plugin and a short description of each.
4245
--verbose shows the path where each plugin is located.
4247
A plugin is an external component for Bazaar that extends the
4248
revision control system, by adding or replacing code in Bazaar.
4249
Plugins can do a variety of things, including overriding commands,
4250
adding new commands, providing additional network transports and
4251
customizing log output.
4253
See the Bazaar web site, http://bazaar-vcs.org, for further
4254
information on plugins including where to find them and how to
4255
install them. Instructions are also provided there on how to
4256
write new plugins using the Python programming language.
4258
takes_options = ['verbose']
4261
def run(self, verbose=False):
4262
import bzrlib.plugin
4263
from inspect import getdoc
4265
for name, plugin in bzrlib.plugin.plugins().items():
4266
version = plugin.__version__
4267
if version == 'unknown':
4269
name_ver = '%s %s' % (name, version)
4270
d = getdoc(plugin.module)
4272
doc = d.split('\n')[0]
4274
doc = '(no description)'
4275
result.append((name_ver, doc, plugin.path()))
4276
for name_ver, doc, path in sorted(result):
4284
class cmd_testament(Command):
4285
"""Show testament (signing-form) of a revision."""
4288
Option('long', help='Produce long-format testament.'),
4290
help='Produce a strict-format testament.')]
4291
takes_args = ['branch?']
4293
def run(self, branch=u'.', revision=None, long=False, strict=False):
4294
from bzrlib.testament import Testament, StrictTestament
4296
testament_class = StrictTestament
4298
testament_class = Testament
4300
b = Branch.open_containing(branch)[0]
4302
b = Branch.open(branch)
4305
if revision is None:
4306
rev_id = b.last_revision()
4308
rev_id = revision[0].as_revision_id(b)
4309
t = testament_class.from_revision(b.repository, rev_id)
4311
sys.stdout.writelines(t.as_text_lines())
4313
sys.stdout.write(t.as_short_text())
4318
class cmd_annotate(Command):
4319
"""Show the origin of each line in a file.
4321
This prints out the given file with an annotation on the left side
4322
indicating which revision, author and date introduced the change.
4324
If the origin is the same for a run of consecutive lines, it is
4325
shown only at the top, unless the --all option is given.
4327
# TODO: annotate directories; showing when each file was last changed
4328
# TODO: if the working copy is modified, show annotations on that
4329
# with new uncommitted lines marked
4330
aliases = ['ann', 'blame', 'praise']
4331
takes_args = ['filename']
4332
takes_options = [Option('all', help='Show annotations on all lines.'),
4333
Option('long', help='Show commit date in annotations.'),
4337
encoding_type = 'exact'
4340
def run(self, filename, all=False, long=False, revision=None,
4342
from bzrlib.annotate import annotate_file, annotate_file_tree
4343
wt, branch, relpath = \
4344
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4350
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4352
file_id = wt.path2id(relpath)
4354
file_id = tree.path2id(relpath)
4356
raise errors.NotVersionedError(filename)
4357
file_version = tree.inventory[file_id].revision
4358
if wt is not None and revision is None:
4359
# If there is a tree and we're not annotating historical
4360
# versions, annotate the working tree's content.
4361
annotate_file_tree(wt, file_id, self.outf, long, all,
4364
annotate_file(branch, file_version, file_id, long, all, self.outf,
4373
class cmd_re_sign(Command):
4374
"""Create a digital signature for an existing revision."""
4375
# TODO be able to replace existing ones.
4377
hidden = True # is this right ?
4378
takes_args = ['revision_id*']
4379
takes_options = ['revision']
4381
def run(self, revision_id_list=None, revision=None):
4382
if revision_id_list is not None and revision is not None:
4383
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4384
if revision_id_list is None and revision is None:
4385
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4386
b = WorkingTree.open_containing(u'.')[0].branch
4389
return self._run(b, revision_id_list, revision)
4393
def _run(self, b, revision_id_list, revision):
4394
import bzrlib.gpg as gpg
4395
gpg_strategy = gpg.GPGStrategy(b.get_config())
4396
if revision_id_list is not None:
4397
b.repository.start_write_group()
4399
for revision_id in revision_id_list:
4400
b.repository.sign_revision(revision_id, gpg_strategy)
4402
b.repository.abort_write_group()
4405
b.repository.commit_write_group()
4406
elif revision is not None:
4407
if len(revision) == 1:
4408
revno, rev_id = revision[0].in_history(b)
4409
b.repository.start_write_group()
4411
b.repository.sign_revision(rev_id, gpg_strategy)
4413
b.repository.abort_write_group()
4416
b.repository.commit_write_group()
4417
elif len(revision) == 2:
4418
# are they both on rh- if so we can walk between them
4419
# might be nice to have a range helper for arbitrary
4420
# revision paths. hmm.
4421
from_revno, from_revid = revision[0].in_history(b)
4422
to_revno, to_revid = revision[1].in_history(b)
4423
if to_revid is None:
4424
to_revno = b.revno()
4425
if from_revno is None or to_revno is None:
4426
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4427
b.repository.start_write_group()
4429
for revno in range(from_revno, to_revno + 1):
4430
b.repository.sign_revision(b.get_rev_id(revno),
4433
b.repository.abort_write_group()
4436
b.repository.commit_write_group()
4438
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4441
class cmd_bind(Command):
4442
"""Convert the current branch into a checkout of the supplied branch.
4444
Once converted into a checkout, commits must succeed on the master branch
4445
before they will be applied to the local branch.
4447
Bound branches use the nickname of its master branch unless it is set
4448
locally, in which case binding will update the the local nickname to be
4452
_see_also = ['checkouts', 'unbind']
4453
takes_args = ['location?']
4456
def run(self, location=None):
4457
b, relpath = Branch.open_containing(u'.')
4458
if location is None:
4460
location = b.get_old_bound_location()
4461
except errors.UpgradeRequired:
4462
raise errors.BzrCommandError('No location supplied. '
4463
'This format does not remember old locations.')
4465
if location is None:
4466
raise errors.BzrCommandError('No location supplied and no '
4467
'previous location known')
4468
b_other = Branch.open(location)
4471
except errors.DivergedBranches:
4472
raise errors.BzrCommandError('These branches have diverged.'
4473
' Try merging, and then bind again.')
4474
if b.get_config().has_explicit_nickname():
4475
b.nick = b_other.nick
4478
class cmd_unbind(Command):
4479
"""Convert the current checkout into a regular branch.
4481
After unbinding, the local branch is considered independent and subsequent
4482
commits will be local only.
4485
_see_also = ['checkouts', 'bind']
4490
b, relpath = Branch.open_containing(u'.')
4492
raise errors.BzrCommandError('Local branch is not bound')
4495
class cmd_uncommit(Command):
4496
"""Remove the last committed revision.
4498
--verbose will print out what is being removed.
4499
--dry-run will go through all the motions, but not actually
4502
If --revision is specified, uncommit revisions to leave the branch at the
4503
specified revision. For example, "bzr uncommit -r 15" will leave the
4504
branch at revision 15.
4506
Uncommit leaves the working tree ready for a new commit. The only change
4507
it may make is to restore any pending merges that were present before
4511
# TODO: jam 20060108 Add an option to allow uncommit to remove
4512
# unreferenced information in 'branch-as-repository' branches.
4513
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4514
# information in shared branches as well.
4515
_see_also = ['commit']
4516
takes_options = ['verbose', 'revision',
4517
Option('dry-run', help='Don\'t actually make changes.'),
4518
Option('force', help='Say yes to all questions.'),
4520
help="Only remove the commits from the local branch"
4521
" when in a checkout."
4524
takes_args = ['location?']
4526
encoding_type = 'replace'
4528
def run(self, location=None,
4529
dry_run=False, verbose=False,
4530
revision=None, force=False, local=False):
4531
if location is None:
4533
control, relpath = bzrdir.BzrDir.open_containing(location)
4535
tree = control.open_workingtree()
4537
except (errors.NoWorkingTree, errors.NotLocalUrl):
4539
b = control.open_branch()
4541
if tree is not None:
4546
return self._run(b, tree, dry_run, verbose, revision, force,
4549
if tree is not None:
4554
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4555
from bzrlib.log import log_formatter, show_log
4556
from bzrlib.uncommit import uncommit
4558
last_revno, last_rev_id = b.last_revision_info()
4561
if revision is None:
4563
rev_id = last_rev_id
4565
# 'bzr uncommit -r 10' actually means uncommit
4566
# so that the final tree is at revno 10.
4567
# but bzrlib.uncommit.uncommit() actually uncommits
4568
# the revisions that are supplied.
4569
# So we need to offset it by one
4570
revno = revision[0].in_history(b).revno + 1
4571
if revno <= last_revno:
4572
rev_id = b.get_rev_id(revno)
4574
if rev_id is None or _mod_revision.is_null(rev_id):
4575
self.outf.write('No revisions to uncommit.\n')
4578
lf = log_formatter('short',
4580
show_timezone='original')
4585
direction='forward',
4586
start_revision=revno,
4587
end_revision=last_revno)
4590
print 'Dry-run, pretending to remove the above revisions.'
4592
val = raw_input('Press <enter> to continue')
4594
print 'The above revision(s) will be removed.'
4596
val = raw_input('Are you sure [y/N]? ')
4597
if val.lower() not in ('y', 'yes'):
4601
mutter('Uncommitting from {%s} to {%s}',
4602
last_rev_id, rev_id)
4603
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4604
revno=revno, local=local)
4605
note('You can restore the old tip by running:\n'
4606
' bzr pull . -r revid:%s', last_rev_id)
4609
class cmd_break_lock(Command):
4610
"""Break a dead lock on a repository, branch or working directory.
4612
CAUTION: Locks should only be broken when you are sure that the process
4613
holding the lock has been stopped.
4615
You can get information on what locks are open via the 'bzr info' command.
4620
takes_args = ['location?']
4622
def run(self, location=None, show=False):
4623
if location is None:
4625
control, relpath = bzrdir.BzrDir.open_containing(location)
4627
control.break_lock()
4628
except NotImplementedError:
4632
class cmd_wait_until_signalled(Command):
4633
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4635
This just prints a line to signal when it is ready, then blocks on stdin.
4641
sys.stdout.write("running\n")
4643
sys.stdin.readline()
4646
class cmd_serve(Command):
4647
"""Run the bzr server."""
4649
aliases = ['server']
4653
help='Serve on stdin/out for use from inetd or sshd.'),
4654
RegistryOption('protocol',
4655
help="Protocol to serve.",
4656
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4657
value_switches=True),
4659
help='Listen for connections on nominated port of the form '
4660
'[hostname:]portnumber. Passing 0 as the port number will '
4661
'result in a dynamically allocated port. The default port '
4662
'depends on the protocol.',
4665
help='Serve contents of this directory.',
4667
Option('allow-writes',
4668
help='By default the server is a readonly server. Supplying '
4669
'--allow-writes enables write access to the contents of '
4670
'the served directory and below.'
4674
def get_host_and_port(self, port):
4675
"""Return the host and port to run the smart server on.
4677
If 'port' is None, None will be returned for the host and port.
4679
If 'port' has a colon in it, the string before the colon will be
4680
interpreted as the host.
4682
:param port: A string of the port to run the server on.
4683
:return: A tuple of (host, port), where 'host' is a host name or IP,
4684
and port is an integer TCP/IP port.
4687
if port is not None:
4689
host, port = port.split(':')
4693
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4695
from bzrlib.transport import get_transport, transport_server_registry
4696
if directory is None:
4697
directory = os.getcwd()
4698
if protocol is None:
4699
protocol = transport_server_registry.get()
4700
host, port = self.get_host_and_port(port)
4701
url = urlutils.local_path_to_url(directory)
4702
if not allow_writes:
4703
url = 'readonly+' + url
4704
transport = get_transport(url)
4705
protocol(transport, host, port, inet)
4708
class cmd_join(Command):
4709
"""Combine a tree into its containing tree.
4711
This command requires the target tree to be in a rich-root format.
4713
The TREE argument should be an independent tree, inside another tree, but
4714
not part of it. (Such trees can be produced by "bzr split", but also by
4715
running "bzr branch" with the target inside a tree.)
4717
The result is a combined tree, with the subtree no longer an independant
4718
part. This is marked as a merge of the subtree into the containing tree,
4719
and all history is preserved.
4722
_see_also = ['split']
4723
takes_args = ['tree']
4725
Option('reference', help='Join by reference.', hidden=True),
4728
def run(self, tree, reference=False):
4729
sub_tree = WorkingTree.open(tree)
4730
parent_dir = osutils.dirname(sub_tree.basedir)
4731
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4732
repo = containing_tree.branch.repository
4733
if not repo.supports_rich_root():
4734
raise errors.BzrCommandError(
4735
"Can't join trees because %s doesn't support rich root data.\n"
4736
"You can use bzr upgrade on the repository."
4740
containing_tree.add_reference(sub_tree)
4741
except errors.BadReferenceTarget, e:
4742
# XXX: Would be better to just raise a nicely printable
4743
# exception from the real origin. Also below. mbp 20070306
4744
raise errors.BzrCommandError("Cannot join %s. %s" %
4748
containing_tree.subsume(sub_tree)
4749
except errors.BadSubsumeSource, e:
4750
raise errors.BzrCommandError("Cannot join %s. %s" %
4754
class cmd_split(Command):
4755
"""Split a subdirectory of a tree into a separate tree.
4757
This command will produce a target tree in a format that supports
4758
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4759
converted into earlier formats like 'dirstate-tags'.
4761
The TREE argument should be a subdirectory of a working tree. That
4762
subdirectory will be converted into an independent tree, with its own
4763
branch. Commits in the top-level tree will not apply to the new subtree.
4766
_see_also = ['join']
4767
takes_args = ['tree']
4769
def run(self, tree):
4770
containing_tree, subdir = WorkingTree.open_containing(tree)
4771
sub_id = containing_tree.path2id(subdir)
4773
raise errors.NotVersionedError(subdir)
4775
containing_tree.extract(sub_id)
4776
except errors.RootNotRich:
4777
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4780
class cmd_merge_directive(Command):
4781
"""Generate a merge directive for auto-merge tools.
4783
A directive requests a merge to be performed, and also provides all the
4784
information necessary to do so. This means it must either include a
4785
revision bundle, or the location of a branch containing the desired
4788
A submit branch (the location to merge into) must be supplied the first
4789
time the command is issued. After it has been supplied once, it will
4790
be remembered as the default.
4792
A public branch is optional if a revision bundle is supplied, but required
4793
if --diff or --plain is specified. It will be remembered as the default
4794
after the first use.
4797
takes_args = ['submit_branch?', 'public_branch?']
4801
_see_also = ['send']
4804
RegistryOption.from_kwargs('patch-type',
4805
'The type of patch to include in the directive.',
4807
value_switches=True,
4809
bundle='Bazaar revision bundle (default).',
4810
diff='Normal unified diff.',
4811
plain='No patch, just directive.'),
4812
Option('sign', help='GPG-sign the directive.'), 'revision',
4813
Option('mail-to', type=str,
4814
help='Instead of printing the directive, email to this address.'),
4815
Option('message', type=str, short_name='m',
4816
help='Message to use when committing this merge.')
4819
encoding_type = 'exact'
4821
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4822
sign=False, revision=None, mail_to=None, message=None):
4823
from bzrlib.revision import ensure_null, NULL_REVISION
4824
include_patch, include_bundle = {
4825
'plain': (False, False),
4826
'diff': (True, False),
4827
'bundle': (True, True),
4829
branch = Branch.open('.')
4830
stored_submit_branch = branch.get_submit_branch()
4831
if submit_branch is None:
4832
submit_branch = stored_submit_branch
4834
if stored_submit_branch is None:
4835
branch.set_submit_branch(submit_branch)
4836
if submit_branch is None:
4837
submit_branch = branch.get_parent()
4838
if submit_branch is None:
4839
raise errors.BzrCommandError('No submit branch specified or known')
4841
stored_public_branch = branch.get_public_branch()
4842
if public_branch is None:
4843
public_branch = stored_public_branch
4844
elif stored_public_branch is None:
4845
branch.set_public_branch(public_branch)
4846
if not include_bundle and public_branch is None:
4847
raise errors.BzrCommandError('No public branch specified or'
4849
base_revision_id = None
4850
if revision is not None:
4851
if len(revision) > 2:
4852
raise errors.BzrCommandError('bzr merge-directive takes '
4853
'at most two one revision identifiers')
4854
revision_id = revision[-1].as_revision_id(branch)
4855
if len(revision) == 2:
4856
base_revision_id = revision[0].as_revision_id(branch)
4858
revision_id = branch.last_revision()
4859
revision_id = ensure_null(revision_id)
4860
if revision_id == NULL_REVISION:
4861
raise errors.BzrCommandError('No revisions to bundle.')
4862
directive = merge_directive.MergeDirective2.from_objects(
4863
branch.repository, revision_id, time.time(),
4864
osutils.local_time_offset(), submit_branch,
4865
public_branch=public_branch, include_patch=include_patch,
4866
include_bundle=include_bundle, message=message,
4867
base_revision_id=base_revision_id)
4870
self.outf.write(directive.to_signed(branch))
4872
self.outf.writelines(directive.to_lines())
4874
message = directive.to_email(mail_to, branch, sign)
4875
s = SMTPConnection(branch.get_config())
4876
s.send_email(message)
4879
class cmd_send(Command):
4880
"""Mail or create a merge-directive for submitting changes.
4882
A merge directive provides many things needed for requesting merges:
4884
* A machine-readable description of the merge to perform
4886
* An optional patch that is a preview of the changes requested
4888
* An optional bundle of revision data, so that the changes can be applied
4889
directly from the merge directive, without retrieving data from a
4892
If --no-bundle is specified, then public_branch is needed (and must be
4893
up-to-date), so that the receiver can perform the merge using the
4894
public_branch. The public_branch is always included if known, so that
4895
people can check it later.
4897
The submit branch defaults to the parent, but can be overridden. Both
4898
submit branch and public branch will be remembered if supplied.
4900
If a public_branch is known for the submit_branch, that public submit
4901
branch is used in the merge instructions. This means that a local mirror
4902
can be used as your actual submit branch, once you have set public_branch
4905
Mail is sent using your preferred mail program. This should be transparent
4906
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4907
If the preferred client can't be found (or used), your editor will be used.
4909
To use a specific mail program, set the mail_client configuration option.
4910
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4911
specific clients are "claws", "evolution", "kmail", "mutt", and
4912
"thunderbird"; generic options are "default", "editor", "emacsclient",
4913
"mapi", and "xdg-email". Plugins may also add supported clients.
4915
If mail is being sent, a to address is required. This can be supplied
4916
either on the commandline, by setting the submit_to configuration
4917
option in the branch itself or the child_submit_to configuration option
4918
in the submit branch.
4920
Two formats are currently supported: "4" uses revision bundle format 4 and
4921
merge directive format 2. It is significantly faster and smaller than
4922
older formats. It is compatible with Bazaar 0.19 and later. It is the
4923
default. "0.9" uses revision bundle format 0.9 and merge directive
4924
format 1. It is compatible with Bazaar 0.12 - 0.18.
4926
The merge directives created by bzr send may be applied using bzr merge or
4927
bzr pull by specifying a file containing a merge directive as the location.
4930
encoding_type = 'exact'
4932
_see_also = ['merge', 'pull']
4934
takes_args = ['submit_branch?', 'public_branch?']
4938
help='Do not include a bundle in the merge directive.'),
4939
Option('no-patch', help='Do not include a preview patch in the merge'
4942
help='Remember submit and public branch.'),
4944
help='Branch to generate the submission from, '
4945
'rather than the one containing the working directory.',
4948
Option('output', short_name='o',
4949
help='Write merge directive to this file; '
4950
'use - for stdout.',
4952
Option('mail-to', help='Mail the request to this address.',
4956
Option('body', help='Body for the email.', type=unicode),
4957
RegistryOption('format',
4958
help='Use the specified output format.',
4959
lazy_registry=('bzrlib.send', 'format_registry'))
4962
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4963
no_patch=False, revision=None, remember=False, output=None,
4964
format=None, mail_to=None, message=None, body=None, **kwargs):
4965
from bzrlib.send import send
4966
return send(submit_branch, revision, public_branch, remember,
4967
format, no_bundle, no_patch, output,
4968
kwargs.get('from', '.'), mail_to, message, body,
4972
class cmd_bundle_revisions(cmd_send):
4973
"""Create a merge-directive for submitting changes.
4975
A merge directive provides many things needed for requesting merges:
4977
* A machine-readable description of the merge to perform
4979
* An optional patch that is a preview of the changes requested
4981
* An optional bundle of revision data, so that the changes can be applied
4982
directly from the merge directive, without retrieving data from a
4985
If --no-bundle is specified, then public_branch is needed (and must be
4986
up-to-date), so that the receiver can perform the merge using the
4987
public_branch. The public_branch is always included if known, so that
4988
people can check it later.
4990
The submit branch defaults to the parent, but can be overridden. Both
4991
submit branch and public branch will be remembered if supplied.
4993
If a public_branch is known for the submit_branch, that public submit
4994
branch is used in the merge instructions. This means that a local mirror
4995
can be used as your actual submit branch, once you have set public_branch
4998
Two formats are currently supported: "4" uses revision bundle format 4 and
4999
merge directive format 2. It is significantly faster and smaller than
5000
older formats. It is compatible with Bazaar 0.19 and later. It is the
5001
default. "0.9" uses revision bundle format 0.9 and merge directive
5002
format 1. It is compatible with Bazaar 0.12 - 0.18.
5007
help='Do not include a bundle in the merge directive.'),
5008
Option('no-patch', help='Do not include a preview patch in the merge'
5011
help='Remember submit and public branch.'),
5013
help='Branch to generate the submission from, '
5014
'rather than the one containing the working directory.',
5017
Option('output', short_name='o', help='Write directive to this file.',
5020
RegistryOption('format',
5021
help='Use the specified output format.',
5022
lazy_registry=('bzrlib.send', 'format_registry')),
5024
aliases = ['bundle']
5026
_see_also = ['send', 'merge']
5030
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5031
no_patch=False, revision=None, remember=False, output=None,
5032
format=None, **kwargs):
5035
from bzrlib.send import send
5036
return send(submit_branch, revision, public_branch, remember,
5037
format, no_bundle, no_patch, output,
5038
kwargs.get('from', '.'), None, None, None,
5042
class cmd_tag(Command):
5043
"""Create, remove or modify a tag naming a revision.
5045
Tags give human-meaningful names to revisions. Commands that take a -r
5046
(--revision) option can be given -rtag:X, where X is any previously
5049
Tags are stored in the branch. Tags are copied from one branch to another
5050
along when you branch, push, pull or merge.
5052
It is an error to give a tag name that already exists unless you pass
5053
--force, in which case the tag is moved to point to the new revision.
5055
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5056
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5059
_see_also = ['commit', 'tags']
5060
takes_args = ['tag_name']
5063
help='Delete this tag rather than placing it.',
5066
help='Branch in which to place the tag.',
5071
help='Replace existing tags.',
5076
def run(self, tag_name,
5082
branch, relpath = Branch.open_containing(directory)
5086
branch.tags.delete_tag(tag_name)
5087
self.outf.write('Deleted tag %s.\n' % tag_name)
5090
if len(revision) != 1:
5091
raise errors.BzrCommandError(
5092
"Tags can only be placed on a single revision, "
5094
revision_id = revision[0].as_revision_id(branch)
5096
revision_id = branch.last_revision()
5097
if (not force) and branch.tags.has_tag(tag_name):
5098
raise errors.TagAlreadyExists(tag_name)
5099
branch.tags.set_tag(tag_name, revision_id)
5100
self.outf.write('Created tag %s.\n' % tag_name)
5105
class cmd_tags(Command):
5108
This command shows a table of tag names and the revisions they reference.
5114
help='Branch whose tags should be displayed.',
5118
RegistryOption.from_kwargs('sort',
5119
'Sort tags by different criteria.', title='Sorting',
5120
alpha='Sort tags lexicographically (default).',
5121
time='Sort tags chronologically.',
5134
branch, relpath = Branch.open_containing(directory)
5136
tags = branch.tags.get_tag_dict().items()
5143
graph = branch.repository.get_graph()
5144
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5145
revid1, revid2 = rev1.rev_id, rev2.rev_id
5146
# only show revisions between revid1 and revid2 (inclusive)
5147
tags = [(tag, revid) for tag, revid in tags if
5148
graph.is_between(revid, revid1, revid2)]
5151
elif sort == 'time':
5153
for tag, revid in tags:
5155
revobj = branch.repository.get_revision(revid)
5156
except errors.NoSuchRevision:
5157
timestamp = sys.maxint # place them at the end
5159
timestamp = revobj.timestamp
5160
timestamps[revid] = timestamp
5161
tags.sort(key=lambda x: timestamps[x[1]])
5163
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5164
for index, (tag, revid) in enumerate(tags):
5166
revno = branch.revision_id_to_dotted_revno(revid)
5167
if isinstance(revno, tuple):
5168
revno = '.'.join(map(str, revno))
5169
except errors.NoSuchRevision:
5170
# Bad tag data/merges can lead to tagged revisions
5171
# which are not in this branch. Fail gracefully ...
5173
tags[index] = (tag, revno)
5176
for tag, revspec in tags:
5177
self.outf.write('%-20s %s\n' % (tag, revspec))
5180
class cmd_reconfigure(Command):
5181
"""Reconfigure the type of a bzr directory.
5183
A target configuration must be specified.
5185
For checkouts, the bind-to location will be auto-detected if not specified.
5186
The order of preference is
5187
1. For a lightweight checkout, the current bound location.
5188
2. For branches that used to be checkouts, the previously-bound location.
5189
3. The push location.
5190
4. The parent location.
5191
If none of these is available, --bind-to must be specified.
5194
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5195
takes_args = ['location?']
5197
RegistryOption.from_kwargs(
5199
title='Target type',
5200
help='The type to reconfigure the directory to.',
5201
value_switches=True, enum_switch=False,
5202
branch='Reconfigure to be an unbound branch with no working tree.',
5203
tree='Reconfigure to be an unbound branch with a working tree.',
5204
checkout='Reconfigure to be a bound branch with a working tree.',
5205
lightweight_checkout='Reconfigure to be a lightweight'
5206
' checkout (with no local history).',
5207
standalone='Reconfigure to be a standalone branch '
5208
'(i.e. stop using shared repository).',
5209
use_shared='Reconfigure to use a shared repository.',
5210
with_trees='Reconfigure repository to create '
5211
'working trees on branches by default.',
5212
with_no_trees='Reconfigure repository to not create '
5213
'working trees on branches by default.'
5215
Option('bind-to', help='Branch to bind checkout to.', type=str),
5217
help='Perform reconfiguration even if local changes'
5221
def run(self, location=None, target_type=None, bind_to=None, force=False):
5222
directory = bzrdir.BzrDir.open(location)
5223
if target_type is None:
5224
raise errors.BzrCommandError('No target configuration specified')
5225
elif target_type == 'branch':
5226
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5227
elif target_type == 'tree':
5228
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5229
elif target_type == 'checkout':
5230
reconfiguration = reconfigure.Reconfigure.to_checkout(
5232
elif target_type == 'lightweight-checkout':
5233
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5235
elif target_type == 'use-shared':
5236
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5237
elif target_type == 'standalone':
5238
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5239
elif target_type == 'with-trees':
5240
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5242
elif target_type == 'with-no-trees':
5243
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5245
reconfiguration.apply(force)
5248
class cmd_switch(Command):
5249
"""Set the branch of a checkout and update.
5251
For lightweight checkouts, this changes the branch being referenced.
5252
For heavyweight checkouts, this checks that there are no local commits
5253
versus the current bound branch, then it makes the local branch a mirror
5254
of the new location and binds to it.
5256
In both cases, the working tree is updated and uncommitted changes
5257
are merged. The user can commit or revert these as they desire.
5259
Pending merges need to be committed or reverted before using switch.
5261
The path to the branch to switch to can be specified relative to the parent
5262
directory of the current branch. For example, if you are currently in a
5263
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5266
Bound branches use the nickname of its master branch unless it is set
5267
locally, in which case switching will update the the local nickname to be
5271
takes_args = ['to_location']
5272
takes_options = [Option('force',
5273
help='Switch even if local commits will be lost.')
5276
def run(self, to_location, force=False):
5277
from bzrlib import switch
5279
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5281
branch = control_dir.open_branch()
5282
had_explicit_nick = branch.get_config().has_explicit_nickname()
5283
except errors.NotBranchError:
5284
had_explicit_nick = False
5286
to_branch = Branch.open(to_location)
5287
except errors.NotBranchError:
5288
this_url = self._get_branch_location(control_dir)
5289
to_branch = Branch.open(
5290
urlutils.join(this_url, '..', to_location))
5291
switch.switch(control_dir, to_branch, force)
5292
if had_explicit_nick:
5293
branch = control_dir.open_branch() #get the new branch!
5294
branch.nick = to_branch.nick
5295
note('Switched to branch: %s',
5296
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5298
def _get_branch_location(self, control_dir):
5299
"""Return location of branch for this control dir."""
5301
this_branch = control_dir.open_branch()
5302
# This may be a heavy checkout, where we want the master branch
5303
master_location = this_branch.get_bound_location()
5304
if master_location is not None:
5305
return master_location
5306
# If not, use a local sibling
5307
return this_branch.base
5308
except errors.NotBranchError:
5309
format = control_dir.find_branch_format()
5310
if getattr(format, 'get_reference', None) is not None:
5311
return format.get_reference(control_dir)
5313
return control_dir.root_transport.base
5316
class cmd_view(Command):
5317
"""Manage filtered views.
5319
Views provide a mask over the tree so that users can focus on
5320
a subset of a tree when doing their work. After creating a view,
5321
commands that support a list of files - status, diff, commit, etc -
5322
effectively have that list of files implicitly given each time.
5323
An explicit list of files can still be given but those files
5324
must be within the current view.
5326
In most cases, a view has a short life-span: it is created to make
5327
a selected change and is deleted once that change is committed.
5328
At other times, you may wish to create one or more named views
5329
and switch between them.
5331
To disable the current view without deleting it, you can switch to
5332
the pseudo view called ``off``. This can be useful when you need
5333
to see the whole tree for an operation or two (e.g. merge) but
5334
want to switch back to your view after that.
5337
To define the current view::
5339
bzr view file1 dir1 ...
5341
To list the current view::
5345
To delete the current view::
5349
To disable the current view without deleting it::
5351
bzr view --switch off
5353
To define a named view and switch to it::
5355
bzr view --name view-name file1 dir1 ...
5357
To list a named view::
5359
bzr view --name view-name
5361
To delete a named view::
5363
bzr view --name view-name --delete
5365
To switch to a named view::
5367
bzr view --switch view-name
5369
To list all views defined::
5373
To delete all views::
5375
bzr view --delete --all
5379
takes_args = ['file*']
5382
help='Apply list or delete action to all views.',
5385
help='Delete the view.',
5388
help='Name of the view to define, list or delete.',
5392
help='Name of the view to switch to.',
5397
def run(self, file_list,
5403
tree, file_list = tree_files(file_list, apply_view=False)
5404
current_view, view_dict = tree.views.get_view_info()
5409
raise errors.BzrCommandError(
5410
"Both --delete and a file list specified")
5412
raise errors.BzrCommandError(
5413
"Both --delete and --switch specified")
5415
tree.views.set_view_info(None, {})
5416
self.outf.write("Deleted all views.\n")
5418
raise errors.BzrCommandError("No current view to delete")
5420
tree.views.delete_view(name)
5421
self.outf.write("Deleted '%s' view.\n" % name)
5424
raise errors.BzrCommandError(
5425
"Both --switch and a file list specified")
5427
raise errors.BzrCommandError(
5428
"Both --switch and --all specified")
5429
elif switch == 'off':
5430
if current_view is None:
5431
raise errors.BzrCommandError("No current view to disable")
5432
tree.views.set_view_info(None, view_dict)
5433
self.outf.write("Disabled '%s' view.\n" % (current_view))
5435
tree.views.set_view_info(switch, view_dict)
5436
view_str = views.view_display_str(tree.views.lookup_view())
5437
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5440
self.outf.write('Views defined:\n')
5441
for view in sorted(view_dict):
5442
if view == current_view:
5446
view_str = views.view_display_str(view_dict[view])
5447
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5449
self.outf.write('No views defined.\n')
5452
# No name given and no current view set
5455
raise errors.BzrCommandError(
5456
"Cannot change the 'off' pseudo view")
5457
tree.views.set_view(name, sorted(file_list))
5458
view_str = views.view_display_str(tree.views.lookup_view())
5459
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5463
# No name given and no current view set
5464
self.outf.write('No current view.\n')
5466
view_str = views.view_display_str(tree.views.lookup_view(name))
5467
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5470
class cmd_hooks(Command):
5476
for hook_key in sorted(hooks.known_hooks.keys()):
5477
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5478
self.outf.write("%s:\n" % type(some_hooks).__name__)
5479
for hook_name, hook_point in sorted(some_hooks.items()):
5480
self.outf.write(" %s:\n" % (hook_name,))
5481
found_hooks = list(hook_point)
5483
for hook in found_hooks:
5484
self.outf.write(" %s\n" %
5485
(some_hooks.get_hook_name(hook),))
5487
self.outf.write(" <no hooks installed>\n")
5490
class cmd_shelve(Command):
5491
"""Temporarily set aside some changes from the current tree.
5493
Shelve allows you to temporarily put changes you've made "on the shelf",
5494
ie. out of the way, until a later time when you can bring them back from
5495
the shelf with the 'unshelve' command. The changes are stored alongside
5496
your working tree, and so they aren't propagated along with your branch nor
5497
will they survive its deletion.
5499
If shelve --list is specified, previously-shelved changes are listed.
5501
Shelve is intended to help separate several sets of changes that have
5502
been inappropriately mingled. If you just want to get rid of all changes
5503
and you don't need to restore them later, use revert. If you want to
5504
shelve all text changes at once, use shelve --all.
5506
If filenames are specified, only the changes to those files will be
5507
shelved. Other files will be left untouched.
5509
If a revision is specified, changes since that revision will be shelved.
5511
You can put multiple items on the shelf, and by default, 'unshelve' will
5512
restore the most recently shelved changes.
5515
takes_args = ['file*']
5519
Option('all', help='Shelve all changes.'),
5521
RegistryOption('writer', 'Method to use for writing diffs.',
5522
bzrlib.option.diff_writer_registry,
5523
value_switches=True, enum_switch=False),
5525
Option('list', help='List shelved changes.'),
5527
help='Destroy removed changes instead of shelving them.'),
5529
_see_also = ['unshelve']
5531
def run(self, revision=None, all=False, file_list=None, message=None,
5532
writer=None, list=False, destroy=False):
5534
return self.run_for_list()
5535
from bzrlib.shelf_ui import Shelver
5537
writer = bzrlib.option.diff_writer_registry.get()
5539
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5540
message, destroy=destroy).run()
5541
except errors.UserAbort:
5544
def run_for_list(self):
5545
tree = WorkingTree.open_containing('.')[0]
5548
manager = tree.get_shelf_manager()
5549
shelves = manager.active_shelves()
5550
if len(shelves) == 0:
5551
note('No shelved changes.')
5553
for shelf_id in reversed(shelves):
5554
message = manager.get_metadata(shelf_id).get('message')
5556
message = '<no message>'
5557
self.outf.write('%3d: %s\n' % (shelf_id, message))
5563
class cmd_unshelve(Command):
5564
"""Restore shelved changes.
5566
By default, the most recently shelved changes are restored. However if you
5567
specify a shelf by id those changes will be restored instead. This works
5568
best when the changes don't depend on each other.
5571
takes_args = ['shelf_id?']
5573
RegistryOption.from_kwargs(
5574
'action', help="The action to perform.",
5575
enum_switch=False, value_switches=True,
5576
apply="Apply changes and remove from the shelf.",
5577
dry_run="Show changes, but do not apply or remove them.",
5578
delete_only="Delete changes without applying them."
5581
_see_also = ['shelve']
5583
def run(self, shelf_id=None, action='apply'):
5584
from bzrlib.shelf_ui import Unshelver
5585
Unshelver.from_args(shelf_id, action).run()
5588
class cmd_clean_tree(Command):
5589
"""Remove unwanted files from working tree.
5591
By default, only unknown files, not ignored files, are deleted. Versioned
5592
files are never deleted.
5594
Another class is 'detritus', which includes files emitted by bzr during
5595
normal operations and selftests. (The value of these files decreases with
5598
If no options are specified, unknown files are deleted. Otherwise, option
5599
flags are respected, and may be combined.
5601
To check what clean-tree will do, use --dry-run.
5603
takes_options = [Option('ignored', help='Delete all ignored files.'),
5604
Option('detritus', help='Delete conflict files, merge'
5605
' backups, and failed selftest dirs.'),
5607
help='Delete files unknown to bzr (default).'),
5608
Option('dry-run', help='Show files to delete instead of'
5610
Option('force', help='Do not prompt before deleting.')]
5611
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5613
from bzrlib.clean_tree import clean_tree
5614
if not (unknown or ignored or detritus):
5618
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5619
dry_run=dry_run, no_prompt=force)
5622
class cmd_reference(Command):
5623
"""list, view and set branch locations for nested trees.
5625
If no arguments are provided, lists the branch locations for nested trees.
5626
If one argument is provided, display the branch location for that tree.
5627
If two arguments are provided, set the branch location for that tree.
5632
takes_args = ['path?', 'location?']
5634
def run(self, path=None, location=None):
5636
if path is not None:
5638
tree, branch, relpath =(
5639
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5640
if path is not None:
5643
tree = branch.basis_tree()
5645
info = branch._get_all_reference_info().iteritems()
5646
self._display_reference_info(tree, branch, info)
5648
file_id = tree.path2id(path)
5650
raise errors.NotVersionedError(path)
5651
if location is None:
5652
info = [(file_id, branch.get_reference_info(file_id))]
5653
self._display_reference_info(tree, branch, info)
5655
branch.set_reference_info(file_id, path, location)
5657
def _display_reference_info(self, tree, branch, info):
5659
for file_id, (path, location) in info:
5661
path = tree.id2path(file_id)
5662
except errors.NoSuchId:
5664
ref_list.append((path, location))
5665
for path, location in sorted(ref_list):
5666
self.outf.write('%s %s\n' % (path, location))
5669
# these get imported and then picked up by the scan for cmd_*
5670
# TODO: Some more consistent way to split command definitions across files;
5671
# we do need to load at least some information about them to know of
5672
# aliases. ideally we would avoid loading the implementation until the
5673
# details were needed.
5674
from bzrlib.cmd_version_info import cmd_version_info
5675
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5676
from bzrlib.bundle.commands import (
5679
from bzrlib.foreign import cmd_dpush
5680
from bzrlib.sign_my_commits import cmd_sign_my_commits
5681
from bzrlib.weave_commands import cmd_versionedfile_list, \
5682
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
