1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import (
71
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
74
def tree_files(file_list, default_branch=u'.', canonicalize=True,
77
return internal_tree_files(file_list, default_branch, canonicalize,
79
except errors.FileInWrongBranch, e:
80
raise errors.BzrCommandError("%s is not in the same branch as %s" %
81
(e.path, file_list[0]))
84
def tree_files_for_add(file_list):
86
Return a tree and list of absolute paths from a file list.
88
Similar to tree_files, but add handles files a bit differently, so it a
89
custom implementation. In particular, MutableTreeTree.smart_add expects
90
absolute paths, which it immediately converts to relative paths.
92
# FIXME Would be nice to just return the relative paths like
93
# internal_tree_files does, but there are a large number of unit tests
94
# that assume the current interface to mutabletree.smart_add
96
tree, relpath = WorkingTree.open_containing(file_list[0])
97
if tree.supports_views():
98
view_files = tree.views.lookup_view()
100
for filename in file_list:
101
if not osutils.is_inside_any(view_files, filename):
102
raise errors.FileOutsideView(filename, view_files)
103
file_list = file_list[:]
104
file_list[0] = tree.abspath(relpath)
106
tree = WorkingTree.open_containing(u'.')[0]
107
if tree.supports_views():
108
view_files = tree.views.lookup_view()
110
file_list = view_files
111
view_str = views.view_display_str(view_files)
112
note("Ignoring files outside view. View is %s" % view_str)
113
return tree, file_list
116
def _get_one_revision(command_name, revisions):
117
if revisions is None:
119
if len(revisions) != 1:
120
raise errors.BzrCommandError(
121
'bzr %s --revision takes exactly one revision identifier' % (
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
127
"""Get a revision tree. Not suitable for commands that change the tree.
129
Specifically, the basis tree in dirstate trees is coupled to the dirstate
130
and doing a commit/uncommit/pull will at best fail due to changing the
133
If tree is passed in, it should be already locked, for lifetime management
134
of the trees internal cached state.
138
if revisions is None:
140
rev_tree = tree.basis_tree()
142
rev_tree = branch.basis_tree()
144
revision = _get_one_revision(command_name, revisions)
145
rev_tree = revision.as_tree(branch)
149
# XXX: Bad function name; should possibly also be a class method of
150
# WorkingTree rather than a function.
151
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
"""Convert command-line paths to a WorkingTree and relative paths.
155
This is typically used for command-line processors that take one or
156
more filenames, and infer the workingtree that contains them.
158
The filenames given are not required to exist.
160
:param file_list: Filenames to convert.
162
:param default_branch: Fallback tree path to use if file_list is empty or
165
:param apply_view: if True and a view is set, apply it or check that
166
specified files are within it
168
:return: workingtree, [relative_paths]
170
if file_list is None or len(file_list) == 0:
171
tree = WorkingTree.open_containing(default_branch)[0]
172
if tree.supports_views() and apply_view:
173
view_files = tree.views.lookup_view()
175
file_list = view_files
176
view_str = views.view_display_str(view_files)
177
note("Ignoring files outside view. View is %s" % view_str)
178
return tree, file_list
179
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
180
return tree, safe_relpath_files(tree, file_list, canonicalize,
181
apply_view=apply_view)
184
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
185
"""Convert file_list into a list of relpaths in tree.
187
:param tree: A tree to operate on.
188
:param file_list: A list of user provided paths or None.
189
:param apply_view: if True and a view is set, apply it or check that
190
specified files are within it
191
:return: A list of relative paths.
192
:raises errors.PathNotChild: When a provided path is in a different tree
195
if file_list is None:
197
if tree.supports_views() and apply_view:
198
view_files = tree.views.lookup_view()
202
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
203
# doesn't - fix that up here before we enter the loop.
205
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
208
for filename in file_list:
210
relpath = fixer(osutils.dereference_path(filename))
211
if view_files and not osutils.is_inside_any(view_files, relpath):
212
raise errors.FileOutsideView(filename, view_files)
213
new_list.append(relpath)
214
except errors.PathNotChild:
215
raise errors.FileInWrongBranch(tree.branch, filename)
219
def _get_view_info_for_change_reporter(tree):
220
"""Get the view information from a tree for change reporting."""
223
current_view = tree.views.get_view_info()[0]
224
if current_view is not None:
225
view_info = (current_view, tree.views.lookup_view())
226
except errors.ViewsNotSupported:
231
# TODO: Make sure no commands unconditionally use the working directory as a
232
# branch. If a filename argument is used, the first of them should be used to
233
# specify the branch. (Perhaps this can be factored out into some kind of
234
# Argument class, representing a file in a branch, where the first occurrence
237
class cmd_status(Command):
238
"""Display status summary.
240
This reports on versioned and unknown files, reporting them
241
grouped by state. Possible states are:
244
Versioned in the working copy but not in the previous revision.
247
Versioned in the previous revision but removed or deleted
251
Path of this file changed from the previous revision;
252
the text may also have changed. This includes files whose
253
parent directory was renamed.
256
Text has changed since the previous revision.
259
File kind has been changed (e.g. from file to directory).
262
Not versioned and not matching an ignore pattern.
264
Additionally for directories, symlinks and files with an executable
265
bit, Bazaar indicates their type using a trailing character: '/', '@'
268
To see ignored files use 'bzr ignored'. For details on the
269
changes to file texts, use 'bzr diff'.
271
Note that --short or -S gives status flags for each item, similar
272
to Subversion's status command. To get output similar to svn -q,
275
If no arguments are specified, the status of the entire working
276
directory is shown. Otherwise, only the status of the specified
277
files or directories is reported. If a directory is given, status
278
is reported for everything inside that directory.
280
Before merges are committed, the pending merge tip revisions are
281
shown. To see all pending merge revisions, use the -v option.
282
To skip the display of pending merge information altogether, use
283
the no-pending option or specify a file/directory.
285
If a revision argument is given, the status is calculated against
286
that revision, or between two revisions if two are provided.
289
# TODO: --no-recurse, --recurse options
291
takes_args = ['file*']
292
takes_options = ['show-ids', 'revision', 'change', 'verbose',
293
Option('short', help='Use short status indicators.',
295
Option('versioned', help='Only show versioned files.',
297
Option('no-pending', help='Don\'t show pending merges.',
300
aliases = ['st', 'stat']
302
encoding_type = 'replace'
303
_see_also = ['diff', 'revert', 'status-flags']
306
def run(self, show_ids=False, file_list=None, revision=None, short=False,
307
versioned=False, no_pending=False, verbose=False):
308
from bzrlib.status import show_tree_status
310
if revision and len(revision) > 2:
311
raise errors.BzrCommandError('bzr status --revision takes exactly'
312
' one or two revision specifiers')
314
tree, relfile_list = tree_files(file_list)
315
# Avoid asking for specific files when that is not needed.
316
if relfile_list == ['']:
318
# Don't disable pending merges for full trees other than '.'.
319
if file_list == ['.']:
321
# A specific path within a tree was given.
322
elif relfile_list is not None:
324
show_tree_status(tree, show_ids=show_ids,
325
specific_files=relfile_list, revision=revision,
326
to_file=self.outf, short=short, versioned=versioned,
327
show_pending=(not no_pending), verbose=verbose)
330
class cmd_cat_revision(Command):
331
"""Write out metadata for a revision.
333
The revision to print can either be specified by a specific
334
revision identifier, or you can use --revision.
338
takes_args = ['revision_id?']
339
takes_options = ['revision']
340
# cat-revision is more for frontends so should be exact
343
def print_revision(self, revisions, revid):
344
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
345
record = stream.next()
346
if record.storage_kind == 'absent':
347
raise errors.NoSuchRevision(revisions, revid)
348
revtext = record.get_bytes_as('fulltext')
349
self.outf.write(revtext.decode('utf-8'))
352
def run(self, revision_id=None, revision=None):
353
if revision_id is not None and revision is not None:
354
raise errors.BzrCommandError('You can only supply one of'
355
' revision_id or --revision')
356
if revision_id is None and revision is None:
357
raise errors.BzrCommandError('You must supply either'
358
' --revision or a revision_id')
359
b = WorkingTree.open_containing(u'.')[0].branch
361
revisions = b.repository.revisions
362
if revisions is None:
363
raise errors.BzrCommandError('Repository %r does not support '
364
'access to raw revision texts')
366
b.repository.lock_read()
368
# TODO: jam 20060112 should cat-revision always output utf-8?
369
if revision_id is not None:
370
revision_id = osutils.safe_revision_id(revision_id, warn=False)
372
self.print_revision(revisions, revision_id)
373
except errors.NoSuchRevision:
374
msg = "The repository %s contains no revision %s." % (
375
b.repository.base, revision_id)
376
raise errors.BzrCommandError(msg)
377
elif revision is not None:
380
raise errors.BzrCommandError(
381
'You cannot specify a NULL revision.')
382
rev_id = rev.as_revision_id(b)
383
self.print_revision(revisions, rev_id)
385
b.repository.unlock()
388
class cmd_dump_btree(Command):
389
"""Dump the contents of a btree index file to stdout.
391
PATH is a btree index file, it can be any URL. This includes things like
392
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
394
By default, the tuples stored in the index file will be displayed. With
395
--raw, we will uncompress the pages, but otherwise display the raw bytes
399
# TODO: Do we want to dump the internal nodes as well?
400
# TODO: It would be nice to be able to dump the un-parsed information,
401
# rather than only going through iter_all_entries. However, this is
402
# good enough for a start
404
encoding_type = 'exact'
405
takes_args = ['path']
406
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
407
' rather than the parsed tuples.'),
410
def run(self, path, raw=False):
411
dirname, basename = osutils.split(path)
412
t = transport.get_transport(dirname)
414
self._dump_raw_bytes(t, basename)
416
self._dump_entries(t, basename)
418
def _get_index_and_bytes(self, trans, basename):
419
"""Create a BTreeGraphIndex and raw bytes."""
420
bt = btree_index.BTreeGraphIndex(trans, basename, None)
421
bytes = trans.get_bytes(basename)
422
bt._file = cStringIO.StringIO(bytes)
423
bt._size = len(bytes)
426
def _dump_raw_bytes(self, trans, basename):
429
# We need to parse at least the root node.
430
# This is because the first page of every row starts with an
431
# uncompressed header.
432
bt, bytes = self._get_index_and_bytes(trans, basename)
433
for page_idx, page_start in enumerate(xrange(0, len(bytes),
434
btree_index._PAGE_SIZE)):
435
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
436
page_bytes = bytes[page_start:page_end]
438
self.outf.write('Root node:\n')
439
header_end, data = bt._parse_header_from_bytes(page_bytes)
440
self.outf.write(page_bytes[:header_end])
442
self.outf.write('\nPage %d\n' % (page_idx,))
443
decomp_bytes = zlib.decompress(page_bytes)
444
self.outf.write(decomp_bytes)
445
self.outf.write('\n')
447
def _dump_entries(self, trans, basename):
449
st = trans.stat(basename)
450
except errors.TransportNotPossible:
451
# We can't stat, so we'll fake it because we have to do the 'get()'
453
bt, _ = self._get_index_and_bytes(trans, basename)
455
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
456
for node in bt.iter_all_entries():
457
# Node is made up of:
458
# (index, key, value, [references])
462
refs_as_tuples = None
464
refs_as_tuples = static_tuple.as_tuples(refs)
465
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
466
self.outf.write('%s\n' % (as_tuple,))
469
class cmd_remove_tree(Command):
470
"""Remove the working tree from a given branch/checkout.
472
Since a lightweight checkout is little more than a working tree
473
this will refuse to run against one.
475
To re-create the working tree, use "bzr checkout".
477
_see_also = ['checkout', 'working-trees']
478
takes_args = ['location*']
481
help='Remove the working tree even if it has '
482
'uncommitted changes.'),
485
def run(self, location_list, force=False):
486
if not location_list:
489
for location in location_list:
490
d = bzrdir.BzrDir.open(location)
493
working = d.open_workingtree()
494
except errors.NoWorkingTree:
495
raise errors.BzrCommandError("No working tree to remove")
496
except errors.NotLocalUrl:
497
raise errors.BzrCommandError("You cannot remove the working tree"
500
if (working.has_changes()):
501
raise errors.UncommittedChanges(working)
503
working_path = working.bzrdir.root_transport.base
504
branch_path = working.branch.bzrdir.root_transport.base
505
if working_path != branch_path:
506
raise errors.BzrCommandError("You cannot remove the working tree"
507
" from a lightweight checkout")
509
d.destroy_workingtree()
512
class cmd_revno(Command):
513
"""Show current revision number.
515
This is equal to the number of revisions on this branch.
519
takes_args = ['location?']
521
Option('tree', help='Show revno of working tree'),
525
def run(self, tree=False, location=u'.'):
528
wt = WorkingTree.open_containing(location)[0]
530
except (errors.NoWorkingTree, errors.NotLocalUrl):
531
raise errors.NoWorkingTree(location)
532
self.add_cleanup(wt.unlock)
533
revid = wt.last_revision()
535
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
536
except errors.NoSuchRevision:
538
revno = ".".join(str(n) for n in revno_t)
540
b = Branch.open_containing(location)[0]
542
self.add_cleanup(b.unlock)
545
self.outf.write(str(revno) + '\n')
548
class cmd_revision_info(Command):
549
"""Show revision number and revision id for a given revision identifier.
552
takes_args = ['revision_info*']
556
help='Branch to examine, '
557
'rather than the one containing the working directory.',
561
Option('tree', help='Show revno of working tree'),
565
def run(self, revision=None, directory=u'.', tree=False,
566
revision_info_list=[]):
569
wt = WorkingTree.open_containing(directory)[0]
572
self.add_cleanup(wt.unlock)
573
except (errors.NoWorkingTree, errors.NotLocalUrl):
575
b = Branch.open_containing(directory)[0]
577
self.add_cleanup(b.unlock)
579
if revision is not None:
580
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
581
if revision_info_list is not None:
582
for rev_str in revision_info_list:
583
rev_spec = RevisionSpec.from_string(rev_str)
584
revision_ids.append(rev_spec.as_revision_id(b))
585
# No arguments supplied, default to the last revision
586
if len(revision_ids) == 0:
589
raise errors.NoWorkingTree(directory)
590
revision_ids.append(wt.last_revision())
592
revision_ids.append(b.last_revision())
596
for revision_id in revision_ids:
598
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
599
revno = '.'.join(str(i) for i in dotted_revno)
600
except errors.NoSuchRevision:
602
maxlen = max(maxlen, len(revno))
603
revinfos.append([revno, revision_id])
607
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
610
class cmd_add(Command):
611
"""Add specified files or directories.
613
In non-recursive mode, all the named items are added, regardless
614
of whether they were previously ignored. A warning is given if
615
any of the named files are already versioned.
617
In recursive mode (the default), files are treated the same way
618
but the behaviour for directories is different. Directories that
619
are already versioned do not give a warning. All directories,
620
whether already versioned or not, are searched for files or
621
subdirectories that are neither versioned or ignored, and these
622
are added. This search proceeds recursively into versioned
623
directories. If no names are given '.' is assumed.
625
Therefore simply saying 'bzr add' will version all files that
626
are currently unknown.
628
Adding a file whose parent directory is not versioned will
629
implicitly add the parent, and so on up to the root. This means
630
you should never need to explicitly add a directory, they'll just
631
get added when you add a file in the directory.
633
--dry-run will show which files would be added, but not actually
636
--file-ids-from will try to use the file ids from the supplied path.
637
It looks up ids trying to find a matching parent directory with the
638
same filename, and then by pure path. This option is rarely needed
639
but can be useful when adding the same logical file into two
640
branches that will be merged later (without showing the two different
641
adds as a conflict). It is also useful when merging another project
642
into a subdirectory of this one.
644
Any files matching patterns in the ignore list will not be added
645
unless they are explicitly mentioned.
647
takes_args = ['file*']
650
help="Don't recursively add the contents of directories."),
652
help="Show what would be done, but don't actually do anything."),
654
Option('file-ids-from',
656
help='Lookup file ids from this tree.'),
658
encoding_type = 'replace'
659
_see_also = ['remove', 'ignore']
661
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
666
if file_ids_from is not None:
668
base_tree, base_path = WorkingTree.open_containing(
670
except errors.NoWorkingTree:
671
base_branch, base_path = Branch.open_containing(
673
base_tree = base_branch.basis_tree()
675
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
676
to_file=self.outf, should_print=(not is_quiet()))
678
action = bzrlib.add.AddAction(to_file=self.outf,
679
should_print=(not is_quiet()))
682
base_tree.lock_read()
683
self.add_cleanup(base_tree.unlock)
684
tree, file_list = tree_files_for_add(file_list)
685
added, ignored = tree.smart_add(file_list, not
686
no_recurse, action=action, save=not dry_run)
690
for glob in sorted(ignored.keys()):
691
for path in ignored[glob]:
692
self.outf.write("ignored %s matching \"%s\"\n"
696
class cmd_mkdir(Command):
697
"""Create a new versioned directory.
699
This is equivalent to creating the directory and then adding it.
702
takes_args = ['dir+']
703
encoding_type = 'replace'
705
def run(self, dir_list):
707
wt, dd = WorkingTree.open_containing(d)
708
base = os.path.dirname(dd)
709
id = wt.path2id(base)
713
self.outf.write('added %s\n' % d)
715
raise errors.NotVersionedError(path=base)
718
class cmd_relpath(Command):
719
"""Show path of a file relative to root"""
721
takes_args = ['filename']
725
def run(self, filename):
726
# TODO: jam 20050106 Can relpath return a munged path if
727
# sys.stdout encoding cannot represent it?
728
tree, relpath = WorkingTree.open_containing(filename)
729
self.outf.write(relpath)
730
self.outf.write('\n')
733
class cmd_inventory(Command):
734
"""Show inventory of the current working copy or a revision.
736
It is possible to limit the output to a particular entry
737
type using the --kind option. For example: --kind file.
739
It is also possible to restrict the list of files to a specific
740
set. For example: bzr inventory --show-ids this/file
749
help='List entries of a particular kind: file, directory, symlink.',
752
takes_args = ['file*']
755
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
756
if kind and kind not in ['file', 'directory', 'symlink']:
757
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
759
revision = _get_one_revision('inventory', revision)
760
work_tree, file_list = tree_files(file_list)
761
work_tree.lock_read()
762
self.add_cleanup(work_tree.unlock)
763
if revision is not None:
764
tree = revision.as_tree(work_tree.branch)
766
extra_trees = [work_tree]
768
self.add_cleanup(tree.unlock)
773
if file_list is not None:
774
file_ids = tree.paths2ids(file_list, trees=extra_trees,
775
require_versioned=True)
776
# find_ids_across_trees may include some paths that don't
778
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
779
for file_id in file_ids if file_id in tree)
781
entries = tree.inventory.entries()
784
for path, entry in entries:
785
if kind and kind != entry.kind:
788
self.outf.write('%-50s %s\n' % (path, entry.file_id))
790
self.outf.write(path)
791
self.outf.write('\n')
794
class cmd_mv(Command):
795
"""Move or rename a file.
798
bzr mv OLDNAME NEWNAME
800
bzr mv SOURCE... DESTINATION
802
If the last argument is a versioned directory, all the other names
803
are moved into it. Otherwise, there must be exactly two arguments
804
and the file is changed to a new name.
806
If OLDNAME does not exist on the filesystem but is versioned and
807
NEWNAME does exist on the filesystem but is not versioned, mv
808
assumes that the file has been manually moved and only updates
809
its internal inventory to reflect that change.
810
The same is valid when moving many SOURCE files to a DESTINATION.
812
Files cannot be moved between branches.
815
takes_args = ['names*']
816
takes_options = [Option("after", help="Move only the bzr identifier"
817
" of the file, because the file has already been moved."),
818
Option('auto', help='Automatically guess renames.'),
819
Option('dry-run', help='Avoid making changes when guessing renames.'),
821
aliases = ['move', 'rename']
822
encoding_type = 'replace'
824
def run(self, names_list, after=False, auto=False, dry_run=False):
826
return self.run_auto(names_list, after, dry_run)
828
raise errors.BzrCommandError('--dry-run requires --auto.')
829
if names_list is None:
831
if len(names_list) < 2:
832
raise errors.BzrCommandError("missing file argument")
833
tree, rel_names = tree_files(names_list, canonicalize=False)
834
tree.lock_tree_write()
835
self.add_cleanup(tree.unlock)
836
self._run(tree, names_list, rel_names, after)
838
def run_auto(self, names_list, after, dry_run):
839
if names_list is not None and len(names_list) > 1:
840
raise errors.BzrCommandError('Only one path may be specified to'
843
raise errors.BzrCommandError('--after cannot be specified with'
845
work_tree, file_list = tree_files(names_list, default_branch='.')
846
work_tree.lock_tree_write()
847
self.add_cleanup(work_tree.unlock)
848
rename_map.RenameMap.guess_renames(work_tree, dry_run)
850
def _run(self, tree, names_list, rel_names, after):
851
into_existing = osutils.isdir(names_list[-1])
852
if into_existing and len(names_list) == 2:
854
# a. case-insensitive filesystem and change case of dir
855
# b. move directory after the fact (if the source used to be
856
# a directory, but now doesn't exist in the working tree
857
# and the target is an existing directory, just rename it)
858
if (not tree.case_sensitive
859
and rel_names[0].lower() == rel_names[1].lower()):
860
into_existing = False
863
# 'fix' the case of a potential 'from'
864
from_id = tree.path2id(
865
tree.get_canonical_inventory_path(rel_names[0]))
866
if (not osutils.lexists(names_list[0]) and
867
from_id and inv.get_file_kind(from_id) == "directory"):
868
into_existing = False
871
# move into existing directory
872
# All entries reference existing inventory items, so fix them up
873
# for cicp file-systems.
874
rel_names = tree.get_canonical_inventory_paths(rel_names)
875
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
877
self.outf.write("%s => %s\n" % (src, dest))
879
if len(names_list) != 2:
880
raise errors.BzrCommandError('to mv multiple files the'
881
' destination must be a versioned'
884
# for cicp file-systems: the src references an existing inventory
886
src = tree.get_canonical_inventory_path(rel_names[0])
887
# Find the canonical version of the destination: In all cases, the
888
# parent of the target must be in the inventory, so we fetch the
889
# canonical version from there (we do not always *use* the
890
# canonicalized tail portion - we may be attempting to rename the
892
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
893
dest_parent = osutils.dirname(canon_dest)
894
spec_tail = osutils.basename(rel_names[1])
895
# For a CICP file-system, we need to avoid creating 2 inventory
896
# entries that differ only by case. So regardless of the case
897
# we *want* to use (ie, specified by the user or the file-system),
898
# we must always choose to use the case of any existing inventory
899
# items. The only exception to this is when we are attempting a
900
# case-only rename (ie, canonical versions of src and dest are
902
dest_id = tree.path2id(canon_dest)
903
if dest_id is None or tree.path2id(src) == dest_id:
904
# No existing item we care about, so work out what case we
905
# are actually going to use.
907
# If 'after' is specified, the tail must refer to a file on disk.
909
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
911
# pathjoin with an empty tail adds a slash, which breaks
913
dest_parent_fq = tree.basedir
915
dest_tail = osutils.canonical_relpath(
917
osutils.pathjoin(dest_parent_fq, spec_tail))
919
# not 'after', so case as specified is used
920
dest_tail = spec_tail
922
# Use the existing item so 'mv' fails with AlreadyVersioned.
923
dest_tail = os.path.basename(canon_dest)
924
dest = osutils.pathjoin(dest_parent, dest_tail)
925
mutter("attempting to move %s => %s", src, dest)
926
tree.rename_one(src, dest, after=after)
928
self.outf.write("%s => %s\n" % (src, dest))
931
class cmd_pull(Command):
932
"""Turn this branch into a mirror of another branch.
934
By default, this command only works on branches that have not diverged.
935
Branches are considered diverged if the destination branch's most recent
936
commit is one that has not been merged (directly or indirectly) into the
939
If branches have diverged, you can use 'bzr merge' to integrate the changes
940
from one into the other. Once one branch has merged, the other should
941
be able to pull it again.
943
If you want to replace your local changes and just want your branch to
944
match the remote one, use pull --overwrite. This will work even if the two
945
branches have diverged.
947
If there is no default location set, the first pull will set it. After
948
that, you can omit the location to use the default. To change the
949
default, use --remember. The value will only be saved if the remote
950
location can be accessed.
952
Note: The location can be specified either in the form of a branch,
953
or in the form of a path to a file containing a merge directive generated
957
_see_also = ['push', 'update', 'status-flags', 'send']
958
takes_options = ['remember', 'overwrite', 'revision',
959
custom_help('verbose',
960
help='Show logs of pulled revisions.'),
962
help='Branch to pull into, '
963
'rather than the one containing the working directory.',
968
help="Perform a local pull in a bound "
969
"branch. Local pulls are not applied to "
973
takes_args = ['location?']
974
encoding_type = 'replace'
976
def run(self, location=None, remember=False, overwrite=False,
977
revision=None, verbose=False,
978
directory=None, local=False):
979
# FIXME: too much stuff is in the command class
982
if directory is None:
985
tree_to = WorkingTree.open_containing(directory)[0]
986
branch_to = tree_to.branch
987
except errors.NoWorkingTree:
989
branch_to = Branch.open_containing(directory)[0]
991
if local and not branch_to.get_bound_location():
992
raise errors.LocalRequiresBoundBranch()
994
possible_transports = []
995
if location is not None:
997
mergeable = bundle.read_mergeable_from_url(location,
998
possible_transports=possible_transports)
999
except errors.NotABundle:
1002
stored_loc = branch_to.get_parent()
1003
if location is None:
1004
if stored_loc is None:
1005
raise errors.BzrCommandError("No pull location known or"
1008
display_url = urlutils.unescape_for_display(stored_loc,
1011
self.outf.write("Using saved parent location: %s\n" % display_url)
1012
location = stored_loc
1014
revision = _get_one_revision('pull', revision)
1015
if mergeable is not None:
1016
if revision is not None:
1017
raise errors.BzrCommandError(
1018
'Cannot use -r with merge directives or bundles')
1019
mergeable.install_revisions(branch_to.repository)
1020
base_revision_id, revision_id, verified = \
1021
mergeable.get_merge_request(branch_to.repository)
1022
branch_from = branch_to
1024
branch_from = Branch.open(location,
1025
possible_transports=possible_transports)
1027
if branch_to.get_parent() is None or remember:
1028
branch_to.set_parent(branch_from.base)
1030
if branch_from is not branch_to:
1031
branch_from.lock_read()
1032
self.add_cleanup(branch_from.unlock)
1033
if revision is not None:
1034
revision_id = revision.as_revision_id(branch_from)
1036
branch_to.lock_write()
1037
self.add_cleanup(branch_to.unlock)
1038
if tree_to is not None:
1039
view_info = _get_view_info_for_change_reporter(tree_to)
1040
change_reporter = delta._ChangeReporter(
1041
unversioned_filter=tree_to.is_ignored,
1042
view_info=view_info)
1043
result = tree_to.pull(
1044
branch_from, overwrite, revision_id, change_reporter,
1045
possible_transports=possible_transports, local=local)
1047
result = branch_to.pull(
1048
branch_from, overwrite, revision_id, local=local)
1050
result.report(self.outf)
1051
if verbose and result.old_revid != result.new_revid:
1052
log.show_branch_change(
1053
branch_to, self.outf, result.old_revno,
1057
class cmd_push(Command):
1058
"""Update a mirror of this branch.
1060
The target branch will not have its working tree populated because this
1061
is both expensive, and is not supported on remote file systems.
1063
Some smart servers or protocols *may* put the working tree in place in
1066
This command only works on branches that have not diverged. Branches are
1067
considered diverged if the destination branch's most recent commit is one
1068
that has not been merged (directly or indirectly) by the source branch.
1070
If branches have diverged, you can use 'bzr push --overwrite' to replace
1071
the other branch completely, discarding its unmerged changes.
1073
If you want to ensure you have the different changes in the other branch,
1074
do a merge (see bzr help merge) from the other branch, and commit that.
1075
After that you will be able to do a push without '--overwrite'.
1077
If there is no default push location set, the first push will set it.
1078
After that, you can omit the location to use the default. To change the
1079
default, use --remember. The value will only be saved if the remote
1080
location can be accessed.
1083
_see_also = ['pull', 'update', 'working-trees']
1084
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1085
Option('create-prefix',
1086
help='Create the path leading up to the branch '
1087
'if it does not already exist.'),
1089
help='Branch to push from, '
1090
'rather than the one containing the working directory.',
1094
Option('use-existing-dir',
1095
help='By default push will fail if the target'
1096
' directory exists, but does not already'
1097
' have a control directory. This flag will'
1098
' allow push to proceed.'),
1100
help='Create a stacked branch that references the public location '
1101
'of the parent branch.'),
1102
Option('stacked-on',
1103
help='Create a stacked branch that refers to another branch '
1104
'for the commit history. Only the work not present in the '
1105
'referenced branch is included in the branch created.',
1108
help='Refuse to push if there are uncommitted changes in'
1109
' the working tree, --no-strict disables the check.'),
1111
takes_args = ['location?']
1112
encoding_type = 'replace'
1114
def run(self, location=None, remember=False, overwrite=False,
1115
create_prefix=False, verbose=False, revision=None,
1116
use_existing_dir=False, directory=None, stacked_on=None,
1117
stacked=False, strict=None):
1118
from bzrlib.push import _show_push_branch
1120
if directory is None:
1122
# Get the source branch
1124
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1126
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1127
if strict is None: strict = True # default value
1128
# Get the tip's revision_id
1129
revision = _get_one_revision('push', revision)
1130
if revision is not None:
1131
revision_id = revision.in_history(br_from).rev_id
1134
if strict and tree is not None and revision_id is None:
1135
if (tree.has_changes()):
1136
raise errors.UncommittedChanges(
1137
tree, more='Use --no-strict to force the push.')
1138
if tree.last_revision() != tree.branch.last_revision():
1139
# The tree has lost sync with its branch, there is little
1140
# chance that the user is aware of it but he can still force
1141
# the push with --no-strict
1142
raise errors.OutOfDateTree(
1143
tree, more='Use --no-strict to force the push.')
1145
# Get the stacked_on branch, if any
1146
if stacked_on is not None:
1147
stacked_on = urlutils.normalize_url(stacked_on)
1149
parent_url = br_from.get_parent()
1151
parent = Branch.open(parent_url)
1152
stacked_on = parent.get_public_branch()
1154
# I considered excluding non-http url's here, thus forcing
1155
# 'public' branches only, but that only works for some
1156
# users, so it's best to just depend on the user spotting an
1157
# error by the feedback given to them. RBC 20080227.
1158
stacked_on = parent_url
1160
raise errors.BzrCommandError(
1161
"Could not determine branch to refer to.")
1163
# Get the destination location
1164
if location is None:
1165
stored_loc = br_from.get_push_location()
1166
if stored_loc is None:
1167
raise errors.BzrCommandError(
1168
"No push location known or specified.")
1170
display_url = urlutils.unescape_for_display(stored_loc,
1172
self.outf.write("Using saved push location: %s\n" % display_url)
1173
location = stored_loc
1175
_show_push_branch(br_from, revision_id, location, self.outf,
1176
verbose=verbose, overwrite=overwrite, remember=remember,
1177
stacked_on=stacked_on, create_prefix=create_prefix,
1178
use_existing_dir=use_existing_dir)
1181
class cmd_branch(Command):
1182
"""Create a new branch that is a copy of an existing branch.
1184
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1185
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1186
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1187
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1188
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1191
To retrieve the branch as of a particular revision, supply the --revision
1192
parameter, as in "branch foo/bar -r 5".
1195
_see_also = ['checkout']
1196
takes_args = ['from_location', 'to_location?']
1197
takes_options = ['revision', Option('hardlink',
1198
help='Hard-link working tree files where possible.'),
1200
help="Create a branch without a working-tree."),
1202
help="Switch the checkout in the current directory "
1203
"to the new branch."),
1205
help='Create a stacked branch referring to the source branch. '
1206
'The new branch will depend on the availability of the source '
1207
'branch for all operations.'),
1208
Option('standalone',
1209
help='Do not use a shared repository, even if available.'),
1210
Option('use-existing-dir',
1211
help='By default branch will fail if the target'
1212
' directory exists, but does not already'
1213
' have a control directory. This flag will'
1214
' allow branch to proceed.'),
1216
help="Bind new branch to from location."),
1218
aliases = ['get', 'clone']
1220
def run(self, from_location, to_location=None, revision=None,
1221
hardlink=False, stacked=False, standalone=False, no_tree=False,
1222
use_existing_dir=False, switch=False, bind=False):
1223
from bzrlib import switch as _mod_switch
1224
from bzrlib.tag import _merge_tags_if_possible
1225
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1227
revision = _get_one_revision('branch', revision)
1229
self.add_cleanup(br_from.unlock)
1230
if revision is not None:
1231
revision_id = revision.as_revision_id(br_from)
1233
# FIXME - wt.last_revision, fallback to branch, fall back to
1234
# None or perhaps NULL_REVISION to mean copy nothing
1236
revision_id = br_from.last_revision()
1237
if to_location is None:
1238
to_location = urlutils.derive_to_location(from_location)
1239
to_transport = transport.get_transport(to_location)
1241
to_transport.mkdir('.')
1242
except errors.FileExists:
1243
if not use_existing_dir:
1244
raise errors.BzrCommandError('Target directory "%s" '
1245
'already exists.' % to_location)
1248
bzrdir.BzrDir.open_from_transport(to_transport)
1249
except errors.NotBranchError:
1252
raise errors.AlreadyBranchError(to_location)
1253
except errors.NoSuchFile:
1254
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1257
# preserve whatever source format we have.
1258
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1259
possible_transports=[to_transport],
1260
accelerator_tree=accelerator_tree,
1261
hardlink=hardlink, stacked=stacked,
1262
force_new_repo=standalone,
1263
create_tree_if_local=not no_tree,
1264
source_branch=br_from)
1265
branch = dir.open_branch()
1266
except errors.NoSuchRevision:
1267
to_transport.delete_tree('.')
1268
msg = "The branch %s has no revision %s." % (from_location,
1270
raise errors.BzrCommandError(msg)
1271
_merge_tags_if_possible(br_from, branch)
1272
# If the source branch is stacked, the new branch may
1273
# be stacked whether we asked for that explicitly or not.
1274
# We therefore need a try/except here and not just 'if stacked:'
1276
note('Created new stacked branch referring to %s.' %
1277
branch.get_stacked_on_url())
1278
except (errors.NotStacked, errors.UnstackableBranchFormat,
1279
errors.UnstackableRepositoryFormat), e:
1280
note('Branched %d revision(s).' % branch.revno())
1282
# Bind to the parent
1283
parent_branch = Branch.open(from_location)
1284
branch.bind(parent_branch)
1285
note('New branch bound to %s' % from_location)
1287
# Switch to the new branch
1288
wt, _ = WorkingTree.open_containing('.')
1289
_mod_switch.switch(wt.bzrdir, branch)
1290
note('Switched to branch: %s',
1291
urlutils.unescape_for_display(branch.base, 'utf-8'))
1294
class cmd_checkout(Command):
1295
"""Create a new checkout of an existing branch.
1297
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1298
the branch found in '.'. This is useful if you have removed the working tree
1299
or if it was never created - i.e. if you pushed the branch to its current
1300
location using SFTP.
1302
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1303
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1304
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1305
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1306
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1309
To retrieve the branch as of a particular revision, supply the --revision
1310
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1311
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1315
_see_also = ['checkouts', 'branch']
1316
takes_args = ['branch_location?', 'to_location?']
1317
takes_options = ['revision',
1318
Option('lightweight',
1319
help="Perform a lightweight checkout. Lightweight "
1320
"checkouts depend on access to the branch for "
1321
"every operation. Normal checkouts can perform "
1322
"common operations like diff and status without "
1323
"such access, and also support local commits."
1325
Option('files-from', type=str,
1326
help="Get file contents from this tree."),
1328
help='Hard-link working tree files where possible.'
1333
def run(self, branch_location=None, to_location=None, revision=None,
1334
lightweight=False, files_from=None, hardlink=False):
1335
if branch_location is None:
1336
branch_location = osutils.getcwd()
1337
to_location = branch_location
1338
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1340
revision = _get_one_revision('checkout', revision)
1341
if files_from is not None:
1342
accelerator_tree = WorkingTree.open(files_from)
1343
if revision is not None:
1344
revision_id = revision.as_revision_id(source)
1347
if to_location is None:
1348
to_location = urlutils.derive_to_location(branch_location)
1349
# if the source and to_location are the same,
1350
# and there is no working tree,
1351
# then reconstitute a branch
1352
if (osutils.abspath(to_location) ==
1353
osutils.abspath(branch_location)):
1355
source.bzrdir.open_workingtree()
1356
except errors.NoWorkingTree:
1357
source.bzrdir.create_workingtree(revision_id)
1359
source.create_checkout(to_location, revision_id, lightweight,
1360
accelerator_tree, hardlink)
1363
class cmd_renames(Command):
1364
"""Show list of renamed files.
1366
# TODO: Option to show renames between two historical versions.
1368
# TODO: Only show renames under dir, rather than in the whole branch.
1369
_see_also = ['status']
1370
takes_args = ['dir?']
1373
def run(self, dir=u'.'):
1374
tree = WorkingTree.open_containing(dir)[0]
1376
self.add_cleanup(tree.unlock)
1377
new_inv = tree.inventory
1378
old_tree = tree.basis_tree()
1379
old_tree.lock_read()
1380
self.add_cleanup(old_tree.unlock)
1381
old_inv = old_tree.inventory
1383
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1384
for f, paths, c, v, p, n, k, e in iterator:
1385
if paths[0] == paths[1]:
1389
renames.append(paths)
1391
for old_name, new_name in renames:
1392
self.outf.write("%s => %s\n" % (old_name, new_name))
1395
class cmd_update(Command):
1396
"""Update a tree to have the latest code committed to its branch.
1398
This will perform a merge into the working tree, and may generate
1399
conflicts. If you have any local changes, you will still
1400
need to commit them after the update for the update to be complete.
1402
If you want to discard your local changes, you can just do a
1403
'bzr revert' instead of 'bzr commit' after the update.
1405
If the tree's branch is bound to a master branch, it will also update
1406
the branch from the master.
1409
_see_also = ['pull', 'working-trees', 'status-flags']
1410
takes_args = ['dir?']
1411
takes_options = ['revision']
1414
def run(self, dir='.', revision=None):
1415
if revision is not None and len(revision) != 1:
1416
raise errors.BzrCommandError(
1417
"bzr update --revision takes exactly one revision")
1418
tree = WorkingTree.open_containing(dir)[0]
1419
branch = tree.branch
1420
possible_transports = []
1421
master = branch.get_master_branch(
1422
possible_transports=possible_transports)
1423
if master is not None:
1425
branch_location = master.base
1427
tree.lock_tree_write()
1428
branch_location = tree.branch.base
1429
self.add_cleanup(tree.unlock)
1430
# get rid of the final '/' and be ready for display
1431
branch_location = urlutils.unescape_for_display(
1432
branch_location.rstrip('/'),
1434
existing_pending_merges = tree.get_parent_ids()[1:]
1438
# may need to fetch data into a heavyweight checkout
1439
# XXX: this may take some time, maybe we should display a
1441
old_tip = branch.update(possible_transports)
1442
if revision is not None:
1443
revision_id = revision[0].as_revision_id(branch)
1445
revision_id = branch.last_revision()
1446
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1447
revno = branch.revision_id_to_revno(revision_id)
1448
note("Tree is up to date at revision %d of branch %s" %
1449
(revno, branch_location))
1451
view_info = _get_view_info_for_change_reporter(tree)
1452
change_reporter = delta._ChangeReporter(
1453
unversioned_filter=tree.is_ignored,
1454
view_info=view_info)
1456
conflicts = tree.update(
1458
possible_transports=possible_transports,
1459
revision=revision_id,
1461
except errors.NoSuchRevision, e:
1462
raise errors.BzrCommandError(
1463
"branch has no revision %s\n"
1464
"bzr update --revision only works"
1465
" for a revision in the branch history"
1467
revno = tree.branch.revision_id_to_revno(
1468
_mod_revision.ensure_null(tree.last_revision()))
1469
note('Updated to revision %d of branch %s' %
1470
(revno, branch_location))
1471
if tree.get_parent_ids()[1:] != existing_pending_merges:
1472
note('Your local commits will now show as pending merges with '
1473
"'bzr status', and can be committed with 'bzr commit'.")
1480
class cmd_info(Command):
1481
"""Show information about a working tree, branch or repository.
1483
This command will show all known locations and formats associated to the
1484
tree, branch or repository.
1486
In verbose mode, statistical information is included with each report.
1487
To see extended statistic information, use a verbosity level of 2 or
1488
higher by specifying the verbose option multiple times, e.g. -vv.
1490
Branches and working trees will also report any missing revisions.
1494
Display information on the format and related locations:
1498
Display the above together with extended format information and
1499
basic statistics (like the number of files in the working tree and
1500
number of revisions in the branch and repository):
1504
Display the above together with number of committers to the branch:
1508
_see_also = ['revno', 'working-trees', 'repositories']
1509
takes_args = ['location?']
1510
takes_options = ['verbose']
1511
encoding_type = 'replace'
1514
def run(self, location=None, verbose=False):
1516
noise_level = get_verbosity_level()
1519
from bzrlib.info import show_bzrdir_info
1520
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1521
verbose=noise_level, outfile=self.outf)
1524
class cmd_remove(Command):
1525
"""Remove files or directories.
1527
This makes bzr stop tracking changes to the specified files. bzr will delete
1528
them if they can easily be recovered using revert. If no options or
1529
parameters are given bzr will scan for files that are being tracked by bzr
1530
but missing in your tree and stop tracking them for you.
1532
takes_args = ['file*']
1533
takes_options = ['verbose',
1534
Option('new', help='Only remove files that have never been committed.'),
1535
RegistryOption.from_kwargs('file-deletion-strategy',
1536
'The file deletion mode to be used.',
1537
title='Deletion Strategy', value_switches=True, enum_switch=False,
1538
safe='Only delete files if they can be'
1539
' safely recovered (default).',
1540
keep='Delete from bzr but leave the working copy.',
1541
force='Delete all the specified files, even if they can not be '
1542
'recovered and even if they are non-empty directories.')]
1543
aliases = ['rm', 'del']
1544
encoding_type = 'replace'
1546
def run(self, file_list, verbose=False, new=False,
1547
file_deletion_strategy='safe'):
1548
tree, file_list = tree_files(file_list)
1550
if file_list is not None:
1551
file_list = [f for f in file_list]
1554
self.add_cleanup(tree.unlock)
1555
# Heuristics should probably all move into tree.remove_smart or
1558
added = tree.changes_from(tree.basis_tree(),
1559
specific_files=file_list).added
1560
file_list = sorted([f[0] for f in added], reverse=True)
1561
if len(file_list) == 0:
1562
raise errors.BzrCommandError('No matching files.')
1563
elif file_list is None:
1564
# missing files show up in iter_changes(basis) as
1565
# versioned-with-no-kind.
1567
for change in tree.iter_changes(tree.basis_tree()):
1568
# Find paths in the working tree that have no kind:
1569
if change[1][1] is not None and change[6][1] is None:
1570
missing.append(change[1][1])
1571
file_list = sorted(missing, reverse=True)
1572
file_deletion_strategy = 'keep'
1573
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1574
keep_files=file_deletion_strategy=='keep',
1575
force=file_deletion_strategy=='force')
1578
class cmd_file_id(Command):
1579
"""Print file_id of a particular file or directory.
1581
The file_id is assigned when the file is first added and remains the
1582
same through all revisions where the file exists, even when it is
1587
_see_also = ['inventory', 'ls']
1588
takes_args = ['filename']
1591
def run(self, filename):
1592
tree, relpath = WorkingTree.open_containing(filename)
1593
i = tree.path2id(relpath)
1595
raise errors.NotVersionedError(filename)
1597
self.outf.write(i + '\n')
1600
class cmd_file_path(Command):
1601
"""Print path of file_ids to a file or directory.
1603
This prints one line for each directory down to the target,
1604
starting at the branch root.
1608
takes_args = ['filename']
1611
def run(self, filename):
1612
tree, relpath = WorkingTree.open_containing(filename)
1613
fid = tree.path2id(relpath)
1615
raise errors.NotVersionedError(filename)
1616
segments = osutils.splitpath(relpath)
1617
for pos in range(1, len(segments) + 1):
1618
path = osutils.joinpath(segments[:pos])
1619
self.outf.write("%s\n" % tree.path2id(path))
1622
class cmd_reconcile(Command):
1623
"""Reconcile bzr metadata in a branch.
1625
This can correct data mismatches that may have been caused by
1626
previous ghost operations or bzr upgrades. You should only
1627
need to run this command if 'bzr check' or a bzr developer
1628
advises you to run it.
1630
If a second branch is provided, cross-branch reconciliation is
1631
also attempted, which will check that data like the tree root
1632
id which was not present in very early bzr versions is represented
1633
correctly in both branches.
1635
At the same time it is run it may recompress data resulting in
1636
a potential saving in disk space or performance gain.
1638
The branch *MUST* be on a listable system such as local disk or sftp.
1641
_see_also = ['check']
1642
takes_args = ['branch?']
1644
def run(self, branch="."):
1645
from bzrlib.reconcile import reconcile
1646
dir = bzrdir.BzrDir.open(branch)
1650
class cmd_revision_history(Command):
1651
"""Display the list of revision ids on a branch."""
1654
takes_args = ['location?']
1659
def run(self, location="."):
1660
branch = Branch.open_containing(location)[0]
1661
for revid in branch.revision_history():
1662
self.outf.write(revid)
1663
self.outf.write('\n')
1666
class cmd_ancestry(Command):
1667
"""List all revisions merged into this branch."""
1669
_see_also = ['log', 'revision-history']
1670
takes_args = ['location?']
1675
def run(self, location="."):
1677
wt = WorkingTree.open_containing(location)[0]
1678
except errors.NoWorkingTree:
1679
b = Branch.open(location)
1680
last_revision = b.last_revision()
1683
last_revision = wt.last_revision()
1685
revision_ids = b.repository.get_ancestry(last_revision)
1687
for revision_id in revision_ids:
1688
self.outf.write(revision_id + '\n')
1691
class cmd_init(Command):
1692
"""Make a directory into a versioned branch.
1694
Use this to create an empty branch, or before importing an
1697
If there is a repository in a parent directory of the location, then
1698
the history of the branch will be stored in the repository. Otherwise
1699
init creates a standalone branch which carries its own history
1700
in the .bzr directory.
1702
If there is already a branch at the location but it has no working tree,
1703
the tree can be populated with 'bzr checkout'.
1705
Recipe for importing a tree of files::
1711
bzr commit -m "imported project"
1714
_see_also = ['init-repository', 'branch', 'checkout']
1715
takes_args = ['location?']
1717
Option('create-prefix',
1718
help='Create the path leading up to the branch '
1719
'if it does not already exist.'),
1720
RegistryOption('format',
1721
help='Specify a format for this branch. '
1722
'See "help formats".',
1723
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1724
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1725
value_switches=True,
1726
title="Branch format",
1728
Option('append-revisions-only',
1729
help='Never change revnos or the existing log.'
1730
' Append revisions to it only.')
1732
def run(self, location=None, format=None, append_revisions_only=False,
1733
create_prefix=False):
1735
format = bzrdir.format_registry.make_bzrdir('default')
1736
if location is None:
1739
to_transport = transport.get_transport(location)
1741
# The path has to exist to initialize a
1742
# branch inside of it.
1743
# Just using os.mkdir, since I don't
1744
# believe that we want to create a bunch of
1745
# locations if the user supplies an extended path
1747
to_transport.ensure_base()
1748
except errors.NoSuchFile:
1749
if not create_prefix:
1750
raise errors.BzrCommandError("Parent directory of %s"
1752
"\nYou may supply --create-prefix to create all"
1753
" leading parent directories."
1755
to_transport.create_prefix()
1758
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1759
except errors.NotBranchError:
1760
# really a NotBzrDir error...
1761
create_branch = bzrdir.BzrDir.create_branch_convenience
1762
branch = create_branch(to_transport.base, format=format,
1763
possible_transports=[to_transport])
1764
a_bzrdir = branch.bzrdir
1766
from bzrlib.transport.local import LocalTransport
1767
if a_bzrdir.has_branch():
1768
if (isinstance(to_transport, LocalTransport)
1769
and not a_bzrdir.has_workingtree()):
1770
raise errors.BranchExistsWithoutWorkingTree(location)
1771
raise errors.AlreadyBranchError(location)
1772
branch = a_bzrdir.create_branch()
1773
a_bzrdir.create_workingtree()
1774
if append_revisions_only:
1776
branch.set_append_revisions_only(True)
1777
except errors.UpgradeRequired:
1778
raise errors.BzrCommandError('This branch format cannot be set'
1779
' to append-revisions-only. Try --default.')
1781
from bzrlib.info import describe_layout, describe_format
1783
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1784
except (errors.NoWorkingTree, errors.NotLocalUrl):
1786
repository = branch.repository
1787
layout = describe_layout(repository, branch, tree).lower()
1788
format = describe_format(a_bzrdir, repository, branch, tree)
1789
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1790
if repository.is_shared():
1791
#XXX: maybe this can be refactored into transport.path_or_url()
1792
url = repository.bzrdir.root_transport.external_url()
1794
url = urlutils.local_path_from_url(url)
1795
except errors.InvalidURL:
1797
self.outf.write("Using shared repository: %s\n" % url)
1800
class cmd_init_repository(Command):
1801
"""Create a shared repository for branches to share storage space.
1803
New branches created under the repository directory will store their
1804
revisions in the repository, not in the branch directory. For branches
1805
with shared history, this reduces the amount of storage needed and
1806
speeds up the creation of new branches.
1808
If the --no-trees option is given then the branches in the repository
1809
will not have working trees by default. They will still exist as
1810
directories on disk, but they will not have separate copies of the
1811
files at a certain revision. This can be useful for repositories that
1812
store branches which are interacted with through checkouts or remote
1813
branches, such as on a server.
1816
Create a shared repository holding just branches::
1818
bzr init-repo --no-trees repo
1821
Make a lightweight checkout elsewhere::
1823
bzr checkout --lightweight repo/trunk trunk-checkout
1828
_see_also = ['init', 'branch', 'checkout', 'repositories']
1829
takes_args = ["location"]
1830
takes_options = [RegistryOption('format',
1831
help='Specify a format for this repository. See'
1832
' "bzr help formats" for details.',
1833
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1834
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1835
value_switches=True, title='Repository format'),
1837
help='Branches in the repository will default to'
1838
' not having a working tree.'),
1840
aliases = ["init-repo"]
1842
def run(self, location, format=None, no_trees=False):
1844
format = bzrdir.format_registry.make_bzrdir('default')
1846
if location is None:
1849
to_transport = transport.get_transport(location)
1850
to_transport.ensure_base()
1852
newdir = format.initialize_on_transport(to_transport)
1853
repo = newdir.create_repository(shared=True)
1854
repo.set_make_working_trees(not no_trees)
1856
from bzrlib.info import show_bzrdir_info
1857
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1860
class cmd_diff(Command):
1861
"""Show differences in the working tree, between revisions or branches.
1863
If no arguments are given, all changes for the current tree are listed.
1864
If files are given, only the changes in those files are listed.
1865
Remote and multiple branches can be compared by using the --old and
1866
--new options. If not provided, the default for both is derived from
1867
the first argument, if any, or the current tree if no arguments are
1870
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1871
produces patches suitable for "patch -p1".
1875
2 - unrepresentable changes
1880
Shows the difference in the working tree versus the last commit::
1884
Difference between the working tree and revision 1::
1888
Difference between revision 3 and revision 1::
1892
Difference between revision 3 and revision 1 for branch xxx::
1896
To see the changes introduced in revision X::
1900
Note that in the case of a merge, the -c option shows the changes
1901
compared to the left hand parent. To see the changes against
1902
another parent, use::
1904
bzr diff -r<chosen_parent>..X
1906
The changes introduced by revision 2 (equivalent to -r1..2)::
1910
Show just the differences for file NEWS::
1914
Show the differences in working tree xxx for file NEWS::
1918
Show the differences from branch xxx to this working tree:
1922
Show the differences between two branches for file NEWS::
1924
bzr diff --old xxx --new yyy NEWS
1926
Same as 'bzr diff' but prefix paths with old/ and new/::
1928
bzr diff --prefix old/:new/
1930
_see_also = ['status']
1931
takes_args = ['file*']
1933
Option('diff-options', type=str,
1934
help='Pass these options to the external diff program.'),
1935
Option('prefix', type=str,
1937
help='Set prefixes added to old and new filenames, as '
1938
'two values separated by a colon. (eg "old/:new/").'),
1940
help='Branch/tree to compare from.',
1944
help='Branch/tree to compare to.',
1950
help='Use this command to compare files.',
1954
aliases = ['di', 'dif']
1955
encoding_type = 'exact'
1958
def run(self, revision=None, file_list=None, diff_options=None,
1959
prefix=None, old=None, new=None, using=None):
1960
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1962
if (prefix is None) or (prefix == '0'):
1970
old_label, new_label = prefix.split(":")
1972
raise errors.BzrCommandError(
1973
'--prefix expects two values separated by a colon'
1974
' (eg "old/:new/")')
1976
if revision and len(revision) > 2:
1977
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
' one or two revision specifiers')
1980
(old_tree, new_tree,
1981
old_branch, new_branch,
1982
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1983
file_list, revision, old, new, apply_view=True)
1984
return show_diff_trees(old_tree, new_tree, sys.stdout,
1985
specific_files=specific_files,
1986
external_diff_options=diff_options,
1987
old_label=old_label, new_label=new_label,
1988
extra_trees=extra_trees, using=using)
1991
class cmd_deleted(Command):
1992
"""List files deleted in the working tree.
1994
# TODO: Show files deleted since a previous revision, or
1995
# between two revisions.
1996
# TODO: Much more efficient way to do this: read in new
1997
# directories with readdir, rather than stating each one. Same
1998
# level of effort but possibly much less IO. (Or possibly not,
1999
# if the directories are very large...)
2000
_see_also = ['status', 'ls']
2001
takes_options = ['show-ids']
2004
def run(self, show_ids=False):
2005
tree = WorkingTree.open_containing(u'.')[0]
2007
self.add_cleanup(tree.unlock)
2008
old = tree.basis_tree()
2010
self.add_cleanup(old.unlock)
2011
for path, ie in old.inventory.iter_entries():
2012
if not tree.has_id(ie.file_id):
2013
self.outf.write(path)
2015
self.outf.write(' ')
2016
self.outf.write(ie.file_id)
2017
self.outf.write('\n')
2020
class cmd_modified(Command):
2021
"""List files modified in working tree.
2025
_see_also = ['status', 'ls']
2028
help='Write an ascii NUL (\\0) separator '
2029
'between files rather than a newline.')
2033
def run(self, null=False):
2034
tree = WorkingTree.open_containing(u'.')[0]
2035
td = tree.changes_from(tree.basis_tree())
2036
for path, id, kind, text_modified, meta_modified in td.modified:
2038
self.outf.write(path + '\0')
2040
self.outf.write(osutils.quotefn(path) + '\n')
2043
class cmd_added(Command):
2044
"""List files added in working tree.
2048
_see_also = ['status', 'ls']
2051
help='Write an ascii NUL (\\0) separator '
2052
'between files rather than a newline.')
2056
def run(self, null=False):
2057
wt = WorkingTree.open_containing(u'.')[0]
2059
self.add_cleanup(wt.unlock)
2060
basis = wt.basis_tree()
2062
self.add_cleanup(basis.unlock)
2063
basis_inv = basis.inventory
2066
if file_id in basis_inv:
2068
if inv.is_root(file_id) and len(basis_inv) == 0:
2070
path = inv.id2path(file_id)
2071
if not os.access(osutils.abspath(path), os.F_OK):
2074
self.outf.write(path + '\0')
2076
self.outf.write(osutils.quotefn(path) + '\n')
2079
class cmd_root(Command):
2080
"""Show the tree root directory.
2082
The root is the nearest enclosing directory with a .bzr control
2085
takes_args = ['filename?']
2087
def run(self, filename=None):
2088
"""Print the branch root."""
2089
tree = WorkingTree.open_containing(filename)[0]
2090
self.outf.write(tree.basedir + '\n')
2093
def _parse_limit(limitstring):
2095
return int(limitstring)
2097
msg = "The limit argument must be an integer."
2098
raise errors.BzrCommandError(msg)
2101
def _parse_levels(s):
2105
msg = "The levels argument must be an integer."
2106
raise errors.BzrCommandError(msg)
2109
class cmd_log(Command):
2110
"""Show historical log for a branch or subset of a branch.
2112
log is bzr's default tool for exploring the history of a branch.
2113
The branch to use is taken from the first parameter. If no parameters
2114
are given, the branch containing the working directory is logged.
2115
Here are some simple examples::
2117
bzr log log the current branch
2118
bzr log foo.py log a file in its branch
2119
bzr log http://server/branch log a branch on a server
2121
The filtering, ordering and information shown for each revision can
2122
be controlled as explained below. By default, all revisions are
2123
shown sorted (topologically) so that newer revisions appear before
2124
older ones and descendants always appear before ancestors. If displayed,
2125
merged revisions are shown indented under the revision in which they
2130
The log format controls how information about each revision is
2131
displayed. The standard log formats are called ``long``, ``short``
2132
and ``line``. The default is long. See ``bzr help log-formats``
2133
for more details on log formats.
2135
The following options can be used to control what information is
2138
-l N display a maximum of N revisions
2139
-n N display N levels of revisions (0 for all, 1 for collapsed)
2140
-v display a status summary (delta) for each revision
2141
-p display a diff (patch) for each revision
2142
--show-ids display revision-ids (and file-ids), not just revnos
2144
Note that the default number of levels to display is a function of the
2145
log format. If the -n option is not used, the standard log formats show
2146
just the top level (mainline).
2148
Status summaries are shown using status flags like A, M, etc. To see
2149
the changes explained using words like ``added`` and ``modified``
2150
instead, use the -vv option.
2154
To display revisions from oldest to newest, use the --forward option.
2155
In most cases, using this option will have little impact on the total
2156
time taken to produce a log, though --forward does not incrementally
2157
display revisions like --reverse does when it can.
2159
:Revision filtering:
2161
The -r option can be used to specify what revision or range of revisions
2162
to filter against. The various forms are shown below::
2164
-rX display revision X
2165
-rX.. display revision X and later
2166
-r..Y display up to and including revision Y
2167
-rX..Y display from X to Y inclusive
2169
See ``bzr help revisionspec`` for details on how to specify X and Y.
2170
Some common examples are given below::
2172
-r-1 show just the tip
2173
-r-10.. show the last 10 mainline revisions
2174
-rsubmit:.. show what's new on this branch
2175
-rancestor:path.. show changes since the common ancestor of this
2176
branch and the one at location path
2177
-rdate:yesterday.. show changes since yesterday
2179
When logging a range of revisions using -rX..Y, log starts at
2180
revision Y and searches back in history through the primary
2181
("left-hand") parents until it finds X. When logging just the
2182
top level (using -n1), an error is reported if X is not found
2183
along the way. If multi-level logging is used (-n0), X may be
2184
a nested merge revision and the log will be truncated accordingly.
2188
If parameters are given and the first one is not a branch, the log
2189
will be filtered to show only those revisions that changed the
2190
nominated files or directories.
2192
Filenames are interpreted within their historical context. To log a
2193
deleted file, specify a revision range so that the file existed at
2194
the end or start of the range.
2196
Historical context is also important when interpreting pathnames of
2197
renamed files/directories. Consider the following example:
2199
* revision 1: add tutorial.txt
2200
* revision 2: modify tutorial.txt
2201
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2205
* ``bzr log guide.txt`` will log the file added in revision 1
2207
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2209
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2210
the original file in revision 2.
2212
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2213
was no file called guide.txt in revision 2.
2215
Renames are always followed by log. By design, there is no need to
2216
explicitly ask for this (and no way to stop logging a file back
2217
until it was last renamed).
2221
The --message option can be used for finding revisions that match a
2222
regular expression in a commit message.
2226
GUI tools and IDEs are often better at exploring history than command
2227
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2228
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2229
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2230
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2232
You may find it useful to add the aliases below to ``bazaar.conf``::
2236
top = log -l10 --line
2239
``bzr tip`` will then show the latest revision while ``bzr top``
2240
will show the last 10 mainline revisions. To see the details of a
2241
particular revision X, ``bzr show -rX``.
2243
If you are interested in looking deeper into a particular merge X,
2244
use ``bzr log -n0 -rX``.
2246
``bzr log -v`` on a branch with lots of history is currently
2247
very slow. A fix for this issue is currently under development.
2248
With or without that fix, it is recommended that a revision range
2249
be given when using the -v option.
2251
bzr has a generic full-text matching plugin, bzr-search, that can be
2252
used to find revisions matching user names, commit messages, etc.
2253
Among other features, this plugin can find all revisions containing
2254
a list of words but not others.
2256
When exploring non-mainline history on large projects with deep
2257
history, the performance of log can be greatly improved by installing
2258
the historycache plugin. This plugin buffers historical information
2259
trading disk space for faster speed.
2261
takes_args = ['file*']
2262
_see_also = ['log-formats', 'revisionspec']
2265
help='Show from oldest to newest.'),
2267
custom_help('verbose',
2268
help='Show files changed in each revision.'),
2272
type=bzrlib.option._parse_revision_str,
2274
help='Show just the specified revision.'
2275
' See also "help revisionspec".'),
2279
help='Number of levels to display - 0 for all, 1 for flat.',
2281
type=_parse_levels),
2284
help='Show revisions whose message matches this '
2285
'regular expression.',
2289
help='Limit the output to the first N revisions.',
2294
help='Show changes made in each revision as a patch.'),
2295
Option('include-merges',
2296
help='Show merged revisions like --levels 0 does.'),
2298
encoding_type = 'replace'
2301
def run(self, file_list=None, timezone='original',
2312
include_merges=False):
2313
from bzrlib.log import (
2315
make_log_request_dict,
2316
_get_info_for_log_files,
2318
direction = (forward and 'forward') or 'reverse'
2323
raise errors.BzrCommandError(
2324
'--levels and --include-merges are mutually exclusive')
2326
if change is not None:
2328
raise errors.RangeInChangeOption()
2329
if revision is not None:
2330
raise errors.BzrCommandError(
2331
'--revision and --change are mutually exclusive')
2336
filter_by_dir = False
2338
# find the file ids to log and check for directory filtering
2339
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2340
revision, file_list)
2341
self.add_cleanup(b.unlock)
2342
for relpath, file_id, kind in file_info_list:
2344
raise errors.BzrCommandError(
2345
"Path unknown at end or start of revision range: %s" %
2347
# If the relpath is the top of the tree, we log everything
2352
file_ids.append(file_id)
2353
filter_by_dir = filter_by_dir or (
2354
kind in ['directory', 'tree-reference'])
2357
# FIXME ? log the current subdir only RBC 20060203
2358
if revision is not None \
2359
and len(revision) > 0 and revision[0].get_branch():
2360
location = revision[0].get_branch()
2363
dir, relpath = bzrdir.BzrDir.open_containing(location)
2364
b = dir.open_branch()
2366
self.add_cleanup(b.unlock)
2367
rev1, rev2 = _get_revision_range(revision, b, self.name())
2369
# Decide on the type of delta & diff filtering to use
2370
# TODO: add an --all-files option to make this configurable & consistent
2378
diff_type = 'partial'
2382
# Build the log formatter
2383
if log_format is None:
2384
log_format = log.log_formatter_registry.get_default(b)
2385
# Make a non-encoding output to include the diffs - bug 328007
2386
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2387
lf = log_format(show_ids=show_ids, to_file=self.outf,
2388
to_exact_file=unencoded_output,
2389
show_timezone=timezone,
2390
delta_format=get_verbosity_level(),
2392
show_advice=levels is None)
2394
# Choose the algorithm for doing the logging. It's annoying
2395
# having multiple code paths like this but necessary until
2396
# the underlying repository format is faster at generating
2397
# deltas or can provide everything we need from the indices.
2398
# The default algorithm - match-using-deltas - works for
2399
# multiple files and directories and is faster for small
2400
# amounts of history (200 revisions say). However, it's too
2401
# slow for logging a single file in a repository with deep
2402
# history, i.e. > 10K revisions. In the spirit of "do no
2403
# evil when adding features", we continue to use the
2404
# original algorithm - per-file-graph - for the "single
2405
# file that isn't a directory without showing a delta" case.
2406
partial_history = revision and b.repository._format.supports_chks
2407
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2408
or delta_type or partial_history)
2410
# Build the LogRequest and execute it
2411
if len(file_ids) == 0:
2413
rqst = make_log_request_dict(
2414
direction=direction, specific_fileids=file_ids,
2415
start_revision=rev1, end_revision=rev2, limit=limit,
2416
message_search=message, delta_type=delta_type,
2417
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2418
Logger(b, rqst).show(lf)
2421
def _get_revision_range(revisionspec_list, branch, command_name):
2422
"""Take the input of a revision option and turn it into a revision range.
2424
It returns RevisionInfo objects which can be used to obtain the rev_id's
2425
of the desired revisions. It does some user input validations.
2427
if revisionspec_list is None:
2430
elif len(revisionspec_list) == 1:
2431
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2432
elif len(revisionspec_list) == 2:
2433
start_spec = revisionspec_list[0]
2434
end_spec = revisionspec_list[1]
2435
if end_spec.get_branch() != start_spec.get_branch():
2436
# b is taken from revision[0].get_branch(), and
2437
# show_log will use its revision_history. Having
2438
# different branches will lead to weird behaviors.
2439
raise errors.BzrCommandError(
2440
"bzr %s doesn't accept two revisions in different"
2441
" branches." % command_name)
2442
if start_spec.spec is None:
2443
# Avoid loading all the history.
2444
rev1 = RevisionInfo(branch, None, None)
2446
rev1 = start_spec.in_history(branch)
2447
# Avoid loading all of history when we know a missing
2448
# end of range means the last revision ...
2449
if end_spec.spec is None:
2450
last_revno, last_revision_id = branch.last_revision_info()
2451
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2453
rev2 = end_spec.in_history(branch)
2455
raise errors.BzrCommandError(
2456
'bzr %s --revision takes one or two values.' % command_name)
2460
def _revision_range_to_revid_range(revision_range):
2463
if revision_range[0] is not None:
2464
rev_id1 = revision_range[0].rev_id
2465
if revision_range[1] is not None:
2466
rev_id2 = revision_range[1].rev_id
2467
return rev_id1, rev_id2
2469
def get_log_format(long=False, short=False, line=False, default='long'):
2470
log_format = default
2474
log_format = 'short'
2480
class cmd_touching_revisions(Command):
2481
"""Return revision-ids which affected a particular file.
2483
A more user-friendly interface is "bzr log FILE".
2487
takes_args = ["filename"]
2490
def run(self, filename):
2491
tree, relpath = WorkingTree.open_containing(filename)
2492
file_id = tree.path2id(relpath)
2495
self.add_cleanup(b.unlock)
2496
touching_revs = log.find_touching_revisions(b, file_id)
2497
for revno, revision_id, what in touching_revs:
2498
self.outf.write("%6d %s\n" % (revno, what))
2501
class cmd_ls(Command):
2502
"""List files in a tree.
2505
_see_also = ['status', 'cat']
2506
takes_args = ['path?']
2510
Option('recursive', short_name='R',
2511
help='Recurse into subdirectories.'),
2513
help='Print paths relative to the root of the branch.'),
2514
Option('unknown', help='Print unknown files.'),
2515
Option('versioned', help='Print versioned files.',
2517
Option('ignored', help='Print ignored files.'),
2519
help='Write an ascii NUL (\\0) separator '
2520
'between files rather than a newline.'),
2522
help='List entries of a particular kind: file, directory, symlink.',
2527
def run(self, revision=None, verbose=False,
2528
recursive=False, from_root=False,
2529
unknown=False, versioned=False, ignored=False,
2530
null=False, kind=None, show_ids=False, path=None):
2532
if kind and kind not in ('file', 'directory', 'symlink'):
2533
raise errors.BzrCommandError('invalid kind specified')
2535
if verbose and null:
2536
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2537
all = not (unknown or versioned or ignored)
2539
selection = {'I':ignored, '?':unknown, 'V':versioned}
2545
raise errors.BzrCommandError('cannot specify both --from-root'
2548
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2551
# Calculate the prefix to use
2555
prefix = relpath + '/'
2556
elif fs_path != '.' and not fs_path.endswith('/'):
2557
prefix = fs_path + '/'
2559
if revision is not None or tree is None:
2560
tree = _get_one_revision_tree('ls', revision, branch=branch)
2563
if isinstance(tree, WorkingTree) and tree.supports_views():
2564
view_files = tree.views.lookup_view()
2567
view_str = views.view_display_str(view_files)
2568
note("Ignoring files outside view. View is %s" % view_str)
2571
self.add_cleanup(tree.unlock)
2572
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2573
from_dir=relpath, recursive=recursive):
2574
# Apply additional masking
2575
if not all and not selection[fc]:
2577
if kind is not None and fkind != kind:
2582
fullpath = osutils.pathjoin(relpath, fp)
2585
views.check_path_in_view(tree, fullpath)
2586
except errors.FileOutsideView:
2591
fp = osutils.pathjoin(prefix, fp)
2592
kindch = entry.kind_character()
2593
outstring = fp + kindch
2594
ui.ui_factory.clear_term()
2596
outstring = '%-8s %s' % (fc, outstring)
2597
if show_ids and fid is not None:
2598
outstring = "%-50s %s" % (outstring, fid)
2599
self.outf.write(outstring + '\n')
2601
self.outf.write(fp + '\0')
2604
self.outf.write(fid)
2605
self.outf.write('\0')
2613
self.outf.write('%-50s %s\n' % (outstring, my_id))
2615
self.outf.write(outstring + '\n')
2618
class cmd_unknowns(Command):
2619
"""List unknown files.
2627
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2628
self.outf.write(osutils.quotefn(f) + '\n')
2631
class cmd_ignore(Command):
2632
"""Ignore specified files or patterns.
2634
See ``bzr help patterns`` for details on the syntax of patterns.
2636
If a .bzrignore file does not exist, the ignore command
2637
will create one and add the specified files or patterns to the newly
2638
created file. The ignore command will also automatically add the
2639
.bzrignore file to be versioned. Creating a .bzrignore file without
2640
the use of the ignore command will require an explicit add command.
2642
To remove patterns from the ignore list, edit the .bzrignore file.
2643
After adding, editing or deleting that file either indirectly by
2644
using this command or directly by using an editor, be sure to commit
2647
Patterns prefixed with '!' are exceptions to ignore patterns and take
2648
precedence over regular ignores. Such exceptions are used to specify
2649
files that should be versioned which would otherwise be ignored.
2651
Patterns prefixed with '!!' act as regular ignore patterns, but have
2652
precedence over the '!' exception patterns.
2654
Note: ignore patterns containing shell wildcards must be quoted from
2658
Ignore the top level Makefile::
2660
bzr ignore ./Makefile
2662
Ignore .class files in all directories...::
2664
bzr ignore "*.class"
2666
...but do not ignore "special.class"::
2668
bzr ignore "!special.class"
2670
Ignore .o files under the lib directory::
2672
bzr ignore "lib/**/*.o"
2674
Ignore .o files under the lib directory::
2676
bzr ignore "RE:lib/.*\.o"
2678
Ignore everything but the "debian" toplevel directory::
2680
bzr ignore "RE:(?!debian/).*"
2682
Ignore everything except the "local" toplevel directory,
2683
but always ignore "*~" autosave files, even under local/::
2686
bzr ignore "!./local"
2690
_see_also = ['status', 'ignored', 'patterns']
2691
takes_args = ['name_pattern*']
2693
Option('old-default-rules',
2694
help='Write out the ignore rules bzr < 0.9 always used.')
2697
def run(self, name_pattern_list=None, old_default_rules=None):
2698
from bzrlib import ignores
2699
if old_default_rules is not None:
2700
# dump the rules and exit
2701
for pattern in ignores.OLD_DEFAULTS:
2702
self.outf.write("%s\n" % pattern)
2704
if not name_pattern_list:
2705
raise errors.BzrCommandError("ignore requires at least one "
2706
"NAME_PATTERN or --old-default-rules")
2707
name_pattern_list = [globbing.normalize_pattern(p)
2708
for p in name_pattern_list]
2709
for name_pattern in name_pattern_list:
2710
if (name_pattern[0] == '/' or
2711
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2712
raise errors.BzrCommandError(
2713
"NAME_PATTERN should not be an absolute path")
2714
tree, relpath = WorkingTree.open_containing(u'.')
2715
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2716
ignored = globbing.Globster(name_pattern_list)
2719
for entry in tree.list_files():
2723
if ignored.match(filename):
2724
matches.append(filename)
2726
if len(matches) > 0:
2727
self.outf.write("Warning: the following files are version controlled and"
2728
" match your ignore pattern:\n%s"
2729
"\nThese files will continue to be version controlled"
2730
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2733
class cmd_ignored(Command):
2734
"""List ignored files and the patterns that matched them.
2736
List all the ignored files and the ignore pattern that caused the file to
2739
Alternatively, to list just the files::
2744
encoding_type = 'replace'
2745
_see_also = ['ignore', 'ls']
2749
tree = WorkingTree.open_containing(u'.')[0]
2751
self.add_cleanup(tree.unlock)
2752
for path, file_class, kind, file_id, entry in tree.list_files():
2753
if file_class != 'I':
2755
## XXX: Slightly inefficient since this was already calculated
2756
pat = tree.is_ignored(path)
2757
self.outf.write('%-50s %s\n' % (path, pat))
2760
class cmd_lookup_revision(Command):
2761
"""Lookup the revision-id from a revision-number
2764
bzr lookup-revision 33
2767
takes_args = ['revno']
2770
def run(self, revno):
2774
raise errors.BzrCommandError("not a valid revision-number: %r"
2776
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2777
self.outf.write("%s\n" % revid)
2780
class cmd_export(Command):
2781
"""Export current or past revision to a destination directory or archive.
2783
If no revision is specified this exports the last committed revision.
2785
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2786
given, try to find the format with the extension. If no extension
2787
is found exports to a directory (equivalent to --format=dir).
2789
If root is supplied, it will be used as the root directory inside
2790
container formats (tar, zip, etc). If it is not supplied it will default
2791
to the exported filename. The root option has no effect for 'dir' format.
2793
If branch is omitted then the branch containing the current working
2794
directory will be used.
2796
Note: Export of tree with non-ASCII filenames to zip is not supported.
2798
================= =========================
2799
Supported formats Autodetected by extension
2800
================= =========================
2803
tbz2 .tar.bz2, .tbz2
2806
================= =========================
2808
takes_args = ['dest', 'branch_or_subdir?']
2811
help="Type of file to export to.",
2814
Option('filters', help='Apply content filters to export the '
2815
'convenient form.'),
2818
help="Name of the root directory inside the exported file."),
2819
Option('per-file-timestamps',
2820
help='Set modification time of files to that of the last '
2821
'revision in which it was changed.'),
2823
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2824
root=None, filters=False, per_file_timestamps=False):
2825
from bzrlib.export import export
2827
if branch_or_subdir is None:
2828
tree = WorkingTree.open_containing(u'.')[0]
2832
b, subdir = Branch.open_containing(branch_or_subdir)
2835
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2837
export(rev_tree, dest, format, root, subdir, filtered=filters,
2838
per_file_timestamps=per_file_timestamps)
2839
except errors.NoSuchExportFormat, e:
2840
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2843
class cmd_cat(Command):
2844
"""Write the contents of a file as of a given revision to standard output.
2846
If no revision is nominated, the last revision is used.
2848
Note: Take care to redirect standard output when using this command on a
2854
Option('name-from-revision', help='The path name in the old tree.'),
2855
Option('filters', help='Apply content filters to display the '
2856
'convenience form.'),
2859
takes_args = ['filename']
2860
encoding_type = 'exact'
2863
def run(self, filename, revision=None, name_from_revision=False,
2865
if revision is not None and len(revision) != 1:
2866
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2867
" one revision specifier")
2868
tree, branch, relpath = \
2869
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2871
self.add_cleanup(branch.unlock)
2872
return self._run(tree, branch, relpath, filename, revision,
2873
name_from_revision, filters)
2875
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2878
tree = b.basis_tree()
2879
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2880
rev_tree.lock_read()
2881
self.add_cleanup(rev_tree.unlock)
2883
old_file_id = rev_tree.path2id(relpath)
2885
if name_from_revision:
2886
# Try in revision if requested
2887
if old_file_id is None:
2888
raise errors.BzrCommandError(
2889
"%r is not present in revision %s" % (
2890
filename, rev_tree.get_revision_id()))
2892
content = rev_tree.get_file_text(old_file_id)
2894
cur_file_id = tree.path2id(relpath)
2896
if cur_file_id is not None:
2897
# Then try with the actual file id
2899
content = rev_tree.get_file_text(cur_file_id)
2901
except errors.NoSuchId:
2902
# The actual file id didn't exist at that time
2904
if not found and old_file_id is not None:
2905
# Finally try with the old file id
2906
content = rev_tree.get_file_text(old_file_id)
2909
# Can't be found anywhere
2910
raise errors.BzrCommandError(
2911
"%r is not present in revision %s" % (
2912
filename, rev_tree.get_revision_id()))
2914
from bzrlib.filters import (
2915
ContentFilterContext,
2916
filtered_output_bytes,
2918
filters = rev_tree._content_filter_stack(relpath)
2919
chunks = content.splitlines(True)
2920
content = filtered_output_bytes(chunks, filters,
2921
ContentFilterContext(relpath, rev_tree))
2923
self.outf.writelines(content)
2926
self.outf.write(content)
2929
class cmd_local_time_offset(Command):
2930
"""Show the offset in seconds from GMT to local time."""
2934
self.outf.write("%s\n" % osutils.local_time_offset())
2938
class cmd_commit(Command):
2939
"""Commit changes into a new revision.
2941
An explanatory message needs to be given for each commit. This is
2942
often done by using the --message option (getting the message from the
2943
command line) or by using the --file option (getting the message from
2944
a file). If neither of these options is given, an editor is opened for
2945
the user to enter the message. To see the changed files in the
2946
boilerplate text loaded into the editor, use the --show-diff option.
2948
By default, the entire tree is committed and the person doing the
2949
commit is assumed to be the author. These defaults can be overridden
2954
If selected files are specified, only changes to those files are
2955
committed. If a directory is specified then the directory and
2956
everything within it is committed.
2958
When excludes are given, they take precedence over selected files.
2959
For example, to commit only changes within foo, but not changes
2962
bzr commit foo -x foo/bar
2964
A selective commit after a merge is not yet supported.
2968
If the author of the change is not the same person as the committer,
2969
you can specify the author's name using the --author option. The
2970
name should be in the same format as a committer-id, e.g.
2971
"John Doe <jdoe@example.com>". If there is more than one author of
2972
the change you can specify the option multiple times, once for each
2977
A common mistake is to forget to add a new file or directory before
2978
running the commit command. The --strict option checks for unknown
2979
files and aborts the commit if any are found. More advanced pre-commit
2980
checks can be implemented by defining hooks. See ``bzr help hooks``
2985
If you accidentially commit the wrong changes or make a spelling
2986
mistake in the commit message say, you can use the uncommit command
2987
to undo it. See ``bzr help uncommit`` for details.
2989
Hooks can also be configured to run after a commit. This allows you
2990
to trigger updates to external systems like bug trackers. The --fixes
2991
option can be used to record the association between a revision and
2992
one or more bugs. See ``bzr help bugs`` for details.
2994
A selective commit may fail in some cases where the committed
2995
tree would be invalid. Consider::
3000
bzr commit foo -m "committing foo"
3001
bzr mv foo/bar foo/baz
3004
bzr commit foo/bar -m "committing bar but not baz"
3006
In the example above, the last commit will fail by design. This gives
3007
the user the opportunity to decide whether they want to commit the
3008
rename at the same time, separately first, or not at all. (As a general
3009
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3011
# TODO: Run hooks on tree to-be-committed, and after commit.
3013
# TODO: Strict commit that fails if there are deleted files.
3014
# (what does "deleted files" mean ??)
3016
# TODO: Give better message for -s, --summary, used by tla people
3018
# XXX: verbose currently does nothing
3020
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3021
takes_args = ['selected*']
3023
ListOption('exclude', type=str, short_name='x',
3024
help="Do not consider changes made to a given path."),
3025
Option('message', type=unicode,
3027
help="Description of the new revision."),
3030
help='Commit even if nothing has changed.'),
3031
Option('file', type=str,
3034
help='Take commit message from this file.'),
3036
help="Refuse to commit if there are unknown "
3037
"files in the working tree."),
3038
Option('commit-time', type=str,
3039
help="Manually set a commit time using commit date "
3040
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3041
ListOption('fixes', type=str,
3042
help="Mark a bug as being fixed by this revision "
3043
"(see \"bzr help bugs\")."),
3044
ListOption('author', type=unicode,
3045
help="Set the author's name, if it's different "
3046
"from the committer."),
3048
help="Perform a local commit in a bound "
3049
"branch. Local commits are not pushed to "
3050
"the master branch until a normal commit "
3054
help='When no message is supplied, show the diff along'
3055
' with the status summary in the message editor.'),
3057
aliases = ['ci', 'checkin']
3059
def _iter_bug_fix_urls(self, fixes, branch):
3060
# Configure the properties for bug fixing attributes.
3061
for fixed_bug in fixes:
3062
tokens = fixed_bug.split(':')
3063
if len(tokens) != 2:
3064
raise errors.BzrCommandError(
3065
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3066
"See \"bzr help bugs\" for more information on this "
3067
"feature.\nCommit refused." % fixed_bug)
3068
tag, bug_id = tokens
3070
yield bugtracker.get_bug_url(tag, branch, bug_id)
3071
except errors.UnknownBugTrackerAbbreviation:
3072
raise errors.BzrCommandError(
3073
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3074
except errors.MalformedBugIdentifier, e:
3075
raise errors.BzrCommandError(
3076
"%s\nCommit refused." % (str(e),))
3078
def run(self, message=None, file=None, verbose=False, selected_list=None,
3079
unchanged=False, strict=False, local=False, fixes=None,
3080
author=None, show_diff=False, exclude=None, commit_time=None):
3081
from bzrlib.errors import (
3086
from bzrlib.msgeditor import (
3087
edit_commit_message_encoded,
3088
generate_commit_message_template,
3089
make_commit_message_template_encoded
3092
commit_stamp = offset = None
3093
if commit_time is not None:
3095
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3096
except ValueError, e:
3097
raise errors.BzrCommandError(
3098
"Could not parse --commit-time: " + str(e))
3100
# TODO: Need a blackbox test for invoking the external editor; may be
3101
# slightly problematic to run this cross-platform.
3103
# TODO: do more checks that the commit will succeed before
3104
# spending the user's valuable time typing a commit message.
3108
tree, selected_list = tree_files(selected_list)
3109
if selected_list == ['']:
3110
# workaround - commit of root of tree should be exactly the same
3111
# as just default commit in that tree, and succeed even though
3112
# selected-file merge commit is not done yet
3117
bug_property = bugtracker.encode_fixes_bug_urls(
3118
self._iter_bug_fix_urls(fixes, tree.branch))
3120
properties['bugs'] = bug_property
3122
if local and not tree.branch.get_bound_location():
3123
raise errors.LocalRequiresBoundBranch()
3125
if message is not None:
3127
file_exists = osutils.lexists(message)
3128
except UnicodeError:
3129
# The commit message contains unicode characters that can't be
3130
# represented in the filesystem encoding, so that can't be a
3135
'The commit message is a file name: "%(f)s".\n'
3136
'(use --file "%(f)s" to take commit message from that file)'
3138
ui.ui_factory.show_warning(warning_msg)
3140
def get_message(commit_obj):
3141
"""Callback to get commit message"""
3142
my_message = message
3143
if my_message is not None and '\r' in my_message:
3144
my_message = my_message.replace('\r\n', '\n')
3145
my_message = my_message.replace('\r', '\n')
3146
if my_message is None and not file:
3147
t = make_commit_message_template_encoded(tree,
3148
selected_list, diff=show_diff,
3149
output_encoding=osutils.get_user_encoding())
3150
start_message = generate_commit_message_template(commit_obj)
3151
my_message = edit_commit_message_encoded(t,
3152
start_message=start_message)
3153
if my_message is None:
3154
raise errors.BzrCommandError("please specify a commit"
3155
" message with either --message or --file")
3156
elif my_message and file:
3157
raise errors.BzrCommandError(
3158
"please specify either --message or --file")
3160
my_message = codecs.open(file, 'rt',
3161
osutils.get_user_encoding()).read()
3162
if my_message == "":
3163
raise errors.BzrCommandError("empty commit message specified")
3166
# The API permits a commit with a filter of [] to mean 'select nothing'
3167
# but the command line should not do that.
3168
if not selected_list:
3169
selected_list = None
3171
tree.commit(message_callback=get_message,
3172
specific_files=selected_list,
3173
allow_pointless=unchanged, strict=strict, local=local,
3174
reporter=None, verbose=verbose, revprops=properties,
3175
authors=author, timestamp=commit_stamp,
3177
exclude=safe_relpath_files(tree, exclude))
3178
except PointlessCommit:
3179
# FIXME: This should really happen before the file is read in;
3180
# perhaps prepare the commit; get the message; then actually commit
3181
raise errors.BzrCommandError("No changes to commit."
3182
" Use --unchanged to commit anyhow.")
3183
except ConflictsInTree:
3184
raise errors.BzrCommandError('Conflicts detected in working '
3185
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3187
except StrictCommitFailed:
3188
raise errors.BzrCommandError("Commit refused because there are"
3189
" unknown files in the working tree.")
3190
except errors.BoundBranchOutOfDate, e:
3191
e.extra_help = ("\n"
3192
'To commit to master branch, run update and then commit.\n'
3193
'You can also pass --local to commit to continue working '
3198
class cmd_check(Command):
3199
"""Validate working tree structure, branch consistency and repository history.
3201
This command checks various invariants about branch and repository storage
3202
to detect data corruption or bzr bugs.
3204
The working tree and branch checks will only give output if a problem is
3205
detected. The output fields of the repository check are:
3208
This is just the number of revisions checked. It doesn't
3212
This is just the number of versionedfiles checked. It
3213
doesn't indicate a problem.
3215
unreferenced ancestors
3216
Texts that are ancestors of other texts, but
3217
are not properly referenced by the revision ancestry. This is a
3218
subtle problem that Bazaar can work around.
3221
This is the total number of unique file contents
3222
seen in the checked revisions. It does not indicate a problem.
3225
This is the total number of repeated texts seen
3226
in the checked revisions. Texts can be repeated when their file
3227
entries are modified, but the file contents are not. It does not
3230
If no restrictions are specified, all Bazaar data that is found at the given
3231
location will be checked.
3235
Check the tree and branch at 'foo'::
3237
bzr check --tree --branch foo
3239
Check only the repository at 'bar'::
3241
bzr check --repo bar
3243
Check everything at 'baz'::
3248
_see_also = ['reconcile']
3249
takes_args = ['path?']
3250
takes_options = ['verbose',
3251
Option('branch', help="Check the branch related to the"
3252
" current directory."),
3253
Option('repo', help="Check the repository related to the"
3254
" current directory."),
3255
Option('tree', help="Check the working tree related to"
3256
" the current directory.")]
3258
def run(self, path=None, verbose=False, branch=False, repo=False,
3260
from bzrlib.check import check_dwim
3263
if not branch and not repo and not tree:
3264
branch = repo = tree = True
3265
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3268
class cmd_upgrade(Command):
3269
"""Upgrade branch storage to current format.
3271
The check command or bzr developers may sometimes advise you to run
3272
this command. When the default format has changed you may also be warned
3273
during other operations to upgrade.
3276
_see_also = ['check']
3277
takes_args = ['url?']
3279
RegistryOption('format',
3280
help='Upgrade to a specific format. See "bzr help'
3281
' formats" for details.',
3282
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3283
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3284
value_switches=True, title='Branch format'),
3287
def run(self, url='.', format=None):
3288
from bzrlib.upgrade import upgrade
3289
upgrade(url, format)
3292
class cmd_whoami(Command):
3293
"""Show or set bzr user id.
3296
Show the email of the current user::
3300
Set the current user::
3302
bzr whoami "Frank Chu <fchu@example.com>"
3304
takes_options = [ Option('email',
3305
help='Display email address only.'),
3307
help='Set identity for the current branch instead of '
3310
takes_args = ['name?']
3311
encoding_type = 'replace'
3314
def run(self, email=False, branch=False, name=None):
3316
# use branch if we're inside one; otherwise global config
3318
c = Branch.open_containing('.')[0].get_config()
3319
except errors.NotBranchError:
3320
c = config.GlobalConfig()
3322
self.outf.write(c.user_email() + '\n')
3324
self.outf.write(c.username() + '\n')
3327
# display a warning if an email address isn't included in the given name.
3329
config.extract_email_address(name)
3330
except errors.NoEmailInUsername, e:
3331
warning('"%s" does not seem to contain an email address. '
3332
'This is allowed, but not recommended.', name)
3334
# use global config unless --branch given
3336
c = Branch.open_containing('.')[0].get_config()
3338
c = config.GlobalConfig()
3339
c.set_user_option('email', name)
3342
class cmd_nick(Command):
3343
"""Print or set the branch nickname.
3345
If unset, the tree root directory name is used as the nickname.
3346
To print the current nickname, execute with no argument.
3348
Bound branches use the nickname of its master branch unless it is set
3352
_see_also = ['info']
3353
takes_args = ['nickname?']
3354
def run(self, nickname=None):
3355
branch = Branch.open_containing(u'.')[0]
3356
if nickname is None:
3357
self.printme(branch)
3359
branch.nick = nickname
3362
def printme(self, branch):
3363
self.outf.write('%s\n' % branch.nick)
3366
class cmd_alias(Command):
3367
"""Set/unset and display aliases.
3370
Show the current aliases::
3374
Show the alias specified for 'll'::
3378
Set an alias for 'll'::
3380
bzr alias ll="log --line -r-10..-1"
3382
To remove an alias for 'll'::
3384
bzr alias --remove ll
3387
takes_args = ['name?']
3389
Option('remove', help='Remove the alias.'),
3392
def run(self, name=None, remove=False):
3394
self.remove_alias(name)
3396
self.print_aliases()
3398
equal_pos = name.find('=')
3400
self.print_alias(name)
3402
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3404
def remove_alias(self, alias_name):
3405
if alias_name is None:
3406
raise errors.BzrCommandError(
3407
'bzr alias --remove expects an alias to remove.')
3408
# If alias is not found, print something like:
3409
# unalias: foo: not found
3410
c = config.GlobalConfig()
3411
c.unset_alias(alias_name)
3414
def print_aliases(self):
3415
"""Print out the defined aliases in a similar format to bash."""
3416
aliases = config.GlobalConfig().get_aliases()
3417
for key, value in sorted(aliases.iteritems()):
3418
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3421
def print_alias(self, alias_name):
3422
from bzrlib.commands import get_alias
3423
alias = get_alias(alias_name)
3425
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3428
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3430
def set_alias(self, alias_name, alias_command):
3431
"""Save the alias in the global config."""
3432
c = config.GlobalConfig()
3433
c.set_alias(alias_name, alias_command)
3436
class cmd_selftest(Command):
3437
"""Run internal test suite.
3439
If arguments are given, they are regular expressions that say which tests
3440
should run. Tests matching any expression are run, and other tests are
3443
Alternatively if --first is given, matching tests are run first and then
3444
all other tests are run. This is useful if you have been working in a
3445
particular area, but want to make sure nothing else was broken.
3447
If --exclude is given, tests that match that regular expression are
3448
excluded, regardless of whether they match --first or not.
3450
To help catch accidential dependencies between tests, the --randomize
3451
option is useful. In most cases, the argument used is the word 'now'.
3452
Note that the seed used for the random number generator is displayed
3453
when this option is used. The seed can be explicitly passed as the
3454
argument to this option if required. This enables reproduction of the
3455
actual ordering used if and when an order sensitive problem is encountered.
3457
If --list-only is given, the tests that would be run are listed. This is
3458
useful when combined with --first, --exclude and/or --randomize to
3459
understand their impact. The test harness reports "Listed nn tests in ..."
3460
instead of "Ran nn tests in ..." when list mode is enabled.
3462
If the global option '--no-plugins' is given, plugins are not loaded
3463
before running the selftests. This has two effects: features provided or
3464
modified by plugins will not be tested, and tests provided by plugins will
3467
Tests that need working space on disk use a common temporary directory,
3468
typically inside $TMPDIR or /tmp.
3470
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3471
into a pdb postmortem session.
3474
Run only tests relating to 'ignore'::
3478
Disable plugins and list tests as they're run::
3480
bzr --no-plugins selftest -v
3482
# NB: this is used from the class without creating an instance, which is
3483
# why it does not have a self parameter.
3484
def get_transport_type(typestring):
3485
"""Parse and return a transport specifier."""
3486
if typestring == "sftp":
3487
from bzrlib.tests import stub_sftp
3488
return stub_sftp.SFTPAbsoluteServer
3489
if typestring == "memory":
3490
from bzrlib.tests import test_server
3491
return memory.MemoryServer
3492
if typestring == "fakenfs":
3493
from bzrlib.tests import test_server
3494
return test_server.FakeNFSServer
3495
msg = "No known transport type %s. Supported types are: sftp\n" %\
3497
raise errors.BzrCommandError(msg)
3500
takes_args = ['testspecs*']
3501
takes_options = ['verbose',
3503
help='Stop when one test fails.',
3507
help='Use a different transport by default '
3508
'throughout the test suite.',
3509
type=get_transport_type),
3511
help='Run the benchmarks rather than selftests.'),
3512
Option('lsprof-timed',
3513
help='Generate lsprof output for benchmarked'
3514
' sections of code.'),
3515
Option('lsprof-tests',
3516
help='Generate lsprof output for each test.'),
3517
Option('cache-dir', type=str,
3518
help='Cache intermediate benchmark output in this '
3521
help='Run all tests, but run specified tests first.',
3525
help='List the tests instead of running them.'),
3526
RegistryOption('parallel',
3527
help="Run the test suite in parallel.",
3528
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3529
value_switches=False,
3531
Option('randomize', type=str, argname="SEED",
3532
help='Randomize the order of tests using the given'
3533
' seed or "now" for the current time.'),
3534
Option('exclude', type=str, argname="PATTERN",
3536
help='Exclude tests that match this regular'
3539
help='Output test progress via subunit.'),
3540
Option('strict', help='Fail on missing dependencies or '
3542
Option('load-list', type=str, argname='TESTLISTFILE',
3543
help='Load a test id list from a text file.'),
3544
ListOption('debugflag', type=str, short_name='E',
3545
help='Turn on a selftest debug flag.'),
3546
ListOption('starting-with', type=str, argname='TESTID',
3547
param_name='starting_with', short_name='s',
3549
'Load only the tests starting with TESTID.'),
3551
encoding_type = 'replace'
3554
Command.__init__(self)
3555
self.additional_selftest_args = {}
3557
def run(self, testspecs_list=None, verbose=False, one=False,
3558
transport=None, benchmark=None,
3559
lsprof_timed=None, cache_dir=None,
3560
first=False, list_only=False,
3561
randomize=None, exclude=None, strict=False,
3562
load_list=None, debugflag=None, starting_with=None, subunit=False,
3563
parallel=None, lsprof_tests=False):
3564
from bzrlib.tests import selftest
3565
import bzrlib.benchmarks as benchmarks
3566
from bzrlib.benchmarks import tree_creator
3568
# Make deprecation warnings visible, unless -Werror is set
3569
symbol_versioning.activate_deprecation_warnings(override=False)
3571
if cache_dir is not None:
3572
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3573
if testspecs_list is not None:
3574
pattern = '|'.join(testspecs_list)
3579
from bzrlib.tests import SubUnitBzrRunner
3581
raise errors.BzrCommandError("subunit not available. subunit "
3582
"needs to be installed to use --subunit.")
3583
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3585
self.additional_selftest_args.setdefault(
3586
'suite_decorators', []).append(parallel)
3588
test_suite_factory = benchmarks.test_suite
3589
# Unless user explicitly asks for quiet, be verbose in benchmarks
3590
verbose = not is_quiet()
3591
# TODO: should possibly lock the history file...
3592
benchfile = open(".perf_history", "at", buffering=1)
3593
self.add_cleanup(benchfile.close)
3595
test_suite_factory = None
3597
selftest_kwargs = {"verbose": verbose,
3599
"stop_on_failure": one,
3600
"transport": transport,
3601
"test_suite_factory": test_suite_factory,
3602
"lsprof_timed": lsprof_timed,
3603
"lsprof_tests": lsprof_tests,
3604
"bench_history": benchfile,
3605
"matching_tests_first": first,
3606
"list_only": list_only,
3607
"random_seed": randomize,
3608
"exclude_pattern": exclude,
3610
"load_list": load_list,
3611
"debug_flags": debugflag,
3612
"starting_with": starting_with
3614
selftest_kwargs.update(self.additional_selftest_args)
3615
result = selftest(**selftest_kwargs)
3616
return int(not result)
3619
class cmd_version(Command):
3620
"""Show version of bzr."""
3622
encoding_type = 'replace'
3624
Option("short", help="Print just the version number."),
3628
def run(self, short=False):
3629
from bzrlib.version import show_version
3631
self.outf.write(bzrlib.version_string + '\n')
3633
show_version(to_file=self.outf)
3636
class cmd_rocks(Command):
3637
"""Statement of optimism."""
3643
self.outf.write("It sure does!\n")
3646
class cmd_find_merge_base(Command):
3647
"""Find and print a base revision for merging two branches."""
3648
# TODO: Options to specify revisions on either side, as if
3649
# merging only part of the history.
3650
takes_args = ['branch', 'other']
3654
def run(self, branch, other):
3655
from bzrlib.revision import ensure_null
3657
branch1 = Branch.open_containing(branch)[0]
3658
branch2 = Branch.open_containing(other)[0]
3660
self.add_cleanup(branch1.unlock)
3662
self.add_cleanup(branch2.unlock)
3663
last1 = ensure_null(branch1.last_revision())
3664
last2 = ensure_null(branch2.last_revision())
3666
graph = branch1.repository.get_graph(branch2.repository)
3667
base_rev_id = graph.find_unique_lca(last1, last2)
3669
self.outf.write('merge base is revision %s\n' % base_rev_id)
3672
class cmd_merge(Command):
3673
"""Perform a three-way merge.
3675
The source of the merge can be specified either in the form of a branch,
3676
or in the form of a path to a file containing a merge directive generated
3677
with bzr send. If neither is specified, the default is the upstream branch
3678
or the branch most recently merged using --remember.
3680
When merging a branch, by default the tip will be merged. To pick a different
3681
revision, pass --revision. If you specify two values, the first will be used as
3682
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3683
available revisions, like this is commonly referred to as "cherrypicking".
3685
Revision numbers are always relative to the branch being merged.
3687
By default, bzr will try to merge in all new work from the other
3688
branch, automatically determining an appropriate base. If this
3689
fails, you may need to give an explicit base.
3691
Merge will do its best to combine the changes in two branches, but there
3692
are some kinds of problems only a human can fix. When it encounters those,
3693
it will mark a conflict. A conflict means that you need to fix something,
3694
before you should commit.
3696
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3698
If there is no default branch set, the first merge will set it. After
3699
that, you can omit the branch to use the default. To change the
3700
default, use --remember. The value will only be saved if the remote
3701
location can be accessed.
3703
The results of the merge are placed into the destination working
3704
directory, where they can be reviewed (with bzr diff), tested, and then
3705
committed to record the result of the merge.
3707
merge refuses to run if there are any uncommitted changes, unless
3708
--force is given. The --force option can also be used to create a
3709
merge revision which has more than two parents.
3711
If one would like to merge changes from the working tree of the other
3712
branch without merging any committed revisions, the --uncommitted option
3715
To select only some changes to merge, use "merge -i", which will prompt
3716
you to apply each diff hunk and file change, similar to "shelve".
3719
To merge the latest revision from bzr.dev::
3721
bzr merge ../bzr.dev
3723
To merge changes up to and including revision 82 from bzr.dev::
3725
bzr merge -r 82 ../bzr.dev
3727
To merge the changes introduced by 82, without previous changes::
3729
bzr merge -r 81..82 ../bzr.dev
3731
To apply a merge directive contained in /tmp/merge::
3733
bzr merge /tmp/merge
3735
To create a merge revision with three parents from two branches
3736
feature1a and feature1b:
3738
bzr merge ../feature1a
3739
bzr merge ../feature1b --force
3740
bzr commit -m 'revision with three parents'
3743
encoding_type = 'exact'
3744
_see_also = ['update', 'remerge', 'status-flags', 'send']
3745
takes_args = ['location?']
3750
help='Merge even if the destination tree has uncommitted changes.'),
3754
Option('show-base', help="Show base revision text in "
3756
Option('uncommitted', help='Apply uncommitted changes'
3757
' from a working copy, instead of branch changes.'),
3758
Option('pull', help='If the destination is already'
3759
' completely merged into the source, pull from the'
3760
' source rather than merging. When this happens,'
3761
' you do not need to commit the result.'),
3763
help='Branch to merge into, '
3764
'rather than the one containing the working directory.',
3768
Option('preview', help='Instead of merging, show a diff of the'
3770
Option('interactive', help='Select changes interactively.',
3774
def run(self, location=None, revision=None, force=False,
3775
merge_type=None, show_base=False, reprocess=None, remember=False,
3776
uncommitted=False, pull=False,
3781
if merge_type is None:
3782
merge_type = _mod_merge.Merge3Merger
3784
if directory is None: directory = u'.'
3785
possible_transports = []
3787
allow_pending = True
3788
verified = 'inapplicable'
3789
tree = WorkingTree.open_containing(directory)[0]
3792
basis_tree = tree.revision_tree(tree.last_revision())
3793
except errors.NoSuchRevision:
3794
basis_tree = tree.basis_tree()
3796
# die as quickly as possible if there are uncommitted changes
3798
if tree.has_changes():
3799
raise errors.UncommittedChanges(tree)
3801
view_info = _get_view_info_for_change_reporter(tree)
3802
change_reporter = delta._ChangeReporter(
3803
unversioned_filter=tree.is_ignored, view_info=view_info)
3804
pb = ui.ui_factory.nested_progress_bar()
3805
self.add_cleanup(pb.finished)
3807
self.add_cleanup(tree.unlock)
3808
if location is not None:
3810
mergeable = bundle.read_mergeable_from_url(location,
3811
possible_transports=possible_transports)
3812
except errors.NotABundle:
3816
raise errors.BzrCommandError('Cannot use --uncommitted'
3817
' with bundles or merge directives.')
3819
if revision is not None:
3820
raise errors.BzrCommandError(
3821
'Cannot use -r with merge directives or bundles')
3822
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3825
if merger is None and uncommitted:
3826
if revision is not None and len(revision) > 0:
3827
raise errors.BzrCommandError('Cannot use --uncommitted and'
3828
' --revision at the same time.')
3829
merger = self.get_merger_from_uncommitted(tree, location, None)
3830
allow_pending = False
3833
merger, allow_pending = self._get_merger_from_branch(tree,
3834
location, revision, remember, possible_transports, None)
3836
merger.merge_type = merge_type
3837
merger.reprocess = reprocess
3838
merger.show_base = show_base
3839
self.sanity_check_merger(merger)
3840
if (merger.base_rev_id == merger.other_rev_id and
3841
merger.other_rev_id is not None):
3842
note('Nothing to do.')
3845
if merger.interesting_files is not None:
3846
raise errors.BzrCommandError('Cannot pull individual files')
3847
if (merger.base_rev_id == tree.last_revision()):
3848
result = tree.pull(merger.other_branch, False,
3849
merger.other_rev_id)
3850
result.report(self.outf)
3852
if merger.this_basis is None:
3853
raise errors.BzrCommandError(
3854
"This branch has no commits."
3855
" (perhaps you would prefer 'bzr pull')")
3857
return self._do_preview(merger)
3859
return self._do_interactive(merger)
3861
return self._do_merge(merger, change_reporter, allow_pending,
3864
def _get_preview(self, merger):
3865
tree_merger = merger.make_merger()
3866
tt = tree_merger.make_preview_transform()
3867
self.add_cleanup(tt.finalize)
3868
result_tree = tt.get_preview_tree()
3871
def _do_preview(self, merger):
3872
from bzrlib.diff import show_diff_trees
3873
result_tree = self._get_preview(merger)
3874
show_diff_trees(merger.this_tree, result_tree, self.outf,
3875
old_label='', new_label='')
3877
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3878
merger.change_reporter = change_reporter
3879
conflict_count = merger.do_merge()
3881
merger.set_pending()
3882
if verified == 'failed':
3883
warning('Preview patch does not match changes')
3884
if conflict_count != 0:
3889
def _do_interactive(self, merger):
3890
"""Perform an interactive merge.
3892
This works by generating a preview tree of the merge, then using
3893
Shelver to selectively remove the differences between the working tree
3894
and the preview tree.
3896
from bzrlib import shelf_ui
3897
result_tree = self._get_preview(merger)
3898
writer = bzrlib.option.diff_writer_registry.get()
3899
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3900
reporter=shelf_ui.ApplyReporter(),
3901
diff_writer=writer(sys.stdout))
3907
def sanity_check_merger(self, merger):
3908
if (merger.show_base and
3909
not merger.merge_type is _mod_merge.Merge3Merger):
3910
raise errors.BzrCommandError("Show-base is not supported for this"
3911
" merge type. %s" % merger.merge_type)
3912
if merger.reprocess is None:
3913
if merger.show_base:
3914
merger.reprocess = False
3916
# Use reprocess if the merger supports it
3917
merger.reprocess = merger.merge_type.supports_reprocess
3918
if merger.reprocess and not merger.merge_type.supports_reprocess:
3919
raise errors.BzrCommandError("Conflict reduction is not supported"
3920
" for merge type %s." %
3922
if merger.reprocess and merger.show_base:
3923
raise errors.BzrCommandError("Cannot do conflict reduction and"
3926
def _get_merger_from_branch(self, tree, location, revision, remember,
3927
possible_transports, pb):
3928
"""Produce a merger from a location, assuming it refers to a branch."""
3929
from bzrlib.tag import _merge_tags_if_possible
3930
# find the branch locations
3931
other_loc, user_location = self._select_branch_location(tree, location,
3933
if revision is not None and len(revision) == 2:
3934
base_loc, _unused = self._select_branch_location(tree,
3935
location, revision, 0)
3937
base_loc = other_loc
3939
other_branch, other_path = Branch.open_containing(other_loc,
3940
possible_transports)
3941
if base_loc == other_loc:
3942
base_branch = other_branch
3944
base_branch, base_path = Branch.open_containing(base_loc,
3945
possible_transports)
3946
# Find the revision ids
3947
other_revision_id = None
3948
base_revision_id = None
3949
if revision is not None:
3950
if len(revision) >= 1:
3951
other_revision_id = revision[-1].as_revision_id(other_branch)
3952
if len(revision) == 2:
3953
base_revision_id = revision[0].as_revision_id(base_branch)
3954
if other_revision_id is None:
3955
other_revision_id = _mod_revision.ensure_null(
3956
other_branch.last_revision())
3957
# Remember where we merge from
3958
if ((remember or tree.branch.get_submit_branch() is None) and
3959
user_location is not None):
3960
tree.branch.set_submit_branch(other_branch.base)
3961
_merge_tags_if_possible(other_branch, tree.branch)
3962
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3963
other_revision_id, base_revision_id, other_branch, base_branch)
3964
if other_path != '':
3965
allow_pending = False
3966
merger.interesting_files = [other_path]
3968
allow_pending = True
3969
return merger, allow_pending
3971
def get_merger_from_uncommitted(self, tree, location, pb):
3972
"""Get a merger for uncommitted changes.
3974
:param tree: The tree the merger should apply to.
3975
:param location: The location containing uncommitted changes.
3976
:param pb: The progress bar to use for showing progress.
3978
location = self._select_branch_location(tree, location)[0]
3979
other_tree, other_path = WorkingTree.open_containing(location)
3980
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3981
if other_path != '':
3982
merger.interesting_files = [other_path]
3985
def _select_branch_location(self, tree, user_location, revision=None,
3987
"""Select a branch location, according to possible inputs.
3989
If provided, branches from ``revision`` are preferred. (Both
3990
``revision`` and ``index`` must be supplied.)
3992
Otherwise, the ``location`` parameter is used. If it is None, then the
3993
``submit`` or ``parent`` location is used, and a note is printed.
3995
:param tree: The working tree to select a branch for merging into
3996
:param location: The location entered by the user
3997
:param revision: The revision parameter to the command
3998
:param index: The index to use for the revision parameter. Negative
3999
indices are permitted.
4000
:return: (selected_location, user_location). The default location
4001
will be the user-entered location.
4003
if (revision is not None and index is not None
4004
and revision[index] is not None):
4005
branch = revision[index].get_branch()
4006
if branch is not None:
4007
return branch, branch
4008
if user_location is None:
4009
location = self._get_remembered(tree, 'Merging from')
4011
location = user_location
4012
return location, user_location
4014
def _get_remembered(self, tree, verb_string):
4015
"""Use tree.branch's parent if none was supplied.
4017
Report if the remembered location was used.
4019
stored_location = tree.branch.get_submit_branch()
4020
stored_location_type = "submit"
4021
if stored_location is None:
4022
stored_location = tree.branch.get_parent()
4023
stored_location_type = "parent"
4024
mutter("%s", stored_location)
4025
if stored_location is None:
4026
raise errors.BzrCommandError("No location specified or remembered")
4027
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4028
note(u"%s remembered %s location %s", verb_string,
4029
stored_location_type, display_url)
4030
return stored_location
4033
class cmd_remerge(Command):
4036
Use this if you want to try a different merge technique while resolving
4037
conflicts. Some merge techniques are better than others, and remerge
4038
lets you try different ones on different files.
4040
The options for remerge have the same meaning and defaults as the ones for
4041
merge. The difference is that remerge can (only) be run when there is a
4042
pending merge, and it lets you specify particular files.
4045
Re-do the merge of all conflicted files, and show the base text in
4046
conflict regions, in addition to the usual THIS and OTHER texts::
4048
bzr remerge --show-base
4050
Re-do the merge of "foobar", using the weave merge algorithm, with
4051
additional processing to reduce the size of conflict regions::
4053
bzr remerge --merge-type weave --reprocess foobar
4055
takes_args = ['file*']
4060
help="Show base revision text in conflicts."),
4063
def run(self, file_list=None, merge_type=None, show_base=False,
4065
if merge_type is None:
4066
merge_type = _mod_merge.Merge3Merger
4067
tree, file_list = tree_files(file_list)
4069
self.add_cleanup(tree.unlock)
4070
parents = tree.get_parent_ids()
4071
if len(parents) != 2:
4072
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4073
" merges. Not cherrypicking or"
4075
repository = tree.branch.repository
4076
interesting_ids = None
4078
conflicts = tree.conflicts()
4079
if file_list is not None:
4080
interesting_ids = set()
4081
for filename in file_list:
4082
file_id = tree.path2id(filename)
4084
raise errors.NotVersionedError(filename)
4085
interesting_ids.add(file_id)
4086
if tree.kind(file_id) != "directory":
4089
for name, ie in tree.inventory.iter_entries(file_id):
4090
interesting_ids.add(ie.file_id)
4091
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4093
# Remerge only supports resolving contents conflicts
4094
allowed_conflicts = ('text conflict', 'contents conflict')
4095
restore_files = [c.path for c in conflicts
4096
if c.typestring in allowed_conflicts]
4097
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4098
tree.set_conflicts(ConflictList(new_conflicts))
4099
if file_list is not None:
4100
restore_files = file_list
4101
for filename in restore_files:
4103
restore(tree.abspath(filename))
4104
except errors.NotConflicted:
4106
# Disable pending merges, because the file texts we are remerging
4107
# have not had those merges performed. If we use the wrong parents
4108
# list, we imply that the working tree text has seen and rejected
4109
# all the changes from the other tree, when in fact those changes
4110
# have not yet been seen.
4111
tree.set_parent_ids(parents[:1])
4113
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4114
merger.interesting_ids = interesting_ids
4115
merger.merge_type = merge_type
4116
merger.show_base = show_base
4117
merger.reprocess = reprocess
4118
conflicts = merger.do_merge()
4120
tree.set_parent_ids(parents)
4127
class cmd_revert(Command):
4128
"""Revert files to a previous revision.
4130
Giving a list of files will revert only those files. Otherwise, all files
4131
will be reverted. If the revision is not specified with '--revision', the
4132
last committed revision is used.
4134
To remove only some changes, without reverting to a prior version, use
4135
merge instead. For example, "merge . --revision -2..-3" will remove the
4136
changes introduced by -2, without affecting the changes introduced by -1.
4137
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4139
By default, any files that have been manually changed will be backed up
4140
first. (Files changed only by merge are not backed up.) Backup files have
4141
'.~#~' appended to their name, where # is a number.
4143
When you provide files, you can use their current pathname or the pathname
4144
from the target revision. So you can use revert to "undelete" a file by
4145
name. If you name a directory, all the contents of that directory will be
4148
If you have newly added files since the target revision, they will be
4149
removed. If the files to be removed have been changed, backups will be
4150
created as above. Directories containing unknown files will not be
4153
The working tree contains a list of revisions that have been merged but
4154
not yet committed. These revisions will be included as additional parents
4155
of the next commit. Normally, using revert clears that list as well as
4156
reverting the files. If any files are specified, revert leaves the list
4157
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4158
.`` in the tree root to revert all files but keep the recorded merges,
4159
and ``bzr revert --forget-merges`` to clear the pending merge list without
4160
reverting any files.
4162
Using "bzr revert --forget-merges", it is possible to apply all of the
4163
changes from a branch in a single revision. To do this, perform the merge
4164
as desired. Then doing revert with the "--forget-merges" option will keep
4165
the content of the tree as it was, but it will clear the list of pending
4166
merges. The next commit will then contain all of the changes that are
4167
present in the other branch, but without any other parent revisions.
4168
Because this technique forgets where these changes originated, it may
4169
cause additional conflicts on later merges involving the same source and
4173
_see_also = ['cat', 'export']
4176
Option('no-backup', "Do not save backups of reverted files."),
4177
Option('forget-merges',
4178
'Remove pending merge marker, without changing any files.'),
4180
takes_args = ['file*']
4182
def run(self, revision=None, no_backup=False, file_list=None,
4183
forget_merges=None):
4184
tree, file_list = tree_files(file_list)
4186
self.add_cleanup(tree.unlock)
4188
tree.set_parent_ids(tree.get_parent_ids()[:1])
4190
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4193
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4194
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4195
tree.revert(file_list, rev_tree, not no_backup, None,
4196
report_changes=True)
4199
class cmd_assert_fail(Command):
4200
"""Test reporting of assertion failures"""
4201
# intended just for use in testing
4206
raise AssertionError("always fails")
4209
class cmd_help(Command):
4210
"""Show help on a command or other topic.
4213
_see_also = ['topics']
4215
Option('long', 'Show help on all commands.'),
4217
takes_args = ['topic?']
4218
aliases = ['?', '--help', '-?', '-h']
4221
def run(self, topic=None, long=False):
4223
if topic is None and long:
4225
bzrlib.help.help(topic)
4228
class cmd_shell_complete(Command):
4229
"""Show appropriate completions for context.
4231
For a list of all available commands, say 'bzr shell-complete'.
4233
takes_args = ['context?']
4238
def run(self, context=None):
4239
import shellcomplete
4240
shellcomplete.shellcomplete(context)
4243
class cmd_missing(Command):
4244
"""Show unmerged/unpulled revisions between two branches.
4246
OTHER_BRANCH may be local or remote.
4248
To filter on a range of revisions, you can use the command -r begin..end
4249
-r revision requests a specific revision, -r ..end or -r begin.. are
4253
1 - some missing revisions
4254
0 - no missing revisions
4258
Determine the missing revisions between this and the branch at the
4259
remembered pull location::
4263
Determine the missing revisions between this and another branch::
4265
bzr missing http://server/branch
4267
Determine the missing revisions up to a specific revision on the other
4270
bzr missing -r ..-10
4272
Determine the missing revisions up to a specific revision on this
4275
bzr missing --my-revision ..-10
4278
_see_also = ['merge', 'pull']
4279
takes_args = ['other_branch?']
4281
Option('reverse', 'Reverse the order of revisions.'),
4283
'Display changes in the local branch only.'),
4284
Option('this' , 'Same as --mine-only.'),
4285
Option('theirs-only',
4286
'Display changes in the remote branch only.'),
4287
Option('other', 'Same as --theirs-only.'),
4291
custom_help('revision',
4292
help='Filter on other branch revisions (inclusive). '
4293
'See "help revisionspec" for details.'),
4294
Option('my-revision',
4295
type=_parse_revision_str,
4296
help='Filter on local branch revisions (inclusive). '
4297
'See "help revisionspec" for details.'),
4298
Option('include-merges',
4299
'Show all revisions in addition to the mainline ones.'),
4301
encoding_type = 'replace'
4304
def run(self, other_branch=None, reverse=False, mine_only=False,
4306
log_format=None, long=False, short=False, line=False,
4307
show_ids=False, verbose=False, this=False, other=False,
4308
include_merges=False, revision=None, my_revision=None):
4309
from bzrlib.missing import find_unmerged, iter_log_revisions
4318
# TODO: We should probably check that we don't have mine-only and
4319
# theirs-only set, but it gets complicated because we also have
4320
# this and other which could be used.
4327
local_branch = Branch.open_containing(u".")[0]
4328
parent = local_branch.get_parent()
4329
if other_branch is None:
4330
other_branch = parent
4331
if other_branch is None:
4332
raise errors.BzrCommandError("No peer location known"
4334
display_url = urlutils.unescape_for_display(parent,
4336
message("Using saved parent location: "
4337
+ display_url + "\n")
4339
remote_branch = Branch.open(other_branch)
4340
if remote_branch.base == local_branch.base:
4341
remote_branch = local_branch
4343
local_branch.lock_read()
4344
self.add_cleanup(local_branch.unlock)
4345
local_revid_range = _revision_range_to_revid_range(
4346
_get_revision_range(my_revision, local_branch,
4349
remote_branch.lock_read()
4350
self.add_cleanup(remote_branch.unlock)
4351
remote_revid_range = _revision_range_to_revid_range(
4352
_get_revision_range(revision,
4353
remote_branch, self.name()))
4355
local_extra, remote_extra = find_unmerged(
4356
local_branch, remote_branch, restrict,
4357
backward=not reverse,
4358
include_merges=include_merges,
4359
local_revid_range=local_revid_range,
4360
remote_revid_range=remote_revid_range)
4362
if log_format is None:
4363
registry = log.log_formatter_registry
4364
log_format = registry.get_default(local_branch)
4365
lf = log_format(to_file=self.outf,
4367
show_timezone='original')
4370
if local_extra and not theirs_only:
4371
message("You have %d extra revision(s):\n" %
4373
for revision in iter_log_revisions(local_extra,
4374
local_branch.repository,
4376
lf.log_revision(revision)
4377
printed_local = True
4380
printed_local = False
4382
if remote_extra and not mine_only:
4383
if printed_local is True:
4385
message("You are missing %d revision(s):\n" %
4387
for revision in iter_log_revisions(remote_extra,
4388
remote_branch.repository,
4390
lf.log_revision(revision)
4393
if mine_only and not local_extra:
4394
# We checked local, and found nothing extra
4395
message('This branch is up to date.\n')
4396
elif theirs_only and not remote_extra:
4397
# We checked remote, and found nothing extra
4398
message('Other branch is up to date.\n')
4399
elif not (mine_only or theirs_only or local_extra or
4401
# We checked both branches, and neither one had extra
4403
message("Branches are up to date.\n")
4405
if not status_code and parent is None and other_branch is not None:
4406
local_branch.lock_write()
4407
self.add_cleanup(local_branch.unlock)
4408
# handle race conditions - a parent might be set while we run.
4409
if local_branch.get_parent() is None:
4410
local_branch.set_parent(remote_branch.base)
4414
class cmd_pack(Command):
4415
"""Compress the data within a repository."""
4417
_see_also = ['repositories']
4418
takes_args = ['branch_or_repo?']
4420
def run(self, branch_or_repo='.'):
4421
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4423
branch = dir.open_branch()
4424
repository = branch.repository
4425
except errors.NotBranchError:
4426
repository = dir.open_repository()
4430
class cmd_plugins(Command):
4431
"""List the installed plugins.
4433
This command displays the list of installed plugins including
4434
version of plugin and a short description of each.
4436
--verbose shows the path where each plugin is located.
4438
A plugin is an external component for Bazaar that extends the
4439
revision control system, by adding or replacing code in Bazaar.
4440
Plugins can do a variety of things, including overriding commands,
4441
adding new commands, providing additional network transports and
4442
customizing log output.
4444
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4445
for further information on plugins including where to find them and how to
4446
install them. Instructions are also provided there on how to write new
4447
plugins using the Python programming language.
4449
takes_options = ['verbose']
4452
def run(self, verbose=False):
4453
import bzrlib.plugin
4454
from inspect import getdoc
4456
for name, plugin in bzrlib.plugin.plugins().items():
4457
version = plugin.__version__
4458
if version == 'unknown':
4460
name_ver = '%s %s' % (name, version)
4461
d = getdoc(plugin.module)
4463
doc = d.split('\n')[0]
4465
doc = '(no description)'
4466
result.append((name_ver, doc, plugin.path()))
4467
for name_ver, doc, path in sorted(result):
4468
self.outf.write("%s\n" % name_ver)
4469
self.outf.write(" %s\n" % doc)
4471
self.outf.write(" %s\n" % path)
4472
self.outf.write("\n")
4475
class cmd_testament(Command):
4476
"""Show testament (signing-form) of a revision."""
4479
Option('long', help='Produce long-format testament.'),
4481
help='Produce a strict-format testament.')]
4482
takes_args = ['branch?']
4484
def run(self, branch=u'.', revision=None, long=False, strict=False):
4485
from bzrlib.testament import Testament, StrictTestament
4487
testament_class = StrictTestament
4489
testament_class = Testament
4491
b = Branch.open_containing(branch)[0]
4493
b = Branch.open(branch)
4495
self.add_cleanup(b.unlock)
4496
if revision is None:
4497
rev_id = b.last_revision()
4499
rev_id = revision[0].as_revision_id(b)
4500
t = testament_class.from_revision(b.repository, rev_id)
4502
sys.stdout.writelines(t.as_text_lines())
4504
sys.stdout.write(t.as_short_text())
4507
class cmd_annotate(Command):
4508
"""Show the origin of each line in a file.
4510
This prints out the given file with an annotation on the left side
4511
indicating which revision, author and date introduced the change.
4513
If the origin is the same for a run of consecutive lines, it is
4514
shown only at the top, unless the --all option is given.
4516
# TODO: annotate directories; showing when each file was last changed
4517
# TODO: if the working copy is modified, show annotations on that
4518
# with new uncommitted lines marked
4519
aliases = ['ann', 'blame', 'praise']
4520
takes_args = ['filename']
4521
takes_options = [Option('all', help='Show annotations on all lines.'),
4522
Option('long', help='Show commit date in annotations.'),
4526
encoding_type = 'exact'
4529
def run(self, filename, all=False, long=False, revision=None,
4531
from bzrlib.annotate import annotate_file, annotate_file_tree
4532
wt, branch, relpath = \
4533
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4536
self.add_cleanup(wt.unlock)
4539
self.add_cleanup(branch.unlock)
4540
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4542
self.add_cleanup(tree.unlock)
4544
file_id = wt.path2id(relpath)
4546
file_id = tree.path2id(relpath)
4548
raise errors.NotVersionedError(filename)
4549
file_version = tree.inventory[file_id].revision
4550
if wt is not None and revision is None:
4551
# If there is a tree and we're not annotating historical
4552
# versions, annotate the working tree's content.
4553
annotate_file_tree(wt, file_id, self.outf, long, all,
4556
annotate_file(branch, file_version, file_id, long, all, self.outf,
4560
class cmd_re_sign(Command):
4561
"""Create a digital signature for an existing revision."""
4562
# TODO be able to replace existing ones.
4564
hidden = True # is this right ?
4565
takes_args = ['revision_id*']
4566
takes_options = ['revision']
4568
def run(self, revision_id_list=None, revision=None):
4569
if revision_id_list is not None and revision is not None:
4570
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4571
if revision_id_list is None and revision is None:
4572
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4573
b = WorkingTree.open_containing(u'.')[0].branch
4575
self.add_cleanup(b.unlock)
4576
return self._run(b, revision_id_list, revision)
4578
def _run(self, b, revision_id_list, revision):
4579
import bzrlib.gpg as gpg
4580
gpg_strategy = gpg.GPGStrategy(b.get_config())
4581
if revision_id_list is not None:
4582
b.repository.start_write_group()
4584
for revision_id in revision_id_list:
4585
b.repository.sign_revision(revision_id, gpg_strategy)
4587
b.repository.abort_write_group()
4590
b.repository.commit_write_group()
4591
elif revision is not None:
4592
if len(revision) == 1:
4593
revno, rev_id = revision[0].in_history(b)
4594
b.repository.start_write_group()
4596
b.repository.sign_revision(rev_id, gpg_strategy)
4598
b.repository.abort_write_group()
4601
b.repository.commit_write_group()
4602
elif len(revision) == 2:
4603
# are they both on rh- if so we can walk between them
4604
# might be nice to have a range helper for arbitrary
4605
# revision paths. hmm.
4606
from_revno, from_revid = revision[0].in_history(b)
4607
to_revno, to_revid = revision[1].in_history(b)
4608
if to_revid is None:
4609
to_revno = b.revno()
4610
if from_revno is None or to_revno is None:
4611
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4612
b.repository.start_write_group()
4614
for revno in range(from_revno, to_revno + 1):
4615
b.repository.sign_revision(b.get_rev_id(revno),
4618
b.repository.abort_write_group()
4621
b.repository.commit_write_group()
4623
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4626
class cmd_bind(Command):
4627
"""Convert the current branch into a checkout of the supplied branch.
4629
Once converted into a checkout, commits must succeed on the master branch
4630
before they will be applied to the local branch.
4632
Bound branches use the nickname of its master branch unless it is set
4633
locally, in which case binding will update the local nickname to be
4637
_see_also = ['checkouts', 'unbind']
4638
takes_args = ['location?']
4641
def run(self, location=None):
4642
b, relpath = Branch.open_containing(u'.')
4643
if location is None:
4645
location = b.get_old_bound_location()
4646
except errors.UpgradeRequired:
4647
raise errors.BzrCommandError('No location supplied. '
4648
'This format does not remember old locations.')
4650
if location is None:
4651
if b.get_bound_location() is not None:
4652
raise errors.BzrCommandError('Branch is already bound')
4654
raise errors.BzrCommandError('No location supplied '
4655
'and no previous location known')
4656
b_other = Branch.open(location)
4659
except errors.DivergedBranches:
4660
raise errors.BzrCommandError('These branches have diverged.'
4661
' Try merging, and then bind again.')
4662
if b.get_config().has_explicit_nickname():
4663
b.nick = b_other.nick
4666
class cmd_unbind(Command):
4667
"""Convert the current checkout into a regular branch.
4669
After unbinding, the local branch is considered independent and subsequent
4670
commits will be local only.
4673
_see_also = ['checkouts', 'bind']
4678
b, relpath = Branch.open_containing(u'.')
4680
raise errors.BzrCommandError('Local branch is not bound')
4683
class cmd_uncommit(Command):
4684
"""Remove the last committed revision.
4686
--verbose will print out what is being removed.
4687
--dry-run will go through all the motions, but not actually
4690
If --revision is specified, uncommit revisions to leave the branch at the
4691
specified revision. For example, "bzr uncommit -r 15" will leave the
4692
branch at revision 15.
4694
Uncommit leaves the working tree ready for a new commit. The only change
4695
it may make is to restore any pending merges that were present before
4699
# TODO: jam 20060108 Add an option to allow uncommit to remove
4700
# unreferenced information in 'branch-as-repository' branches.
4701
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4702
# information in shared branches as well.
4703
_see_also = ['commit']
4704
takes_options = ['verbose', 'revision',
4705
Option('dry-run', help='Don\'t actually make changes.'),
4706
Option('force', help='Say yes to all questions.'),
4708
help="Only remove the commits from the local branch"
4709
" when in a checkout."
4712
takes_args = ['location?']
4714
encoding_type = 'replace'
4716
def run(self, location=None,
4717
dry_run=False, verbose=False,
4718
revision=None, force=False, local=False):
4719
if location is None:
4721
control, relpath = bzrdir.BzrDir.open_containing(location)
4723
tree = control.open_workingtree()
4725
except (errors.NoWorkingTree, errors.NotLocalUrl):
4727
b = control.open_branch()
4729
if tree is not None:
4731
self.add_cleanup(tree.unlock)
4734
self.add_cleanup(b.unlock)
4735
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4737
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4738
from bzrlib.log import log_formatter, show_log
4739
from bzrlib.uncommit import uncommit
4741
last_revno, last_rev_id = b.last_revision_info()
4744
if revision is None:
4746
rev_id = last_rev_id
4748
# 'bzr uncommit -r 10' actually means uncommit
4749
# so that the final tree is at revno 10.
4750
# but bzrlib.uncommit.uncommit() actually uncommits
4751
# the revisions that are supplied.
4752
# So we need to offset it by one
4753
revno = revision[0].in_history(b).revno + 1
4754
if revno <= last_revno:
4755
rev_id = b.get_rev_id(revno)
4757
if rev_id is None or _mod_revision.is_null(rev_id):
4758
self.outf.write('No revisions to uncommit.\n')
4761
lf = log_formatter('short',
4763
show_timezone='original')
4768
direction='forward',
4769
start_revision=revno,
4770
end_revision=last_revno)
4773
self.outf.write('Dry-run, pretending to remove'
4774
' the above revisions.\n')
4776
self.outf.write('The above revision(s) will be removed.\n')
4779
if not ui.ui_factory.get_boolean('Are you sure'):
4780
self.outf.write('Canceled')
4783
mutter('Uncommitting from {%s} to {%s}',
4784
last_rev_id, rev_id)
4785
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4786
revno=revno, local=local)
4787
self.outf.write('You can restore the old tip by running:\n'
4788
' bzr pull . -r revid:%s\n' % last_rev_id)
4791
class cmd_break_lock(Command):
4792
"""Break a dead lock on a repository, branch or working directory.
4794
CAUTION: Locks should only be broken when you are sure that the process
4795
holding the lock has been stopped.
4797
You can get information on what locks are open via the 'bzr info
4798
[location]' command.
4802
bzr break-lock bzr+ssh://example.com/bzr/foo
4804
takes_args = ['location?']
4806
def run(self, location=None, show=False):
4807
if location is None:
4809
control, relpath = bzrdir.BzrDir.open_containing(location)
4811
control.break_lock()
4812
except NotImplementedError:
4816
class cmd_wait_until_signalled(Command):
4817
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4819
This just prints a line to signal when it is ready, then blocks on stdin.
4825
sys.stdout.write("running\n")
4827
sys.stdin.readline()
4830
class cmd_serve(Command):
4831
"""Run the bzr server."""
4833
aliases = ['server']
4837
help='Serve on stdin/out for use from inetd or sshd.'),
4838
RegistryOption('protocol',
4839
help="Protocol to serve.",
4840
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4841
value_switches=True),
4843
help='Listen for connections on nominated port of the form '
4844
'[hostname:]portnumber. Passing 0 as the port number will '
4845
'result in a dynamically allocated port. The default port '
4846
'depends on the protocol.',
4849
help='Serve contents of this directory.',
4851
Option('allow-writes',
4852
help='By default the server is a readonly server. Supplying '
4853
'--allow-writes enables write access to the contents of '
4854
'the served directory and below. Note that ``bzr serve`` '
4855
'does not perform authentication, so unless some form of '
4856
'external authentication is arranged supplying this '
4857
'option leads to global uncontrolled write access to your '
4862
def get_host_and_port(self, port):
4863
"""Return the host and port to run the smart server on.
4865
If 'port' is None, None will be returned for the host and port.
4867
If 'port' has a colon in it, the string before the colon will be
4868
interpreted as the host.
4870
:param port: A string of the port to run the server on.
4871
:return: A tuple of (host, port), where 'host' is a host name or IP,
4872
and port is an integer TCP/IP port.
4875
if port is not None:
4877
host, port = port.split(':')
4881
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4883
from bzrlib.transport import get_transport, transport_server_registry
4884
if directory is None:
4885
directory = os.getcwd()
4886
if protocol is None:
4887
protocol = transport_server_registry.get()
4888
host, port = self.get_host_and_port(port)
4889
url = urlutils.local_path_to_url(directory)
4890
if not allow_writes:
4891
url = 'readonly+' + url
4892
transport = get_transport(url)
4893
protocol(transport, host, port, inet)
4896
class cmd_join(Command):
4897
"""Combine a tree into its containing tree.
4899
This command requires the target tree to be in a rich-root format.
4901
The TREE argument should be an independent tree, inside another tree, but
4902
not part of it. (Such trees can be produced by "bzr split", but also by
4903
running "bzr branch" with the target inside a tree.)
4905
The result is a combined tree, with the subtree no longer an independant
4906
part. This is marked as a merge of the subtree into the containing tree,
4907
and all history is preserved.
4910
_see_also = ['split']
4911
takes_args = ['tree']
4913
Option('reference', help='Join by reference.', hidden=True),
4916
def run(self, tree, reference=False):
4917
sub_tree = WorkingTree.open(tree)
4918
parent_dir = osutils.dirname(sub_tree.basedir)
4919
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4920
repo = containing_tree.branch.repository
4921
if not repo.supports_rich_root():
4922
raise errors.BzrCommandError(
4923
"Can't join trees because %s doesn't support rich root data.\n"
4924
"You can use bzr upgrade on the repository."
4928
containing_tree.add_reference(sub_tree)
4929
except errors.BadReferenceTarget, e:
4930
# XXX: Would be better to just raise a nicely printable
4931
# exception from the real origin. Also below. mbp 20070306
4932
raise errors.BzrCommandError("Cannot join %s. %s" %
4936
containing_tree.subsume(sub_tree)
4937
except errors.BadSubsumeSource, e:
4938
raise errors.BzrCommandError("Cannot join %s. %s" %
4942
class cmd_split(Command):
4943
"""Split a subdirectory of a tree into a separate tree.
4945
This command will produce a target tree in a format that supports
4946
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4947
converted into earlier formats like 'dirstate-tags'.
4949
The TREE argument should be a subdirectory of a working tree. That
4950
subdirectory will be converted into an independent tree, with its own
4951
branch. Commits in the top-level tree will not apply to the new subtree.
4954
_see_also = ['join']
4955
takes_args = ['tree']
4957
def run(self, tree):
4958
containing_tree, subdir = WorkingTree.open_containing(tree)
4959
sub_id = containing_tree.path2id(subdir)
4961
raise errors.NotVersionedError(subdir)
4963
containing_tree.extract(sub_id)
4964
except errors.RootNotRich:
4965
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4968
class cmd_merge_directive(Command):
4969
"""Generate a merge directive for auto-merge tools.
4971
A directive requests a merge to be performed, and also provides all the
4972
information necessary to do so. This means it must either include a
4973
revision bundle, or the location of a branch containing the desired
4976
A submit branch (the location to merge into) must be supplied the first
4977
time the command is issued. After it has been supplied once, it will
4978
be remembered as the default.
4980
A public branch is optional if a revision bundle is supplied, but required
4981
if --diff or --plain is specified. It will be remembered as the default
4982
after the first use.
4985
takes_args = ['submit_branch?', 'public_branch?']
4989
_see_also = ['send']
4992
RegistryOption.from_kwargs('patch-type',
4993
'The type of patch to include in the directive.',
4995
value_switches=True,
4997
bundle='Bazaar revision bundle (default).',
4998
diff='Normal unified diff.',
4999
plain='No patch, just directive.'),
5000
Option('sign', help='GPG-sign the directive.'), 'revision',
5001
Option('mail-to', type=str,
5002
help='Instead of printing the directive, email to this address.'),
5003
Option('message', type=str, short_name='m',
5004
help='Message to use when committing this merge.')
5007
encoding_type = 'exact'
5009
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5010
sign=False, revision=None, mail_to=None, message=None):
5011
from bzrlib.revision import ensure_null, NULL_REVISION
5012
include_patch, include_bundle = {
5013
'plain': (False, False),
5014
'diff': (True, False),
5015
'bundle': (True, True),
5017
branch = Branch.open('.')
5018
stored_submit_branch = branch.get_submit_branch()
5019
if submit_branch is None:
5020
submit_branch = stored_submit_branch
5022
if stored_submit_branch is None:
5023
branch.set_submit_branch(submit_branch)
5024
if submit_branch is None:
5025
submit_branch = branch.get_parent()
5026
if submit_branch is None:
5027
raise errors.BzrCommandError('No submit branch specified or known')
5029
stored_public_branch = branch.get_public_branch()
5030
if public_branch is None:
5031
public_branch = stored_public_branch
5032
elif stored_public_branch is None:
5033
branch.set_public_branch(public_branch)
5034
if not include_bundle and public_branch is None:
5035
raise errors.BzrCommandError('No public branch specified or'
5037
base_revision_id = None
5038
if revision is not None:
5039
if len(revision) > 2:
5040
raise errors.BzrCommandError('bzr merge-directive takes '
5041
'at most two one revision identifiers')
5042
revision_id = revision[-1].as_revision_id(branch)
5043
if len(revision) == 2:
5044
base_revision_id = revision[0].as_revision_id(branch)
5046
revision_id = branch.last_revision()
5047
revision_id = ensure_null(revision_id)
5048
if revision_id == NULL_REVISION:
5049
raise errors.BzrCommandError('No revisions to bundle.')
5050
directive = merge_directive.MergeDirective2.from_objects(
5051
branch.repository, revision_id, time.time(),
5052
osutils.local_time_offset(), submit_branch,
5053
public_branch=public_branch, include_patch=include_patch,
5054
include_bundle=include_bundle, message=message,
5055
base_revision_id=base_revision_id)
5058
self.outf.write(directive.to_signed(branch))
5060
self.outf.writelines(directive.to_lines())
5062
message = directive.to_email(mail_to, branch, sign)
5063
s = SMTPConnection(branch.get_config())
5064
s.send_email(message)
5067
class cmd_send(Command):
5068
"""Mail or create a merge-directive for submitting changes.
5070
A merge directive provides many things needed for requesting merges:
5072
* A machine-readable description of the merge to perform
5074
* An optional patch that is a preview of the changes requested
5076
* An optional bundle of revision data, so that the changes can be applied
5077
directly from the merge directive, without retrieving data from a
5080
`bzr send` creates a compact data set that, when applied using bzr
5081
merge, has the same effect as merging from the source branch.
5083
By default the merge directive is self-contained and can be applied to any
5084
branch containing submit_branch in its ancestory without needing access to
5087
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5088
revisions, but only a structured request to merge from the
5089
public_location. In that case the public_branch is needed and it must be
5090
up-to-date and accessible to the recipient. The public_branch is always
5091
included if known, so that people can check it later.
5093
The submit branch defaults to the parent of the source branch, but can be
5094
overridden. Both submit branch and public branch will be remembered in
5095
branch.conf the first time they are used for a particular branch. The
5096
source branch defaults to that containing the working directory, but can
5097
be changed using --from.
5099
In order to calculate those changes, bzr must analyse the submit branch.
5100
Therefore it is most efficient for the submit branch to be a local mirror.
5101
If a public location is known for the submit_branch, that location is used
5102
in the merge directive.
5104
The default behaviour is to send the merge directive by mail, unless -o is
5105
given, in which case it is sent to a file.
5107
Mail is sent using your preferred mail program. This should be transparent
5108
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5109
If the preferred client can't be found (or used), your editor will be used.
5111
To use a specific mail program, set the mail_client configuration option.
5112
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5113
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5114
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5115
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5118
If mail is being sent, a to address is required. This can be supplied
5119
either on the commandline, by setting the submit_to configuration
5120
option in the branch itself or the child_submit_to configuration option
5121
in the submit branch.
5123
Two formats are currently supported: "4" uses revision bundle format 4 and
5124
merge directive format 2. It is significantly faster and smaller than
5125
older formats. It is compatible with Bazaar 0.19 and later. It is the
5126
default. "0.9" uses revision bundle format 0.9 and merge directive
5127
format 1. It is compatible with Bazaar 0.12 - 0.18.
5129
The merge directives created by bzr send may be applied using bzr merge or
5130
bzr pull by specifying a file containing a merge directive as the location.
5132
bzr send makes extensive use of public locations to map local locations into
5133
URLs that can be used by other people. See `bzr help configuration` to
5134
set them, and use `bzr info` to display them.
5137
encoding_type = 'exact'
5139
_see_also = ['merge', 'pull']
5141
takes_args = ['submit_branch?', 'public_branch?']
5145
help='Do not include a bundle in the merge directive.'),
5146
Option('no-patch', help='Do not include a preview patch in the merge'
5149
help='Remember submit and public branch.'),
5151
help='Branch to generate the submission from, '
5152
'rather than the one containing the working directory.',
5155
Option('output', short_name='o',
5156
help='Write merge directive to this file or directory; '
5157
'use - for stdout.',
5160
help='Refuse to send if there are uncommitted changes in'
5161
' the working tree, --no-strict disables the check.'),
5162
Option('mail-to', help='Mail the request to this address.',
5166
Option('body', help='Body for the email.', type=unicode),
5167
RegistryOption('format',
5168
help='Use the specified output format.',
5169
lazy_registry=('bzrlib.send', 'format_registry')),
5172
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5173
no_patch=False, revision=None, remember=False, output=None,
5174
format=None, mail_to=None, message=None, body=None,
5175
strict=None, **kwargs):
5176
from bzrlib.send import send
5177
return send(submit_branch, revision, public_branch, remember,
5178
format, no_bundle, no_patch, output,
5179
kwargs.get('from', '.'), mail_to, message, body,
5184
class cmd_bundle_revisions(cmd_send):
5185
"""Create a merge-directive for submitting changes.
5187
A merge directive provides many things needed for requesting merges:
5189
* A machine-readable description of the merge to perform
5191
* An optional patch that is a preview of the changes requested
5193
* An optional bundle of revision data, so that the changes can be applied
5194
directly from the merge directive, without retrieving data from a
5197
If --no-bundle is specified, then public_branch is needed (and must be
5198
up-to-date), so that the receiver can perform the merge using the
5199
public_branch. The public_branch is always included if known, so that
5200
people can check it later.
5202
The submit branch defaults to the parent, but can be overridden. Both
5203
submit branch and public branch will be remembered if supplied.
5205
If a public_branch is known for the submit_branch, that public submit
5206
branch is used in the merge instructions. This means that a local mirror
5207
can be used as your actual submit branch, once you have set public_branch
5210
Two formats are currently supported: "4" uses revision bundle format 4 and
5211
merge directive format 2. It is significantly faster and smaller than
5212
older formats. It is compatible with Bazaar 0.19 and later. It is the
5213
default. "0.9" uses revision bundle format 0.9 and merge directive
5214
format 1. It is compatible with Bazaar 0.12 - 0.18.
5219
help='Do not include a bundle in the merge directive.'),
5220
Option('no-patch', help='Do not include a preview patch in the merge'
5223
help='Remember submit and public branch.'),
5225
help='Branch to generate the submission from, '
5226
'rather than the one containing the working directory.',
5229
Option('output', short_name='o', help='Write directive to this file.',
5232
help='Refuse to bundle revisions if there are uncommitted'
5233
' changes in the working tree, --no-strict disables the check.'),
5235
RegistryOption('format',
5236
help='Use the specified output format.',
5237
lazy_registry=('bzrlib.send', 'format_registry')),
5239
aliases = ['bundle']
5241
_see_also = ['send', 'merge']
5245
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5246
no_patch=False, revision=None, remember=False, output=None,
5247
format=None, strict=None, **kwargs):
5250
from bzrlib.send import send
5251
return send(submit_branch, revision, public_branch, remember,
5252
format, no_bundle, no_patch, output,
5253
kwargs.get('from', '.'), None, None, None,
5254
self.outf, strict=strict)
5257
class cmd_tag(Command):
5258
"""Create, remove or modify a tag naming a revision.
5260
Tags give human-meaningful names to revisions. Commands that take a -r
5261
(--revision) option can be given -rtag:X, where X is any previously
5264
Tags are stored in the branch. Tags are copied from one branch to another
5265
along when you branch, push, pull or merge.
5267
It is an error to give a tag name that already exists unless you pass
5268
--force, in which case the tag is moved to point to the new revision.
5270
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5271
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5273
If no tag name is specified it will be determined through the
5274
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5275
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5279
_see_also = ['commit', 'tags']
5280
takes_args = ['tag_name?']
5283
help='Delete this tag rather than placing it.',
5286
help='Branch in which to place the tag.',
5291
help='Replace existing tags.',
5296
def run(self, tag_name=None,
5302
branch, relpath = Branch.open_containing(directory)
5304
self.add_cleanup(branch.unlock)
5306
if tag_name is None:
5307
raise errors.BzrCommandError("No tag specified to delete.")
5308
branch.tags.delete_tag(tag_name)
5309
self.outf.write('Deleted tag %s.\n' % tag_name)
5312
if len(revision) != 1:
5313
raise errors.BzrCommandError(
5314
"Tags can only be placed on a single revision, "
5316
revision_id = revision[0].as_revision_id(branch)
5318
revision_id = branch.last_revision()
5319
if tag_name is None:
5320
tag_name = branch.automatic_tag_name(revision_id)
5321
if tag_name is None:
5322
raise errors.BzrCommandError(
5323
"Please specify a tag name.")
5324
if (not force) and branch.tags.has_tag(tag_name):
5325
raise errors.TagAlreadyExists(tag_name)
5326
branch.tags.set_tag(tag_name, revision_id)
5327
self.outf.write('Created tag %s.\n' % tag_name)
5330
class cmd_tags(Command):
5333
This command shows a table of tag names and the revisions they reference.
5339
help='Branch whose tags should be displayed.',
5343
RegistryOption.from_kwargs('sort',
5344
'Sort tags by different criteria.', title='Sorting',
5345
alpha='Sort tags lexicographically (default).',
5346
time='Sort tags chronologically.',
5359
branch, relpath = Branch.open_containing(directory)
5361
tags = branch.tags.get_tag_dict().items()
5366
self.add_cleanup(branch.unlock)
5368
graph = branch.repository.get_graph()
5369
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5370
revid1, revid2 = rev1.rev_id, rev2.rev_id
5371
# only show revisions between revid1 and revid2 (inclusive)
5372
tags = [(tag, revid) for tag, revid in tags if
5373
graph.is_between(revid, revid1, revid2)]
5376
elif sort == 'time':
5378
for tag, revid in tags:
5380
revobj = branch.repository.get_revision(revid)
5381
except errors.NoSuchRevision:
5382
timestamp = sys.maxint # place them at the end
5384
timestamp = revobj.timestamp
5385
timestamps[revid] = timestamp
5386
tags.sort(key=lambda x: timestamps[x[1]])
5388
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5389
for index, (tag, revid) in enumerate(tags):
5391
revno = branch.revision_id_to_dotted_revno(revid)
5392
if isinstance(revno, tuple):
5393
revno = '.'.join(map(str, revno))
5394
except errors.NoSuchRevision:
5395
# Bad tag data/merges can lead to tagged revisions
5396
# which are not in this branch. Fail gracefully ...
5398
tags[index] = (tag, revno)
5400
for tag, revspec in tags:
5401
self.outf.write('%-20s %s\n' % (tag, revspec))
5404
class cmd_reconfigure(Command):
5405
"""Reconfigure the type of a bzr directory.
5407
A target configuration must be specified.
5409
For checkouts, the bind-to location will be auto-detected if not specified.
5410
The order of preference is
5411
1. For a lightweight checkout, the current bound location.
5412
2. For branches that used to be checkouts, the previously-bound location.
5413
3. The push location.
5414
4. The parent location.
5415
If none of these is available, --bind-to must be specified.
5418
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5419
takes_args = ['location?']
5421
RegistryOption.from_kwargs(
5423
title='Target type',
5424
help='The type to reconfigure the directory to.',
5425
value_switches=True, enum_switch=False,
5426
branch='Reconfigure to be an unbound branch with no working tree.',
5427
tree='Reconfigure to be an unbound branch with a working tree.',
5428
checkout='Reconfigure to be a bound branch with a working tree.',
5429
lightweight_checkout='Reconfigure to be a lightweight'
5430
' checkout (with no local history).',
5431
standalone='Reconfigure to be a standalone branch '
5432
'(i.e. stop using shared repository).',
5433
use_shared='Reconfigure to use a shared repository.',
5434
with_trees='Reconfigure repository to create '
5435
'working trees on branches by default.',
5436
with_no_trees='Reconfigure repository to not create '
5437
'working trees on branches by default.'
5439
Option('bind-to', help='Branch to bind checkout to.', type=str),
5441
help='Perform reconfiguration even if local changes'
5443
Option('stacked-on',
5444
help='Reconfigure a branch to be stacked on another branch.',
5448
help='Reconfigure a branch to be unstacked. This '
5449
'may require copying substantial data into it.',
5453
def run(self, location=None, target_type=None, bind_to=None, force=False,
5456
directory = bzrdir.BzrDir.open(location)
5457
if stacked_on and unstacked:
5458
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5459
elif stacked_on is not None:
5460
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5462
reconfigure.ReconfigureUnstacked().apply(directory)
5463
# At the moment you can use --stacked-on and a different
5464
# reconfiguration shape at the same time; there seems no good reason
5466
if target_type is None:
5467
if stacked_on or unstacked:
5470
raise errors.BzrCommandError('No target configuration '
5472
elif target_type == 'branch':
5473
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5474
elif target_type == 'tree':
5475
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5476
elif target_type == 'checkout':
5477
reconfiguration = reconfigure.Reconfigure.to_checkout(
5479
elif target_type == 'lightweight-checkout':
5480
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5482
elif target_type == 'use-shared':
5483
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5484
elif target_type == 'standalone':
5485
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5486
elif target_type == 'with-trees':
5487
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5489
elif target_type == 'with-no-trees':
5490
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5492
reconfiguration.apply(force)
5495
class cmd_switch(Command):
5496
"""Set the branch of a checkout and update.
5498
For lightweight checkouts, this changes the branch being referenced.
5499
For heavyweight checkouts, this checks that there are no local commits
5500
versus the current bound branch, then it makes the local branch a mirror
5501
of the new location and binds to it.
5503
In both cases, the working tree is updated and uncommitted changes
5504
are merged. The user can commit or revert these as they desire.
5506
Pending merges need to be committed or reverted before using switch.
5508
The path to the branch to switch to can be specified relative to the parent
5509
directory of the current branch. For example, if you are currently in a
5510
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5513
Bound branches use the nickname of its master branch unless it is set
5514
locally, in which case switching will update the local nickname to be
5518
takes_args = ['to_location?']
5519
takes_options = [Option('force',
5520
help='Switch even if local commits will be lost.'),
5522
Option('create-branch', short_name='b',
5523
help='Create the target branch from this one before'
5524
' switching to it.'),
5527
def run(self, to_location=None, force=False, create_branch=False,
5529
from bzrlib import switch
5531
revision = _get_one_revision('switch', revision)
5532
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5533
if to_location is None:
5534
if revision is None:
5535
raise errors.BzrCommandError('You must supply either a'
5536
' revision or a location')
5539
branch = control_dir.open_branch()
5540
had_explicit_nick = branch.get_config().has_explicit_nickname()
5541
except errors.NotBranchError:
5543
had_explicit_nick = False
5546
raise errors.BzrCommandError('cannot create branch without'
5548
to_location = directory_service.directories.dereference(
5550
if '/' not in to_location and '\\' not in to_location:
5551
# This path is meant to be relative to the existing branch
5552
this_url = self._get_branch_location(control_dir)
5553
to_location = urlutils.join(this_url, '..', to_location)
5554
to_branch = branch.bzrdir.sprout(to_location,
5555
possible_transports=[branch.bzrdir.root_transport],
5556
source_branch=branch).open_branch()
5559
to_branch = Branch.open(to_location)
5560
except errors.NotBranchError:
5561
this_url = self._get_branch_location(control_dir)
5562
to_branch = Branch.open(
5563
urlutils.join(this_url, '..', to_location))
5564
if revision is not None:
5565
revision = revision.as_revision_id(to_branch)
5566
switch.switch(control_dir, to_branch, force, revision_id=revision)
5567
if had_explicit_nick:
5568
branch = control_dir.open_branch() #get the new branch!
5569
branch.nick = to_branch.nick
5570
note('Switched to branch: %s',
5571
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5573
def _get_branch_location(self, control_dir):
5574
"""Return location of branch for this control dir."""
5576
this_branch = control_dir.open_branch()
5577
# This may be a heavy checkout, where we want the master branch
5578
master_location = this_branch.get_bound_location()
5579
if master_location is not None:
5580
return master_location
5581
# If not, use a local sibling
5582
return this_branch.base
5583
except errors.NotBranchError:
5584
format = control_dir.find_branch_format()
5585
if getattr(format, 'get_reference', None) is not None:
5586
return format.get_reference(control_dir)
5588
return control_dir.root_transport.base
5591
class cmd_view(Command):
5592
"""Manage filtered views.
5594
Views provide a mask over the tree so that users can focus on
5595
a subset of a tree when doing their work. After creating a view,
5596
commands that support a list of files - status, diff, commit, etc -
5597
effectively have that list of files implicitly given each time.
5598
An explicit list of files can still be given but those files
5599
must be within the current view.
5601
In most cases, a view has a short life-span: it is created to make
5602
a selected change and is deleted once that change is committed.
5603
At other times, you may wish to create one or more named views
5604
and switch between them.
5606
To disable the current view without deleting it, you can switch to
5607
the pseudo view called ``off``. This can be useful when you need
5608
to see the whole tree for an operation or two (e.g. merge) but
5609
want to switch back to your view after that.
5612
To define the current view::
5614
bzr view file1 dir1 ...
5616
To list the current view::
5620
To delete the current view::
5624
To disable the current view without deleting it::
5626
bzr view --switch off
5628
To define a named view and switch to it::
5630
bzr view --name view-name file1 dir1 ...
5632
To list a named view::
5634
bzr view --name view-name
5636
To delete a named view::
5638
bzr view --name view-name --delete
5640
To switch to a named view::
5642
bzr view --switch view-name
5644
To list all views defined::
5648
To delete all views::
5650
bzr view --delete --all
5654
takes_args = ['file*']
5657
help='Apply list or delete action to all views.',
5660
help='Delete the view.',
5663
help='Name of the view to define, list or delete.',
5667
help='Name of the view to switch to.',
5672
def run(self, file_list,
5678
tree, file_list = tree_files(file_list, apply_view=False)
5679
current_view, view_dict = tree.views.get_view_info()
5684
raise errors.BzrCommandError(
5685
"Both --delete and a file list specified")
5687
raise errors.BzrCommandError(
5688
"Both --delete and --switch specified")
5690
tree.views.set_view_info(None, {})
5691
self.outf.write("Deleted all views.\n")
5693
raise errors.BzrCommandError("No current view to delete")
5695
tree.views.delete_view(name)
5696
self.outf.write("Deleted '%s' view.\n" % name)
5699
raise errors.BzrCommandError(
5700
"Both --switch and a file list specified")
5702
raise errors.BzrCommandError(
5703
"Both --switch and --all specified")
5704
elif switch == 'off':
5705
if current_view is None:
5706
raise errors.BzrCommandError("No current view to disable")
5707
tree.views.set_view_info(None, view_dict)
5708
self.outf.write("Disabled '%s' view.\n" % (current_view))
5710
tree.views.set_view_info(switch, view_dict)
5711
view_str = views.view_display_str(tree.views.lookup_view())
5712
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5715
self.outf.write('Views defined:\n')
5716
for view in sorted(view_dict):
5717
if view == current_view:
5721
view_str = views.view_display_str(view_dict[view])
5722
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5724
self.outf.write('No views defined.\n')
5727
# No name given and no current view set
5730
raise errors.BzrCommandError(
5731
"Cannot change the 'off' pseudo view")
5732
tree.views.set_view(name, sorted(file_list))
5733
view_str = views.view_display_str(tree.views.lookup_view())
5734
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5738
# No name given and no current view set
5739
self.outf.write('No current view.\n')
5741
view_str = views.view_display_str(tree.views.lookup_view(name))
5742
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5745
class cmd_hooks(Command):
5751
for hook_key in sorted(hooks.known_hooks.keys()):
5752
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5753
self.outf.write("%s:\n" % type(some_hooks).__name__)
5754
for hook_name, hook_point in sorted(some_hooks.items()):
5755
self.outf.write(" %s:\n" % (hook_name,))
5756
found_hooks = list(hook_point)
5758
for hook in found_hooks:
5759
self.outf.write(" %s\n" %
5760
(some_hooks.get_hook_name(hook),))
5762
self.outf.write(" <no hooks installed>\n")
5765
class cmd_remove_branch(Command):
5768
This will remove the branch from the specified location but
5769
will keep any working tree or repository in place.
5773
Remove the branch at repo/trunk::
5775
bzr remove-branch repo/trunk
5779
takes_args = ["location?"]
5781
aliases = ["rmbranch"]
5783
def run(self, location=None):
5784
if location is None:
5786
branch = Branch.open_containing(location)[0]
5787
branch.bzrdir.destroy_branch()
5790
class cmd_shelve(Command):
5791
"""Temporarily set aside some changes from the current tree.
5793
Shelve allows you to temporarily put changes you've made "on the shelf",
5794
ie. out of the way, until a later time when you can bring them back from
5795
the shelf with the 'unshelve' command. The changes are stored alongside
5796
your working tree, and so they aren't propagated along with your branch nor
5797
will they survive its deletion.
5799
If shelve --list is specified, previously-shelved changes are listed.
5801
Shelve is intended to help separate several sets of changes that have
5802
been inappropriately mingled. If you just want to get rid of all changes
5803
and you don't need to restore them later, use revert. If you want to
5804
shelve all text changes at once, use shelve --all.
5806
If filenames are specified, only the changes to those files will be
5807
shelved. Other files will be left untouched.
5809
If a revision is specified, changes since that revision will be shelved.
5811
You can put multiple items on the shelf, and by default, 'unshelve' will
5812
restore the most recently shelved changes.
5815
takes_args = ['file*']
5819
Option('all', help='Shelve all changes.'),
5821
RegistryOption('writer', 'Method to use for writing diffs.',
5822
bzrlib.option.diff_writer_registry,
5823
value_switches=True, enum_switch=False),
5825
Option('list', help='List shelved changes.'),
5827
help='Destroy removed changes instead of shelving them.'),
5829
_see_also = ['unshelve']
5831
def run(self, revision=None, all=False, file_list=None, message=None,
5832
writer=None, list=False, destroy=False):
5834
return self.run_for_list()
5835
from bzrlib.shelf_ui import Shelver
5837
writer = bzrlib.option.diff_writer_registry.get()
5839
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5840
file_list, message, destroy=destroy)
5845
except errors.UserAbort:
5848
def run_for_list(self):
5849
tree = WorkingTree.open_containing('.')[0]
5851
self.add_cleanup(tree.unlock)
5852
manager = tree.get_shelf_manager()
5853
shelves = manager.active_shelves()
5854
if len(shelves) == 0:
5855
note('No shelved changes.')
5857
for shelf_id in reversed(shelves):
5858
message = manager.get_metadata(shelf_id).get('message')
5860
message = '<no message>'
5861
self.outf.write('%3d: %s\n' % (shelf_id, message))
5865
class cmd_unshelve(Command):
5866
"""Restore shelved changes.
5868
By default, the most recently shelved changes are restored. However if you
5869
specify a shelf by id those changes will be restored instead. This works
5870
best when the changes don't depend on each other.
5873
takes_args = ['shelf_id?']
5875
RegistryOption.from_kwargs(
5876
'action', help="The action to perform.",
5877
enum_switch=False, value_switches=True,
5878
apply="Apply changes and remove from the shelf.",
5879
dry_run="Show changes, but do not apply or remove them.",
5880
preview="Instead of unshelving the changes, show the diff that "
5881
"would result from unshelving.",
5882
delete_only="Delete changes without applying them.",
5883
keep="Apply changes but don't delete them.",
5886
_see_also = ['shelve']
5888
def run(self, shelf_id=None, action='apply'):
5889
from bzrlib.shelf_ui import Unshelver
5890
unshelver = Unshelver.from_args(shelf_id, action)
5894
unshelver.tree.unlock()
5897
class cmd_clean_tree(Command):
5898
"""Remove unwanted files from working tree.
5900
By default, only unknown files, not ignored files, are deleted. Versioned
5901
files are never deleted.
5903
Another class is 'detritus', which includes files emitted by bzr during
5904
normal operations and selftests. (The value of these files decreases with
5907
If no options are specified, unknown files are deleted. Otherwise, option
5908
flags are respected, and may be combined.
5910
To check what clean-tree will do, use --dry-run.
5912
takes_options = [Option('ignored', help='Delete all ignored files.'),
5913
Option('detritus', help='Delete conflict files, merge'
5914
' backups, and failed selftest dirs.'),
5916
help='Delete files unknown to bzr (default).'),
5917
Option('dry-run', help='Show files to delete instead of'
5919
Option('force', help='Do not prompt before deleting.')]
5920
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5922
from bzrlib.clean_tree import clean_tree
5923
if not (unknown or ignored or detritus):
5927
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5928
dry_run=dry_run, no_prompt=force)
5931
class cmd_reference(Command):
5932
"""list, view and set branch locations for nested trees.
5934
If no arguments are provided, lists the branch locations for nested trees.
5935
If one argument is provided, display the branch location for that tree.
5936
If two arguments are provided, set the branch location for that tree.
5941
takes_args = ['path?', 'location?']
5943
def run(self, path=None, location=None):
5945
if path is not None:
5947
tree, branch, relpath =(
5948
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5949
if path is not None:
5952
tree = branch.basis_tree()
5954
info = branch._get_all_reference_info().iteritems()
5955
self._display_reference_info(tree, branch, info)
5957
file_id = tree.path2id(path)
5959
raise errors.NotVersionedError(path)
5960
if location is None:
5961
info = [(file_id, branch.get_reference_info(file_id))]
5962
self._display_reference_info(tree, branch, info)
5964
branch.set_reference_info(file_id, path, location)
5966
def _display_reference_info(self, tree, branch, info):
5968
for file_id, (path, location) in info:
5970
path = tree.id2path(file_id)
5971
except errors.NoSuchId:
5973
ref_list.append((path, location))
5974
for path, location in sorted(ref_list):
5975
self.outf.write('%s %s\n' % (path, location))
5978
from bzrlib.cmd_version_info import cmd_version_info
5979
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5980
from bzrlib.foreign import cmd_dpush
5981
from bzrlib.sign_my_commits import cmd_sign_my_commits
added
removed
bzrlib/builtins.py
