1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import (
65
builtin_command_registry,
68
from bzrlib.option import (
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
81
return internal_tree_files(file_list, default_branch, canonicalize,
83
except errors.FileInWrongBranch, e:
84
raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
(e.path, file_list[0]))
88
def tree_files_for_add(file_list):
90
Return a tree and list of absolute paths from a file list.
92
Similar to tree_files, but add handles files a bit differently, so it a
93
custom implementation. In particular, MutableTreeTree.smart_add expects
94
absolute paths, which it immediately converts to relative paths.
96
# FIXME Would be nice to just return the relative paths like
97
# internal_tree_files does, but there are a large number of unit tests
98
# that assume the current interface to mutabletree.smart_add
100
tree, relpath = WorkingTree.open_containing(file_list[0])
101
if tree.supports_views():
102
view_files = tree.views.lookup_view()
104
for filename in file_list:
105
if not osutils.is_inside_any(view_files, filename):
106
raise errors.FileOutsideView(filename, view_files)
107
file_list = file_list[:]
108
file_list[0] = tree.abspath(relpath)
110
tree = WorkingTree.open_containing(u'.')[0]
111
if tree.supports_views():
112
view_files = tree.views.lookup_view()
114
file_list = view_files
115
view_str = views.view_display_str(view_files)
116
note("Ignoring files outside view. View is %s" % view_str)
117
return tree, file_list
120
def _get_one_revision(command_name, revisions):
121
if revisions is None:
123
if len(revisions) != 1:
124
raise errors.BzrCommandError(
125
'bzr %s --revision takes exactly one revision identifier' % (
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
"""Get a revision tree. Not suitable for commands that change the tree.
133
Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
and doing a commit/uncommit/pull will at best fail due to changing the
137
If tree is passed in, it should be already locked, for lifetime management
138
of the trees internal cached state.
142
if revisions is None:
144
rev_tree = tree.basis_tree()
146
rev_tree = branch.basis_tree()
148
revision = _get_one_revision(command_name, revisions)
149
rev_tree = revision.as_tree(branch)
153
# XXX: Bad function name; should possibly also be a class method of
154
# WorkingTree rather than a function.
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
157
"""Convert command-line paths to a WorkingTree and relative paths.
159
This is typically used for command-line processors that take one or
160
more filenames, and infer the workingtree that contains them.
162
The filenames given are not required to exist.
164
:param file_list: Filenames to convert.
166
:param default_branch: Fallback tree path to use if file_list is empty or
169
:param apply_view: if True and a view is set, apply it or check that
170
specified files are within it
172
:return: workingtree, [relative_paths]
174
if file_list is None or len(file_list) == 0:
175
tree = WorkingTree.open_containing(default_branch)[0]
176
if tree.supports_views() and apply_view:
177
view_files = tree.views.lookup_view()
179
file_list = view_files
180
view_str = views.view_display_str(view_files)
181
note("Ignoring files outside view. View is %s" % view_str)
182
return tree, file_list
183
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
return tree, safe_relpath_files(tree, file_list, canonicalize,
185
apply_view=apply_view)
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
"""Convert file_list into a list of relpaths in tree.
191
:param tree: A tree to operate on.
192
:param file_list: A list of user provided paths or None.
193
:param apply_view: if True and a view is set, apply it or check that
194
specified files are within it
195
:return: A list of relative paths.
196
:raises errors.PathNotChild: When a provided path is in a different tree
199
if file_list is None:
201
if tree.supports_views() and apply_view:
202
view_files = tree.views.lookup_view()
206
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
# doesn't - fix that up here before we enter the loop.
209
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
212
for filename in file_list:
214
relpath = fixer(osutils.dereference_path(filename))
215
if view_files and not osutils.is_inside_any(view_files, relpath):
216
raise errors.FileOutsideView(filename, view_files)
217
new_list.append(relpath)
218
except errors.PathNotChild:
219
raise errors.FileInWrongBranch(tree.branch, filename)
223
def _get_view_info_for_change_reporter(tree):
224
"""Get the view information from a tree for change reporting."""
227
current_view = tree.views.get_view_info()[0]
228
if current_view is not None:
229
view_info = (current_view, tree.views.lookup_view())
230
except errors.ViewsNotSupported:
235
# TODO: Make sure no commands unconditionally use the working directory as a
236
# branch. If a filename argument is used, the first of them should be used to
237
# specify the branch. (Perhaps this can be factored out into some kind of
238
# Argument class, representing a file in a branch, where the first occurrence
241
class cmd_status(Command):
242
"""Display status summary.
244
This reports on versioned and unknown files, reporting them
245
grouped by state. Possible states are:
248
Versioned in the working copy but not in the previous revision.
251
Versioned in the previous revision but removed or deleted
255
Path of this file changed from the previous revision;
256
the text may also have changed. This includes files whose
257
parent directory was renamed.
260
Text has changed since the previous revision.
263
File kind has been changed (e.g. from file to directory).
266
Not versioned and not matching an ignore pattern.
268
Additionally for directories, symlinks and files with an executable
269
bit, Bazaar indicates their type using a trailing character: '/', '@'
272
To see ignored files use 'bzr ignored'. For details on the
273
changes to file texts, use 'bzr diff'.
275
Note that --short or -S gives status flags for each item, similar
276
to Subversion's status command. To get output similar to svn -q,
279
If no arguments are specified, the status of the entire working
280
directory is shown. Otherwise, only the status of the specified
281
files or directories is reported. If a directory is given, status
282
is reported for everything inside that directory.
284
Before merges are committed, the pending merge tip revisions are
285
shown. To see all pending merge revisions, use the -v option.
286
To skip the display of pending merge information altogether, use
287
the no-pending option or specify a file/directory.
289
If a revision argument is given, the status is calculated against
290
that revision, or between two revisions if two are provided.
293
# TODO: --no-recurse, --recurse options
295
takes_args = ['file*']
296
takes_options = ['show-ids', 'revision', 'change', 'verbose',
297
Option('short', help='Use short status indicators.',
299
Option('versioned', help='Only show versioned files.',
301
Option('no-pending', help='Don\'t show pending merges.',
304
aliases = ['st', 'stat']
306
encoding_type = 'replace'
307
_see_also = ['diff', 'revert', 'status-flags']
310
def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
versioned=False, no_pending=False, verbose=False):
312
from bzrlib.status import show_tree_status
314
if revision and len(revision) > 2:
315
raise errors.BzrCommandError('bzr status --revision takes exactly'
316
' one or two revision specifiers')
318
tree, relfile_list = tree_files(file_list)
319
# Avoid asking for specific files when that is not needed.
320
if relfile_list == ['']:
322
# Don't disable pending merges for full trees other than '.'.
323
if file_list == ['.']:
325
# A specific path within a tree was given.
326
elif relfile_list is not None:
328
show_tree_status(tree, show_ids=show_ids,
329
specific_files=relfile_list, revision=revision,
330
to_file=self.outf, short=short, versioned=versioned,
331
show_pending=(not no_pending), verbose=verbose)
334
class cmd_cat_revision(Command):
335
"""Write out metadata for a revision.
337
The revision to print can either be specified by a specific
338
revision identifier, or you can use --revision.
342
takes_args = ['revision_id?']
343
takes_options = ['revision']
344
# cat-revision is more for frontends so should be exact
347
def print_revision(self, revisions, revid):
348
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
record = stream.next()
350
if record.storage_kind == 'absent':
351
raise errors.NoSuchRevision(revisions, revid)
352
revtext = record.get_bytes_as('fulltext')
353
self.outf.write(revtext.decode('utf-8'))
356
def run(self, revision_id=None, revision=None):
357
if revision_id is not None and revision is not None:
358
raise errors.BzrCommandError('You can only supply one of'
359
' revision_id or --revision')
360
if revision_id is None and revision is None:
361
raise errors.BzrCommandError('You must supply either'
362
' --revision or a revision_id')
363
b = WorkingTree.open_containing(u'.')[0].branch
365
revisions = b.repository.revisions
366
if revisions is None:
367
raise errors.BzrCommandError('Repository %r does not support '
368
'access to raw revision texts')
370
b.repository.lock_read()
372
# TODO: jam 20060112 should cat-revision always output utf-8?
373
if revision_id is not None:
374
revision_id = osutils.safe_revision_id(revision_id, warn=False)
376
self.print_revision(revisions, revision_id)
377
except errors.NoSuchRevision:
378
msg = "The repository %s contains no revision %s." % (
379
b.repository.base, revision_id)
380
raise errors.BzrCommandError(msg)
381
elif revision is not None:
384
raise errors.BzrCommandError(
385
'You cannot specify a NULL revision.')
386
rev_id = rev.as_revision_id(b)
387
self.print_revision(revisions, rev_id)
389
b.repository.unlock()
392
class cmd_dump_btree(Command):
393
"""Dump the contents of a btree index file to stdout.
395
PATH is a btree index file, it can be any URL. This includes things like
396
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
398
By default, the tuples stored in the index file will be displayed. With
399
--raw, we will uncompress the pages, but otherwise display the raw bytes
403
# TODO: Do we want to dump the internal nodes as well?
404
# TODO: It would be nice to be able to dump the un-parsed information,
405
# rather than only going through iter_all_entries. However, this is
406
# good enough for a start
408
encoding_type = 'exact'
409
takes_args = ['path']
410
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
411
' rather than the parsed tuples.'),
414
def run(self, path, raw=False):
415
dirname, basename = osutils.split(path)
416
t = transport.get_transport(dirname)
418
self._dump_raw_bytes(t, basename)
420
self._dump_entries(t, basename)
422
def _get_index_and_bytes(self, trans, basename):
423
"""Create a BTreeGraphIndex and raw bytes."""
424
bt = btree_index.BTreeGraphIndex(trans, basename, None)
425
bytes = trans.get_bytes(basename)
426
bt._file = cStringIO.StringIO(bytes)
427
bt._size = len(bytes)
430
def _dump_raw_bytes(self, trans, basename):
433
# We need to parse at least the root node.
434
# This is because the first page of every row starts with an
435
# uncompressed header.
436
bt, bytes = self._get_index_and_bytes(trans, basename)
437
for page_idx, page_start in enumerate(xrange(0, len(bytes),
438
btree_index._PAGE_SIZE)):
439
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
440
page_bytes = bytes[page_start:page_end]
442
self.outf.write('Root node:\n')
443
header_end, data = bt._parse_header_from_bytes(page_bytes)
444
self.outf.write(page_bytes[:header_end])
446
self.outf.write('\nPage %d\n' % (page_idx,))
447
decomp_bytes = zlib.decompress(page_bytes)
448
self.outf.write(decomp_bytes)
449
self.outf.write('\n')
451
def _dump_entries(self, trans, basename):
453
st = trans.stat(basename)
454
except errors.TransportNotPossible:
455
# We can't stat, so we'll fake it because we have to do the 'get()'
457
bt, _ = self._get_index_and_bytes(trans, basename)
459
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
460
for node in bt.iter_all_entries():
461
# Node is made up of:
462
# (index, key, value, [references])
466
refs_as_tuples = None
468
refs_as_tuples = static_tuple.as_tuples(refs)
469
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
self.outf.write('%s\n' % (as_tuple,))
473
class cmd_remove_tree(Command):
474
"""Remove the working tree from a given branch/checkout.
476
Since a lightweight checkout is little more than a working tree
477
this will refuse to run against one.
479
To re-create the working tree, use "bzr checkout".
481
_see_also = ['checkout', 'working-trees']
482
takes_args = ['location*']
485
help='Remove the working tree even if it has '
486
'uncommitted changes.'),
489
def run(self, location_list, force=False):
490
if not location_list:
493
for location in location_list:
494
d = bzrdir.BzrDir.open(location)
497
working = d.open_workingtree()
498
except errors.NoWorkingTree:
499
raise errors.BzrCommandError("No working tree to remove")
500
except errors.NotLocalUrl:
501
raise errors.BzrCommandError("You cannot remove the working tree"
504
if (working.has_changes()):
505
raise errors.UncommittedChanges(working)
507
working_path = working.bzrdir.root_transport.base
508
branch_path = working.branch.bzrdir.root_transport.base
509
if working_path != branch_path:
510
raise errors.BzrCommandError("You cannot remove the working tree"
511
" from a lightweight checkout")
513
d.destroy_workingtree()
516
class cmd_revno(Command):
517
"""Show current revision number.
519
This is equal to the number of revisions on this branch.
523
takes_args = ['location?']
525
Option('tree', help='Show revno of working tree'),
529
def run(self, tree=False, location=u'.'):
532
wt = WorkingTree.open_containing(location)[0]
534
except (errors.NoWorkingTree, errors.NotLocalUrl):
535
raise errors.NoWorkingTree(location)
536
self.add_cleanup(wt.unlock)
537
revid = wt.last_revision()
539
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
540
except errors.NoSuchRevision:
542
revno = ".".join(str(n) for n in revno_t)
544
b = Branch.open_containing(location)[0]
546
self.add_cleanup(b.unlock)
549
self.outf.write(str(revno) + '\n')
552
class cmd_revision_info(Command):
553
"""Show revision number and revision id for a given revision identifier.
556
takes_args = ['revision_info*']
560
help='Branch to examine, '
561
'rather than the one containing the working directory.',
565
Option('tree', help='Show revno of working tree'),
569
def run(self, revision=None, directory=u'.', tree=False,
570
revision_info_list=[]):
573
wt = WorkingTree.open_containing(directory)[0]
576
self.add_cleanup(wt.unlock)
577
except (errors.NoWorkingTree, errors.NotLocalUrl):
579
b = Branch.open_containing(directory)[0]
581
self.add_cleanup(b.unlock)
583
if revision is not None:
584
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
585
if revision_info_list is not None:
586
for rev_str in revision_info_list:
587
rev_spec = RevisionSpec.from_string(rev_str)
588
revision_ids.append(rev_spec.as_revision_id(b))
589
# No arguments supplied, default to the last revision
590
if len(revision_ids) == 0:
593
raise errors.NoWorkingTree(directory)
594
revision_ids.append(wt.last_revision())
596
revision_ids.append(b.last_revision())
600
for revision_id in revision_ids:
602
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
603
revno = '.'.join(str(i) for i in dotted_revno)
604
except errors.NoSuchRevision:
606
maxlen = max(maxlen, len(revno))
607
revinfos.append([revno, revision_id])
611
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
614
class cmd_add(Command):
615
"""Add specified files or directories.
617
In non-recursive mode, all the named items are added, regardless
618
of whether they were previously ignored. A warning is given if
619
any of the named files are already versioned.
621
In recursive mode (the default), files are treated the same way
622
but the behaviour for directories is different. Directories that
623
are already versioned do not give a warning. All directories,
624
whether already versioned or not, are searched for files or
625
subdirectories that are neither versioned or ignored, and these
626
are added. This search proceeds recursively into versioned
627
directories. If no names are given '.' is assumed.
629
Therefore simply saying 'bzr add' will version all files that
630
are currently unknown.
632
Adding a file whose parent directory is not versioned will
633
implicitly add the parent, and so on up to the root. This means
634
you should never need to explicitly add a directory, they'll just
635
get added when you add a file in the directory.
637
--dry-run will show which files would be added, but not actually
640
--file-ids-from will try to use the file ids from the supplied path.
641
It looks up ids trying to find a matching parent directory with the
642
same filename, and then by pure path. This option is rarely needed
643
but can be useful when adding the same logical file into two
644
branches that will be merged later (without showing the two different
645
adds as a conflict). It is also useful when merging another project
646
into a subdirectory of this one.
648
Any files matching patterns in the ignore list will not be added
649
unless they are explicitly mentioned.
651
takes_args = ['file*']
654
help="Don't recursively add the contents of directories."),
656
help="Show what would be done, but don't actually do anything."),
658
Option('file-ids-from',
660
help='Lookup file ids from this tree.'),
662
encoding_type = 'replace'
663
_see_also = ['remove', 'ignore']
665
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
670
if file_ids_from is not None:
672
base_tree, base_path = WorkingTree.open_containing(
674
except errors.NoWorkingTree:
675
base_branch, base_path = Branch.open_containing(
677
base_tree = base_branch.basis_tree()
679
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
680
to_file=self.outf, should_print=(not is_quiet()))
682
action = bzrlib.add.AddAction(to_file=self.outf,
683
should_print=(not is_quiet()))
686
base_tree.lock_read()
687
self.add_cleanup(base_tree.unlock)
688
tree, file_list = tree_files_for_add(file_list)
689
added, ignored = tree.smart_add(file_list, not
690
no_recurse, action=action, save=not dry_run)
694
for glob in sorted(ignored.keys()):
695
for path in ignored[glob]:
696
self.outf.write("ignored %s matching \"%s\"\n"
700
class cmd_mkdir(Command):
701
"""Create a new versioned directory.
703
This is equivalent to creating the directory and then adding it.
706
takes_args = ['dir+']
707
encoding_type = 'replace'
709
def run(self, dir_list):
711
wt, dd = WorkingTree.open_containing(d)
712
base = os.path.dirname(dd)
713
id = wt.path2id(base)
717
self.outf.write('added %s\n' % d)
719
raise errors.NotVersionedError(path=base)
722
class cmd_relpath(Command):
723
"""Show path of a file relative to root"""
725
takes_args = ['filename']
729
def run(self, filename):
730
# TODO: jam 20050106 Can relpath return a munged path if
731
# sys.stdout encoding cannot represent it?
732
tree, relpath = WorkingTree.open_containing(filename)
733
self.outf.write(relpath)
734
self.outf.write('\n')
737
class cmd_inventory(Command):
738
"""Show inventory of the current working copy or a revision.
740
It is possible to limit the output to a particular entry
741
type using the --kind option. For example: --kind file.
743
It is also possible to restrict the list of files to a specific
744
set. For example: bzr inventory --show-ids this/file
753
help='List entries of a particular kind: file, directory, symlink.',
756
takes_args = ['file*']
759
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
760
if kind and kind not in ['file', 'directory', 'symlink']:
761
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
763
revision = _get_one_revision('inventory', revision)
764
work_tree, file_list = tree_files(file_list)
765
work_tree.lock_read()
766
self.add_cleanup(work_tree.unlock)
767
if revision is not None:
768
tree = revision.as_tree(work_tree.branch)
770
extra_trees = [work_tree]
772
self.add_cleanup(tree.unlock)
777
if file_list is not None:
778
file_ids = tree.paths2ids(file_list, trees=extra_trees,
779
require_versioned=True)
780
# find_ids_across_trees may include some paths that don't
782
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
783
for file_id in file_ids if file_id in tree)
785
entries = tree.inventory.entries()
788
for path, entry in entries:
789
if kind and kind != entry.kind:
792
self.outf.write('%-50s %s\n' % (path, entry.file_id))
794
self.outf.write(path)
795
self.outf.write('\n')
798
class cmd_mv(Command):
799
"""Move or rename a file.
802
bzr mv OLDNAME NEWNAME
804
bzr mv SOURCE... DESTINATION
806
If the last argument is a versioned directory, all the other names
807
are moved into it. Otherwise, there must be exactly two arguments
808
and the file is changed to a new name.
810
If OLDNAME does not exist on the filesystem but is versioned and
811
NEWNAME does exist on the filesystem but is not versioned, mv
812
assumes that the file has been manually moved and only updates
813
its internal inventory to reflect that change.
814
The same is valid when moving many SOURCE files to a DESTINATION.
816
Files cannot be moved between branches.
819
takes_args = ['names*']
820
takes_options = [Option("after", help="Move only the bzr identifier"
821
" of the file, because the file has already been moved."),
822
Option('auto', help='Automatically guess renames.'),
823
Option('dry-run', help='Avoid making changes when guessing renames.'),
825
aliases = ['move', 'rename']
826
encoding_type = 'replace'
828
def run(self, names_list, after=False, auto=False, dry_run=False):
830
return self.run_auto(names_list, after, dry_run)
832
raise errors.BzrCommandError('--dry-run requires --auto.')
833
if names_list is None:
835
if len(names_list) < 2:
836
raise errors.BzrCommandError("missing file argument")
837
tree, rel_names = tree_files(names_list, canonicalize=False)
838
tree.lock_tree_write()
839
self.add_cleanup(tree.unlock)
840
self._run(tree, names_list, rel_names, after)
842
def run_auto(self, names_list, after, dry_run):
843
if names_list is not None and len(names_list) > 1:
844
raise errors.BzrCommandError('Only one path may be specified to'
847
raise errors.BzrCommandError('--after cannot be specified with'
849
work_tree, file_list = tree_files(names_list, default_branch='.')
850
work_tree.lock_tree_write()
851
self.add_cleanup(work_tree.unlock)
852
rename_map.RenameMap.guess_renames(work_tree, dry_run)
854
def _run(self, tree, names_list, rel_names, after):
855
into_existing = osutils.isdir(names_list[-1])
856
if into_existing and len(names_list) == 2:
858
# a. case-insensitive filesystem and change case of dir
859
# b. move directory after the fact (if the source used to be
860
# a directory, but now doesn't exist in the working tree
861
# and the target is an existing directory, just rename it)
862
if (not tree.case_sensitive
863
and rel_names[0].lower() == rel_names[1].lower()):
864
into_existing = False
867
# 'fix' the case of a potential 'from'
868
from_id = tree.path2id(
869
tree.get_canonical_inventory_path(rel_names[0]))
870
if (not osutils.lexists(names_list[0]) and
871
from_id and inv.get_file_kind(from_id) == "directory"):
872
into_existing = False
875
# move into existing directory
876
# All entries reference existing inventory items, so fix them up
877
# for cicp file-systems.
878
rel_names = tree.get_canonical_inventory_paths(rel_names)
879
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
881
self.outf.write("%s => %s\n" % (src, dest))
883
if len(names_list) != 2:
884
raise errors.BzrCommandError('to mv multiple files the'
885
' destination must be a versioned'
888
# for cicp file-systems: the src references an existing inventory
890
src = tree.get_canonical_inventory_path(rel_names[0])
891
# Find the canonical version of the destination: In all cases, the
892
# parent of the target must be in the inventory, so we fetch the
893
# canonical version from there (we do not always *use* the
894
# canonicalized tail portion - we may be attempting to rename the
896
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
897
dest_parent = osutils.dirname(canon_dest)
898
spec_tail = osutils.basename(rel_names[1])
899
# For a CICP file-system, we need to avoid creating 2 inventory
900
# entries that differ only by case. So regardless of the case
901
# we *want* to use (ie, specified by the user or the file-system),
902
# we must always choose to use the case of any existing inventory
903
# items. The only exception to this is when we are attempting a
904
# case-only rename (ie, canonical versions of src and dest are
906
dest_id = tree.path2id(canon_dest)
907
if dest_id is None or tree.path2id(src) == dest_id:
908
# No existing item we care about, so work out what case we
909
# are actually going to use.
911
# If 'after' is specified, the tail must refer to a file on disk.
913
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
915
# pathjoin with an empty tail adds a slash, which breaks
917
dest_parent_fq = tree.basedir
919
dest_tail = osutils.canonical_relpath(
921
osutils.pathjoin(dest_parent_fq, spec_tail))
923
# not 'after', so case as specified is used
924
dest_tail = spec_tail
926
# Use the existing item so 'mv' fails with AlreadyVersioned.
927
dest_tail = os.path.basename(canon_dest)
928
dest = osutils.pathjoin(dest_parent, dest_tail)
929
mutter("attempting to move %s => %s", src, dest)
930
tree.rename_one(src, dest, after=after)
932
self.outf.write("%s => %s\n" % (src, dest))
935
class cmd_pull(Command):
936
"""Turn this branch into a mirror of another branch.
938
By default, this command only works on branches that have not diverged.
939
Branches are considered diverged if the destination branch's most recent
940
commit is one that has not been merged (directly or indirectly) into the
943
If branches have diverged, you can use 'bzr merge' to integrate the changes
944
from one into the other. Once one branch has merged, the other should
945
be able to pull it again.
947
If you want to replace your local changes and just want your branch to
948
match the remote one, use pull --overwrite. This will work even if the two
949
branches have diverged.
951
If there is no default location set, the first pull will set it. After
952
that, you can omit the location to use the default. To change the
953
default, use --remember. The value will only be saved if the remote
954
location can be accessed.
956
Note: The location can be specified either in the form of a branch,
957
or in the form of a path to a file containing a merge directive generated
961
_see_also = ['push', 'update', 'status-flags', 'send']
962
takes_options = ['remember', 'overwrite', 'revision',
963
custom_help('verbose',
964
help='Show logs of pulled revisions.'),
966
help='Branch to pull into, '
967
'rather than the one containing the working directory.',
972
help="Perform a local pull in a bound "
973
"branch. Local pulls are not applied to "
977
takes_args = ['location?']
978
encoding_type = 'replace'
980
def run(self, location=None, remember=False, overwrite=False,
981
revision=None, verbose=False,
982
directory=None, local=False):
983
# FIXME: too much stuff is in the command class
986
if directory is None:
989
tree_to = WorkingTree.open_containing(directory)[0]
990
branch_to = tree_to.branch
992
self.add_cleanup(tree_to.unlock)
993
except errors.NoWorkingTree:
995
branch_to = Branch.open_containing(directory)[0]
996
branch_to.lock_write()
997
self.add_cleanup(branch_to.unlock)
999
if local and not branch_to.get_bound_location():
1000
raise errors.LocalRequiresBoundBranch()
1002
possible_transports = []
1003
if location is not None:
1005
mergeable = bundle.read_mergeable_from_url(location,
1006
possible_transports=possible_transports)
1007
except errors.NotABundle:
1010
stored_loc = branch_to.get_parent()
1011
if location is None:
1012
if stored_loc is None:
1013
raise errors.BzrCommandError("No pull location known or"
1016
display_url = urlutils.unescape_for_display(stored_loc,
1019
self.outf.write("Using saved parent location: %s\n" % display_url)
1020
location = stored_loc
1022
revision = _get_one_revision('pull', revision)
1023
if mergeable is not None:
1024
if revision is not None:
1025
raise errors.BzrCommandError(
1026
'Cannot use -r with merge directives or bundles')
1027
mergeable.install_revisions(branch_to.repository)
1028
base_revision_id, revision_id, verified = \
1029
mergeable.get_merge_request(branch_to.repository)
1030
branch_from = branch_to
1032
branch_from = Branch.open(location,
1033
possible_transports=possible_transports)
1034
branch_from.lock_read()
1035
self.add_cleanup(branch_from.unlock)
1037
if branch_to.get_parent() is None or remember:
1038
branch_to.set_parent(branch_from.base)
1040
if revision is not None:
1041
revision_id = revision.as_revision_id(branch_from)
1043
if tree_to is not None:
1044
view_info = _get_view_info_for_change_reporter(tree_to)
1045
change_reporter = delta._ChangeReporter(
1046
unversioned_filter=tree_to.is_ignored,
1047
view_info=view_info)
1048
result = tree_to.pull(
1049
branch_from, overwrite, revision_id, change_reporter,
1050
possible_transports=possible_transports, local=local)
1052
result = branch_to.pull(
1053
branch_from, overwrite, revision_id, local=local)
1055
result.report(self.outf)
1056
if verbose and result.old_revid != result.new_revid:
1057
log.show_branch_change(
1058
branch_to, self.outf, result.old_revno,
1062
class cmd_push(Command):
1063
"""Update a mirror of this branch.
1065
The target branch will not have its working tree populated because this
1066
is both expensive, and is not supported on remote file systems.
1068
Some smart servers or protocols *may* put the working tree in place in
1071
This command only works on branches that have not diverged. Branches are
1072
considered diverged if the destination branch's most recent commit is one
1073
that has not been merged (directly or indirectly) by the source branch.
1075
If branches have diverged, you can use 'bzr push --overwrite' to replace
1076
the other branch completely, discarding its unmerged changes.
1078
If you want to ensure you have the different changes in the other branch,
1079
do a merge (see bzr help merge) from the other branch, and commit that.
1080
After that you will be able to do a push without '--overwrite'.
1082
If there is no default push location set, the first push will set it.
1083
After that, you can omit the location to use the default. To change the
1084
default, use --remember. The value will only be saved if the remote
1085
location can be accessed.
1088
_see_also = ['pull', 'update', 'working-trees']
1089
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1090
Option('create-prefix',
1091
help='Create the path leading up to the branch '
1092
'if it does not already exist.'),
1094
help='Branch to push from, '
1095
'rather than the one containing the working directory.',
1099
Option('use-existing-dir',
1100
help='By default push will fail if the target'
1101
' directory exists, but does not already'
1102
' have a control directory. This flag will'
1103
' allow push to proceed.'),
1105
help='Create a stacked branch that references the public location '
1106
'of the parent branch.'),
1107
Option('stacked-on',
1108
help='Create a stacked branch that refers to another branch '
1109
'for the commit history. Only the work not present in the '
1110
'referenced branch is included in the branch created.',
1113
help='Refuse to push if there are uncommitted changes in'
1114
' the working tree, --no-strict disables the check.'),
1116
takes_args = ['location?']
1117
encoding_type = 'replace'
1119
def run(self, location=None, remember=False, overwrite=False,
1120
create_prefix=False, verbose=False, revision=None,
1121
use_existing_dir=False, directory=None, stacked_on=None,
1122
stacked=False, strict=None):
1123
from bzrlib.push import _show_push_branch
1125
if directory is None:
1127
# Get the source branch
1129
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1130
# Get the tip's revision_id
1131
revision = _get_one_revision('push', revision)
1132
if revision is not None:
1133
revision_id = revision.in_history(br_from).rev_id
1136
if tree is not None and revision_id is None:
1137
tree.warn_if_changed_or_out_of_date(
1138
strict, 'push_strict', 'Use --no-strict to force the push.')
1139
# Get the stacked_on branch, if any
1140
if stacked_on is not None:
1141
stacked_on = urlutils.normalize_url(stacked_on)
1143
parent_url = br_from.get_parent()
1145
parent = Branch.open(parent_url)
1146
stacked_on = parent.get_public_branch()
1148
# I considered excluding non-http url's here, thus forcing
1149
# 'public' branches only, but that only works for some
1150
# users, so it's best to just depend on the user spotting an
1151
# error by the feedback given to them. RBC 20080227.
1152
stacked_on = parent_url
1154
raise errors.BzrCommandError(
1155
"Could not determine branch to refer to.")
1157
# Get the destination location
1158
if location is None:
1159
stored_loc = br_from.get_push_location()
1160
if stored_loc is None:
1161
raise errors.BzrCommandError(
1162
"No push location known or specified.")
1164
display_url = urlutils.unescape_for_display(stored_loc,
1166
self.outf.write("Using saved push location: %s\n" % display_url)
1167
location = stored_loc
1169
_show_push_branch(br_from, revision_id, location, self.outf,
1170
verbose=verbose, overwrite=overwrite, remember=remember,
1171
stacked_on=stacked_on, create_prefix=create_prefix,
1172
use_existing_dir=use_existing_dir)
1175
class cmd_branch(Command):
1176
"""Create a new branch that is a copy of an existing branch.
1178
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1180
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1181
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1182
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1185
To retrieve the branch as of a particular revision, supply the --revision
1186
parameter, as in "branch foo/bar -r 5".
1189
_see_also = ['checkout']
1190
takes_args = ['from_location', 'to_location?']
1191
takes_options = ['revision', Option('hardlink',
1192
help='Hard-link working tree files where possible.'),
1194
help="Create a branch without a working-tree."),
1196
help="Switch the checkout in the current directory "
1197
"to the new branch."),
1199
help='Create a stacked branch referring to the source branch. '
1200
'The new branch will depend on the availability of the source '
1201
'branch for all operations.'),
1202
Option('standalone',
1203
help='Do not use a shared repository, even if available.'),
1204
Option('use-existing-dir',
1205
help='By default branch will fail if the target'
1206
' directory exists, but does not already'
1207
' have a control directory. This flag will'
1208
' allow branch to proceed.'),
1210
help="Bind new branch to from location."),
1212
aliases = ['get', 'clone']
1214
def run(self, from_location, to_location=None, revision=None,
1215
hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
use_existing_dir=False, switch=False, bind=False):
1217
from bzrlib import switch as _mod_switch
1218
from bzrlib.tag import _merge_tags_if_possible
1219
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1221
revision = _get_one_revision('branch', revision)
1223
self.add_cleanup(br_from.unlock)
1224
if revision is not None:
1225
revision_id = revision.as_revision_id(br_from)
1227
# FIXME - wt.last_revision, fallback to branch, fall back to
1228
# None or perhaps NULL_REVISION to mean copy nothing
1230
revision_id = br_from.last_revision()
1231
if to_location is None:
1232
to_location = urlutils.derive_to_location(from_location)
1233
to_transport = transport.get_transport(to_location)
1235
to_transport.mkdir('.')
1236
except errors.FileExists:
1237
if not use_existing_dir:
1238
raise errors.BzrCommandError('Target directory "%s" '
1239
'already exists.' % to_location)
1242
bzrdir.BzrDir.open_from_transport(to_transport)
1243
except errors.NotBranchError:
1246
raise errors.AlreadyBranchError(to_location)
1247
except errors.NoSuchFile:
1248
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1251
# preserve whatever source format we have.
1252
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1253
possible_transports=[to_transport],
1254
accelerator_tree=accelerator_tree,
1255
hardlink=hardlink, stacked=stacked,
1256
force_new_repo=standalone,
1257
create_tree_if_local=not no_tree,
1258
source_branch=br_from)
1259
branch = dir.open_branch()
1260
except errors.NoSuchRevision:
1261
to_transport.delete_tree('.')
1262
msg = "The branch %s has no revision %s." % (from_location,
1264
raise errors.BzrCommandError(msg)
1265
_merge_tags_if_possible(br_from, branch)
1266
# If the source branch is stacked, the new branch may
1267
# be stacked whether we asked for that explicitly or not.
1268
# We therefore need a try/except here and not just 'if stacked:'
1270
note('Created new stacked branch referring to %s.' %
1271
branch.get_stacked_on_url())
1272
except (errors.NotStacked, errors.UnstackableBranchFormat,
1273
errors.UnstackableRepositoryFormat), e:
1274
note('Branched %d revision(s).' % branch.revno())
1276
# Bind to the parent
1277
parent_branch = Branch.open(from_location)
1278
branch.bind(parent_branch)
1279
note('New branch bound to %s' % from_location)
1281
# Switch to the new branch
1282
wt, _ = WorkingTree.open_containing('.')
1283
_mod_switch.switch(wt.bzrdir, branch)
1284
note('Switched to branch: %s',
1285
urlutils.unescape_for_display(branch.base, 'utf-8'))
1288
class cmd_checkout(Command):
1289
"""Create a new checkout of an existing branch.
1291
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
the branch found in '.'. This is useful if you have removed the working tree
1293
or if it was never created - i.e. if you pushed the branch to its current
1294
location using SFTP.
1296
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1297
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1298
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1299
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1300
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1303
To retrieve the branch as of a particular revision, supply the --revision
1304
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1305
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1309
_see_also = ['checkouts', 'branch']
1310
takes_args = ['branch_location?', 'to_location?']
1311
takes_options = ['revision',
1312
Option('lightweight',
1313
help="Perform a lightweight checkout. Lightweight "
1314
"checkouts depend on access to the branch for "
1315
"every operation. Normal checkouts can perform "
1316
"common operations like diff and status without "
1317
"such access, and also support local commits."
1319
Option('files-from', type=str,
1320
help="Get file contents from this tree."),
1322
help='Hard-link working tree files where possible.'
1327
def run(self, branch_location=None, to_location=None, revision=None,
1328
lightweight=False, files_from=None, hardlink=False):
1329
if branch_location is None:
1330
branch_location = osutils.getcwd()
1331
to_location = branch_location
1332
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1334
revision = _get_one_revision('checkout', revision)
1335
if files_from is not None:
1336
accelerator_tree = WorkingTree.open(files_from)
1337
if revision is not None:
1338
revision_id = revision.as_revision_id(source)
1341
if to_location is None:
1342
to_location = urlutils.derive_to_location(branch_location)
1343
# if the source and to_location are the same,
1344
# and there is no working tree,
1345
# then reconstitute a branch
1346
if (osutils.abspath(to_location) ==
1347
osutils.abspath(branch_location)):
1349
source.bzrdir.open_workingtree()
1350
except errors.NoWorkingTree:
1351
source.bzrdir.create_workingtree(revision_id)
1353
source.create_checkout(to_location, revision_id, lightweight,
1354
accelerator_tree, hardlink)
1357
class cmd_renames(Command):
1358
"""Show list of renamed files.
1360
# TODO: Option to show renames between two historical versions.
1362
# TODO: Only show renames under dir, rather than in the whole branch.
1363
_see_also = ['status']
1364
takes_args = ['dir?']
1367
def run(self, dir=u'.'):
1368
tree = WorkingTree.open_containing(dir)[0]
1370
self.add_cleanup(tree.unlock)
1371
new_inv = tree.inventory
1372
old_tree = tree.basis_tree()
1373
old_tree.lock_read()
1374
self.add_cleanup(old_tree.unlock)
1375
old_inv = old_tree.inventory
1377
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1378
for f, paths, c, v, p, n, k, e in iterator:
1379
if paths[0] == paths[1]:
1383
renames.append(paths)
1385
for old_name, new_name in renames:
1386
self.outf.write("%s => %s\n" % (old_name, new_name))
1389
class cmd_update(Command):
1390
"""Update a tree to have the latest code committed to its branch.
1392
This will perform a merge into the working tree, and may generate
1393
conflicts. If you have any local changes, you will still
1394
need to commit them after the update for the update to be complete.
1396
If you want to discard your local changes, you can just do a
1397
'bzr revert' instead of 'bzr commit' after the update.
1399
If the tree's branch is bound to a master branch, it will also update
1400
the branch from the master.
1403
_see_also = ['pull', 'working-trees', 'status-flags']
1404
takes_args = ['dir?']
1405
takes_options = ['revision']
1408
def run(self, dir='.', revision=None):
1409
if revision is not None and len(revision) != 1:
1410
raise errors.BzrCommandError(
1411
"bzr update --revision takes exactly one revision")
1412
tree = WorkingTree.open_containing(dir)[0]
1413
branch = tree.branch
1414
possible_transports = []
1415
master = branch.get_master_branch(
1416
possible_transports=possible_transports)
1417
if master is not None:
1419
branch_location = master.base
1421
tree.lock_tree_write()
1422
branch_location = tree.branch.base
1423
self.add_cleanup(tree.unlock)
1424
# get rid of the final '/' and be ready for display
1425
branch_location = urlutils.unescape_for_display(
1426
branch_location.rstrip('/'),
1428
existing_pending_merges = tree.get_parent_ids()[1:]
1432
# may need to fetch data into a heavyweight checkout
1433
# XXX: this may take some time, maybe we should display a
1435
old_tip = branch.update(possible_transports)
1436
if revision is not None:
1437
revision_id = revision[0].as_revision_id(branch)
1439
revision_id = branch.last_revision()
1440
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
revno = branch.revision_id_to_dotted_revno(revision_id)
1442
note("Tree is up to date at revision %s of branch %s" %
1443
('.'.join(map(str, revno)), branch_location))
1445
view_info = _get_view_info_for_change_reporter(tree)
1446
change_reporter = delta._ChangeReporter(
1447
unversioned_filter=tree.is_ignored,
1448
view_info=view_info)
1450
conflicts = tree.update(
1452
possible_transports=possible_transports,
1453
revision=revision_id,
1455
except errors.NoSuchRevision, e:
1456
raise errors.BzrCommandError(
1457
"branch has no revision %s\n"
1458
"bzr update --revision only works"
1459
" for a revision in the branch history"
1461
revno = tree.branch.revision_id_to_dotted_revno(
1462
_mod_revision.ensure_null(tree.last_revision()))
1463
note('Updated to revision %s of branch %s' %
1464
('.'.join(map(str, revno)), branch_location))
1465
parent_ids = tree.get_parent_ids()
1466
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1467
note('Your local commits will now show as pending merges with '
1468
"'bzr status', and can be committed with 'bzr commit'.")
1475
class cmd_info(Command):
1476
"""Show information about a working tree, branch or repository.
1478
This command will show all known locations and formats associated to the
1479
tree, branch or repository.
1481
In verbose mode, statistical information is included with each report.
1482
To see extended statistic information, use a verbosity level of 2 or
1483
higher by specifying the verbose option multiple times, e.g. -vv.
1485
Branches and working trees will also report any missing revisions.
1489
Display information on the format and related locations:
1493
Display the above together with extended format information and
1494
basic statistics (like the number of files in the working tree and
1495
number of revisions in the branch and repository):
1499
Display the above together with number of committers to the branch:
1503
_see_also = ['revno', 'working-trees', 'repositories']
1504
takes_args = ['location?']
1505
takes_options = ['verbose']
1506
encoding_type = 'replace'
1509
def run(self, location=None, verbose=False):
1511
noise_level = get_verbosity_level()
1514
from bzrlib.info import show_bzrdir_info
1515
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1516
verbose=noise_level, outfile=self.outf)
1519
class cmd_remove(Command):
1520
"""Remove files or directories.
1522
This makes bzr stop tracking changes to the specified files. bzr will delete
1523
them if they can easily be recovered using revert. If no options or
1524
parameters are given bzr will scan for files that are being tracked by bzr
1525
but missing in your tree and stop tracking them for you.
1527
takes_args = ['file*']
1528
takes_options = ['verbose',
1529
Option('new', help='Only remove files that have never been committed.'),
1530
RegistryOption.from_kwargs('file-deletion-strategy',
1531
'The file deletion mode to be used.',
1532
title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
safe='Only delete files if they can be'
1534
' safely recovered (default).',
1535
keep='Delete from bzr but leave the working copy.',
1536
force='Delete all the specified files, even if they can not be '
1537
'recovered and even if they are non-empty directories.')]
1538
aliases = ['rm', 'del']
1539
encoding_type = 'replace'
1541
def run(self, file_list, verbose=False, new=False,
1542
file_deletion_strategy='safe'):
1543
tree, file_list = tree_files(file_list)
1545
if file_list is not None:
1546
file_list = [f for f in file_list]
1549
self.add_cleanup(tree.unlock)
1550
# Heuristics should probably all move into tree.remove_smart or
1553
added = tree.changes_from(tree.basis_tree(),
1554
specific_files=file_list).added
1555
file_list = sorted([f[0] for f in added], reverse=True)
1556
if len(file_list) == 0:
1557
raise errors.BzrCommandError('No matching files.')
1558
elif file_list is None:
1559
# missing files show up in iter_changes(basis) as
1560
# versioned-with-no-kind.
1562
for change in tree.iter_changes(tree.basis_tree()):
1563
# Find paths in the working tree that have no kind:
1564
if change[1][1] is not None and change[6][1] is None:
1565
missing.append(change[1][1])
1566
file_list = sorted(missing, reverse=True)
1567
file_deletion_strategy = 'keep'
1568
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
keep_files=file_deletion_strategy=='keep',
1570
force=file_deletion_strategy=='force')
1573
class cmd_file_id(Command):
1574
"""Print file_id of a particular file or directory.
1576
The file_id is assigned when the file is first added and remains the
1577
same through all revisions where the file exists, even when it is
1582
_see_also = ['inventory', 'ls']
1583
takes_args = ['filename']
1586
def run(self, filename):
1587
tree, relpath = WorkingTree.open_containing(filename)
1588
i = tree.path2id(relpath)
1590
raise errors.NotVersionedError(filename)
1592
self.outf.write(i + '\n')
1595
class cmd_file_path(Command):
1596
"""Print path of file_ids to a file or directory.
1598
This prints one line for each directory down to the target,
1599
starting at the branch root.
1603
takes_args = ['filename']
1606
def run(self, filename):
1607
tree, relpath = WorkingTree.open_containing(filename)
1608
fid = tree.path2id(relpath)
1610
raise errors.NotVersionedError(filename)
1611
segments = osutils.splitpath(relpath)
1612
for pos in range(1, len(segments) + 1):
1613
path = osutils.joinpath(segments[:pos])
1614
self.outf.write("%s\n" % tree.path2id(path))
1617
class cmd_reconcile(Command):
1618
"""Reconcile bzr metadata in a branch.
1620
This can correct data mismatches that may have been caused by
1621
previous ghost operations or bzr upgrades. You should only
1622
need to run this command if 'bzr check' or a bzr developer
1623
advises you to run it.
1625
If a second branch is provided, cross-branch reconciliation is
1626
also attempted, which will check that data like the tree root
1627
id which was not present in very early bzr versions is represented
1628
correctly in both branches.
1630
At the same time it is run it may recompress data resulting in
1631
a potential saving in disk space or performance gain.
1633
The branch *MUST* be on a listable system such as local disk or sftp.
1636
_see_also = ['check']
1637
takes_args = ['branch?']
1639
def run(self, branch="."):
1640
from bzrlib.reconcile import reconcile
1641
dir = bzrdir.BzrDir.open(branch)
1645
class cmd_revision_history(Command):
1646
"""Display the list of revision ids on a branch."""
1649
takes_args = ['location?']
1654
def run(self, location="."):
1655
branch = Branch.open_containing(location)[0]
1656
for revid in branch.revision_history():
1657
self.outf.write(revid)
1658
self.outf.write('\n')
1661
class cmd_ancestry(Command):
1662
"""List all revisions merged into this branch."""
1664
_see_also = ['log', 'revision-history']
1665
takes_args = ['location?']
1670
def run(self, location="."):
1672
wt = WorkingTree.open_containing(location)[0]
1673
except errors.NoWorkingTree:
1674
b = Branch.open(location)
1675
last_revision = b.last_revision()
1678
last_revision = wt.last_revision()
1680
revision_ids = b.repository.get_ancestry(last_revision)
1682
for revision_id in revision_ids:
1683
self.outf.write(revision_id + '\n')
1686
class cmd_init(Command):
1687
"""Make a directory into a versioned branch.
1689
Use this to create an empty branch, or before importing an
1692
If there is a repository in a parent directory of the location, then
1693
the history of the branch will be stored in the repository. Otherwise
1694
init creates a standalone branch which carries its own history
1695
in the .bzr directory.
1697
If there is already a branch at the location but it has no working tree,
1698
the tree can be populated with 'bzr checkout'.
1700
Recipe for importing a tree of files::
1706
bzr commit -m "imported project"
1709
_see_also = ['init-repository', 'branch', 'checkout']
1710
takes_args = ['location?']
1712
Option('create-prefix',
1713
help='Create the path leading up to the branch '
1714
'if it does not already exist.'),
1715
RegistryOption('format',
1716
help='Specify a format for this branch. '
1717
'See "help formats".',
1718
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1719
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1720
value_switches=True,
1721
title="Branch format",
1723
Option('append-revisions-only',
1724
help='Never change revnos or the existing log.'
1725
' Append revisions to it only.')
1727
def run(self, location=None, format=None, append_revisions_only=False,
1728
create_prefix=False):
1730
format = bzrdir.format_registry.make_bzrdir('default')
1731
if location is None:
1734
to_transport = transport.get_transport(location)
1736
# The path has to exist to initialize a
1737
# branch inside of it.
1738
# Just using os.mkdir, since I don't
1739
# believe that we want to create a bunch of
1740
# locations if the user supplies an extended path
1742
to_transport.ensure_base()
1743
except errors.NoSuchFile:
1744
if not create_prefix:
1745
raise errors.BzrCommandError("Parent directory of %s"
1747
"\nYou may supply --create-prefix to create all"
1748
" leading parent directories."
1750
to_transport.create_prefix()
1753
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1754
except errors.NotBranchError:
1755
# really a NotBzrDir error...
1756
create_branch = bzrdir.BzrDir.create_branch_convenience
1757
branch = create_branch(to_transport.base, format=format,
1758
possible_transports=[to_transport])
1759
a_bzrdir = branch.bzrdir
1761
from bzrlib.transport.local import LocalTransport
1762
if a_bzrdir.has_branch():
1763
if (isinstance(to_transport, LocalTransport)
1764
and not a_bzrdir.has_workingtree()):
1765
raise errors.BranchExistsWithoutWorkingTree(location)
1766
raise errors.AlreadyBranchError(location)
1767
branch = a_bzrdir.create_branch()
1768
a_bzrdir.create_workingtree()
1769
if append_revisions_only:
1771
branch.set_append_revisions_only(True)
1772
except errors.UpgradeRequired:
1773
raise errors.BzrCommandError('This branch format cannot be set'
1774
' to append-revisions-only. Try --default.')
1776
from bzrlib.info import describe_layout, describe_format
1778
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1779
except (errors.NoWorkingTree, errors.NotLocalUrl):
1781
repository = branch.repository
1782
layout = describe_layout(repository, branch, tree).lower()
1783
format = describe_format(a_bzrdir, repository, branch, tree)
1784
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1785
if repository.is_shared():
1786
#XXX: maybe this can be refactored into transport.path_or_url()
1787
url = repository.bzrdir.root_transport.external_url()
1789
url = urlutils.local_path_from_url(url)
1790
except errors.InvalidURL:
1792
self.outf.write("Using shared repository: %s\n" % url)
1795
class cmd_init_repository(Command):
1796
"""Create a shared repository for branches to share storage space.
1798
New branches created under the repository directory will store their
1799
revisions in the repository, not in the branch directory. For branches
1800
with shared history, this reduces the amount of storage needed and
1801
speeds up the creation of new branches.
1803
If the --no-trees option is given then the branches in the repository
1804
will not have working trees by default. They will still exist as
1805
directories on disk, but they will not have separate copies of the
1806
files at a certain revision. This can be useful for repositories that
1807
store branches which are interacted with through checkouts or remote
1808
branches, such as on a server.
1811
Create a shared repository holding just branches::
1813
bzr init-repo --no-trees repo
1816
Make a lightweight checkout elsewhere::
1818
bzr checkout --lightweight repo/trunk trunk-checkout
1823
_see_also = ['init', 'branch', 'checkout', 'repositories']
1824
takes_args = ["location"]
1825
takes_options = [RegistryOption('format',
1826
help='Specify a format for this repository. See'
1827
' "bzr help formats" for details.',
1828
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1829
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1830
value_switches=True, title='Repository format'),
1832
help='Branches in the repository will default to'
1833
' not having a working tree.'),
1835
aliases = ["init-repo"]
1837
def run(self, location, format=None, no_trees=False):
1839
format = bzrdir.format_registry.make_bzrdir('default')
1841
if location is None:
1844
to_transport = transport.get_transport(location)
1845
to_transport.ensure_base()
1847
newdir = format.initialize_on_transport(to_transport)
1848
repo = newdir.create_repository(shared=True)
1849
repo.set_make_working_trees(not no_trees)
1851
from bzrlib.info import show_bzrdir_info
1852
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1855
class cmd_diff(Command):
1856
"""Show differences in the working tree, between revisions or branches.
1858
If no arguments are given, all changes for the current tree are listed.
1859
If files are given, only the changes in those files are listed.
1860
Remote and multiple branches can be compared by using the --old and
1861
--new options. If not provided, the default for both is derived from
1862
the first argument, if any, or the current tree if no arguments are
1865
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1866
produces patches suitable for "patch -p1".
1870
2 - unrepresentable changes
1875
Shows the difference in the working tree versus the last commit::
1879
Difference between the working tree and revision 1::
1883
Difference between revision 3 and revision 1::
1887
Difference between revision 3 and revision 1 for branch xxx::
1891
To see the changes introduced in revision X::
1895
Note that in the case of a merge, the -c option shows the changes
1896
compared to the left hand parent. To see the changes against
1897
another parent, use::
1899
bzr diff -r<chosen_parent>..X
1901
The changes introduced by revision 2 (equivalent to -r1..2)::
1905
Show just the differences for file NEWS::
1909
Show the differences in working tree xxx for file NEWS::
1913
Show the differences from branch xxx to this working tree:
1917
Show the differences between two branches for file NEWS::
1919
bzr diff --old xxx --new yyy NEWS
1921
Same as 'bzr diff' but prefix paths with old/ and new/::
1923
bzr diff --prefix old/:new/
1925
_see_also = ['status']
1926
takes_args = ['file*']
1928
Option('diff-options', type=str,
1929
help='Pass these options to the external diff program.'),
1930
Option('prefix', type=str,
1932
help='Set prefixes added to old and new filenames, as '
1933
'two values separated by a colon. (eg "old/:new/").'),
1935
help='Branch/tree to compare from.',
1939
help='Branch/tree to compare to.',
1945
help='Use this command to compare files.',
1948
RegistryOption('format',
1949
help='Diff format to use.',
1950
lazy_registry=('bzrlib.diff', 'format_registry'),
1951
value_switches=False, title='Diff format'),
1953
aliases = ['di', 'dif']
1954
encoding_type = 'exact'
1957
def run(self, revision=None, file_list=None, diff_options=None,
1958
prefix=None, old=None, new=None, using=None, format=None):
1959
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
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
if using is not None and format is not None:
1981
raise errors.BzrCommandError('--using and --format are mutually '
1984
(old_tree, new_tree,
1985
old_branch, new_branch,
1986
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1988
return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
specific_files=specific_files,
1990
external_diff_options=diff_options,
1991
old_label=old_label, new_label=new_label,
1992
extra_trees=extra_trees, using=using,
1996
class cmd_deleted(Command):
1997
"""List files deleted in the working tree.
1999
# TODO: Show files deleted since a previous revision, or
2000
# between two revisions.
2001
# TODO: Much more efficient way to do this: read in new
2002
# directories with readdir, rather than stating each one. Same
2003
# level of effort but possibly much less IO. (Or possibly not,
2004
# if the directories are very large...)
2005
_see_also = ['status', 'ls']
2006
takes_options = ['show-ids']
2009
def run(self, show_ids=False):
2010
tree = WorkingTree.open_containing(u'.')[0]
2012
self.add_cleanup(tree.unlock)
2013
old = tree.basis_tree()
2015
self.add_cleanup(old.unlock)
2016
for path, ie in old.inventory.iter_entries():
2017
if not tree.has_id(ie.file_id):
2018
self.outf.write(path)
2020
self.outf.write(' ')
2021
self.outf.write(ie.file_id)
2022
self.outf.write('\n')
2025
class cmd_modified(Command):
2026
"""List files modified in working tree.
2030
_see_also = ['status', 'ls']
2033
help='Write an ascii NUL (\\0) separator '
2034
'between files rather than a newline.')
2038
def run(self, null=False):
2039
tree = WorkingTree.open_containing(u'.')[0]
2040
td = tree.changes_from(tree.basis_tree())
2041
for path, id, kind, text_modified, meta_modified in td.modified:
2043
self.outf.write(path + '\0')
2045
self.outf.write(osutils.quotefn(path) + '\n')
2048
class cmd_added(Command):
2049
"""List files added in working tree.
2053
_see_also = ['status', 'ls']
2056
help='Write an ascii NUL (\\0) separator '
2057
'between files rather than a newline.')
2061
def run(self, null=False):
2062
wt = WorkingTree.open_containing(u'.')[0]
2064
self.add_cleanup(wt.unlock)
2065
basis = wt.basis_tree()
2067
self.add_cleanup(basis.unlock)
2068
basis_inv = basis.inventory
2071
if file_id in basis_inv:
2073
if inv.is_root(file_id) and len(basis_inv) == 0:
2075
path = inv.id2path(file_id)
2076
if not os.access(osutils.abspath(path), os.F_OK):
2079
self.outf.write(path + '\0')
2081
self.outf.write(osutils.quotefn(path) + '\n')
2084
class cmd_root(Command):
2085
"""Show the tree root directory.
2087
The root is the nearest enclosing directory with a .bzr control
2090
takes_args = ['filename?']
2092
def run(self, filename=None):
2093
"""Print the branch root."""
2094
tree = WorkingTree.open_containing(filename)[0]
2095
self.outf.write(tree.basedir + '\n')
2098
def _parse_limit(limitstring):
2100
return int(limitstring)
2102
msg = "The limit argument must be an integer."
2103
raise errors.BzrCommandError(msg)
2106
def _parse_levels(s):
2110
msg = "The levels argument must be an integer."
2111
raise errors.BzrCommandError(msg)
2114
class cmd_log(Command):
2115
"""Show historical log for a branch or subset of a branch.
2117
log is bzr's default tool for exploring the history of a branch.
2118
The branch to use is taken from the first parameter. If no parameters
2119
are given, the branch containing the working directory is logged.
2120
Here are some simple examples::
2122
bzr log log the current branch
2123
bzr log foo.py log a file in its branch
2124
bzr log http://server/branch log a branch on a server
2126
The filtering, ordering and information shown for each revision can
2127
be controlled as explained below. By default, all revisions are
2128
shown sorted (topologically) so that newer revisions appear before
2129
older ones and descendants always appear before ancestors. If displayed,
2130
merged revisions are shown indented under the revision in which they
2135
The log format controls how information about each revision is
2136
displayed. The standard log formats are called ``long``, ``short``
2137
and ``line``. The default is long. See ``bzr help log-formats``
2138
for more details on log formats.
2140
The following options can be used to control what information is
2143
-l N display a maximum of N revisions
2144
-n N display N levels of revisions (0 for all, 1 for collapsed)
2145
-v display a status summary (delta) for each revision
2146
-p display a diff (patch) for each revision
2147
--show-ids display revision-ids (and file-ids), not just revnos
2149
Note that the default number of levels to display is a function of the
2150
log format. If the -n option is not used, the standard log formats show
2151
just the top level (mainline).
2153
Status summaries are shown using status flags like A, M, etc. To see
2154
the changes explained using words like ``added`` and ``modified``
2155
instead, use the -vv option.
2159
To display revisions from oldest to newest, use the --forward option.
2160
In most cases, using this option will have little impact on the total
2161
time taken to produce a log, though --forward does not incrementally
2162
display revisions like --reverse does when it can.
2164
:Revision filtering:
2166
The -r option can be used to specify what revision or range of revisions
2167
to filter against. The various forms are shown below::
2169
-rX display revision X
2170
-rX.. display revision X and later
2171
-r..Y display up to and including revision Y
2172
-rX..Y display from X to Y inclusive
2174
See ``bzr help revisionspec`` for details on how to specify X and Y.
2175
Some common examples are given below::
2177
-r-1 show just the tip
2178
-r-10.. show the last 10 mainline revisions
2179
-rsubmit:.. show what's new on this branch
2180
-rancestor:path.. show changes since the common ancestor of this
2181
branch and the one at location path
2182
-rdate:yesterday.. show changes since yesterday
2184
When logging a range of revisions using -rX..Y, log starts at
2185
revision Y and searches back in history through the primary
2186
("left-hand") parents until it finds X. When logging just the
2187
top level (using -n1), an error is reported if X is not found
2188
along the way. If multi-level logging is used (-n0), X may be
2189
a nested merge revision and the log will be truncated accordingly.
2193
If parameters are given and the first one is not a branch, the log
2194
will be filtered to show only those revisions that changed the
2195
nominated files or directories.
2197
Filenames are interpreted within their historical context. To log a
2198
deleted file, specify a revision range so that the file existed at
2199
the end or start of the range.
2201
Historical context is also important when interpreting pathnames of
2202
renamed files/directories. Consider the following example:
2204
* revision 1: add tutorial.txt
2205
* revision 2: modify tutorial.txt
2206
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2210
* ``bzr log guide.txt`` will log the file added in revision 1
2212
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2214
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2215
the original file in revision 2.
2217
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2218
was no file called guide.txt in revision 2.
2220
Renames are always followed by log. By design, there is no need to
2221
explicitly ask for this (and no way to stop logging a file back
2222
until it was last renamed).
2226
The --message option can be used for finding revisions that match a
2227
regular expression in a commit message.
2231
GUI tools and IDEs are often better at exploring history than command
2232
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2233
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2234
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2235
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2237
You may find it useful to add the aliases below to ``bazaar.conf``::
2241
top = log -l10 --line
2244
``bzr tip`` will then show the latest revision while ``bzr top``
2245
will show the last 10 mainline revisions. To see the details of a
2246
particular revision X, ``bzr show -rX``.
2248
If you are interested in looking deeper into a particular merge X,
2249
use ``bzr log -n0 -rX``.
2251
``bzr log -v`` on a branch with lots of history is currently
2252
very slow. A fix for this issue is currently under development.
2253
With or without that fix, it is recommended that a revision range
2254
be given when using the -v option.
2256
bzr has a generic full-text matching plugin, bzr-search, that can be
2257
used to find revisions matching user names, commit messages, etc.
2258
Among other features, this plugin can find all revisions containing
2259
a list of words but not others.
2261
When exploring non-mainline history on large projects with deep
2262
history, the performance of log can be greatly improved by installing
2263
the historycache plugin. This plugin buffers historical information
2264
trading disk space for faster speed.
2266
takes_args = ['file*']
2267
_see_also = ['log-formats', 'revisionspec']
2270
help='Show from oldest to newest.'),
2272
custom_help('verbose',
2273
help='Show files changed in each revision.'),
2277
type=bzrlib.option._parse_revision_str,
2279
help='Show just the specified revision.'
2280
' See also "help revisionspec".'),
2284
help='Number of levels to display - 0 for all, 1 for flat.',
2286
type=_parse_levels),
2289
help='Show revisions whose message matches this '
2290
'regular expression.',
2294
help='Limit the output to the first N revisions.',
2299
help='Show changes made in each revision as a patch.'),
2300
Option('include-merges',
2301
help='Show merged revisions like --levels 0 does.'),
2303
encoding_type = 'replace'
2306
def run(self, file_list=None, timezone='original',
2317
include_merges=False):
2318
from bzrlib.log import (
2320
make_log_request_dict,
2321
_get_info_for_log_files,
2323
direction = (forward and 'forward') or 'reverse'
2328
raise errors.BzrCommandError(
2329
'--levels and --include-merges are mutually exclusive')
2331
if change is not None:
2333
raise errors.RangeInChangeOption()
2334
if revision is not None:
2335
raise errors.BzrCommandError(
2336
'--revision and --change are mutually exclusive')
2341
filter_by_dir = False
2343
# find the file ids to log and check for directory filtering
2344
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2345
revision, file_list)
2346
self.add_cleanup(b.unlock)
2347
for relpath, file_id, kind in file_info_list:
2349
raise errors.BzrCommandError(
2350
"Path unknown at end or start of revision range: %s" %
2352
# If the relpath is the top of the tree, we log everything
2357
file_ids.append(file_id)
2358
filter_by_dir = filter_by_dir or (
2359
kind in ['directory', 'tree-reference'])
2362
# FIXME ? log the current subdir only RBC 20060203
2363
if revision is not None \
2364
and len(revision) > 0 and revision[0].get_branch():
2365
location = revision[0].get_branch()
2368
dir, relpath = bzrdir.BzrDir.open_containing(location)
2369
b = dir.open_branch()
2371
self.add_cleanup(b.unlock)
2372
rev1, rev2 = _get_revision_range(revision, b, self.name())
2374
# Decide on the type of delta & diff filtering to use
2375
# TODO: add an --all-files option to make this configurable & consistent
2383
diff_type = 'partial'
2387
# Build the log formatter
2388
if log_format is None:
2389
log_format = log.log_formatter_registry.get_default(b)
2390
# Make a non-encoding output to include the diffs - bug 328007
2391
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2392
lf = log_format(show_ids=show_ids, to_file=self.outf,
2393
to_exact_file=unencoded_output,
2394
show_timezone=timezone,
2395
delta_format=get_verbosity_level(),
2397
show_advice=levels is None)
2399
# Choose the algorithm for doing the logging. It's annoying
2400
# having multiple code paths like this but necessary until
2401
# the underlying repository format is faster at generating
2402
# deltas or can provide everything we need from the indices.
2403
# The default algorithm - match-using-deltas - works for
2404
# multiple files and directories and is faster for small
2405
# amounts of history (200 revisions say). However, it's too
2406
# slow for logging a single file in a repository with deep
2407
# history, i.e. > 10K revisions. In the spirit of "do no
2408
# evil when adding features", we continue to use the
2409
# original algorithm - per-file-graph - for the "single
2410
# file that isn't a directory without showing a delta" case.
2411
partial_history = revision and b.repository._format.supports_chks
2412
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2413
or delta_type or partial_history)
2415
# Build the LogRequest and execute it
2416
if len(file_ids) == 0:
2418
rqst = make_log_request_dict(
2419
direction=direction, specific_fileids=file_ids,
2420
start_revision=rev1, end_revision=rev2, limit=limit,
2421
message_search=message, delta_type=delta_type,
2422
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2423
Logger(b, rqst).show(lf)
2426
def _get_revision_range(revisionspec_list, branch, command_name):
2427
"""Take the input of a revision option and turn it into a revision range.
2429
It returns RevisionInfo objects which can be used to obtain the rev_id's
2430
of the desired revisions. It does some user input validations.
2432
if revisionspec_list is None:
2435
elif len(revisionspec_list) == 1:
2436
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2437
elif len(revisionspec_list) == 2:
2438
start_spec = revisionspec_list[0]
2439
end_spec = revisionspec_list[1]
2440
if end_spec.get_branch() != start_spec.get_branch():
2441
# b is taken from revision[0].get_branch(), and
2442
# show_log will use its revision_history. Having
2443
# different branches will lead to weird behaviors.
2444
raise errors.BzrCommandError(
2445
"bzr %s doesn't accept two revisions in different"
2446
" branches." % command_name)
2447
if start_spec.spec is None:
2448
# Avoid loading all the history.
2449
rev1 = RevisionInfo(branch, None, None)
2451
rev1 = start_spec.in_history(branch)
2452
# Avoid loading all of history when we know a missing
2453
# end of range means the last revision ...
2454
if end_spec.spec is None:
2455
last_revno, last_revision_id = branch.last_revision_info()
2456
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2458
rev2 = end_spec.in_history(branch)
2460
raise errors.BzrCommandError(
2461
'bzr %s --revision takes one or two values.' % command_name)
2465
def _revision_range_to_revid_range(revision_range):
2468
if revision_range[0] is not None:
2469
rev_id1 = revision_range[0].rev_id
2470
if revision_range[1] is not None:
2471
rev_id2 = revision_range[1].rev_id
2472
return rev_id1, rev_id2
2474
def get_log_format(long=False, short=False, line=False, default='long'):
2475
log_format = default
2479
log_format = 'short'
2485
class cmd_touching_revisions(Command):
2486
"""Return revision-ids which affected a particular file.
2488
A more user-friendly interface is "bzr log FILE".
2492
takes_args = ["filename"]
2495
def run(self, filename):
2496
tree, relpath = WorkingTree.open_containing(filename)
2497
file_id = tree.path2id(relpath)
2500
self.add_cleanup(b.unlock)
2501
touching_revs = log.find_touching_revisions(b, file_id)
2502
for revno, revision_id, what in touching_revs:
2503
self.outf.write("%6d %s\n" % (revno, what))
2506
class cmd_ls(Command):
2507
"""List files in a tree.
2510
_see_also = ['status', 'cat']
2511
takes_args = ['path?']
2515
Option('recursive', short_name='R',
2516
help='Recurse into subdirectories.'),
2518
help='Print paths relative to the root of the branch.'),
2519
Option('unknown', help='Print unknown files.'),
2520
Option('versioned', help='Print versioned files.',
2522
Option('ignored', help='Print ignored files.'),
2524
help='Write an ascii NUL (\\0) separator '
2525
'between files rather than a newline.'),
2527
help='List entries of a particular kind: file, directory, symlink.',
2532
def run(self, revision=None, verbose=False,
2533
recursive=False, from_root=False,
2534
unknown=False, versioned=False, ignored=False,
2535
null=False, kind=None, show_ids=False, path=None):
2537
if kind and kind not in ('file', 'directory', 'symlink'):
2538
raise errors.BzrCommandError('invalid kind specified')
2540
if verbose and null:
2541
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2542
all = not (unknown or versioned or ignored)
2544
selection = {'I':ignored, '?':unknown, 'V':versioned}
2550
raise errors.BzrCommandError('cannot specify both --from-root'
2553
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2556
# Calculate the prefix to use
2560
prefix = relpath + '/'
2561
elif fs_path != '.' and not fs_path.endswith('/'):
2562
prefix = fs_path + '/'
2564
if revision is not None or tree is None:
2565
tree = _get_one_revision_tree('ls', revision, branch=branch)
2568
if isinstance(tree, WorkingTree) and tree.supports_views():
2569
view_files = tree.views.lookup_view()
2572
view_str = views.view_display_str(view_files)
2573
note("Ignoring files outside view. View is %s" % view_str)
2576
self.add_cleanup(tree.unlock)
2577
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2578
from_dir=relpath, recursive=recursive):
2579
# Apply additional masking
2580
if not all and not selection[fc]:
2582
if kind is not None and fkind != kind:
2587
fullpath = osutils.pathjoin(relpath, fp)
2590
views.check_path_in_view(tree, fullpath)
2591
except errors.FileOutsideView:
2596
fp = osutils.pathjoin(prefix, fp)
2597
kindch = entry.kind_character()
2598
outstring = fp + kindch
2599
ui.ui_factory.clear_term()
2601
outstring = '%-8s %s' % (fc, outstring)
2602
if show_ids and fid is not None:
2603
outstring = "%-50s %s" % (outstring, fid)
2604
self.outf.write(outstring + '\n')
2606
self.outf.write(fp + '\0')
2609
self.outf.write(fid)
2610
self.outf.write('\0')
2618
self.outf.write('%-50s %s\n' % (outstring, my_id))
2620
self.outf.write(outstring + '\n')
2623
class cmd_unknowns(Command):
2624
"""List unknown files.
2632
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2633
self.outf.write(osutils.quotefn(f) + '\n')
2636
class cmd_ignore(Command):
2637
"""Ignore specified files or patterns.
2639
See ``bzr help patterns`` for details on the syntax of patterns.
2641
If a .bzrignore file does not exist, the ignore command
2642
will create one and add the specified files or patterns to the newly
2643
created file. The ignore command will also automatically add the
2644
.bzrignore file to be versioned. Creating a .bzrignore file without
2645
the use of the ignore command will require an explicit add command.
2647
To remove patterns from the ignore list, edit the .bzrignore file.
2648
After adding, editing or deleting that file either indirectly by
2649
using this command or directly by using an editor, be sure to commit
2652
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2653
the global ignore file can be found in the application data directory as
2654
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2656
Patterns prefixed with '!' are exceptions to ignore patterns and take
2657
precedence over regular ignores. Such exceptions are used to specify
2658
files that should be versioned which would otherwise be ignored.
2660
Patterns prefixed with '!!' act as regular ignore patterns, but have
2661
precedence over the '!' exception patterns.
2663
Note: ignore patterns containing shell wildcards must be quoted from
2667
Ignore the top level Makefile::
2669
bzr ignore ./Makefile
2671
Ignore .class files in all directories...::
2673
bzr ignore "*.class"
2675
...but do not ignore "special.class"::
2677
bzr ignore "!special.class"
2679
Ignore .o files under the lib directory::
2681
bzr ignore "lib/**/*.o"
2683
Ignore .o files under the lib directory::
2685
bzr ignore "RE:lib/.*\.o"
2687
Ignore everything but the "debian" toplevel directory::
2689
bzr ignore "RE:(?!debian/).*"
2691
Ignore everything except the "local" toplevel directory,
2692
but always ignore "*~" autosave files, even under local/::
2695
bzr ignore "!./local"
2699
_see_also = ['status', 'ignored', 'patterns']
2700
takes_args = ['name_pattern*']
2702
Option('default-rules',
2703
help='Display the default ignore rules that bzr uses.')
2706
def run(self, name_pattern_list=None, default_rules=None):
2707
from bzrlib import ignores
2708
if default_rules is not None:
2709
# dump the default rules and exit
2710
for pattern in ignores.USER_DEFAULTS:
2711
self.outf.write("%s\n" % pattern)
2713
if not name_pattern_list:
2714
raise errors.BzrCommandError("ignore requires at least one "
2715
"NAME_PATTERN or --default-rules.")
2716
name_pattern_list = [globbing.normalize_pattern(p)
2717
for p in name_pattern_list]
2718
for name_pattern in name_pattern_list:
2719
if (name_pattern[0] == '/' or
2720
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2721
raise errors.BzrCommandError(
2722
"NAME_PATTERN should not be an absolute path")
2723
tree, relpath = WorkingTree.open_containing(u'.')
2724
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2725
ignored = globbing.Globster(name_pattern_list)
2728
for entry in tree.list_files():
2732
if ignored.match(filename):
2733
matches.append(filename)
2735
if len(matches) > 0:
2736
self.outf.write("Warning: the following files are version controlled and"
2737
" match your ignore pattern:\n%s"
2738
"\nThese files will continue to be version controlled"
2739
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2742
class cmd_ignored(Command):
2743
"""List ignored files and the patterns that matched them.
2745
List all the ignored files and the ignore pattern that caused the file to
2748
Alternatively, to list just the files::
2753
encoding_type = 'replace'
2754
_see_also = ['ignore', 'ls']
2758
tree = WorkingTree.open_containing(u'.')[0]
2760
self.add_cleanup(tree.unlock)
2761
for path, file_class, kind, file_id, entry in tree.list_files():
2762
if file_class != 'I':
2764
## XXX: Slightly inefficient since this was already calculated
2765
pat = tree.is_ignored(path)
2766
self.outf.write('%-50s %s\n' % (path, pat))
2769
class cmd_lookup_revision(Command):
2770
"""Lookup the revision-id from a revision-number
2773
bzr lookup-revision 33
2776
takes_args = ['revno']
2779
def run(self, revno):
2783
raise errors.BzrCommandError("not a valid revision-number: %r"
2785
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2786
self.outf.write("%s\n" % revid)
2789
class cmd_export(Command):
2790
"""Export current or past revision to a destination directory or archive.
2792
If no revision is specified this exports the last committed revision.
2794
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2795
given, try to find the format with the extension. If no extension
2796
is found exports to a directory (equivalent to --format=dir).
2798
If root is supplied, it will be used as the root directory inside
2799
container formats (tar, zip, etc). If it is not supplied it will default
2800
to the exported filename. The root option has no effect for 'dir' format.
2802
If branch is omitted then the branch containing the current working
2803
directory will be used.
2805
Note: Export of tree with non-ASCII filenames to zip is not supported.
2807
================= =========================
2808
Supported formats Autodetected by extension
2809
================= =========================
2812
tbz2 .tar.bz2, .tbz2
2815
================= =========================
2817
takes_args = ['dest', 'branch_or_subdir?']
2820
help="Type of file to export to.",
2823
Option('filters', help='Apply content filters to export the '
2824
'convenient form.'),
2827
help="Name of the root directory inside the exported file."),
2828
Option('per-file-timestamps',
2829
help='Set modification time of files to that of the last '
2830
'revision in which it was changed.'),
2832
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2833
root=None, filters=False, per_file_timestamps=False):
2834
from bzrlib.export import export
2836
if branch_or_subdir is None:
2837
tree = WorkingTree.open_containing(u'.')[0]
2841
b, subdir = Branch.open_containing(branch_or_subdir)
2844
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2846
export(rev_tree, dest, format, root, subdir, filtered=filters,
2847
per_file_timestamps=per_file_timestamps)
2848
except errors.NoSuchExportFormat, e:
2849
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2852
class cmd_cat(Command):
2853
"""Write the contents of a file as of a given revision to standard output.
2855
If no revision is nominated, the last revision is used.
2857
Note: Take care to redirect standard output when using this command on a
2863
Option('name-from-revision', help='The path name in the old tree.'),
2864
Option('filters', help='Apply content filters to display the '
2865
'convenience form.'),
2868
takes_args = ['filename']
2869
encoding_type = 'exact'
2872
def run(self, filename, revision=None, name_from_revision=False,
2874
if revision is not None and len(revision) != 1:
2875
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2876
" one revision specifier")
2877
tree, branch, relpath = \
2878
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2880
self.add_cleanup(branch.unlock)
2881
return self._run(tree, branch, relpath, filename, revision,
2882
name_from_revision, filters)
2884
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2887
tree = b.basis_tree()
2888
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2889
rev_tree.lock_read()
2890
self.add_cleanup(rev_tree.unlock)
2892
old_file_id = rev_tree.path2id(relpath)
2894
if name_from_revision:
2895
# Try in revision if requested
2896
if old_file_id is None:
2897
raise errors.BzrCommandError(
2898
"%r is not present in revision %s" % (
2899
filename, rev_tree.get_revision_id()))
2901
content = rev_tree.get_file_text(old_file_id)
2903
cur_file_id = tree.path2id(relpath)
2905
if cur_file_id is not None:
2906
# Then try with the actual file id
2908
content = rev_tree.get_file_text(cur_file_id)
2910
except errors.NoSuchId:
2911
# The actual file id didn't exist at that time
2913
if not found and old_file_id is not None:
2914
# Finally try with the old file id
2915
content = rev_tree.get_file_text(old_file_id)
2918
# Can't be found anywhere
2919
raise errors.BzrCommandError(
2920
"%r is not present in revision %s" % (
2921
filename, rev_tree.get_revision_id()))
2923
from bzrlib.filters import (
2924
ContentFilterContext,
2925
filtered_output_bytes,
2927
filters = rev_tree._content_filter_stack(relpath)
2928
chunks = content.splitlines(True)
2929
content = filtered_output_bytes(chunks, filters,
2930
ContentFilterContext(relpath, rev_tree))
2932
self.outf.writelines(content)
2935
self.outf.write(content)
2938
class cmd_local_time_offset(Command):
2939
"""Show the offset in seconds from GMT to local time."""
2943
self.outf.write("%s\n" % osutils.local_time_offset())
2947
class cmd_commit(Command):
2948
"""Commit changes into a new revision.
2950
An explanatory message needs to be given for each commit. This is
2951
often done by using the --message option (getting the message from the
2952
command line) or by using the --file option (getting the message from
2953
a file). If neither of these options is given, an editor is opened for
2954
the user to enter the message. To see the changed files in the
2955
boilerplate text loaded into the editor, use the --show-diff option.
2957
By default, the entire tree is committed and the person doing the
2958
commit is assumed to be the author. These defaults can be overridden
2963
If selected files are specified, only changes to those files are
2964
committed. If a directory is specified then the directory and
2965
everything within it is committed.
2967
When excludes are given, they take precedence over selected files.
2968
For example, to commit only changes within foo, but not changes
2971
bzr commit foo -x foo/bar
2973
A selective commit after a merge is not yet supported.
2977
If the author of the change is not the same person as the committer,
2978
you can specify the author's name using the --author option. The
2979
name should be in the same format as a committer-id, e.g.
2980
"John Doe <jdoe@example.com>". If there is more than one author of
2981
the change you can specify the option multiple times, once for each
2986
A common mistake is to forget to add a new file or directory before
2987
running the commit command. The --strict option checks for unknown
2988
files and aborts the commit if any are found. More advanced pre-commit
2989
checks can be implemented by defining hooks. See ``bzr help hooks``
2994
If you accidentially commit the wrong changes or make a spelling
2995
mistake in the commit message say, you can use the uncommit command
2996
to undo it. See ``bzr help uncommit`` for details.
2998
Hooks can also be configured to run after a commit. This allows you
2999
to trigger updates to external systems like bug trackers. The --fixes
3000
option can be used to record the association between a revision and
3001
one or more bugs. See ``bzr help bugs`` for details.
3003
A selective commit may fail in some cases where the committed
3004
tree would be invalid. Consider::
3009
bzr commit foo -m "committing foo"
3010
bzr mv foo/bar foo/baz
3013
bzr commit foo/bar -m "committing bar but not baz"
3015
In the example above, the last commit will fail by design. This gives
3016
the user the opportunity to decide whether they want to commit the
3017
rename at the same time, separately first, or not at all. (As a general
3018
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3020
# TODO: Run hooks on tree to-be-committed, and after commit.
3022
# TODO: Strict commit that fails if there are deleted files.
3023
# (what does "deleted files" mean ??)
3025
# TODO: Give better message for -s, --summary, used by tla people
3027
# XXX: verbose currently does nothing
3029
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3030
takes_args = ['selected*']
3032
ListOption('exclude', type=str, short_name='x',
3033
help="Do not consider changes made to a given path."),
3034
Option('message', type=unicode,
3036
help="Description of the new revision."),
3039
help='Commit even if nothing has changed.'),
3040
Option('file', type=str,
3043
help='Take commit message from this file.'),
3045
help="Refuse to commit if there are unknown "
3046
"files in the working tree."),
3047
Option('commit-time', type=str,
3048
help="Manually set a commit time using commit date "
3049
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3050
ListOption('fixes', type=str,
3051
help="Mark a bug as being fixed by this revision "
3052
"(see \"bzr help bugs\")."),
3053
ListOption('author', type=unicode,
3054
help="Set the author's name, if it's different "
3055
"from the committer."),
3057
help="Perform a local commit in a bound "
3058
"branch. Local commits are not pushed to "
3059
"the master branch until a normal commit "
3063
help='When no message is supplied, show the diff along'
3064
' with the status summary in the message editor.'),
3066
aliases = ['ci', 'checkin']
3068
def _iter_bug_fix_urls(self, fixes, branch):
3069
# Configure the properties for bug fixing attributes.
3070
for fixed_bug in fixes:
3071
tokens = fixed_bug.split(':')
3072
if len(tokens) != 2:
3073
raise errors.BzrCommandError(
3074
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3075
"See \"bzr help bugs\" for more information on this "
3076
"feature.\nCommit refused." % fixed_bug)
3077
tag, bug_id = tokens
3079
yield bugtracker.get_bug_url(tag, branch, bug_id)
3080
except errors.UnknownBugTrackerAbbreviation:
3081
raise errors.BzrCommandError(
3082
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3083
except errors.MalformedBugIdentifier, e:
3084
raise errors.BzrCommandError(
3085
"%s\nCommit refused." % (str(e),))
3087
def run(self, message=None, file=None, verbose=False, selected_list=None,
3088
unchanged=False, strict=False, local=False, fixes=None,
3089
author=None, show_diff=False, exclude=None, commit_time=None):
3090
from bzrlib.errors import (
3095
from bzrlib.msgeditor import (
3096
edit_commit_message_encoded,
3097
generate_commit_message_template,
3098
make_commit_message_template_encoded
3101
commit_stamp = offset = None
3102
if commit_time is not None:
3104
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3105
except ValueError, e:
3106
raise errors.BzrCommandError(
3107
"Could not parse --commit-time: " + str(e))
3109
# TODO: Need a blackbox test for invoking the external editor; may be
3110
# slightly problematic to run this cross-platform.
3112
# TODO: do more checks that the commit will succeed before
3113
# spending the user's valuable time typing a commit message.
3117
tree, selected_list = tree_files(selected_list)
3118
if selected_list == ['']:
3119
# workaround - commit of root of tree should be exactly the same
3120
# as just default commit in that tree, and succeed even though
3121
# selected-file merge commit is not done yet
3126
bug_property = bugtracker.encode_fixes_bug_urls(
3127
self._iter_bug_fix_urls(fixes, tree.branch))
3129
properties['bugs'] = bug_property
3131
if local and not tree.branch.get_bound_location():
3132
raise errors.LocalRequiresBoundBranch()
3134
if message is not None:
3136
file_exists = osutils.lexists(message)
3137
except UnicodeError:
3138
# The commit message contains unicode characters that can't be
3139
# represented in the filesystem encoding, so that can't be a
3144
'The commit message is a file name: "%(f)s".\n'
3145
'(use --file "%(f)s" to take commit message from that file)'
3147
ui.ui_factory.show_warning(warning_msg)
3149
message = message.replace('\r\n', '\n')
3150
message = message.replace('\r', '\n')
3152
raise errors.BzrCommandError(
3153
"please specify either --message or --file")
3155
def get_message(commit_obj):
3156
"""Callback to get commit message"""
3158
my_message = codecs.open(
3159
file, 'rt', osutils.get_user_encoding()).read()
3160
elif message is not None:
3161
my_message = message
3163
# No message supplied: make one up.
3164
# text is the status of the tree
3165
text = make_commit_message_template_encoded(tree,
3166
selected_list, diff=show_diff,
3167
output_encoding=osutils.get_user_encoding())
3168
# start_message is the template generated from hooks
3169
# XXX: Warning - looks like hooks return unicode,
3170
# make_commit_message_template_encoded returns user encoding.
3171
# We probably want to be using edit_commit_message instead to
3173
start_message = generate_commit_message_template(commit_obj)
3174
my_message = edit_commit_message_encoded(text,
3175
start_message=start_message)
3176
if my_message is None:
3177
raise errors.BzrCommandError("please specify a commit"
3178
" message with either --message or --file")
3179
if my_message == "":
3180
raise errors.BzrCommandError("empty commit message specified")
3183
# The API permits a commit with a filter of [] to mean 'select nothing'
3184
# but the command line should not do that.
3185
if not selected_list:
3186
selected_list = None
3188
tree.commit(message_callback=get_message,
3189
specific_files=selected_list,
3190
allow_pointless=unchanged, strict=strict, local=local,
3191
reporter=None, verbose=verbose, revprops=properties,
3192
authors=author, timestamp=commit_stamp,
3194
exclude=safe_relpath_files(tree, exclude))
3195
except PointlessCommit:
3196
raise errors.BzrCommandError("No changes to commit."
3197
" Use --unchanged to commit anyhow.")
3198
except ConflictsInTree:
3199
raise errors.BzrCommandError('Conflicts detected in working '
3200
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3202
except StrictCommitFailed:
3203
raise errors.BzrCommandError("Commit refused because there are"
3204
" unknown files in the working tree.")
3205
except errors.BoundBranchOutOfDate, e:
3206
e.extra_help = ("\n"
3207
'To commit to master branch, run update and then commit.\n'
3208
'You can also pass --local to commit to continue working '
3213
class cmd_check(Command):
3214
"""Validate working tree structure, branch consistency and repository history.
3216
This command checks various invariants about branch and repository storage
3217
to detect data corruption or bzr bugs.
3219
The working tree and branch checks will only give output if a problem is
3220
detected. The output fields of the repository check are:
3223
This is just the number of revisions checked. It doesn't
3227
This is just the number of versionedfiles checked. It
3228
doesn't indicate a problem.
3230
unreferenced ancestors
3231
Texts that are ancestors of other texts, but
3232
are not properly referenced by the revision ancestry. This is a
3233
subtle problem that Bazaar can work around.
3236
This is the total number of unique file contents
3237
seen in the checked revisions. It does not indicate a problem.
3240
This is the total number of repeated texts seen
3241
in the checked revisions. Texts can be repeated when their file
3242
entries are modified, but the file contents are not. It does not
3245
If no restrictions are specified, all Bazaar data that is found at the given
3246
location will be checked.
3250
Check the tree and branch at 'foo'::
3252
bzr check --tree --branch foo
3254
Check only the repository at 'bar'::
3256
bzr check --repo bar
3258
Check everything at 'baz'::
3263
_see_also = ['reconcile']
3264
takes_args = ['path?']
3265
takes_options = ['verbose',
3266
Option('branch', help="Check the branch related to the"
3267
" current directory."),
3268
Option('repo', help="Check the repository related to the"
3269
" current directory."),
3270
Option('tree', help="Check the working tree related to"
3271
" the current directory.")]
3273
def run(self, path=None, verbose=False, branch=False, repo=False,
3275
from bzrlib.check import check_dwim
3278
if not branch and not repo and not tree:
3279
branch = repo = tree = True
3280
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3283
class cmd_upgrade(Command):
3284
"""Upgrade branch storage to current format.
3286
The check command or bzr developers may sometimes advise you to run
3287
this command. When the default format has changed you may also be warned
3288
during other operations to upgrade.
3291
_see_also = ['check']
3292
takes_args = ['url?']
3294
RegistryOption('format',
3295
help='Upgrade to a specific format. See "bzr help'
3296
' formats" for details.',
3297
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3298
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3299
value_switches=True, title='Branch format'),
3302
def run(self, url='.', format=None):
3303
from bzrlib.upgrade import upgrade
3304
upgrade(url, format)
3307
class cmd_whoami(Command):
3308
"""Show or set bzr user id.
3311
Show the email of the current user::
3315
Set the current user::
3317
bzr whoami "Frank Chu <fchu@example.com>"
3319
takes_options = [ Option('email',
3320
help='Display email address only.'),
3322
help='Set identity for the current branch instead of '
3325
takes_args = ['name?']
3326
encoding_type = 'replace'
3329
def run(self, email=False, branch=False, name=None):
3331
# use branch if we're inside one; otherwise global config
3333
c = Branch.open_containing('.')[0].get_config()
3334
except errors.NotBranchError:
3335
c = config.GlobalConfig()
3337
self.outf.write(c.user_email() + '\n')
3339
self.outf.write(c.username() + '\n')
3342
# display a warning if an email address isn't included in the given name.
3344
config.extract_email_address(name)
3345
except errors.NoEmailInUsername, e:
3346
warning('"%s" does not seem to contain an email address. '
3347
'This is allowed, but not recommended.', name)
3349
# use global config unless --branch given
3351
c = Branch.open_containing('.')[0].get_config()
3353
c = config.GlobalConfig()
3354
c.set_user_option('email', name)
3357
class cmd_nick(Command):
3358
"""Print or set the branch nickname.
3360
If unset, the tree root directory name is used as the nickname.
3361
To print the current nickname, execute with no argument.
3363
Bound branches use the nickname of its master branch unless it is set
3367
_see_also = ['info']
3368
takes_args = ['nickname?']
3369
def run(self, nickname=None):
3370
branch = Branch.open_containing(u'.')[0]
3371
if nickname is None:
3372
self.printme(branch)
3374
branch.nick = nickname
3377
def printme(self, branch):
3378
self.outf.write('%s\n' % branch.nick)
3381
class cmd_alias(Command):
3382
"""Set/unset and display aliases.
3385
Show the current aliases::
3389
Show the alias specified for 'll'::
3393
Set an alias for 'll'::
3395
bzr alias ll="log --line -r-10..-1"
3397
To remove an alias for 'll'::
3399
bzr alias --remove ll
3402
takes_args = ['name?']
3404
Option('remove', help='Remove the alias.'),
3407
def run(self, name=None, remove=False):
3409
self.remove_alias(name)
3411
self.print_aliases()
3413
equal_pos = name.find('=')
3415
self.print_alias(name)
3417
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3419
def remove_alias(self, alias_name):
3420
if alias_name is None:
3421
raise errors.BzrCommandError(
3422
'bzr alias --remove expects an alias to remove.')
3423
# If alias is not found, print something like:
3424
# unalias: foo: not found
3425
c = config.GlobalConfig()
3426
c.unset_alias(alias_name)
3429
def print_aliases(self):
3430
"""Print out the defined aliases in a similar format to bash."""
3431
aliases = config.GlobalConfig().get_aliases()
3432
for key, value in sorted(aliases.iteritems()):
3433
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3436
def print_alias(self, alias_name):
3437
from bzrlib.commands import get_alias
3438
alias = get_alias(alias_name)
3440
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3443
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3445
def set_alias(self, alias_name, alias_command):
3446
"""Save the alias in the global config."""
3447
c = config.GlobalConfig()
3448
c.set_alias(alias_name, alias_command)
3451
class cmd_selftest(Command):
3452
"""Run internal test suite.
3454
If arguments are given, they are regular expressions that say which tests
3455
should run. Tests matching any expression are run, and other tests are
3458
Alternatively if --first is given, matching tests are run first and then
3459
all other tests are run. This is useful if you have been working in a
3460
particular area, but want to make sure nothing else was broken.
3462
If --exclude is given, tests that match that regular expression are
3463
excluded, regardless of whether they match --first or not.
3465
To help catch accidential dependencies between tests, the --randomize
3466
option is useful. In most cases, the argument used is the word 'now'.
3467
Note that the seed used for the random number generator is displayed
3468
when this option is used. The seed can be explicitly passed as the
3469
argument to this option if required. This enables reproduction of the
3470
actual ordering used if and when an order sensitive problem is encountered.
3472
If --list-only is given, the tests that would be run are listed. This is
3473
useful when combined with --first, --exclude and/or --randomize to
3474
understand their impact. The test harness reports "Listed nn tests in ..."
3475
instead of "Ran nn tests in ..." when list mode is enabled.
3477
If the global option '--no-plugins' is given, plugins are not loaded
3478
before running the selftests. This has two effects: features provided or
3479
modified by plugins will not be tested, and tests provided by plugins will
3482
Tests that need working space on disk use a common temporary directory,
3483
typically inside $TMPDIR or /tmp.
3485
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3486
into a pdb postmortem session.
3489
Run only tests relating to 'ignore'::
3493
Disable plugins and list tests as they're run::
3495
bzr --no-plugins selftest -v
3497
# NB: this is used from the class without creating an instance, which is
3498
# why it does not have a self parameter.
3499
def get_transport_type(typestring):
3500
"""Parse and return a transport specifier."""
3501
if typestring == "sftp":
3502
from bzrlib.tests import stub_sftp
3503
return stub_sftp.SFTPAbsoluteServer
3504
if typestring == "memory":
3505
from bzrlib.tests import test_server
3506
return memory.MemoryServer
3507
if typestring == "fakenfs":
3508
from bzrlib.tests import test_server
3509
return test_server.FakeNFSServer
3510
msg = "No known transport type %s. Supported types are: sftp\n" %\
3512
raise errors.BzrCommandError(msg)
3515
takes_args = ['testspecs*']
3516
takes_options = ['verbose',
3518
help='Stop when one test fails.',
3522
help='Use a different transport by default '
3523
'throughout the test suite.',
3524
type=get_transport_type),
3526
help='Run the benchmarks rather than selftests.'),
3527
Option('lsprof-timed',
3528
help='Generate lsprof output for benchmarked'
3529
' sections of code.'),
3530
Option('lsprof-tests',
3531
help='Generate lsprof output for each test.'),
3532
Option('cache-dir', type=str,
3533
help='Cache intermediate benchmark output in this '
3536
help='Run all tests, but run specified tests first.',
3540
help='List the tests instead of running them.'),
3541
RegistryOption('parallel',
3542
help="Run the test suite in parallel.",
3543
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3544
value_switches=False,
3546
Option('randomize', type=str, argname="SEED",
3547
help='Randomize the order of tests using the given'
3548
' seed or "now" for the current time.'),
3549
Option('exclude', type=str, argname="PATTERN",
3551
help='Exclude tests that match this regular'
3554
help='Output test progress via subunit.'),
3555
Option('strict', help='Fail on missing dependencies or '
3557
Option('load-list', type=str, argname='TESTLISTFILE',
3558
help='Load a test id list from a text file.'),
3559
ListOption('debugflag', type=str, short_name='E',
3560
help='Turn on a selftest debug flag.'),
3561
ListOption('starting-with', type=str, argname='TESTID',
3562
param_name='starting_with', short_name='s',
3564
'Load only the tests starting with TESTID.'),
3566
encoding_type = 'replace'
3569
Command.__init__(self)
3570
self.additional_selftest_args = {}
3572
def run(self, testspecs_list=None, verbose=False, one=False,
3573
transport=None, benchmark=None,
3574
lsprof_timed=None, cache_dir=None,
3575
first=False, list_only=False,
3576
randomize=None, exclude=None, strict=False,
3577
load_list=None, debugflag=None, starting_with=None, subunit=False,
3578
parallel=None, lsprof_tests=False):
3579
from bzrlib.tests import selftest
3580
import bzrlib.benchmarks as benchmarks
3581
from bzrlib.benchmarks import tree_creator
3583
# Make deprecation warnings visible, unless -Werror is set
3584
symbol_versioning.activate_deprecation_warnings(override=False)
3586
if cache_dir is not None:
3587
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3588
if testspecs_list is not None:
3589
pattern = '|'.join(testspecs_list)
3594
from bzrlib.tests import SubUnitBzrRunner
3596
raise errors.BzrCommandError("subunit not available. subunit "
3597
"needs to be installed to use --subunit.")
3598
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3600
self.additional_selftest_args.setdefault(
3601
'suite_decorators', []).append(parallel)
3603
test_suite_factory = benchmarks.test_suite
3604
# Unless user explicitly asks for quiet, be verbose in benchmarks
3605
verbose = not is_quiet()
3606
# TODO: should possibly lock the history file...
3607
benchfile = open(".perf_history", "at", buffering=1)
3608
self.add_cleanup(benchfile.close)
3610
test_suite_factory = None
3612
selftest_kwargs = {"verbose": verbose,
3614
"stop_on_failure": one,
3615
"transport": transport,
3616
"test_suite_factory": test_suite_factory,
3617
"lsprof_timed": lsprof_timed,
3618
"lsprof_tests": lsprof_tests,
3619
"bench_history": benchfile,
3620
"matching_tests_first": first,
3621
"list_only": list_only,
3622
"random_seed": randomize,
3623
"exclude_pattern": exclude,
3625
"load_list": load_list,
3626
"debug_flags": debugflag,
3627
"starting_with": starting_with
3629
selftest_kwargs.update(self.additional_selftest_args)
3630
result = selftest(**selftest_kwargs)
3631
return int(not result)
3634
class cmd_version(Command):
3635
"""Show version of bzr."""
3637
encoding_type = 'replace'
3639
Option("short", help="Print just the version number."),
3643
def run(self, short=False):
3644
from bzrlib.version import show_version
3646
self.outf.write(bzrlib.version_string + '\n')
3648
show_version(to_file=self.outf)
3651
class cmd_rocks(Command):
3652
"""Statement of optimism."""
3658
self.outf.write("It sure does!\n")
3661
class cmd_find_merge_base(Command):
3662
"""Find and print a base revision for merging two branches."""
3663
# TODO: Options to specify revisions on either side, as if
3664
# merging only part of the history.
3665
takes_args = ['branch', 'other']
3669
def run(self, branch, other):
3670
from bzrlib.revision import ensure_null
3672
branch1 = Branch.open_containing(branch)[0]
3673
branch2 = Branch.open_containing(other)[0]
3675
self.add_cleanup(branch1.unlock)
3677
self.add_cleanup(branch2.unlock)
3678
last1 = ensure_null(branch1.last_revision())
3679
last2 = ensure_null(branch2.last_revision())
3681
graph = branch1.repository.get_graph(branch2.repository)
3682
base_rev_id = graph.find_unique_lca(last1, last2)
3684
self.outf.write('merge base is revision %s\n' % base_rev_id)
3687
class cmd_merge(Command):
3688
"""Perform a three-way merge.
3690
The source of the merge can be specified either in the form of a branch,
3691
or in the form of a path to a file containing a merge directive generated
3692
with bzr send. If neither is specified, the default is the upstream branch
3693
or the branch most recently merged using --remember.
3695
When merging a branch, by default the tip will be merged. To pick a different
3696
revision, pass --revision. If you specify two values, the first will be used as
3697
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3698
available revisions, like this is commonly referred to as "cherrypicking".
3700
Revision numbers are always relative to the branch being merged.
3702
By default, bzr will try to merge in all new work from the other
3703
branch, automatically determining an appropriate base. If this
3704
fails, you may need to give an explicit base.
3706
Merge will do its best to combine the changes in two branches, but there
3707
are some kinds of problems only a human can fix. When it encounters those,
3708
it will mark a conflict. A conflict means that you need to fix something,
3709
before you should commit.
3711
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3713
If there is no default branch set, the first merge will set it. After
3714
that, you can omit the branch to use the default. To change the
3715
default, use --remember. The value will only be saved if the remote
3716
location can be accessed.
3718
The results of the merge are placed into the destination working
3719
directory, where they can be reviewed (with bzr diff), tested, and then
3720
committed to record the result of the merge.
3722
merge refuses to run if there are any uncommitted changes, unless
3723
--force is given. The --force option can also be used to create a
3724
merge revision which has more than two parents.
3726
If one would like to merge changes from the working tree of the other
3727
branch without merging any committed revisions, the --uncommitted option
3730
To select only some changes to merge, use "merge -i", which will prompt
3731
you to apply each diff hunk and file change, similar to "shelve".
3734
To merge the latest revision from bzr.dev::
3736
bzr merge ../bzr.dev
3738
To merge changes up to and including revision 82 from bzr.dev::
3740
bzr merge -r 82 ../bzr.dev
3742
To merge the changes introduced by 82, without previous changes::
3744
bzr merge -r 81..82 ../bzr.dev
3746
To apply a merge directive contained in /tmp/merge::
3748
bzr merge /tmp/merge
3750
To create a merge revision with three parents from two branches
3751
feature1a and feature1b:
3753
bzr merge ../feature1a
3754
bzr merge ../feature1b --force
3755
bzr commit -m 'revision with three parents'
3758
encoding_type = 'exact'
3759
_see_also = ['update', 'remerge', 'status-flags', 'send']
3760
takes_args = ['location?']
3765
help='Merge even if the destination tree has uncommitted changes.'),
3769
Option('show-base', help="Show base revision text in "
3771
Option('uncommitted', help='Apply uncommitted changes'
3772
' from a working copy, instead of branch changes.'),
3773
Option('pull', help='If the destination is already'
3774
' completely merged into the source, pull from the'
3775
' source rather than merging. When this happens,'
3776
' you do not need to commit the result.'),
3778
help='Branch to merge into, '
3779
'rather than the one containing the working directory.',
3783
Option('preview', help='Instead of merging, show a diff of the'
3785
Option('interactive', help='Select changes interactively.',
3789
def run(self, location=None, revision=None, force=False,
3790
merge_type=None, show_base=False, reprocess=None, remember=False,
3791
uncommitted=False, pull=False,
3796
if merge_type is None:
3797
merge_type = _mod_merge.Merge3Merger
3799
if directory is None: directory = u'.'
3800
possible_transports = []
3802
allow_pending = True
3803
verified = 'inapplicable'
3804
tree = WorkingTree.open_containing(directory)[0]
3807
basis_tree = tree.revision_tree(tree.last_revision())
3808
except errors.NoSuchRevision:
3809
basis_tree = tree.basis_tree()
3811
# die as quickly as possible if there are uncommitted changes
3813
if tree.has_changes():
3814
raise errors.UncommittedChanges(tree)
3816
view_info = _get_view_info_for_change_reporter(tree)
3817
change_reporter = delta._ChangeReporter(
3818
unversioned_filter=tree.is_ignored, view_info=view_info)
3819
pb = ui.ui_factory.nested_progress_bar()
3820
self.add_cleanup(pb.finished)
3822
self.add_cleanup(tree.unlock)
3823
if location is not None:
3825
mergeable = bundle.read_mergeable_from_url(location,
3826
possible_transports=possible_transports)
3827
except errors.NotABundle:
3831
raise errors.BzrCommandError('Cannot use --uncommitted'
3832
' with bundles or merge directives.')
3834
if revision is not None:
3835
raise errors.BzrCommandError(
3836
'Cannot use -r with merge directives or bundles')
3837
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3840
if merger is None and uncommitted:
3841
if revision is not None and len(revision) > 0:
3842
raise errors.BzrCommandError('Cannot use --uncommitted and'
3843
' --revision at the same time.')
3844
merger = self.get_merger_from_uncommitted(tree, location, None)
3845
allow_pending = False
3848
merger, allow_pending = self._get_merger_from_branch(tree,
3849
location, revision, remember, possible_transports, None)
3851
merger.merge_type = merge_type
3852
merger.reprocess = reprocess
3853
merger.show_base = show_base
3854
self.sanity_check_merger(merger)
3855
if (merger.base_rev_id == merger.other_rev_id and
3856
merger.other_rev_id is not None):
3857
note('Nothing to do.')
3860
if merger.interesting_files is not None:
3861
raise errors.BzrCommandError('Cannot pull individual files')
3862
if (merger.base_rev_id == tree.last_revision()):
3863
result = tree.pull(merger.other_branch, False,
3864
merger.other_rev_id)
3865
result.report(self.outf)
3867
if merger.this_basis is None:
3868
raise errors.BzrCommandError(
3869
"This branch has no commits."
3870
" (perhaps you would prefer 'bzr pull')")
3872
return self._do_preview(merger)
3874
return self._do_interactive(merger)
3876
return self._do_merge(merger, change_reporter, allow_pending,
3879
def _get_preview(self, merger):
3880
tree_merger = merger.make_merger()
3881
tt = tree_merger.make_preview_transform()
3882
self.add_cleanup(tt.finalize)
3883
result_tree = tt.get_preview_tree()
3886
def _do_preview(self, merger):
3887
from bzrlib.diff import show_diff_trees
3888
result_tree = self._get_preview(merger)
3889
show_diff_trees(merger.this_tree, result_tree, self.outf,
3890
old_label='', new_label='')
3892
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3893
merger.change_reporter = change_reporter
3894
conflict_count = merger.do_merge()
3896
merger.set_pending()
3897
if verified == 'failed':
3898
warning('Preview patch does not match changes')
3899
if conflict_count != 0:
3904
def _do_interactive(self, merger):
3905
"""Perform an interactive merge.
3907
This works by generating a preview tree of the merge, then using
3908
Shelver to selectively remove the differences between the working tree
3909
and the preview tree.
3911
from bzrlib import shelf_ui
3912
result_tree = self._get_preview(merger)
3913
writer = bzrlib.option.diff_writer_registry.get()
3914
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3915
reporter=shelf_ui.ApplyReporter(),
3916
diff_writer=writer(sys.stdout))
3922
def sanity_check_merger(self, merger):
3923
if (merger.show_base and
3924
not merger.merge_type is _mod_merge.Merge3Merger):
3925
raise errors.BzrCommandError("Show-base is not supported for this"
3926
" merge type. %s" % merger.merge_type)
3927
if merger.reprocess is None:
3928
if merger.show_base:
3929
merger.reprocess = False
3931
# Use reprocess if the merger supports it
3932
merger.reprocess = merger.merge_type.supports_reprocess
3933
if merger.reprocess and not merger.merge_type.supports_reprocess:
3934
raise errors.BzrCommandError("Conflict reduction is not supported"
3935
" for merge type %s." %
3937
if merger.reprocess and merger.show_base:
3938
raise errors.BzrCommandError("Cannot do conflict reduction and"
3941
def _get_merger_from_branch(self, tree, location, revision, remember,
3942
possible_transports, pb):
3943
"""Produce a merger from a location, assuming it refers to a branch."""
3944
from bzrlib.tag import _merge_tags_if_possible
3945
# find the branch locations
3946
other_loc, user_location = self._select_branch_location(tree, location,
3948
if revision is not None and len(revision) == 2:
3949
base_loc, _unused = self._select_branch_location(tree,
3950
location, revision, 0)
3952
base_loc = other_loc
3954
other_branch, other_path = Branch.open_containing(other_loc,
3955
possible_transports)
3956
if base_loc == other_loc:
3957
base_branch = other_branch
3959
base_branch, base_path = Branch.open_containing(base_loc,
3960
possible_transports)
3961
# Find the revision ids
3962
other_revision_id = None
3963
base_revision_id = None
3964
if revision is not None:
3965
if len(revision) >= 1:
3966
other_revision_id = revision[-1].as_revision_id(other_branch)
3967
if len(revision) == 2:
3968
base_revision_id = revision[0].as_revision_id(base_branch)
3969
if other_revision_id is None:
3970
other_revision_id = _mod_revision.ensure_null(
3971
other_branch.last_revision())
3972
# Remember where we merge from
3973
if ((remember or tree.branch.get_submit_branch() is None) and
3974
user_location is not None):
3975
tree.branch.set_submit_branch(other_branch.base)
3976
_merge_tags_if_possible(other_branch, tree.branch)
3977
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3978
other_revision_id, base_revision_id, other_branch, base_branch)
3979
if other_path != '':
3980
allow_pending = False
3981
merger.interesting_files = [other_path]
3983
allow_pending = True
3984
return merger, allow_pending
3986
def get_merger_from_uncommitted(self, tree, location, pb):
3987
"""Get a merger for uncommitted changes.
3989
:param tree: The tree the merger should apply to.
3990
:param location: The location containing uncommitted changes.
3991
:param pb: The progress bar to use for showing progress.
3993
location = self._select_branch_location(tree, location)[0]
3994
other_tree, other_path = WorkingTree.open_containing(location)
3995
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3996
if other_path != '':
3997
merger.interesting_files = [other_path]
4000
def _select_branch_location(self, tree, user_location, revision=None,
4002
"""Select a branch location, according to possible inputs.
4004
If provided, branches from ``revision`` are preferred. (Both
4005
``revision`` and ``index`` must be supplied.)
4007
Otherwise, the ``location`` parameter is used. If it is None, then the
4008
``submit`` or ``parent`` location is used, and a note is printed.
4010
:param tree: The working tree to select a branch for merging into
4011
:param location: The location entered by the user
4012
:param revision: The revision parameter to the command
4013
:param index: The index to use for the revision parameter. Negative
4014
indices are permitted.
4015
:return: (selected_location, user_location). The default location
4016
will be the user-entered location.
4018
if (revision is not None and index is not None
4019
and revision[index] is not None):
4020
branch = revision[index].get_branch()
4021
if branch is not None:
4022
return branch, branch
4023
if user_location is None:
4024
location = self._get_remembered(tree, 'Merging from')
4026
location = user_location
4027
return location, user_location
4029
def _get_remembered(self, tree, verb_string):
4030
"""Use tree.branch's parent if none was supplied.
4032
Report if the remembered location was used.
4034
stored_location = tree.branch.get_submit_branch()
4035
stored_location_type = "submit"
4036
if stored_location is None:
4037
stored_location = tree.branch.get_parent()
4038
stored_location_type = "parent"
4039
mutter("%s", stored_location)
4040
if stored_location is None:
4041
raise errors.BzrCommandError("No location specified or remembered")
4042
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4043
note(u"%s remembered %s location %s", verb_string,
4044
stored_location_type, display_url)
4045
return stored_location
4048
class cmd_remerge(Command):
4051
Use this if you want to try a different merge technique while resolving
4052
conflicts. Some merge techniques are better than others, and remerge
4053
lets you try different ones on different files.
4055
The options for remerge have the same meaning and defaults as the ones for
4056
merge. The difference is that remerge can (only) be run when there is a
4057
pending merge, and it lets you specify particular files.
4060
Re-do the merge of all conflicted files, and show the base text in
4061
conflict regions, in addition to the usual THIS and OTHER texts::
4063
bzr remerge --show-base
4065
Re-do the merge of "foobar", using the weave merge algorithm, with
4066
additional processing to reduce the size of conflict regions::
4068
bzr remerge --merge-type weave --reprocess foobar
4070
takes_args = ['file*']
4075
help="Show base revision text in conflicts."),
4078
def run(self, file_list=None, merge_type=None, show_base=False,
4080
from bzrlib.conflicts import restore
4081
if merge_type is None:
4082
merge_type = _mod_merge.Merge3Merger
4083
tree, file_list = tree_files(file_list)
4085
self.add_cleanup(tree.unlock)
4086
parents = tree.get_parent_ids()
4087
if len(parents) != 2:
4088
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4089
" merges. Not cherrypicking or"
4091
repository = tree.branch.repository
4092
interesting_ids = None
4094
conflicts = tree.conflicts()
4095
if file_list is not None:
4096
interesting_ids = set()
4097
for filename in file_list:
4098
file_id = tree.path2id(filename)
4100
raise errors.NotVersionedError(filename)
4101
interesting_ids.add(file_id)
4102
if tree.kind(file_id) != "directory":
4105
for name, ie in tree.inventory.iter_entries(file_id):
4106
interesting_ids.add(ie.file_id)
4107
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4109
# Remerge only supports resolving contents conflicts
4110
allowed_conflicts = ('text conflict', 'contents conflict')
4111
restore_files = [c.path for c in conflicts
4112
if c.typestring in allowed_conflicts]
4113
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4114
tree.set_conflicts(ConflictList(new_conflicts))
4115
if file_list is not None:
4116
restore_files = file_list
4117
for filename in restore_files:
4119
restore(tree.abspath(filename))
4120
except errors.NotConflicted:
4122
# Disable pending merges, because the file texts we are remerging
4123
# have not had those merges performed. If we use the wrong parents
4124
# list, we imply that the working tree text has seen and rejected
4125
# all the changes from the other tree, when in fact those changes
4126
# have not yet been seen.
4127
tree.set_parent_ids(parents[:1])
4129
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4130
merger.interesting_ids = interesting_ids
4131
merger.merge_type = merge_type
4132
merger.show_base = show_base
4133
merger.reprocess = reprocess
4134
conflicts = merger.do_merge()
4136
tree.set_parent_ids(parents)
4143
class cmd_revert(Command):
4144
"""Revert files to a previous revision.
4146
Giving a list of files will revert only those files. Otherwise, all files
4147
will be reverted. If the revision is not specified with '--revision', the
4148
last committed revision is used.
4150
To remove only some changes, without reverting to a prior version, use
4151
merge instead. For example, "merge . --revision -2..-3" will remove the
4152
changes introduced by -2, without affecting the changes introduced by -1.
4153
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4155
By default, any files that have been manually changed will be backed up
4156
first. (Files changed only by merge are not backed up.) Backup files have
4157
'.~#~' appended to their name, where # is a number.
4159
When you provide files, you can use their current pathname or the pathname
4160
from the target revision. So you can use revert to "undelete" a file by
4161
name. If you name a directory, all the contents of that directory will be
4164
If you have newly added files since the target revision, they will be
4165
removed. If the files to be removed have been changed, backups will be
4166
created as above. Directories containing unknown files will not be
4169
The working tree contains a list of revisions that have been merged but
4170
not yet committed. These revisions will be included as additional parents
4171
of the next commit. Normally, using revert clears that list as well as
4172
reverting the files. If any files are specified, revert leaves the list
4173
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4174
.`` in the tree root to revert all files but keep the recorded merges,
4175
and ``bzr revert --forget-merges`` to clear the pending merge list without
4176
reverting any files.
4178
Using "bzr revert --forget-merges", it is possible to apply all of the
4179
changes from a branch in a single revision. To do this, perform the merge
4180
as desired. Then doing revert with the "--forget-merges" option will keep
4181
the content of the tree as it was, but it will clear the list of pending
4182
merges. The next commit will then contain all of the changes that are
4183
present in the other branch, but without any other parent revisions.
4184
Because this technique forgets where these changes originated, it may
4185
cause additional conflicts on later merges involving the same source and
4189
_see_also = ['cat', 'export']
4192
Option('no-backup', "Do not save backups of reverted files."),
4193
Option('forget-merges',
4194
'Remove pending merge marker, without changing any files.'),
4196
takes_args = ['file*']
4198
def run(self, revision=None, no_backup=False, file_list=None,
4199
forget_merges=None):
4200
tree, file_list = tree_files(file_list)
4201
tree.lock_tree_write()
4202
self.add_cleanup(tree.unlock)
4204
tree.set_parent_ids(tree.get_parent_ids()[:1])
4206
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4209
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4210
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4211
tree.revert(file_list, rev_tree, not no_backup, None,
4212
report_changes=True)
4215
class cmd_assert_fail(Command):
4216
"""Test reporting of assertion failures"""
4217
# intended just for use in testing
4222
raise AssertionError("always fails")
4225
class cmd_help(Command):
4226
"""Show help on a command or other topic.
4229
_see_also = ['topics']
4231
Option('long', 'Show help on all commands.'),
4233
takes_args = ['topic?']
4234
aliases = ['?', '--help', '-?', '-h']
4237
def run(self, topic=None, long=False):
4239
if topic is None and long:
4241
bzrlib.help.help(topic)
4244
class cmd_shell_complete(Command):
4245
"""Show appropriate completions for context.
4247
For a list of all available commands, say 'bzr shell-complete'.
4249
takes_args = ['context?']
4254
def run(self, context=None):
4255
import shellcomplete
4256
shellcomplete.shellcomplete(context)
4259
class cmd_missing(Command):
4260
"""Show unmerged/unpulled revisions between two branches.
4262
OTHER_BRANCH may be local or remote.
4264
To filter on a range of revisions, you can use the command -r begin..end
4265
-r revision requests a specific revision, -r ..end or -r begin.. are
4269
1 - some missing revisions
4270
0 - no missing revisions
4274
Determine the missing revisions between this and the branch at the
4275
remembered pull location::
4279
Determine the missing revisions between this and another branch::
4281
bzr missing http://server/branch
4283
Determine the missing revisions up to a specific revision on the other
4286
bzr missing -r ..-10
4288
Determine the missing revisions up to a specific revision on this
4291
bzr missing --my-revision ..-10
4294
_see_also = ['merge', 'pull']
4295
takes_args = ['other_branch?']
4297
Option('reverse', 'Reverse the order of revisions.'),
4299
'Display changes in the local branch only.'),
4300
Option('this' , 'Same as --mine-only.'),
4301
Option('theirs-only',
4302
'Display changes in the remote branch only.'),
4303
Option('other', 'Same as --theirs-only.'),
4307
custom_help('revision',
4308
help='Filter on other branch revisions (inclusive). '
4309
'See "help revisionspec" for details.'),
4310
Option('my-revision',
4311
type=_parse_revision_str,
4312
help='Filter on local branch revisions (inclusive). '
4313
'See "help revisionspec" for details.'),
4314
Option('include-merges',
4315
'Show all revisions in addition to the mainline ones.'),
4317
encoding_type = 'replace'
4320
def run(self, other_branch=None, reverse=False, mine_only=False,
4322
log_format=None, long=False, short=False, line=False,
4323
show_ids=False, verbose=False, this=False, other=False,
4324
include_merges=False, revision=None, my_revision=None):
4325
from bzrlib.missing import find_unmerged, iter_log_revisions
4334
# TODO: We should probably check that we don't have mine-only and
4335
# theirs-only set, but it gets complicated because we also have
4336
# this and other which could be used.
4343
local_branch = Branch.open_containing(u".")[0]
4344
local_branch.lock_read()
4345
self.add_cleanup(local_branch.unlock)
4347
parent = local_branch.get_parent()
4348
if other_branch is None:
4349
other_branch = parent
4350
if other_branch is None:
4351
raise errors.BzrCommandError("No peer location known"
4353
display_url = urlutils.unescape_for_display(parent,
4355
message("Using saved parent location: "
4356
+ display_url + "\n")
4358
remote_branch = Branch.open(other_branch)
4359
if remote_branch.base == local_branch.base:
4360
remote_branch = local_branch
4362
remote_branch.lock_read()
4363
self.add_cleanup(remote_branch.unlock)
4365
local_revid_range = _revision_range_to_revid_range(
4366
_get_revision_range(my_revision, local_branch,
4369
remote_revid_range = _revision_range_to_revid_range(
4370
_get_revision_range(revision,
4371
remote_branch, self.name()))
4373
local_extra, remote_extra = find_unmerged(
4374
local_branch, remote_branch, restrict,
4375
backward=not reverse,
4376
include_merges=include_merges,
4377
local_revid_range=local_revid_range,
4378
remote_revid_range=remote_revid_range)
4380
if log_format is None:
4381
registry = log.log_formatter_registry
4382
log_format = registry.get_default(local_branch)
4383
lf = log_format(to_file=self.outf,
4385
show_timezone='original')
4388
if local_extra and not theirs_only:
4389
message("You have %d extra revision(s):\n" %
4391
for revision in iter_log_revisions(local_extra,
4392
local_branch.repository,
4394
lf.log_revision(revision)
4395
printed_local = True
4398
printed_local = False
4400
if remote_extra and not mine_only:
4401
if printed_local is True:
4403
message("You are missing %d revision(s):\n" %
4405
for revision in iter_log_revisions(remote_extra,
4406
remote_branch.repository,
4408
lf.log_revision(revision)
4411
if mine_only and not local_extra:
4412
# We checked local, and found nothing extra
4413
message('This branch is up to date.\n')
4414
elif theirs_only and not remote_extra:
4415
# We checked remote, and found nothing extra
4416
message('Other branch is up to date.\n')
4417
elif not (mine_only or theirs_only or local_extra or
4419
# We checked both branches, and neither one had extra
4421
message("Branches are up to date.\n")
4423
if not status_code and parent is None and other_branch is not None:
4424
local_branch.lock_write()
4425
self.add_cleanup(local_branch.unlock)
4426
# handle race conditions - a parent might be set while we run.
4427
if local_branch.get_parent() is None:
4428
local_branch.set_parent(remote_branch.base)
4432
class cmd_pack(Command):
4433
"""Compress the data within a repository.
4435
This operation compresses the data within a bazaar repository. As
4436
bazaar supports automatic packing of repository, this operation is
4437
normally not required to be done manually.
4439
During the pack operation, bazaar takes a backup of existing repository
4440
data, i.e. pack files. This backup is eventually removed by bazaar
4441
automatically when it is safe to do so. To save disk space by removing
4442
the backed up pack files, the --clean-obsolete-packs option may be
4445
Warning: If you use --clean-obsolete-packs and your machine crashes
4446
during or immediately after repacking, you may be left with a state
4447
where the deletion has been written to disk but the new packs have not
4448
been. In this case the repository may be unusable.
4451
_see_also = ['repositories']
4452
takes_args = ['branch_or_repo?']
4454
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4457
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4458
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4460
branch = dir.open_branch()
4461
repository = branch.repository
4462
except errors.NotBranchError:
4463
repository = dir.open_repository()
4464
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4467
class cmd_plugins(Command):
4468
"""List the installed plugins.
4470
This command displays the list of installed plugins including
4471
version of plugin and a short description of each.
4473
--verbose shows the path where each plugin is located.
4475
A plugin is an external component for Bazaar that extends the
4476
revision control system, by adding or replacing code in Bazaar.
4477
Plugins can do a variety of things, including overriding commands,
4478
adding new commands, providing additional network transports and
4479
customizing log output.
4481
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4482
for further information on plugins including where to find them and how to
4483
install them. Instructions are also provided there on how to write new
4484
plugins using the Python programming language.
4486
takes_options = ['verbose']
4489
def run(self, verbose=False):
4490
import bzrlib.plugin
4491
from inspect import getdoc
4493
for name, plugin in bzrlib.plugin.plugins().items():
4494
version = plugin.__version__
4495
if version == 'unknown':
4497
name_ver = '%s %s' % (name, version)
4498
d = getdoc(plugin.module)
4500
doc = d.split('\n')[0]
4502
doc = '(no description)'
4503
result.append((name_ver, doc, plugin.path()))
4504
for name_ver, doc, path in sorted(result):
4505
self.outf.write("%s\n" % name_ver)
4506
self.outf.write(" %s\n" % doc)
4508
self.outf.write(" %s\n" % path)
4509
self.outf.write("\n")
4512
class cmd_testament(Command):
4513
"""Show testament (signing-form) of a revision."""
4516
Option('long', help='Produce long-format testament.'),
4518
help='Produce a strict-format testament.')]
4519
takes_args = ['branch?']
4521
def run(self, branch=u'.', revision=None, long=False, strict=False):
4522
from bzrlib.testament import Testament, StrictTestament
4524
testament_class = StrictTestament
4526
testament_class = Testament
4528
b = Branch.open_containing(branch)[0]
4530
b = Branch.open(branch)
4532
self.add_cleanup(b.unlock)
4533
if revision is None:
4534
rev_id = b.last_revision()
4536
rev_id = revision[0].as_revision_id(b)
4537
t = testament_class.from_revision(b.repository, rev_id)
4539
sys.stdout.writelines(t.as_text_lines())
4541
sys.stdout.write(t.as_short_text())
4544
class cmd_annotate(Command):
4545
"""Show the origin of each line in a file.
4547
This prints out the given file with an annotation on the left side
4548
indicating which revision, author and date introduced the change.
4550
If the origin is the same for a run of consecutive lines, it is
4551
shown only at the top, unless the --all option is given.
4553
# TODO: annotate directories; showing when each file was last changed
4554
# TODO: if the working copy is modified, show annotations on that
4555
# with new uncommitted lines marked
4556
aliases = ['ann', 'blame', 'praise']
4557
takes_args = ['filename']
4558
takes_options = [Option('all', help='Show annotations on all lines.'),
4559
Option('long', help='Show commit date in annotations.'),
4563
encoding_type = 'exact'
4566
def run(self, filename, all=False, long=False, revision=None,
4568
from bzrlib.annotate import annotate_file, annotate_file_tree
4569
wt, branch, relpath = \
4570
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4573
self.add_cleanup(wt.unlock)
4576
self.add_cleanup(branch.unlock)
4577
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4579
self.add_cleanup(tree.unlock)
4581
file_id = wt.path2id(relpath)
4583
file_id = tree.path2id(relpath)
4585
raise errors.NotVersionedError(filename)
4586
file_version = tree.inventory[file_id].revision
4587
if wt is not None and revision is None:
4588
# If there is a tree and we're not annotating historical
4589
# versions, annotate the working tree's content.
4590
annotate_file_tree(wt, file_id, self.outf, long, all,
4593
annotate_file(branch, file_version, file_id, long, all, self.outf,
4597
class cmd_re_sign(Command):
4598
"""Create a digital signature for an existing revision."""
4599
# TODO be able to replace existing ones.
4601
hidden = True # is this right ?
4602
takes_args = ['revision_id*']
4603
takes_options = ['revision']
4605
def run(self, revision_id_list=None, revision=None):
4606
if revision_id_list is not None and revision is not None:
4607
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4608
if revision_id_list is None and revision is None:
4609
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4610
b = WorkingTree.open_containing(u'.')[0].branch
4612
self.add_cleanup(b.unlock)
4613
return self._run(b, revision_id_list, revision)
4615
def _run(self, b, revision_id_list, revision):
4616
import bzrlib.gpg as gpg
4617
gpg_strategy = gpg.GPGStrategy(b.get_config())
4618
if revision_id_list is not None:
4619
b.repository.start_write_group()
4621
for revision_id in revision_id_list:
4622
b.repository.sign_revision(revision_id, gpg_strategy)
4624
b.repository.abort_write_group()
4627
b.repository.commit_write_group()
4628
elif revision is not None:
4629
if len(revision) == 1:
4630
revno, rev_id = revision[0].in_history(b)
4631
b.repository.start_write_group()
4633
b.repository.sign_revision(rev_id, gpg_strategy)
4635
b.repository.abort_write_group()
4638
b.repository.commit_write_group()
4639
elif len(revision) == 2:
4640
# are they both on rh- if so we can walk between them
4641
# might be nice to have a range helper for arbitrary
4642
# revision paths. hmm.
4643
from_revno, from_revid = revision[0].in_history(b)
4644
to_revno, to_revid = revision[1].in_history(b)
4645
if to_revid is None:
4646
to_revno = b.revno()
4647
if from_revno is None or to_revno is None:
4648
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4649
b.repository.start_write_group()
4651
for revno in range(from_revno, to_revno + 1):
4652
b.repository.sign_revision(b.get_rev_id(revno),
4655
b.repository.abort_write_group()
4658
b.repository.commit_write_group()
4660
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4663
class cmd_bind(Command):
4664
"""Convert the current branch into a checkout of the supplied branch.
4666
Once converted into a checkout, commits must succeed on the master branch
4667
before they will be applied to the local branch.
4669
Bound branches use the nickname of its master branch unless it is set
4670
locally, in which case binding will update the local nickname to be
4674
_see_also = ['checkouts', 'unbind']
4675
takes_args = ['location?']
4678
def run(self, location=None):
4679
b, relpath = Branch.open_containing(u'.')
4680
if location is None:
4682
location = b.get_old_bound_location()
4683
except errors.UpgradeRequired:
4684
raise errors.BzrCommandError('No location supplied. '
4685
'This format does not remember old locations.')
4687
if location is None:
4688
if b.get_bound_location() is not None:
4689
raise errors.BzrCommandError('Branch is already bound')
4691
raise errors.BzrCommandError('No location supplied '
4692
'and no previous location known')
4693
b_other = Branch.open(location)
4696
except errors.DivergedBranches:
4697
raise errors.BzrCommandError('These branches have diverged.'
4698
' Try merging, and then bind again.')
4699
if b.get_config().has_explicit_nickname():
4700
b.nick = b_other.nick
4703
class cmd_unbind(Command):
4704
"""Convert the current checkout into a regular branch.
4706
After unbinding, the local branch is considered independent and subsequent
4707
commits will be local only.
4710
_see_also = ['checkouts', 'bind']
4715
b, relpath = Branch.open_containing(u'.')
4717
raise errors.BzrCommandError('Local branch is not bound')
4720
class cmd_uncommit(Command):
4721
"""Remove the last committed revision.
4723
--verbose will print out what is being removed.
4724
--dry-run will go through all the motions, but not actually
4727
If --revision is specified, uncommit revisions to leave the branch at the
4728
specified revision. For example, "bzr uncommit -r 15" will leave the
4729
branch at revision 15.
4731
Uncommit leaves the working tree ready for a new commit. The only change
4732
it may make is to restore any pending merges that were present before
4736
# TODO: jam 20060108 Add an option to allow uncommit to remove
4737
# unreferenced information in 'branch-as-repository' branches.
4738
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4739
# information in shared branches as well.
4740
_see_also = ['commit']
4741
takes_options = ['verbose', 'revision',
4742
Option('dry-run', help='Don\'t actually make changes.'),
4743
Option('force', help='Say yes to all questions.'),
4745
help="Only remove the commits from the local branch"
4746
" when in a checkout."
4749
takes_args = ['location?']
4751
encoding_type = 'replace'
4753
def run(self, location=None,
4754
dry_run=False, verbose=False,
4755
revision=None, force=False, local=False):
4756
if location is None:
4758
control, relpath = bzrdir.BzrDir.open_containing(location)
4760
tree = control.open_workingtree()
4762
except (errors.NoWorkingTree, errors.NotLocalUrl):
4764
b = control.open_branch()
4766
if tree is not None:
4768
self.add_cleanup(tree.unlock)
4771
self.add_cleanup(b.unlock)
4772
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4774
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4775
from bzrlib.log import log_formatter, show_log
4776
from bzrlib.uncommit import uncommit
4778
last_revno, last_rev_id = b.last_revision_info()
4781
if revision is None:
4783
rev_id = last_rev_id
4785
# 'bzr uncommit -r 10' actually means uncommit
4786
# so that the final tree is at revno 10.
4787
# but bzrlib.uncommit.uncommit() actually uncommits
4788
# the revisions that are supplied.
4789
# So we need to offset it by one
4790
revno = revision[0].in_history(b).revno + 1
4791
if revno <= last_revno:
4792
rev_id = b.get_rev_id(revno)
4794
if rev_id is None or _mod_revision.is_null(rev_id):
4795
self.outf.write('No revisions to uncommit.\n')
4798
lf = log_formatter('short',
4800
show_timezone='original')
4805
direction='forward',
4806
start_revision=revno,
4807
end_revision=last_revno)
4810
self.outf.write('Dry-run, pretending to remove'
4811
' the above revisions.\n')
4813
self.outf.write('The above revision(s) will be removed.\n')
4816
if not ui.ui_factory.get_boolean('Are you sure'):
4817
self.outf.write('Canceled')
4820
mutter('Uncommitting from {%s} to {%s}',
4821
last_rev_id, rev_id)
4822
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4823
revno=revno, local=local)
4824
self.outf.write('You can restore the old tip by running:\n'
4825
' bzr pull . -r revid:%s\n' % last_rev_id)
4828
class cmd_break_lock(Command):
4829
"""Break a dead lock on a repository, branch or working directory.
4831
CAUTION: Locks should only be broken when you are sure that the process
4832
holding the lock has been stopped.
4834
You can get information on what locks are open via the 'bzr info
4835
[location]' command.
4839
bzr break-lock bzr+ssh://example.com/bzr/foo
4841
takes_args = ['location?']
4843
def run(self, location=None, show=False):
4844
if location is None:
4846
control, relpath = bzrdir.BzrDir.open_containing(location)
4848
control.break_lock()
4849
except NotImplementedError:
4853
class cmd_wait_until_signalled(Command):
4854
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4856
This just prints a line to signal when it is ready, then blocks on stdin.
4862
sys.stdout.write("running\n")
4864
sys.stdin.readline()
4867
class cmd_serve(Command):
4868
"""Run the bzr server."""
4870
aliases = ['server']
4874
help='Serve on stdin/out for use from inetd or sshd.'),
4875
RegistryOption('protocol',
4876
help="Protocol to serve.",
4877
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4878
value_switches=True),
4880
help='Listen for connections on nominated port of the form '
4881
'[hostname:]portnumber. Passing 0 as the port number will '
4882
'result in a dynamically allocated port. The default port '
4883
'depends on the protocol.',
4886
help='Serve contents of this directory.',
4888
Option('allow-writes',
4889
help='By default the server is a readonly server. Supplying '
4890
'--allow-writes enables write access to the contents of '
4891
'the served directory and below. Note that ``bzr serve`` '
4892
'does not perform authentication, so unless some form of '
4893
'external authentication is arranged supplying this '
4894
'option leads to global uncontrolled write access to your '
4899
def get_host_and_port(self, port):
4900
"""Return the host and port to run the smart server on.
4902
If 'port' is None, None will be returned for the host and port.
4904
If 'port' has a colon in it, the string before the colon will be
4905
interpreted as the host.
4907
:param port: A string of the port to run the server on.
4908
:return: A tuple of (host, port), where 'host' is a host name or IP,
4909
and port is an integer TCP/IP port.
4912
if port is not None:
4914
host, port = port.split(':')
4918
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4920
from bzrlib.transport import get_transport, transport_server_registry
4921
if directory is None:
4922
directory = os.getcwd()
4923
if protocol is None:
4924
protocol = transport_server_registry.get()
4925
host, port = self.get_host_and_port(port)
4926
url = urlutils.local_path_to_url(directory)
4927
if not allow_writes:
4928
url = 'readonly+' + url
4929
transport = get_transport(url)
4930
protocol(transport, host, port, inet)
4933
class cmd_join(Command):
4934
"""Combine a tree into its containing tree.
4936
This command requires the target tree to be in a rich-root format.
4938
The TREE argument should be an independent tree, inside another tree, but
4939
not part of it. (Such trees can be produced by "bzr split", but also by
4940
running "bzr branch" with the target inside a tree.)
4942
The result is a combined tree, with the subtree no longer an independant
4943
part. This is marked as a merge of the subtree into the containing tree,
4944
and all history is preserved.
4947
_see_also = ['split']
4948
takes_args = ['tree']
4950
Option('reference', help='Join by reference.', hidden=True),
4953
def run(self, tree, reference=False):
4954
sub_tree = WorkingTree.open(tree)
4955
parent_dir = osutils.dirname(sub_tree.basedir)
4956
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4957
repo = containing_tree.branch.repository
4958
if not repo.supports_rich_root():
4959
raise errors.BzrCommandError(
4960
"Can't join trees because %s doesn't support rich root data.\n"
4961
"You can use bzr upgrade on the repository."
4965
containing_tree.add_reference(sub_tree)
4966
except errors.BadReferenceTarget, e:
4967
# XXX: Would be better to just raise a nicely printable
4968
# exception from the real origin. Also below. mbp 20070306
4969
raise errors.BzrCommandError("Cannot join %s. %s" %
4973
containing_tree.subsume(sub_tree)
4974
except errors.BadSubsumeSource, e:
4975
raise errors.BzrCommandError("Cannot join %s. %s" %
4979
class cmd_split(Command):
4980
"""Split a subdirectory of a tree into a separate tree.
4982
This command will produce a target tree in a format that supports
4983
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4984
converted into earlier formats like 'dirstate-tags'.
4986
The TREE argument should be a subdirectory of a working tree. That
4987
subdirectory will be converted into an independent tree, with its own
4988
branch. Commits in the top-level tree will not apply to the new subtree.
4991
_see_also = ['join']
4992
takes_args = ['tree']
4994
def run(self, tree):
4995
containing_tree, subdir = WorkingTree.open_containing(tree)
4996
sub_id = containing_tree.path2id(subdir)
4998
raise errors.NotVersionedError(subdir)
5000
containing_tree.extract(sub_id)
5001
except errors.RootNotRich:
5002
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5005
class cmd_merge_directive(Command):
5006
"""Generate a merge directive for auto-merge tools.
5008
A directive requests a merge to be performed, and also provides all the
5009
information necessary to do so. This means it must either include a
5010
revision bundle, or the location of a branch containing the desired
5013
A submit branch (the location to merge into) must be supplied the first
5014
time the command is issued. After it has been supplied once, it will
5015
be remembered as the default.
5017
A public branch is optional if a revision bundle is supplied, but required
5018
if --diff or --plain is specified. It will be remembered as the default
5019
after the first use.
5022
takes_args = ['submit_branch?', 'public_branch?']
5026
_see_also = ['send']
5029
RegistryOption.from_kwargs('patch-type',
5030
'The type of patch to include in the directive.',
5032
value_switches=True,
5034
bundle='Bazaar revision bundle (default).',
5035
diff='Normal unified diff.',
5036
plain='No patch, just directive.'),
5037
Option('sign', help='GPG-sign the directive.'), 'revision',
5038
Option('mail-to', type=str,
5039
help='Instead of printing the directive, email to this address.'),
5040
Option('message', type=str, short_name='m',
5041
help='Message to use when committing this merge.')
5044
encoding_type = 'exact'
5046
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5047
sign=False, revision=None, mail_to=None, message=None):
5048
from bzrlib.revision import ensure_null, NULL_REVISION
5049
include_patch, include_bundle = {
5050
'plain': (False, False),
5051
'diff': (True, False),
5052
'bundle': (True, True),
5054
branch = Branch.open('.')
5055
stored_submit_branch = branch.get_submit_branch()
5056
if submit_branch is None:
5057
submit_branch = stored_submit_branch
5059
if stored_submit_branch is None:
5060
branch.set_submit_branch(submit_branch)
5061
if submit_branch is None:
5062
submit_branch = branch.get_parent()
5063
if submit_branch is None:
5064
raise errors.BzrCommandError('No submit branch specified or known')
5066
stored_public_branch = branch.get_public_branch()
5067
if public_branch is None:
5068
public_branch = stored_public_branch
5069
elif stored_public_branch is None:
5070
branch.set_public_branch(public_branch)
5071
if not include_bundle and public_branch is None:
5072
raise errors.BzrCommandError('No public branch specified or'
5074
base_revision_id = None
5075
if revision is not None:
5076
if len(revision) > 2:
5077
raise errors.BzrCommandError('bzr merge-directive takes '
5078
'at most two one revision identifiers')
5079
revision_id = revision[-1].as_revision_id(branch)
5080
if len(revision) == 2:
5081
base_revision_id = revision[0].as_revision_id(branch)
5083
revision_id = branch.last_revision()
5084
revision_id = ensure_null(revision_id)
5085
if revision_id == NULL_REVISION:
5086
raise errors.BzrCommandError('No revisions to bundle.')
5087
directive = merge_directive.MergeDirective2.from_objects(
5088
branch.repository, revision_id, time.time(),
5089
osutils.local_time_offset(), submit_branch,
5090
public_branch=public_branch, include_patch=include_patch,
5091
include_bundle=include_bundle, message=message,
5092
base_revision_id=base_revision_id)
5095
self.outf.write(directive.to_signed(branch))
5097
self.outf.writelines(directive.to_lines())
5099
message = directive.to_email(mail_to, branch, sign)
5100
s = SMTPConnection(branch.get_config())
5101
s.send_email(message)
5104
class cmd_send(Command):
5105
"""Mail or create a merge-directive for submitting changes.
5107
A merge directive provides many things needed for requesting merges:
5109
* A machine-readable description of the merge to perform
5111
* An optional patch that is a preview of the changes requested
5113
* An optional bundle of revision data, so that the changes can be applied
5114
directly from the merge directive, without retrieving data from a
5117
`bzr send` creates a compact data set that, when applied using bzr
5118
merge, has the same effect as merging from the source branch.
5120
By default the merge directive is self-contained and can be applied to any
5121
branch containing submit_branch in its ancestory without needing access to
5124
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5125
revisions, but only a structured request to merge from the
5126
public_location. In that case the public_branch is needed and it must be
5127
up-to-date and accessible to the recipient. The public_branch is always
5128
included if known, so that people can check it later.
5130
The submit branch defaults to the parent of the source branch, but can be
5131
overridden. Both submit branch and public branch will be remembered in
5132
branch.conf the first time they are used for a particular branch. The
5133
source branch defaults to that containing the working directory, but can
5134
be changed using --from.
5136
In order to calculate those changes, bzr must analyse the submit branch.
5137
Therefore it is most efficient for the submit branch to be a local mirror.
5138
If a public location is known for the submit_branch, that location is used
5139
in the merge directive.
5141
The default behaviour is to send the merge directive by mail, unless -o is
5142
given, in which case it is sent to a file.
5144
Mail is sent using your preferred mail program. This should be transparent
5145
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5146
If the preferred client can't be found (or used), your editor will be used.
5148
To use a specific mail program, set the mail_client configuration option.
5149
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5150
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5151
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5152
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5155
If mail is being sent, a to address is required. This can be supplied
5156
either on the commandline, by setting the submit_to configuration
5157
option in the branch itself or the child_submit_to configuration option
5158
in the submit branch.
5160
Two formats are currently supported: "4" uses revision bundle format 4 and
5161
merge directive format 2. It is significantly faster and smaller than
5162
older formats. It is compatible with Bazaar 0.19 and later. It is the
5163
default. "0.9" uses revision bundle format 0.9 and merge directive
5164
format 1. It is compatible with Bazaar 0.12 - 0.18.
5166
The merge directives created by bzr send may be applied using bzr merge or
5167
bzr pull by specifying a file containing a merge directive as the location.
5169
bzr send makes extensive use of public locations to map local locations into
5170
URLs that can be used by other people. See `bzr help configuration` to
5171
set them, and use `bzr info` to display them.
5174
encoding_type = 'exact'
5176
_see_also = ['merge', 'pull']
5178
takes_args = ['submit_branch?', 'public_branch?']
5182
help='Do not include a bundle in the merge directive.'),
5183
Option('no-patch', help='Do not include a preview patch in the merge'
5186
help='Remember submit and public branch.'),
5188
help='Branch to generate the submission from, '
5189
'rather than the one containing the working directory.',
5192
Option('output', short_name='o',
5193
help='Write merge directive to this file or directory; '
5194
'use - for stdout.',
5197
help='Refuse to send if there are uncommitted changes in'
5198
' the working tree, --no-strict disables the check.'),
5199
Option('mail-to', help='Mail the request to this address.',
5203
Option('body', help='Body for the email.', type=unicode),
5204
RegistryOption('format',
5205
help='Use the specified output format.',
5206
lazy_registry=('bzrlib.send', 'format_registry')),
5209
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5210
no_patch=False, revision=None, remember=False, output=None,
5211
format=None, mail_to=None, message=None, body=None,
5212
strict=None, **kwargs):
5213
from bzrlib.send import send
5214
return send(submit_branch, revision, public_branch, remember,
5215
format, no_bundle, no_patch, output,
5216
kwargs.get('from', '.'), mail_to, message, body,
5221
class cmd_bundle_revisions(cmd_send):
5222
"""Create a merge-directive for submitting changes.
5224
A merge directive provides many things needed for requesting merges:
5226
* A machine-readable description of the merge to perform
5228
* An optional patch that is a preview of the changes requested
5230
* An optional bundle of revision data, so that the changes can be applied
5231
directly from the merge directive, without retrieving data from a
5234
If --no-bundle is specified, then public_branch is needed (and must be
5235
up-to-date), so that the receiver can perform the merge using the
5236
public_branch. The public_branch is always included if known, so that
5237
people can check it later.
5239
The submit branch defaults to the parent, but can be overridden. Both
5240
submit branch and public branch will be remembered if supplied.
5242
If a public_branch is known for the submit_branch, that public submit
5243
branch is used in the merge instructions. This means that a local mirror
5244
can be used as your actual submit branch, once you have set public_branch
5247
Two formats are currently supported: "4" uses revision bundle format 4 and
5248
merge directive format 2. It is significantly faster and smaller than
5249
older formats. It is compatible with Bazaar 0.19 and later. It is the
5250
default. "0.9" uses revision bundle format 0.9 and merge directive
5251
format 1. It is compatible with Bazaar 0.12 - 0.18.
5256
help='Do not include a bundle in the merge directive.'),
5257
Option('no-patch', help='Do not include a preview patch in the merge'
5260
help='Remember submit and public branch.'),
5262
help='Branch to generate the submission from, '
5263
'rather than the one containing the working directory.',
5266
Option('output', short_name='o', help='Write directive to this file.',
5269
help='Refuse to bundle revisions if there are uncommitted'
5270
' changes in the working tree, --no-strict disables the check.'),
5272
RegistryOption('format',
5273
help='Use the specified output format.',
5274
lazy_registry=('bzrlib.send', 'format_registry')),
5276
aliases = ['bundle']
5278
_see_also = ['send', 'merge']
5282
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5283
no_patch=False, revision=None, remember=False, output=None,
5284
format=None, strict=None, **kwargs):
5287
from bzrlib.send import send
5288
return send(submit_branch, revision, public_branch, remember,
5289
format, no_bundle, no_patch, output,
5290
kwargs.get('from', '.'), None, None, None,
5291
self.outf, strict=strict)
5294
class cmd_tag(Command):
5295
"""Create, remove or modify a tag naming a revision.
5297
Tags give human-meaningful names to revisions. Commands that take a -r
5298
(--revision) option can be given -rtag:X, where X is any previously
5301
Tags are stored in the branch. Tags are copied from one branch to another
5302
along when you branch, push, pull or merge.
5304
It is an error to give a tag name that already exists unless you pass
5305
--force, in which case the tag is moved to point to the new revision.
5307
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5308
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5310
If no tag name is specified it will be determined through the
5311
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5312
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5316
_see_also = ['commit', 'tags']
5317
takes_args = ['tag_name?']
5320
help='Delete this tag rather than placing it.',
5323
help='Branch in which to place the tag.',
5328
help='Replace existing tags.',
5333
def run(self, tag_name=None,
5339
branch, relpath = Branch.open_containing(directory)
5341
self.add_cleanup(branch.unlock)
5343
if tag_name is None:
5344
raise errors.BzrCommandError("No tag specified to delete.")
5345
branch.tags.delete_tag(tag_name)
5346
self.outf.write('Deleted tag %s.\n' % tag_name)
5349
if len(revision) != 1:
5350
raise errors.BzrCommandError(
5351
"Tags can only be placed on a single revision, "
5353
revision_id = revision[0].as_revision_id(branch)
5355
revision_id = branch.last_revision()
5356
if tag_name is None:
5357
tag_name = branch.automatic_tag_name(revision_id)
5358
if tag_name is None:
5359
raise errors.BzrCommandError(
5360
"Please specify a tag name.")
5361
if (not force) and branch.tags.has_tag(tag_name):
5362
raise errors.TagAlreadyExists(tag_name)
5363
branch.tags.set_tag(tag_name, revision_id)
5364
self.outf.write('Created tag %s.\n' % tag_name)
5367
class cmd_tags(Command):
5370
This command shows a table of tag names and the revisions they reference.
5376
help='Branch whose tags should be displayed.',
5380
RegistryOption.from_kwargs('sort',
5381
'Sort tags by different criteria.', title='Sorting',
5382
alpha='Sort tags lexicographically (default).',
5383
time='Sort tags chronologically.',
5396
branch, relpath = Branch.open_containing(directory)
5398
tags = branch.tags.get_tag_dict().items()
5403
self.add_cleanup(branch.unlock)
5405
graph = branch.repository.get_graph()
5406
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5407
revid1, revid2 = rev1.rev_id, rev2.rev_id
5408
# only show revisions between revid1 and revid2 (inclusive)
5409
tags = [(tag, revid) for tag, revid in tags if
5410
graph.is_between(revid, revid1, revid2)]
5413
elif sort == 'time':
5415
for tag, revid in tags:
5417
revobj = branch.repository.get_revision(revid)
5418
except errors.NoSuchRevision:
5419
timestamp = sys.maxint # place them at the end
5421
timestamp = revobj.timestamp
5422
timestamps[revid] = timestamp
5423
tags.sort(key=lambda x: timestamps[x[1]])
5425
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5426
for index, (tag, revid) in enumerate(tags):
5428
revno = branch.revision_id_to_dotted_revno(revid)
5429
if isinstance(revno, tuple):
5430
revno = '.'.join(map(str, revno))
5431
except errors.NoSuchRevision:
5432
# Bad tag data/merges can lead to tagged revisions
5433
# which are not in this branch. Fail gracefully ...
5435
tags[index] = (tag, revno)
5437
for tag, revspec in tags:
5438
self.outf.write('%-20s %s\n' % (tag, revspec))
5441
class cmd_reconfigure(Command):
5442
"""Reconfigure the type of a bzr directory.
5444
A target configuration must be specified.
5446
For checkouts, the bind-to location will be auto-detected if not specified.
5447
The order of preference is
5448
1. For a lightweight checkout, the current bound location.
5449
2. For branches that used to be checkouts, the previously-bound location.
5450
3. The push location.
5451
4. The parent location.
5452
If none of these is available, --bind-to must be specified.
5455
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5456
takes_args = ['location?']
5458
RegistryOption.from_kwargs(
5460
title='Target type',
5461
help='The type to reconfigure the directory to.',
5462
value_switches=True, enum_switch=False,
5463
branch='Reconfigure to be an unbound branch with no working tree.',
5464
tree='Reconfigure to be an unbound branch with a working tree.',
5465
checkout='Reconfigure to be a bound branch with a working tree.',
5466
lightweight_checkout='Reconfigure to be a lightweight'
5467
' checkout (with no local history).',
5468
standalone='Reconfigure to be a standalone branch '
5469
'(i.e. stop using shared repository).',
5470
use_shared='Reconfigure to use a shared repository.',
5471
with_trees='Reconfigure repository to create '
5472
'working trees on branches by default.',
5473
with_no_trees='Reconfigure repository to not create '
5474
'working trees on branches by default.'
5476
Option('bind-to', help='Branch to bind checkout to.', type=str),
5478
help='Perform reconfiguration even if local changes'
5480
Option('stacked-on',
5481
help='Reconfigure a branch to be stacked on another branch.',
5485
help='Reconfigure a branch to be unstacked. This '
5486
'may require copying substantial data into it.',
5490
def run(self, location=None, target_type=None, bind_to=None, force=False,
5493
directory = bzrdir.BzrDir.open(location)
5494
if stacked_on and unstacked:
5495
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5496
elif stacked_on is not None:
5497
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5499
reconfigure.ReconfigureUnstacked().apply(directory)
5500
# At the moment you can use --stacked-on and a different
5501
# reconfiguration shape at the same time; there seems no good reason
5503
if target_type is None:
5504
if stacked_on or unstacked:
5507
raise errors.BzrCommandError('No target configuration '
5509
elif target_type == 'branch':
5510
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5511
elif target_type == 'tree':
5512
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5513
elif target_type == 'checkout':
5514
reconfiguration = reconfigure.Reconfigure.to_checkout(
5516
elif target_type == 'lightweight-checkout':
5517
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5519
elif target_type == 'use-shared':
5520
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5521
elif target_type == 'standalone':
5522
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5523
elif target_type == 'with-trees':
5524
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5526
elif target_type == 'with-no-trees':
5527
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5529
reconfiguration.apply(force)
5532
class cmd_switch(Command):
5533
"""Set the branch of a checkout and update.
5535
For lightweight checkouts, this changes the branch being referenced.
5536
For heavyweight checkouts, this checks that there are no local commits
5537
versus the current bound branch, then it makes the local branch a mirror
5538
of the new location and binds to it.
5540
In both cases, the working tree is updated and uncommitted changes
5541
are merged. The user can commit or revert these as they desire.
5543
Pending merges need to be committed or reverted before using switch.
5545
The path to the branch to switch to can be specified relative to the parent
5546
directory of the current branch. For example, if you are currently in a
5547
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5550
Bound branches use the nickname of its master branch unless it is set
5551
locally, in which case switching will update the local nickname to be
5555
takes_args = ['to_location?']
5556
takes_options = [Option('force',
5557
help='Switch even if local commits will be lost.'),
5559
Option('create-branch', short_name='b',
5560
help='Create the target branch from this one before'
5561
' switching to it.'),
5564
def run(self, to_location=None, force=False, create_branch=False,
5566
from bzrlib import switch
5568
revision = _get_one_revision('switch', revision)
5569
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5570
if to_location is None:
5571
if revision is None:
5572
raise errors.BzrCommandError('You must supply either a'
5573
' revision or a location')
5576
branch = control_dir.open_branch()
5577
had_explicit_nick = branch.get_config().has_explicit_nickname()
5578
except errors.NotBranchError:
5580
had_explicit_nick = False
5583
raise errors.BzrCommandError('cannot create branch without'
5585
to_location = directory_service.directories.dereference(
5587
if '/' not in to_location and '\\' not in to_location:
5588
# This path is meant to be relative to the existing branch
5589
this_url = self._get_branch_location(control_dir)
5590
to_location = urlutils.join(this_url, '..', to_location)
5591
to_branch = branch.bzrdir.sprout(to_location,
5592
possible_transports=[branch.bzrdir.root_transport],
5593
source_branch=branch).open_branch()
5596
to_branch = Branch.open(to_location)
5597
except errors.NotBranchError:
5598
this_url = self._get_branch_location(control_dir)
5599
to_branch = Branch.open(
5600
urlutils.join(this_url, '..', to_location))
5601
if revision is not None:
5602
revision = revision.as_revision_id(to_branch)
5603
switch.switch(control_dir, to_branch, force, revision_id=revision)
5604
if had_explicit_nick:
5605
branch = control_dir.open_branch() #get the new branch!
5606
branch.nick = to_branch.nick
5607
note('Switched to branch: %s',
5608
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5610
def _get_branch_location(self, control_dir):
5611
"""Return location of branch for this control dir."""
5613
this_branch = control_dir.open_branch()
5614
# This may be a heavy checkout, where we want the master branch
5615
master_location = this_branch.get_bound_location()
5616
if master_location is not None:
5617
return master_location
5618
# If not, use a local sibling
5619
return this_branch.base
5620
except errors.NotBranchError:
5621
format = control_dir.find_branch_format()
5622
if getattr(format, 'get_reference', None) is not None:
5623
return format.get_reference(control_dir)
5625
return control_dir.root_transport.base
5628
class cmd_view(Command):
5629
"""Manage filtered views.
5631
Views provide a mask over the tree so that users can focus on
5632
a subset of a tree when doing their work. After creating a view,
5633
commands that support a list of files - status, diff, commit, etc -
5634
effectively have that list of files implicitly given each time.
5635
An explicit list of files can still be given but those files
5636
must be within the current view.
5638
In most cases, a view has a short life-span: it is created to make
5639
a selected change and is deleted once that change is committed.
5640
At other times, you may wish to create one or more named views
5641
and switch between them.
5643
To disable the current view without deleting it, you can switch to
5644
the pseudo view called ``off``. This can be useful when you need
5645
to see the whole tree for an operation or two (e.g. merge) but
5646
want to switch back to your view after that.
5649
To define the current view::
5651
bzr view file1 dir1 ...
5653
To list the current view::
5657
To delete the current view::
5661
To disable the current view without deleting it::
5663
bzr view --switch off
5665
To define a named view and switch to it::
5667
bzr view --name view-name file1 dir1 ...
5669
To list a named view::
5671
bzr view --name view-name
5673
To delete a named view::
5675
bzr view --name view-name --delete
5677
To switch to a named view::
5679
bzr view --switch view-name
5681
To list all views defined::
5685
To delete all views::
5687
bzr view --delete --all
5691
takes_args = ['file*']
5694
help='Apply list or delete action to all views.',
5697
help='Delete the view.',
5700
help='Name of the view to define, list or delete.',
5704
help='Name of the view to switch to.',
5709
def run(self, file_list,
5715
tree, file_list = tree_files(file_list, apply_view=False)
5716
current_view, view_dict = tree.views.get_view_info()
5721
raise errors.BzrCommandError(
5722
"Both --delete and a file list specified")
5724
raise errors.BzrCommandError(
5725
"Both --delete and --switch specified")
5727
tree.views.set_view_info(None, {})
5728
self.outf.write("Deleted all views.\n")
5730
raise errors.BzrCommandError("No current view to delete")
5732
tree.views.delete_view(name)
5733
self.outf.write("Deleted '%s' view.\n" % name)
5736
raise errors.BzrCommandError(
5737
"Both --switch and a file list specified")
5739
raise errors.BzrCommandError(
5740
"Both --switch and --all specified")
5741
elif switch == 'off':
5742
if current_view is None:
5743
raise errors.BzrCommandError("No current view to disable")
5744
tree.views.set_view_info(None, view_dict)
5745
self.outf.write("Disabled '%s' view.\n" % (current_view))
5747
tree.views.set_view_info(switch, view_dict)
5748
view_str = views.view_display_str(tree.views.lookup_view())
5749
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5752
self.outf.write('Views defined:\n')
5753
for view in sorted(view_dict):
5754
if view == current_view:
5758
view_str = views.view_display_str(view_dict[view])
5759
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5761
self.outf.write('No views defined.\n')
5764
# No name given and no current view set
5767
raise errors.BzrCommandError(
5768
"Cannot change the 'off' pseudo view")
5769
tree.views.set_view(name, sorted(file_list))
5770
view_str = views.view_display_str(tree.views.lookup_view())
5771
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5775
# No name given and no current view set
5776
self.outf.write('No current view.\n')
5778
view_str = views.view_display_str(tree.views.lookup_view(name))
5779
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5782
class cmd_hooks(Command):
5788
for hook_key in sorted(hooks.known_hooks.keys()):
5789
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5790
self.outf.write("%s:\n" % type(some_hooks).__name__)
5791
for hook_name, hook_point in sorted(some_hooks.items()):
5792
self.outf.write(" %s:\n" % (hook_name,))
5793
found_hooks = list(hook_point)
5795
for hook in found_hooks:
5796
self.outf.write(" %s\n" %
5797
(some_hooks.get_hook_name(hook),))
5799
self.outf.write(" <no hooks installed>\n")
5802
class cmd_remove_branch(Command):
5805
This will remove the branch from the specified location but
5806
will keep any working tree or repository in place.
5810
Remove the branch at repo/trunk::
5812
bzr remove-branch repo/trunk
5816
takes_args = ["location?"]
5818
aliases = ["rmbranch"]
5820
def run(self, location=None):
5821
if location is None:
5823
branch = Branch.open_containing(location)[0]
5824
branch.bzrdir.destroy_branch()
5827
class cmd_shelve(Command):
5828
"""Temporarily set aside some changes from the current tree.
5830
Shelve allows you to temporarily put changes you've made "on the shelf",
5831
ie. out of the way, until a later time when you can bring them back from
5832
the shelf with the 'unshelve' command. The changes are stored alongside
5833
your working tree, and so they aren't propagated along with your branch nor
5834
will they survive its deletion.
5836
If shelve --list is specified, previously-shelved changes are listed.
5838
Shelve is intended to help separate several sets of changes that have
5839
been inappropriately mingled. If you just want to get rid of all changes
5840
and you don't need to restore them later, use revert. If you want to
5841
shelve all text changes at once, use shelve --all.
5843
If filenames are specified, only the changes to those files will be
5844
shelved. Other files will be left untouched.
5846
If a revision is specified, changes since that revision will be shelved.
5848
You can put multiple items on the shelf, and by default, 'unshelve' will
5849
restore the most recently shelved changes.
5852
takes_args = ['file*']
5856
Option('all', help='Shelve all changes.'),
5858
RegistryOption('writer', 'Method to use for writing diffs.',
5859
bzrlib.option.diff_writer_registry,
5860
value_switches=True, enum_switch=False),
5862
Option('list', help='List shelved changes.'),
5864
help='Destroy removed changes instead of shelving them.'),
5866
_see_also = ['unshelve']
5868
def run(self, revision=None, all=False, file_list=None, message=None,
5869
writer=None, list=False, destroy=False):
5871
return self.run_for_list()
5872
from bzrlib.shelf_ui import Shelver
5874
writer = bzrlib.option.diff_writer_registry.get()
5876
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5877
file_list, message, destroy=destroy)
5882
except errors.UserAbort:
5885
def run_for_list(self):
5886
tree = WorkingTree.open_containing('.')[0]
5888
self.add_cleanup(tree.unlock)
5889
manager = tree.get_shelf_manager()
5890
shelves = manager.active_shelves()
5891
if len(shelves) == 0:
5892
note('No shelved changes.')
5894
for shelf_id in reversed(shelves):
5895
message = manager.get_metadata(shelf_id).get('message')
5897
message = '<no message>'
5898
self.outf.write('%3d: %s\n' % (shelf_id, message))
5902
class cmd_unshelve(Command):
5903
"""Restore shelved changes.
5905
By default, the most recently shelved changes are restored. However if you
5906
specify a shelf by id those changes will be restored instead. This works
5907
best when the changes don't depend on each other.
5910
takes_args = ['shelf_id?']
5912
RegistryOption.from_kwargs(
5913
'action', help="The action to perform.",
5914
enum_switch=False, value_switches=True,
5915
apply="Apply changes and remove from the shelf.",
5916
dry_run="Show changes, but do not apply or remove them.",
5917
preview="Instead of unshelving the changes, show the diff that "
5918
"would result from unshelving.",
5919
delete_only="Delete changes without applying them.",
5920
keep="Apply changes but don't delete them.",
5923
_see_also = ['shelve']
5925
def run(self, shelf_id=None, action='apply'):
5926
from bzrlib.shelf_ui import Unshelver
5927
unshelver = Unshelver.from_args(shelf_id, action)
5931
unshelver.tree.unlock()
5934
class cmd_clean_tree(Command):
5935
"""Remove unwanted files from working tree.
5937
By default, only unknown files, not ignored files, are deleted. Versioned
5938
files are never deleted.
5940
Another class is 'detritus', which includes files emitted by bzr during
5941
normal operations and selftests. (The value of these files decreases with
5944
If no options are specified, unknown files are deleted. Otherwise, option
5945
flags are respected, and may be combined.
5947
To check what clean-tree will do, use --dry-run.
5949
takes_options = [Option('ignored', help='Delete all ignored files.'),
5950
Option('detritus', help='Delete conflict files, merge'
5951
' backups, and failed selftest dirs.'),
5953
help='Delete files unknown to bzr (default).'),
5954
Option('dry-run', help='Show files to delete instead of'
5956
Option('force', help='Do not prompt before deleting.')]
5957
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5959
from bzrlib.clean_tree import clean_tree
5960
if not (unknown or ignored or detritus):
5964
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5965
dry_run=dry_run, no_prompt=force)
5968
class cmd_reference(Command):
5969
"""list, view and set branch locations for nested trees.
5971
If no arguments are provided, lists the branch locations for nested trees.
5972
If one argument is provided, display the branch location for that tree.
5973
If two arguments are provided, set the branch location for that tree.
5978
takes_args = ['path?', 'location?']
5980
def run(self, path=None, location=None):
5982
if path is not None:
5984
tree, branch, relpath =(
5985
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5986
if path is not None:
5989
tree = branch.basis_tree()
5991
info = branch._get_all_reference_info().iteritems()
5992
self._display_reference_info(tree, branch, info)
5994
file_id = tree.path2id(path)
5996
raise errors.NotVersionedError(path)
5997
if location is None:
5998
info = [(file_id, branch.get_reference_info(file_id))]
5999
self._display_reference_info(tree, branch, info)
6001
branch.set_reference_info(file_id, path, location)
6003
def _display_reference_info(self, tree, branch, info):
6005
for file_id, (path, location) in info:
6007
path = tree.id2path(file_id)
6008
except errors.NoSuchId:
6010
ref_list.append((path, location))
6011
for path, location in sorted(ref_list):
6012
self.outf.write('%s %s\n' % (path, location))
6015
def _register_lazy_builtins():
6016
# register lazy builtins from other modules; called at startup and should
6017
# be only called once.
6018
for (name, aliases, module_name) in [
6019
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6020
('cmd_dpush', [], 'bzrlib.foreign'),
6021
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6022
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6023
('cmd_conflicts', [], 'bzrlib.conflicts'),
6024
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6026
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
