1
# Copyright (C) 2004, 2005, 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
42
revision as _mod_revision,
49
from bzrlib.branch import Branch
50
from bzrlib.conflicts import ConflictList
51
from bzrlib.revisionspec import RevisionSpec
52
from bzrlib.smtp_connection import SMTPConnection
53
from bzrlib.workingtree import WorkingTree
56
from bzrlib.commands import Command, display_command
57
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
58
from bzrlib.trace import mutter, note, warning, is_quiet
61
def tree_files(file_list, default_branch=u'.'):
63
return internal_tree_files(file_list, default_branch)
64
except errors.FileInWrongBranch, e:
65
raise errors.BzrCommandError("%s is not in the same branch as %s" %
66
(e.path, file_list[0]))
69
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
74
rev_tree = tree.basis_tree()
76
rev_tree = branch.basis_tree()
78
if len(revisions) != 1:
79
raise errors.BzrCommandError(
80
'bzr %s --revision takes exactly one revision identifier' % (
82
rev_tree = revisions[0].as_tree(branch)
86
# XXX: Bad function name; should possibly also be a class method of
87
# WorkingTree rather than a function.
88
def internal_tree_files(file_list, default_branch=u'.'):
89
"""Convert command-line paths to a WorkingTree and relative paths.
91
This is typically used for command-line processors that take one or
92
more filenames, and infer the workingtree that contains them.
94
The filenames given are not required to exist.
96
:param file_list: Filenames to convert.
98
:param default_branch: Fallback tree path to use if file_list is empty or
101
:return: workingtree, [relative_paths]
103
if file_list is None or len(file_list) == 0:
104
return WorkingTree.open_containing(default_branch)[0], file_list
105
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
106
return tree, safe_relpath_files(tree, file_list)
109
def safe_relpath_files(tree, file_list):
110
"""Convert file_list into a list of relpaths in tree.
112
:param tree: A tree to operate on.
113
:param file_list: A list of user provided paths or None.
114
:return: A list of relative paths.
115
:raises errors.PathNotChild: When a provided path is in a different tree
118
if file_list is None:
121
for filename in file_list:
123
new_list.append(tree.relpath(osutils.dereference_path(filename)))
124
except errors.PathNotChild:
125
raise errors.FileInWrongBranch(tree.branch, filename)
129
# TODO: Make sure no commands unconditionally use the working directory as a
130
# branch. If a filename argument is used, the first of them should be used to
131
# specify the branch. (Perhaps this can be factored out into some kind of
132
# Argument class, representing a file in a branch, where the first occurrence
135
class cmd_status(Command):
136
"""Display status summary.
138
This reports on versioned and unknown files, reporting them
139
grouped by state. Possible states are:
142
Versioned in the working copy but not in the previous revision.
145
Versioned in the previous revision but removed or deleted
149
Path of this file changed from the previous revision;
150
the text may also have changed. This includes files whose
151
parent directory was renamed.
154
Text has changed since the previous revision.
157
File kind has been changed (e.g. from file to directory).
160
Not versioned and not matching an ignore pattern.
162
To see ignored files use 'bzr ignored'. For details on the
163
changes to file texts, use 'bzr diff'.
165
Note that --short or -S gives status flags for each item, similar
166
to Subversion's status command. To get output similar to svn -q,
169
If no arguments are specified, the status of the entire working
170
directory is shown. Otherwise, only the status of the specified
171
files or directories is reported. If a directory is given, status
172
is reported for everything inside that directory.
174
If a revision argument is given, the status is calculated against
175
that revision, or between two revisions if two are provided.
178
# TODO: --no-recurse, --recurse options
180
takes_args = ['file*']
181
takes_options = ['show-ids', 'revision', 'change',
182
Option('short', help='Use short status indicators.',
184
Option('versioned', help='Only show versioned files.',
186
Option('no-pending', help='Don\'t show pending merges.',
189
aliases = ['st', 'stat']
191
encoding_type = 'replace'
192
_see_also = ['diff', 'revert', 'status-flags']
195
def run(self, show_ids=False, file_list=None, revision=None, short=False,
196
versioned=False, no_pending=False):
197
from bzrlib.status import show_tree_status
199
if revision and len(revision) > 2:
200
raise errors.BzrCommandError('bzr status --revision takes exactly'
201
' one or two revision specifiers')
203
tree, relfile_list = tree_files(file_list)
204
# Avoid asking for specific files when that is not needed.
205
if relfile_list == ['']:
207
# Don't disable pending merges for full trees other than '.'.
208
if file_list == ['.']:
210
# A specific path within a tree was given.
211
elif relfile_list is not None:
213
show_tree_status(tree, show_ids=show_ids,
214
specific_files=relfile_list, revision=revision,
215
to_file=self.outf, short=short, versioned=versioned,
216
show_pending=(not no_pending))
219
class cmd_cat_revision(Command):
220
"""Write out metadata for a revision.
222
The revision to print can either be specified by a specific
223
revision identifier, or you can use --revision.
227
takes_args = ['revision_id?']
228
takes_options = ['revision']
229
# cat-revision is more for frontends so should be exact
233
def run(self, revision_id=None, revision=None):
234
if revision_id is not None and revision is not None:
235
raise errors.BzrCommandError('You can only supply one of'
236
' revision_id or --revision')
237
if revision_id is None and revision is None:
238
raise errors.BzrCommandError('You must supply either'
239
' --revision or a revision_id')
240
b = WorkingTree.open_containing(u'.')[0].branch
242
# TODO: jam 20060112 should cat-revision always output utf-8?
243
if revision_id is not None:
244
revision_id = osutils.safe_revision_id(revision_id, warn=False)
246
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
247
except errors.NoSuchRevision:
248
msg = "The repository %s contains no revision %s." % (b.repository.base,
250
raise errors.BzrCommandError(msg)
251
elif revision is not None:
254
raise errors.BzrCommandError('You cannot specify a NULL'
256
rev_id = rev.as_revision_id(b)
257
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
260
class cmd_remove_tree(Command):
261
"""Remove the working tree from a given branch/checkout.
263
Since a lightweight checkout is little more than a working tree
264
this will refuse to run against one.
266
To re-create the working tree, use "bzr checkout".
268
_see_also = ['checkout', 'working-trees']
269
takes_args = ['location?']
272
help='Remove the working tree even if it has '
273
'uncommitted changes.'),
276
def run(self, location='.', force=False):
277
d = bzrdir.BzrDir.open(location)
280
working = d.open_workingtree()
281
except errors.NoWorkingTree:
282
raise errors.BzrCommandError("No working tree to remove")
283
except errors.NotLocalUrl:
284
raise errors.BzrCommandError("You cannot remove the working tree of a "
287
changes = working.changes_from(working.basis_tree())
288
if changes.has_changed():
289
raise errors.UncommittedChanges(working)
291
working_path = working.bzrdir.root_transport.base
292
branch_path = working.branch.bzrdir.root_transport.base
293
if working_path != branch_path:
294
raise errors.BzrCommandError("You cannot remove the working tree from "
295
"a lightweight checkout")
297
d.destroy_workingtree()
300
class cmd_revno(Command):
301
"""Show current revision number.
303
This is equal to the number of revisions on this branch.
307
takes_args = ['location?']
310
def run(self, location=u'.'):
311
self.outf.write(str(Branch.open_containing(location)[0].revno()))
312
self.outf.write('\n')
315
class cmd_revision_info(Command):
316
"""Show revision number and revision id for a given revision identifier.
319
takes_args = ['revision_info*']
320
takes_options = ['revision']
323
def run(self, revision=None, revision_info_list=[]):
326
if revision is not None:
327
revs.extend(revision)
328
if revision_info_list is not None:
329
for rev in revision_info_list:
330
revs.append(RevisionSpec.from_string(rev))
332
b = Branch.open_containing(u'.')[0]
335
revs.append(RevisionSpec.from_string('-1'))
338
revision_id = rev.as_revision_id(b)
340
revno = '%4d' % (b.revision_id_to_revno(revision_id))
341
except errors.NoSuchRevision:
342
dotted_map = b.get_revision_id_to_revno_map()
343
revno = '.'.join(str(i) for i in dotted_map[revision_id])
344
print '%s %s' % (revno, revision_id)
347
class cmd_add(Command):
348
"""Add specified files or directories.
350
In non-recursive mode, all the named items are added, regardless
351
of whether they were previously ignored. A warning is given if
352
any of the named files are already versioned.
354
In recursive mode (the default), files are treated the same way
355
but the behaviour for directories is different. Directories that
356
are already versioned do not give a warning. All directories,
357
whether already versioned or not, are searched for files or
358
subdirectories that are neither versioned or ignored, and these
359
are added. This search proceeds recursively into versioned
360
directories. If no names are given '.' is assumed.
362
Therefore simply saying 'bzr add' will version all files that
363
are currently unknown.
365
Adding a file whose parent directory is not versioned will
366
implicitly add the parent, and so on up to the root. This means
367
you should never need to explicitly add a directory, they'll just
368
get added when you add a file in the directory.
370
--dry-run will show which files would be added, but not actually
373
--file-ids-from will try to use the file ids from the supplied path.
374
It looks up ids trying to find a matching parent directory with the
375
same filename, and then by pure path. This option is rarely needed
376
but can be useful when adding the same logical file into two
377
branches that will be merged later (without showing the two different
378
adds as a conflict). It is also useful when merging another project
379
into a subdirectory of this one.
381
takes_args = ['file*']
384
help="Don't recursively add the contents of directories."),
386
help="Show what would be done, but don't actually do anything."),
388
Option('file-ids-from',
390
help='Lookup file ids from this tree.'),
392
encoding_type = 'replace'
393
_see_also = ['remove']
395
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
400
if file_ids_from is not None:
402
base_tree, base_path = WorkingTree.open_containing(
404
except errors.NoWorkingTree:
405
base_branch, base_path = Branch.open_containing(
407
base_tree = base_branch.basis_tree()
409
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
410
to_file=self.outf, should_print=(not is_quiet()))
412
action = bzrlib.add.AddAction(to_file=self.outf,
413
should_print=(not is_quiet()))
416
base_tree.lock_read()
418
file_list = self._maybe_expand_globs(file_list)
420
tree = WorkingTree.open_containing(file_list[0])[0]
422
tree = WorkingTree.open_containing(u'.')[0]
423
added, ignored = tree.smart_add(file_list, not
424
no_recurse, action=action, save=not dry_run)
426
if base_tree is not None:
430
for glob in sorted(ignored.keys()):
431
for path in ignored[glob]:
432
self.outf.write("ignored %s matching \"%s\"\n"
436
for glob, paths in ignored.items():
437
match_len += len(paths)
438
self.outf.write("ignored %d file(s).\n" % match_len)
439
self.outf.write("If you wish to add some of these files,"
440
" please add them by name.\n")
443
class cmd_mkdir(Command):
444
"""Create a new versioned directory.
446
This is equivalent to creating the directory and then adding it.
449
takes_args = ['dir+']
450
encoding_type = 'replace'
452
def run(self, dir_list):
455
wt, dd = WorkingTree.open_containing(d)
457
self.outf.write('added %s\n' % d)
460
class cmd_relpath(Command):
461
"""Show path of a file relative to root"""
463
takes_args = ['filename']
467
def run(self, filename):
468
# TODO: jam 20050106 Can relpath return a munged path if
469
# sys.stdout encoding cannot represent it?
470
tree, relpath = WorkingTree.open_containing(filename)
471
self.outf.write(relpath)
472
self.outf.write('\n')
475
class cmd_inventory(Command):
476
"""Show inventory of the current working copy or a revision.
478
It is possible to limit the output to a particular entry
479
type using the --kind option. For example: --kind file.
481
It is also possible to restrict the list of files to a specific
482
set. For example: bzr inventory --show-ids this/file
491
help='List entries of a particular kind: file, directory, symlink.',
494
takes_args = ['file*']
497
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
498
if kind and kind not in ['file', 'directory', 'symlink']:
499
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
501
work_tree, file_list = tree_files(file_list)
502
work_tree.lock_read()
504
if revision is not None:
505
if len(revision) > 1:
506
raise errors.BzrCommandError(
507
'bzr inventory --revision takes exactly one revision'
509
tree = revision[0].as_tree(work_tree.branch)
511
extra_trees = [work_tree]
517
if file_list is not None:
518
file_ids = tree.paths2ids(file_list, trees=extra_trees,
519
require_versioned=True)
520
# find_ids_across_trees may include some paths that don't
522
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
523
for file_id in file_ids if file_id in tree)
525
entries = tree.inventory.entries()
528
if tree is not work_tree:
531
for path, entry in entries:
532
if kind and kind != entry.kind:
535
self.outf.write('%-50s %s\n' % (path, entry.file_id))
537
self.outf.write(path)
538
self.outf.write('\n')
541
class cmd_mv(Command):
542
"""Move or rename a file.
545
bzr mv OLDNAME NEWNAME
547
bzr mv SOURCE... DESTINATION
549
If the last argument is a versioned directory, all the other names
550
are moved into it. Otherwise, there must be exactly two arguments
551
and the file is changed to a new name.
553
If OLDNAME does not exist on the filesystem but is versioned and
554
NEWNAME does exist on the filesystem but is not versioned, mv
555
assumes that the file has been manually moved and only updates
556
its internal inventory to reflect that change.
557
The same is valid when moving many SOURCE files to a DESTINATION.
559
Files cannot be moved between branches.
562
takes_args = ['names*']
563
takes_options = [Option("after", help="Move only the bzr identifier"
564
" of the file, because the file has already been moved."),
566
aliases = ['move', 'rename']
567
encoding_type = 'replace'
569
def run(self, names_list, after=False):
570
if names_list is None:
573
if len(names_list) < 2:
574
raise errors.BzrCommandError("missing file argument")
575
tree, rel_names = tree_files(names_list)
578
self._run(tree, names_list, rel_names, after)
582
def _run(self, tree, names_list, rel_names, after):
583
into_existing = osutils.isdir(names_list[-1])
584
if into_existing and len(names_list) == 2:
586
# a. case-insensitive filesystem and change case of dir
587
# b. move directory after the fact (if the source used to be
588
# a directory, but now doesn't exist in the working tree
589
# and the target is an existing directory, just rename it)
590
if (not tree.case_sensitive
591
and rel_names[0].lower() == rel_names[1].lower()):
592
into_existing = False
595
from_id = tree.path2id(rel_names[0])
596
if (not osutils.lexists(names_list[0]) and
597
from_id and inv.get_file_kind(from_id) == "directory"):
598
into_existing = False
601
# move into existing directory
602
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
603
self.outf.write("%s => %s\n" % pair)
605
if len(names_list) != 2:
606
raise errors.BzrCommandError('to mv multiple files the'
607
' destination must be a versioned'
609
tree.rename_one(rel_names[0], rel_names[1], after=after)
610
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
613
class cmd_pull(Command):
614
"""Turn this branch into a mirror of another branch.
616
This command only works on branches that have not diverged. Branches are
617
considered diverged if the destination branch's most recent commit is one
618
that has not been merged (directly or indirectly) into the parent.
620
If branches have diverged, you can use 'bzr merge' to integrate the changes
621
from one into the other. Once one branch has merged, the other should
622
be able to pull it again.
624
If you want to forget your local changes and just update your branch to
625
match the remote one, use pull --overwrite.
627
If there is no default location set, the first pull will set it. After
628
that, you can omit the location to use the default. To change the
629
default, use --remember. The value will only be saved if the remote
630
location can be accessed.
632
Note: The location can be specified either in the form of a branch,
633
or in the form of a path to a file containing a merge directive generated
637
_see_also = ['push', 'update', 'status-flags']
638
takes_options = ['remember', 'overwrite', 'revision',
639
custom_help('verbose',
640
help='Show logs of pulled revisions.'),
642
help='Branch to pull into, '
643
'rather than the one containing the working directory.',
648
takes_args = ['location?']
649
encoding_type = 'replace'
651
def run(self, location=None, remember=False, overwrite=False,
652
revision=None, verbose=False,
654
# FIXME: too much stuff is in the command class
657
if directory is None:
660
tree_to = WorkingTree.open_containing(directory)[0]
661
branch_to = tree_to.branch
662
except errors.NoWorkingTree:
664
branch_to = Branch.open_containing(directory)[0]
666
possible_transports = []
667
if location is not None:
669
mergeable = bundle.read_mergeable_from_url(location,
670
possible_transports=possible_transports)
671
except errors.NotABundle:
674
stored_loc = branch_to.get_parent()
676
if stored_loc is None:
677
raise errors.BzrCommandError("No pull location known or"
680
display_url = urlutils.unescape_for_display(stored_loc,
683
self.outf.write("Using saved parent location: %s\n" % display_url)
684
location = stored_loc
686
if mergeable is not None:
687
if revision is not None:
688
raise errors.BzrCommandError(
689
'Cannot use -r with merge directives or bundles')
690
mergeable.install_revisions(branch_to.repository)
691
base_revision_id, revision_id, verified = \
692
mergeable.get_merge_request(branch_to.repository)
693
branch_from = branch_to
695
branch_from = Branch.open(location,
696
possible_transports=possible_transports)
698
if branch_to.get_parent() is None or remember:
699
branch_to.set_parent(branch_from.base)
701
if revision is not None:
702
if len(revision) == 1:
703
revision_id = revision[0].as_revision_id(branch_from)
705
raise errors.BzrCommandError(
706
'bzr pull --revision takes one value.')
708
branch_to.lock_write()
710
if tree_to is not None:
711
change_reporter = delta._ChangeReporter(
712
unversioned_filter=tree_to.is_ignored)
713
result = tree_to.pull(branch_from, overwrite, revision_id,
715
possible_transports=possible_transports)
717
result = branch_to.pull(branch_from, overwrite, revision_id)
719
result.report(self.outf)
720
if verbose and result.old_revid != result.new_revid:
722
branch_to.repository.iter_reverse_revision_history(
725
new_rh = branch_to.revision_history()
726
log.show_changed_revisions(branch_to, old_rh, new_rh,
732
class cmd_push(Command):
733
"""Update a mirror of this branch.
735
The target branch will not have its working tree populated because this
736
is both expensive, and is not supported on remote file systems.
738
Some smart servers or protocols *may* put the working tree in place in
741
This command only works on branches that have not diverged. Branches are
742
considered diverged if the destination branch's most recent commit is one
743
that has not been merged (directly or indirectly) by the source branch.
745
If branches have diverged, you can use 'bzr push --overwrite' to replace
746
the other branch completely, discarding its unmerged changes.
748
If you want to ensure you have the different changes in the other branch,
749
do a merge (see bzr help merge) from the other branch, and commit that.
750
After that you will be able to do a push without '--overwrite'.
752
If there is no default push location set, the first push will set it.
753
After that, you can omit the location to use the default. To change the
754
default, use --remember. The value will only be saved if the remote
755
location can be accessed.
758
_see_also = ['pull', 'update', 'working-trees']
759
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
760
Option('create-prefix',
761
help='Create the path leading up to the branch '
762
'if it does not already exist.'),
764
help='Branch to push from, '
765
'rather than the one containing the working directory.',
769
Option('use-existing-dir',
770
help='By default push will fail if the target'
771
' directory exists, but does not already'
772
' have a control directory. This flag will'
773
' allow push to proceed.'),
775
help='Create a stacked branch that references the public location '
776
'of the parent branch.'),
778
help='Create a stacked branch that refers to another branch '
779
'for the commit history. Only the work not present in the '
780
'referenced branch is included in the branch created.',
783
takes_args = ['location?']
784
encoding_type = 'replace'
786
def run(self, location=None, remember=False, overwrite=False,
787
create_prefix=False, verbose=False, revision=None,
788
use_existing_dir=False, directory=None, stacked_on=None,
790
from bzrlib.push import _show_push_branch
792
# Get the source branch and revision_id
793
if directory is None:
795
br_from = Branch.open_containing(directory)[0]
796
if revision is not None:
797
if len(revision) == 1:
798
revision_id = revision[0].in_history(br_from).rev_id
800
raise errors.BzrCommandError(
801
'bzr push --revision takes one value.')
803
revision_id = br_from.last_revision()
805
# Get the stacked_on branch, if any
806
if stacked_on is not None:
807
stacked_on = urlutils.normalize_url(stacked_on)
809
parent_url = br_from.get_parent()
811
parent = Branch.open(parent_url)
812
stacked_on = parent.get_public_branch()
814
# I considered excluding non-http url's here, thus forcing
815
# 'public' branches only, but that only works for some
816
# users, so it's best to just depend on the user spotting an
817
# error by the feedback given to them. RBC 20080227.
818
stacked_on = parent_url
820
raise errors.BzrCommandError(
821
"Could not determine branch to refer to.")
823
# Get the destination location
825
stored_loc = br_from.get_push_location()
826
if stored_loc is None:
827
raise errors.BzrCommandError(
828
"No push location known or specified.")
830
display_url = urlutils.unescape_for_display(stored_loc,
832
self.outf.write("Using saved push location: %s\n" % display_url)
833
location = stored_loc
835
_show_push_branch(br_from, revision_id, location, self.outf,
836
verbose=verbose, overwrite=overwrite, remember=remember,
837
stacked_on=stacked_on, create_prefix=create_prefix,
838
use_existing_dir=use_existing_dir)
841
class cmd_branch(Command):
842
"""Create a new copy of a branch.
844
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
845
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
846
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
847
is derived from the FROM_LOCATION by stripping a leading scheme or drive
848
identifier, if any. For example, "branch lp:foo-bar" will attempt to
851
To retrieve the branch as of a particular revision, supply the --revision
852
parameter, as in "branch foo/bar -r 5".
855
_see_also = ['checkout']
856
takes_args = ['from_location', 'to_location?']
857
takes_options = ['revision', Option('hardlink',
858
help='Hard-link working tree files where possible.'),
860
help='Create a stacked branch referring to the source branch. '
861
'The new branch will depend on the availability of the source '
862
'branch for all operations.'),
864
help='Do not use a shared repository, even if available.'),
866
aliases = ['get', 'clone']
868
def run(self, from_location, to_location=None, revision=None,
869
hardlink=False, stacked=False, standalone=False):
870
from bzrlib.tag import _merge_tags_if_possible
873
elif len(revision) > 1:
874
raise errors.BzrCommandError(
875
'bzr branch --revision takes exactly 1 revision value')
877
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
881
if len(revision) == 1 and revision[0] is not None:
882
revision_id = revision[0].as_revision_id(br_from)
884
# FIXME - wt.last_revision, fallback to branch, fall back to
885
# None or perhaps NULL_REVISION to mean copy nothing
887
revision_id = br_from.last_revision()
888
if to_location is None:
889
to_location = urlutils.derive_to_location(from_location)
890
to_transport = transport.get_transport(to_location)
892
to_transport.mkdir('.')
893
except errors.FileExists:
894
raise errors.BzrCommandError('Target directory "%s" already'
895
' exists.' % to_location)
896
except errors.NoSuchFile:
897
raise errors.BzrCommandError('Parent of "%s" does not exist.'
900
# preserve whatever source format we have.
901
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
902
possible_transports=[to_transport],
903
accelerator_tree=accelerator_tree,
904
hardlink=hardlink, stacked=stacked,
905
force_new_repo=standalone)
906
branch = dir.open_branch()
907
except errors.NoSuchRevision:
908
to_transport.delete_tree('.')
909
msg = "The branch %s has no revision %s." % (from_location,
911
raise errors.BzrCommandError(msg)
912
_merge_tags_if_possible(br_from, branch)
913
# If the source branch is stacked, the new branch may
914
# be stacked whether we asked for that explicitly or not.
915
# We therefore need a try/except here and not just 'if stacked:'
917
note('Created new stacked branch referring to %s.' %
918
branch.get_stacked_on_url())
919
except (errors.NotStacked, errors.UnstackableBranchFormat,
920
errors.UnstackableRepositoryFormat), e:
921
note('Branched %d revision(s).' % branch.revno())
926
class cmd_checkout(Command):
927
"""Create a new checkout of an existing branch.
929
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
930
the branch found in '.'. This is useful if you have removed the working tree
931
or if it was never created - i.e. if you pushed the branch to its current
934
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
935
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
936
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
937
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
938
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
941
To retrieve the branch as of a particular revision, supply the --revision
942
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
943
out of date [so you cannot commit] but it may be useful (i.e. to examine old
947
_see_also = ['checkouts', 'branch']
948
takes_args = ['branch_location?', 'to_location?']
949
takes_options = ['revision',
950
Option('lightweight',
951
help="Perform a lightweight checkout. Lightweight "
952
"checkouts depend on access to the branch for "
953
"every operation. Normal checkouts can perform "
954
"common operations like diff and status without "
955
"such access, and also support local commits."
957
Option('files-from', type=str,
958
help="Get file contents from this tree."),
960
help='Hard-link working tree files where possible.'
965
def run(self, branch_location=None, to_location=None, revision=None,
966
lightweight=False, files_from=None, hardlink=False):
969
elif len(revision) > 1:
970
raise errors.BzrCommandError(
971
'bzr checkout --revision takes exactly 1 revision value')
972
if branch_location is None:
973
branch_location = osutils.getcwd()
974
to_location = branch_location
975
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
977
if files_from is not None:
978
accelerator_tree = WorkingTree.open(files_from)
979
if len(revision) == 1 and revision[0] is not None:
980
revision_id = revision[0].as_revision_id(source)
983
if to_location is None:
984
to_location = urlutils.derive_to_location(branch_location)
985
# if the source and to_location are the same,
986
# and there is no working tree,
987
# then reconstitute a branch
988
if (osutils.abspath(to_location) ==
989
osutils.abspath(branch_location)):
991
source.bzrdir.open_workingtree()
992
except errors.NoWorkingTree:
993
source.bzrdir.create_workingtree(revision_id)
995
source.create_checkout(to_location, revision_id, lightweight,
996
accelerator_tree, hardlink)
999
class cmd_renames(Command):
1000
"""Show list of renamed files.
1002
# TODO: Option to show renames between two historical versions.
1004
# TODO: Only show renames under dir, rather than in the whole branch.
1005
_see_also = ['status']
1006
takes_args = ['dir?']
1009
def run(self, dir=u'.'):
1010
tree = WorkingTree.open_containing(dir)[0]
1013
new_inv = tree.inventory
1014
old_tree = tree.basis_tree()
1015
old_tree.lock_read()
1017
old_inv = old_tree.inventory
1018
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1020
for old_name, new_name in renames:
1021
self.outf.write("%s => %s\n" % (old_name, new_name))
1028
class cmd_update(Command):
1029
"""Update a tree to have the latest code committed to its branch.
1031
This will perform a merge into the working tree, and may generate
1032
conflicts. If you have any local changes, you will still
1033
need to commit them after the update for the update to be complete.
1035
If you want to discard your local changes, you can just do a
1036
'bzr revert' instead of 'bzr commit' after the update.
1039
_see_also = ['pull', 'working-trees', 'status-flags']
1040
takes_args = ['dir?']
1043
def run(self, dir='.'):
1044
tree = WorkingTree.open_containing(dir)[0]
1045
possible_transports = []
1046
master = tree.branch.get_master_branch(
1047
possible_transports=possible_transports)
1048
if master is not None:
1051
tree.lock_tree_write()
1053
existing_pending_merges = tree.get_parent_ids()[1:]
1054
last_rev = _mod_revision.ensure_null(tree.last_revision())
1055
if last_rev == _mod_revision.ensure_null(
1056
tree.branch.last_revision()):
1057
# may be up to date, check master too.
1058
if master is None or last_rev == _mod_revision.ensure_null(
1059
master.last_revision()):
1060
revno = tree.branch.revision_id_to_revno(last_rev)
1061
note("Tree is up to date at revision %d." % (revno,))
1063
conflicts = tree.update(
1064
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1065
possible_transports=possible_transports)
1066
revno = tree.branch.revision_id_to_revno(
1067
_mod_revision.ensure_null(tree.last_revision()))
1068
note('Updated to revision %d.' % (revno,))
1069
if tree.get_parent_ids()[1:] != existing_pending_merges:
1070
note('Your local commits will now show as pending merges with '
1071
"'bzr status', and can be committed with 'bzr commit'.")
1080
class cmd_info(Command):
1081
"""Show information about a working tree, branch or repository.
1083
This command will show all known locations and formats associated to the
1084
tree, branch or repository. Statistical information is included with
1087
Branches and working trees will also report any missing revisions.
1089
_see_also = ['revno', 'working-trees', 'repositories']
1090
takes_args = ['location?']
1091
takes_options = ['verbose']
1092
encoding_type = 'replace'
1095
def run(self, location=None, verbose=False):
1100
from bzrlib.info import show_bzrdir_info
1101
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1102
verbose=noise_level, outfile=self.outf)
1105
class cmd_remove(Command):
1106
"""Remove files or directories.
1108
This makes bzr stop tracking changes to the specified files. bzr will delete
1109
them if they can easily be recovered using revert. If no options or
1110
parameters are given bzr will scan for files that are being tracked by bzr
1111
but missing in your tree and stop tracking them for you.
1113
takes_args = ['file*']
1114
takes_options = ['verbose',
1115
Option('new', help='Only remove files that have never been committed.'),
1116
RegistryOption.from_kwargs('file-deletion-strategy',
1117
'The file deletion mode to be used.',
1118
title='Deletion Strategy', value_switches=True, enum_switch=False,
1119
safe='Only delete files if they can be'
1120
' safely recovered (default).',
1121
keep="Don't delete any files.",
1122
force='Delete all the specified files, even if they can not be '
1123
'recovered and even if they are non-empty directories.')]
1124
aliases = ['rm', 'del']
1125
encoding_type = 'replace'
1127
def run(self, file_list, verbose=False, new=False,
1128
file_deletion_strategy='safe'):
1129
tree, file_list = tree_files(file_list)
1131
if file_list is not None:
1132
file_list = [f for f in file_list]
1136
# Heuristics should probably all move into tree.remove_smart or
1139
added = tree.changes_from(tree.basis_tree(),
1140
specific_files=file_list).added
1141
file_list = sorted([f[0] for f in added], reverse=True)
1142
if len(file_list) == 0:
1143
raise errors.BzrCommandError('No matching files.')
1144
elif file_list is None:
1145
# missing files show up in iter_changes(basis) as
1146
# versioned-with-no-kind.
1148
for change in tree.iter_changes(tree.basis_tree()):
1149
# Find paths in the working tree that have no kind:
1150
if change[1][1] is not None and change[6][1] is None:
1151
missing.append(change[1][1])
1152
file_list = sorted(missing, reverse=True)
1153
file_deletion_strategy = 'keep'
1154
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1155
keep_files=file_deletion_strategy=='keep',
1156
force=file_deletion_strategy=='force')
1161
class cmd_file_id(Command):
1162
"""Print file_id of a particular file or directory.
1164
The file_id is assigned when the file is first added and remains the
1165
same through all revisions where the file exists, even when it is
1170
_see_also = ['inventory', 'ls']
1171
takes_args = ['filename']
1174
def run(self, filename):
1175
tree, relpath = WorkingTree.open_containing(filename)
1176
i = tree.path2id(relpath)
1178
raise errors.NotVersionedError(filename)
1180
self.outf.write(i + '\n')
1183
class cmd_file_path(Command):
1184
"""Print path of file_ids to a file or directory.
1186
This prints one line for each directory down to the target,
1187
starting at the branch root.
1191
takes_args = ['filename']
1194
def run(self, filename):
1195
tree, relpath = WorkingTree.open_containing(filename)
1196
fid = tree.path2id(relpath)
1198
raise errors.NotVersionedError(filename)
1199
segments = osutils.splitpath(relpath)
1200
for pos in range(1, len(segments) + 1):
1201
path = osutils.joinpath(segments[:pos])
1202
self.outf.write("%s\n" % tree.path2id(path))
1205
class cmd_reconcile(Command):
1206
"""Reconcile bzr metadata in a branch.
1208
This can correct data mismatches that may have been caused by
1209
previous ghost operations or bzr upgrades. You should only
1210
need to run this command if 'bzr check' or a bzr developer
1211
advises you to run it.
1213
If a second branch is provided, cross-branch reconciliation is
1214
also attempted, which will check that data like the tree root
1215
id which was not present in very early bzr versions is represented
1216
correctly in both branches.
1218
At the same time it is run it may recompress data resulting in
1219
a potential saving in disk space or performance gain.
1221
The branch *MUST* be on a listable system such as local disk or sftp.
1224
_see_also = ['check']
1225
takes_args = ['branch?']
1227
def run(self, branch="."):
1228
from bzrlib.reconcile import reconcile
1229
dir = bzrdir.BzrDir.open(branch)
1233
class cmd_revision_history(Command):
1234
"""Display the list of revision ids on a branch."""
1237
takes_args = ['location?']
1242
def run(self, location="."):
1243
branch = Branch.open_containing(location)[0]
1244
for revid in branch.revision_history():
1245
self.outf.write(revid)
1246
self.outf.write('\n')
1249
class cmd_ancestry(Command):
1250
"""List all revisions merged into this branch."""
1252
_see_also = ['log', 'revision-history']
1253
takes_args = ['location?']
1258
def run(self, location="."):
1260
wt = WorkingTree.open_containing(location)[0]
1261
except errors.NoWorkingTree:
1262
b = Branch.open(location)
1263
last_revision = b.last_revision()
1266
last_revision = wt.last_revision()
1268
revision_ids = b.repository.get_ancestry(last_revision)
1270
for revision_id in revision_ids:
1271
self.outf.write(revision_id + '\n')
1274
class cmd_init(Command):
1275
"""Make a directory into a versioned branch.
1277
Use this to create an empty branch, or before importing an
1280
If there is a repository in a parent directory of the location, then
1281
the history of the branch will be stored in the repository. Otherwise
1282
init creates a standalone branch which carries its own history
1283
in the .bzr directory.
1285
If there is already a branch at the location but it has no working tree,
1286
the tree can be populated with 'bzr checkout'.
1288
Recipe for importing a tree of files::
1294
bzr commit -m "imported project"
1297
_see_also = ['init-repository', 'branch', 'checkout']
1298
takes_args = ['location?']
1300
Option('create-prefix',
1301
help='Create the path leading up to the branch '
1302
'if it does not already exist.'),
1303
RegistryOption('format',
1304
help='Specify a format for this branch. '
1305
'See "help formats".',
1306
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1307
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1308
value_switches=True,
1309
title="Branch Format",
1311
Option('append-revisions-only',
1312
help='Never change revnos or the existing log.'
1313
' Append revisions to it only.')
1315
def run(self, location=None, format=None, append_revisions_only=False,
1316
create_prefix=False):
1318
format = bzrdir.format_registry.make_bzrdir('default')
1319
if location is None:
1322
to_transport = transport.get_transport(location)
1324
# The path has to exist to initialize a
1325
# branch inside of it.
1326
# Just using os.mkdir, since I don't
1327
# believe that we want to create a bunch of
1328
# locations if the user supplies an extended path
1330
to_transport.ensure_base()
1331
except errors.NoSuchFile:
1332
if not create_prefix:
1333
raise errors.BzrCommandError("Parent directory of %s"
1335
"\nYou may supply --create-prefix to create all"
1336
" leading parent directories."
1338
_create_prefix(to_transport)
1341
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1342
except errors.NotBranchError:
1343
# really a NotBzrDir error...
1344
create_branch = bzrdir.BzrDir.create_branch_convenience
1345
branch = create_branch(to_transport.base, format=format,
1346
possible_transports=[to_transport])
1347
a_bzrdir = branch.bzrdir
1349
from bzrlib.transport.local import LocalTransport
1350
if a_bzrdir.has_branch():
1351
if (isinstance(to_transport, LocalTransport)
1352
and not a_bzrdir.has_workingtree()):
1353
raise errors.BranchExistsWithoutWorkingTree(location)
1354
raise errors.AlreadyBranchError(location)
1355
branch = a_bzrdir.create_branch()
1356
a_bzrdir.create_workingtree()
1357
if append_revisions_only:
1359
branch.set_append_revisions_only(True)
1360
except errors.UpgradeRequired:
1361
raise errors.BzrCommandError('This branch format cannot be set'
1362
' to append-revisions-only. Try --experimental-branch6')
1364
from bzrlib.info import show_bzrdir_info
1365
show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
1368
class cmd_init_repository(Command):
1369
"""Create a shared repository to hold branches.
1371
New branches created under the repository directory will store their
1372
revisions in the repository, not in the branch directory.
1374
If the --no-trees option is used then the branches in the repository
1375
will not have working trees by default.
1378
Create a shared repositories holding just branches::
1380
bzr init-repo --no-trees repo
1383
Make a lightweight checkout elsewhere::
1385
bzr checkout --lightweight repo/trunk trunk-checkout
1390
_see_also = ['init', 'branch', 'checkout', 'repositories']
1391
takes_args = ["location"]
1392
takes_options = [RegistryOption('format',
1393
help='Specify a format for this repository. See'
1394
' "bzr help formats" for details.',
1395
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1396
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1397
value_switches=True, title='Repository format'),
1399
help='Branches in the repository will default to'
1400
' not having a working tree.'),
1402
aliases = ["init-repo"]
1404
def run(self, location, format=None, no_trees=False):
1406
format = bzrdir.format_registry.make_bzrdir('default')
1408
if location is None:
1411
to_transport = transport.get_transport(location)
1412
to_transport.ensure_base()
1414
newdir = format.initialize_on_transport(to_transport)
1415
repo = newdir.create_repository(shared=True)
1416
repo.set_make_working_trees(not no_trees)
1418
from bzrlib.info import show_bzrdir_info
1419
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1422
class cmd_diff(Command):
1423
"""Show differences in the working tree, between revisions or branches.
1425
If no arguments are given, all changes for the current tree are listed.
1426
If files are given, only the changes in those files are listed.
1427
Remote and multiple branches can be compared by using the --old and
1428
--new options. If not provided, the default for both is derived from
1429
the first argument, if any, or the current tree if no arguments are
1432
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1433
produces patches suitable for "patch -p1".
1437
2 - unrepresentable changes
1442
Shows the difference in the working tree versus the last commit::
1446
Difference between the working tree and revision 1::
1450
Difference between revision 2 and revision 1::
1454
Difference between revision 2 and revision 1 for branch xxx::
1458
Show just the differences for file NEWS::
1462
Show the differences in working tree xxx for file NEWS::
1466
Show the differences from branch xxx to this working tree:
1470
Show the differences between two branches for file NEWS::
1472
bzr diff --old xxx --new yyy NEWS
1474
Same as 'bzr diff' but prefix paths with old/ and new/::
1476
bzr diff --prefix old/:new/
1478
_see_also = ['status']
1479
takes_args = ['file*']
1481
Option('diff-options', type=str,
1482
help='Pass these options to the external diff program.'),
1483
Option('prefix', type=str,
1485
help='Set prefixes added to old and new filenames, as '
1486
'two values separated by a colon. (eg "old/:new/").'),
1488
help='Branch/tree to compare from.',
1492
help='Branch/tree to compare to.',
1498
help='Use this command to compare files.',
1502
aliases = ['di', 'dif']
1503
encoding_type = 'exact'
1506
def run(self, revision=None, file_list=None, diff_options=None,
1507
prefix=None, old=None, new=None, using=None):
1508
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1510
if (prefix is None) or (prefix == '0'):
1518
old_label, new_label = prefix.split(":")
1520
raise errors.BzrCommandError(
1521
'--prefix expects two values separated by a colon'
1522
' (eg "old/:new/")')
1524
if revision and len(revision) > 2:
1525
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1526
' one or two revision specifiers')
1528
old_tree, new_tree, specific_files, extra_trees = \
1529
_get_trees_to_diff(file_list, revision, old, new)
1530
return show_diff_trees(old_tree, new_tree, sys.stdout,
1531
specific_files=specific_files,
1532
external_diff_options=diff_options,
1533
old_label=old_label, new_label=new_label,
1534
extra_trees=extra_trees, using=using)
1537
class cmd_deleted(Command):
1538
"""List files deleted in the working tree.
1540
# TODO: Show files deleted since a previous revision, or
1541
# between two revisions.
1542
# TODO: Much more efficient way to do this: read in new
1543
# directories with readdir, rather than stating each one. Same
1544
# level of effort but possibly much less IO. (Or possibly not,
1545
# if the directories are very large...)
1546
_see_also = ['status', 'ls']
1547
takes_options = ['show-ids']
1550
def run(self, show_ids=False):
1551
tree = WorkingTree.open_containing(u'.')[0]
1554
old = tree.basis_tree()
1557
for path, ie in old.inventory.iter_entries():
1558
if not tree.has_id(ie.file_id):
1559
self.outf.write(path)
1561
self.outf.write(' ')
1562
self.outf.write(ie.file_id)
1563
self.outf.write('\n')
1570
class cmd_modified(Command):
1571
"""List files modified in working tree.
1575
_see_also = ['status', 'ls']
1578
help='Write an ascii NUL (\\0) separator '
1579
'between files rather than a newline.')
1583
def run(self, null=False):
1584
tree = WorkingTree.open_containing(u'.')[0]
1585
td = tree.changes_from(tree.basis_tree())
1586
for path, id, kind, text_modified, meta_modified in td.modified:
1588
self.outf.write(path + '\0')
1590
self.outf.write(osutils.quotefn(path) + '\n')
1593
class cmd_added(Command):
1594
"""List files added in working tree.
1598
_see_also = ['status', 'ls']
1601
help='Write an ascii NUL (\\0) separator '
1602
'between files rather than a newline.')
1606
def run(self, null=False):
1607
wt = WorkingTree.open_containing(u'.')[0]
1610
basis = wt.basis_tree()
1613
basis_inv = basis.inventory
1616
if file_id in basis_inv:
1618
if inv.is_root(file_id) and len(basis_inv) == 0:
1620
path = inv.id2path(file_id)
1621
if not os.access(osutils.abspath(path), os.F_OK):
1624
self.outf.write(path + '\0')
1626
self.outf.write(osutils.quotefn(path) + '\n')
1633
class cmd_root(Command):
1634
"""Show the tree root directory.
1636
The root is the nearest enclosing directory with a .bzr control
1639
takes_args = ['filename?']
1641
def run(self, filename=None):
1642
"""Print the branch root."""
1643
tree = WorkingTree.open_containing(filename)[0]
1644
self.outf.write(tree.basedir + '\n')
1647
def _parse_limit(limitstring):
1649
return int(limitstring)
1651
msg = "The limit argument must be an integer."
1652
raise errors.BzrCommandError(msg)
1655
class cmd_log(Command):
1656
"""Show log of a branch, file, or directory.
1658
By default show the log of the branch containing the working directory.
1660
To request a range of logs, you can use the command -r begin..end
1661
-r revision requests a specific revision, -r ..end or -r begin.. are
1665
Log the current branch::
1673
Log the last 10 revisions of a branch::
1675
bzr log -r -10.. http://server/branch
1678
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1680
takes_args = ['location?']
1683
help='Show from oldest to newest.'),
1686
help='Display timezone as local, original, or utc.'),
1687
custom_help('verbose',
1688
help='Show files changed in each revision.'),
1692
type=bzrlib.option._parse_revision_str,
1694
help='Show just the specified revision.'
1695
' See also "help revisionspec".'),
1699
help='Show revisions whose message matches this '
1700
'regular expression.',
1704
help='Limit the output to the first N revisions.',
1708
encoding_type = 'replace'
1711
def run(self, location=None, timezone='original',
1720
from bzrlib.log import show_log
1721
direction = (forward and 'forward') or 'reverse'
1723
if change is not None:
1725
raise errors.RangeInChangeOption()
1726
if revision is not None:
1727
raise errors.BzrCommandError(
1728
'--revision and --change are mutually exclusive')
1735
# find the file id to log:
1737
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1741
tree = b.basis_tree()
1742
file_id = tree.path2id(fp)
1744
raise errors.BzrCommandError(
1745
"Path does not have any revision history: %s" %
1749
# FIXME ? log the current subdir only RBC 20060203
1750
if revision is not None \
1751
and len(revision) > 0 and revision[0].get_branch():
1752
location = revision[0].get_branch()
1755
dir, relpath = bzrdir.BzrDir.open_containing(location)
1756
b = dir.open_branch()
1760
if revision is None:
1763
elif len(revision) == 1:
1764
rev1 = rev2 = revision[0].in_history(b)
1765
elif len(revision) == 2:
1766
if revision[1].get_branch() != revision[0].get_branch():
1767
# b is taken from revision[0].get_branch(), and
1768
# show_log will use its revision_history. Having
1769
# different branches will lead to weird behaviors.
1770
raise errors.BzrCommandError(
1771
"Log doesn't accept two revisions in different"
1773
rev1 = revision[0].in_history(b)
1774
rev2 = revision[1].in_history(b)
1776
raise errors.BzrCommandError(
1777
'bzr log --revision takes one or two values.')
1779
if log_format is None:
1780
log_format = log.log_formatter_registry.get_default(b)
1782
lf = log_format(show_ids=show_ids, to_file=self.outf,
1783
show_timezone=timezone)
1789
direction=direction,
1790
start_revision=rev1,
1798
def get_log_format(long=False, short=False, line=False, default='long'):
1799
log_format = default
1803
log_format = 'short'
1809
class cmd_touching_revisions(Command):
1810
"""Return revision-ids which affected a particular file.
1812
A more user-friendly interface is "bzr log FILE".
1816
takes_args = ["filename"]
1819
def run(self, filename):
1820
tree, relpath = WorkingTree.open_containing(filename)
1822
file_id = tree.path2id(relpath)
1823
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1824
self.outf.write("%6d %s\n" % (revno, what))
1827
class cmd_ls(Command):
1828
"""List files in a tree.
1831
_see_also = ['status', 'cat']
1832
takes_args = ['path?']
1833
# TODO: Take a revision or remote path and list that tree instead.
1837
Option('non-recursive',
1838
help='Don\'t recurse into subdirectories.'),
1840
help='Print paths relative to the root of the branch.'),
1841
Option('unknown', help='Print unknown files.'),
1842
Option('versioned', help='Print versioned files.',
1844
Option('ignored', help='Print ignored files.'),
1846
help='Write an ascii NUL (\\0) separator '
1847
'between files rather than a newline.'),
1849
help='List entries of a particular kind: file, directory, symlink.',
1854
def run(self, revision=None, verbose=False,
1855
non_recursive=False, from_root=False,
1856
unknown=False, versioned=False, ignored=False,
1857
null=False, kind=None, show_ids=False, path=None):
1859
if kind and kind not in ('file', 'directory', 'symlink'):
1860
raise errors.BzrCommandError('invalid kind specified')
1862
if verbose and null:
1863
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1864
all = not (unknown or versioned or ignored)
1866
selection = {'I':ignored, '?':unknown, 'V':versioned}
1873
raise errors.BzrCommandError('cannot specify both --from-root'
1877
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1883
if revision is not None or tree is None:
1884
tree = _get_one_revision_tree('ls', revision, branch=branch)
1888
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1889
if fp.startswith(relpath):
1890
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1891
if non_recursive and '/' in fp:
1893
if not all and not selection[fc]:
1895
if kind is not None and fkind != kind:
1898
kindch = entry.kind_character()
1899
outstring = '%-8s %s%s' % (fc, fp, kindch)
1900
if show_ids and fid is not None:
1901
outstring = "%-50s %s" % (outstring, fid)
1902
self.outf.write(outstring + '\n')
1904
self.outf.write(fp + '\0')
1907
self.outf.write(fid)
1908
self.outf.write('\0')
1916
self.outf.write('%-50s %s\n' % (fp, my_id))
1918
self.outf.write(fp + '\n')
1923
class cmd_unknowns(Command):
1924
"""List unknown files.
1932
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1933
self.outf.write(osutils.quotefn(f) + '\n')
1936
class cmd_ignore(Command):
1937
"""Ignore specified files or patterns.
1939
See ``bzr help patterns`` for details on the syntax of patterns.
1941
To remove patterns from the ignore list, edit the .bzrignore file.
1942
After adding, editing or deleting that file either indirectly by
1943
using this command or directly by using an editor, be sure to commit
1946
Note: ignore patterns containing shell wildcards must be quoted from
1950
Ignore the top level Makefile::
1952
bzr ignore ./Makefile
1954
Ignore class files in all directories::
1956
bzr ignore "*.class"
1958
Ignore .o files under the lib directory::
1960
bzr ignore "lib/**/*.o"
1962
Ignore .o files under the lib directory::
1964
bzr ignore "RE:lib/.*\.o"
1966
Ignore everything but the "debian" toplevel directory::
1968
bzr ignore "RE:(?!debian/).*"
1971
_see_also = ['status', 'ignored', 'patterns']
1972
takes_args = ['name_pattern*']
1974
Option('old-default-rules',
1975
help='Write out the ignore rules bzr < 0.9 always used.')
1978
def run(self, name_pattern_list=None, old_default_rules=None):
1979
from bzrlib import ignores
1980
if old_default_rules is not None:
1981
# dump the rules and exit
1982
for pattern in ignores.OLD_DEFAULTS:
1985
if not name_pattern_list:
1986
raise errors.BzrCommandError("ignore requires at least one "
1987
"NAME_PATTERN or --old-default-rules")
1988
name_pattern_list = [globbing.normalize_pattern(p)
1989
for p in name_pattern_list]
1990
for name_pattern in name_pattern_list:
1991
if (name_pattern[0] == '/' or
1992
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1993
raise errors.BzrCommandError(
1994
"NAME_PATTERN should not be an absolute path")
1995
tree, relpath = WorkingTree.open_containing(u'.')
1996
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1997
ignored = globbing.Globster(name_pattern_list)
2000
for entry in tree.list_files():
2004
if ignored.match(filename):
2005
matches.append(filename.encode('utf-8'))
2007
if len(matches) > 0:
2008
print "Warning: the following files are version controlled and" \
2009
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2012
class cmd_ignored(Command):
2013
"""List ignored files and the patterns that matched them.
2015
List all the ignored files and the ignore pattern that caused the file to
2018
Alternatively, to list just the files::
2023
encoding_type = 'replace'
2024
_see_also = ['ignore', 'ls']
2028
tree = WorkingTree.open_containing(u'.')[0]
2031
for path, file_class, kind, file_id, entry in tree.list_files():
2032
if file_class != 'I':
2034
## XXX: Slightly inefficient since this was already calculated
2035
pat = tree.is_ignored(path)
2036
self.outf.write('%-50s %s\n' % (path, pat))
2041
class cmd_lookup_revision(Command):
2042
"""Lookup the revision-id from a revision-number
2045
bzr lookup-revision 33
2048
takes_args = ['revno']
2051
def run(self, revno):
2055
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2057
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2060
class cmd_export(Command):
2061
"""Export current or past revision to a destination directory or archive.
2063
If no revision is specified this exports the last committed revision.
2065
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2066
given, try to find the format with the extension. If no extension
2067
is found exports to a directory (equivalent to --format=dir).
2069
If root is supplied, it will be used as the root directory inside
2070
container formats (tar, zip, etc). If it is not supplied it will default
2071
to the exported filename. The root option has no effect for 'dir' format.
2073
If branch is omitted then the branch containing the current working
2074
directory will be used.
2076
Note: Export of tree with non-ASCII filenames to zip is not supported.
2078
================= =========================
2079
Supported formats Autodetected by extension
2080
================= =========================
2083
tbz2 .tar.bz2, .tbz2
2086
================= =========================
2088
takes_args = ['dest', 'branch_or_subdir?']
2091
help="Type of file to export to.",
2096
help="Name of the root directory inside the exported file."),
2098
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2100
from bzrlib.export import export
2102
if branch_or_subdir is None:
2103
tree = WorkingTree.open_containing(u'.')[0]
2107
b, subdir = Branch.open_containing(branch_or_subdir)
2110
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2112
export(rev_tree, dest, format, root, subdir)
2113
except errors.NoSuchExportFormat, e:
2114
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2117
class cmd_cat(Command):
2118
"""Write the contents of a file as of a given revision to standard output.
2120
If no revision is nominated, the last revision is used.
2122
Note: Take care to redirect standard output when using this command on a
2128
Option('name-from-revision', help='The path name in the old tree.'),
2131
takes_args = ['filename']
2132
encoding_type = 'exact'
2135
def run(self, filename, revision=None, name_from_revision=False):
2136
if revision is not None and len(revision) != 1:
2137
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2138
" one revision specifier")
2139
tree, branch, relpath = \
2140
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2143
return self._run(tree, branch, relpath, filename, revision,
2148
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2150
tree = b.basis_tree()
2151
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2153
cur_file_id = tree.path2id(relpath)
2154
old_file_id = rev_tree.path2id(relpath)
2156
if name_from_revision:
2157
if old_file_id is None:
2158
raise errors.BzrCommandError(
2159
"%r is not present in revision %s" % (
2160
filename, rev_tree.get_revision_id()))
2162
content = rev_tree.get_file_text(old_file_id)
2163
elif cur_file_id is not None:
2164
content = rev_tree.get_file_text(cur_file_id)
2165
elif old_file_id is not None:
2166
content = rev_tree.get_file_text(old_file_id)
2168
raise errors.BzrCommandError(
2169
"%r is not present in revision %s" % (
2170
filename, rev_tree.get_revision_id()))
2171
self.outf.write(content)
2174
class cmd_local_time_offset(Command):
2175
"""Show the offset in seconds from GMT to local time."""
2179
print osutils.local_time_offset()
2183
class cmd_commit(Command):
2184
"""Commit changes into a new revision.
2186
If no arguments are given, the entire tree is committed.
2188
If selected files are specified, only changes to those files are
2189
committed. If a directory is specified then the directory and everything
2190
within it is committed.
2192
When excludes are given, they take precedence over selected files.
2193
For example, too commit only changes within foo, but not changes within
2196
bzr commit foo -x foo/bar
2198
If author of the change is not the same person as the committer, you can
2199
specify the author's name using the --author option. The name should be
2200
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2202
A selected-file commit may fail in some cases where the committed
2203
tree would be invalid. Consider::
2208
bzr commit foo -m "committing foo"
2209
bzr mv foo/bar foo/baz
2212
bzr commit foo/bar -m "committing bar but not baz"
2214
In the example above, the last commit will fail by design. This gives
2215
the user the opportunity to decide whether they want to commit the
2216
rename at the same time, separately first, or not at all. (As a general
2217
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2219
Note: A selected-file commit after a merge is not yet supported.
2221
# TODO: Run hooks on tree to-be-committed, and after commit.
2223
# TODO: Strict commit that fails if there are deleted files.
2224
# (what does "deleted files" mean ??)
2226
# TODO: Give better message for -s, --summary, used by tla people
2228
# XXX: verbose currently does nothing
2230
_see_also = ['bugs', 'uncommit']
2231
takes_args = ['selected*']
2233
ListOption('exclude', type=str, short_name='x',
2234
help="Do not consider changes made to a given path."),
2235
Option('message', type=unicode,
2237
help="Description of the new revision."),
2240
help='Commit even if nothing has changed.'),
2241
Option('file', type=str,
2244
help='Take commit message from this file.'),
2246
help="Refuse to commit if there are unknown "
2247
"files in the working tree."),
2248
ListOption('fixes', type=str,
2249
help="Mark a bug as being fixed by this revision."),
2250
Option('author', type=unicode,
2251
help="Set the author's name, if it's different "
2252
"from the committer."),
2254
help="Perform a local commit in a bound "
2255
"branch. Local commits are not pushed to "
2256
"the master branch until a normal commit "
2260
help='When no message is supplied, show the diff along'
2261
' with the status summary in the message editor.'),
2263
aliases = ['ci', 'checkin']
2265
def _get_bug_fix_properties(self, fixes, branch):
2267
# Configure the properties for bug fixing attributes.
2268
for fixed_bug in fixes:
2269
tokens = fixed_bug.split(':')
2270
if len(tokens) != 2:
2271
raise errors.BzrCommandError(
2272
"Invalid bug %s. Must be in the form of 'tag:id'. "
2273
"Commit refused." % fixed_bug)
2274
tag, bug_id = tokens
2276
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2277
except errors.UnknownBugTrackerAbbreviation:
2278
raise errors.BzrCommandError(
2279
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2280
except errors.MalformedBugIdentifier:
2281
raise errors.BzrCommandError(
2282
"Invalid bug identifier for %s. Commit refused."
2284
properties.append('%s fixed' % bug_url)
2285
return '\n'.join(properties)
2287
def run(self, message=None, file=None, verbose=False, selected_list=None,
2288
unchanged=False, strict=False, local=False, fixes=None,
2289
author=None, show_diff=False, exclude=None):
2290
from bzrlib.errors import (
2295
from bzrlib.msgeditor import (
2296
edit_commit_message_encoded,
2297
make_commit_message_template_encoded
2300
# TODO: Need a blackbox test for invoking the external editor; may be
2301
# slightly problematic to run this cross-platform.
2303
# TODO: do more checks that the commit will succeed before
2304
# spending the user's valuable time typing a commit message.
2308
tree, selected_list = tree_files(selected_list)
2309
if selected_list == ['']:
2310
# workaround - commit of root of tree should be exactly the same
2311
# as just default commit in that tree, and succeed even though
2312
# selected-file merge commit is not done yet
2317
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2319
properties['bugs'] = bug_property
2321
if local and not tree.branch.get_bound_location():
2322
raise errors.LocalRequiresBoundBranch()
2324
def get_message(commit_obj):
2325
"""Callback to get commit message"""
2326
my_message = message
2327
if my_message is None and not file:
2328
t = make_commit_message_template_encoded(tree,
2329
selected_list, diff=show_diff,
2330
output_encoding=osutils.get_user_encoding())
2331
my_message = edit_commit_message_encoded(t)
2332
if my_message is None:
2333
raise errors.BzrCommandError("please specify a commit"
2334
" message with either --message or --file")
2335
elif my_message and file:
2336
raise errors.BzrCommandError(
2337
"please specify either --message or --file")
2339
my_message = codecs.open(file, 'rt',
2340
osutils.get_user_encoding()).read()
2341
if my_message == "":
2342
raise errors.BzrCommandError("empty commit message specified")
2346
tree.commit(message_callback=get_message,
2347
specific_files=selected_list,
2348
allow_pointless=unchanged, strict=strict, local=local,
2349
reporter=None, verbose=verbose, revprops=properties,
2351
exclude=safe_relpath_files(tree, exclude))
2352
except PointlessCommit:
2353
# FIXME: This should really happen before the file is read in;
2354
# perhaps prepare the commit; get the message; then actually commit
2355
raise errors.BzrCommandError("no changes to commit."
2356
" use --unchanged to commit anyhow")
2357
except ConflictsInTree:
2358
raise errors.BzrCommandError('Conflicts detected in working '
2359
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2361
except StrictCommitFailed:
2362
raise errors.BzrCommandError("Commit refused because there are"
2363
" unknown files in the working tree.")
2364
except errors.BoundBranchOutOfDate, e:
2365
raise errors.BzrCommandError(str(e) + "\n"
2366
'To commit to master branch, run update and then commit.\n'
2367
'You can also pass --local to commit to continue working '
2371
class cmd_check(Command):
2372
"""Validate working tree structure, branch consistency and repository history.
2374
This command checks various invariants about branch and repository storage
2375
to detect data corruption or bzr bugs.
2377
The working tree and branch checks will only give output if a problem is
2378
detected. The output fields of the repository check are:
2380
revisions: This is just the number of revisions checked. It doesn't
2382
versionedfiles: This is just the number of versionedfiles checked. It
2383
doesn't indicate a problem.
2384
unreferenced ancestors: Texts that are ancestors of other texts, but
2385
are not properly referenced by the revision ancestry. This is a
2386
subtle problem that Bazaar can work around.
2387
unique file texts: This is the total number of unique file contents
2388
seen in the checked revisions. It does not indicate a problem.
2389
repeated file texts: This is the total number of repeated texts seen
2390
in the checked revisions. Texts can be repeated when their file
2391
entries are modified, but the file contents are not. It does not
2394
If no restrictions are specified, all Bazaar data that is found at the given
2395
location will be checked.
2399
Check the tree and branch at 'foo'::
2401
bzr check --tree --branch foo
2403
Check only the repository at 'bar'::
2405
bzr check --repo bar
2407
Check everything at 'baz'::
2412
_see_also = ['reconcile']
2413
takes_args = ['path?']
2414
takes_options = ['verbose',
2415
Option('branch', help="Check the branch related to the"
2416
" current directory."),
2417
Option('repo', help="Check the repository related to the"
2418
" current directory."),
2419
Option('tree', help="Check the working tree related to"
2420
" the current directory.")]
2422
def run(self, path=None, verbose=False, branch=False, repo=False,
2424
from bzrlib.check import check_dwim
2427
if not branch and not repo and not tree:
2428
branch = repo = tree = True
2429
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2432
class cmd_upgrade(Command):
2433
"""Upgrade branch storage to current format.
2435
The check command or bzr developers may sometimes advise you to run
2436
this command. When the default format has changed you may also be warned
2437
during other operations to upgrade.
2440
_see_also = ['check']
2441
takes_args = ['url?']
2443
RegistryOption('format',
2444
help='Upgrade to a specific format. See "bzr help'
2445
' formats" for details.',
2446
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2447
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2448
value_switches=True, title='Branch format'),
2451
def run(self, url='.', format=None):
2452
from bzrlib.upgrade import upgrade
2454
format = bzrdir.format_registry.make_bzrdir('default')
2455
upgrade(url, format)
2458
class cmd_whoami(Command):
2459
"""Show or set bzr user id.
2462
Show the email of the current user::
2466
Set the current user::
2468
bzr whoami "Frank Chu <fchu@example.com>"
2470
takes_options = [ Option('email',
2471
help='Display email address only.'),
2473
help='Set identity for the current branch instead of '
2476
takes_args = ['name?']
2477
encoding_type = 'replace'
2480
def run(self, email=False, branch=False, name=None):
2482
# use branch if we're inside one; otherwise global config
2484
c = Branch.open_containing('.')[0].get_config()
2485
except errors.NotBranchError:
2486
c = config.GlobalConfig()
2488
self.outf.write(c.user_email() + '\n')
2490
self.outf.write(c.username() + '\n')
2493
# display a warning if an email address isn't included in the given name.
2495
config.extract_email_address(name)
2496
except errors.NoEmailInUsername, e:
2497
warning('"%s" does not seem to contain an email address. '
2498
'This is allowed, but not recommended.', name)
2500
# use global config unless --branch given
2502
c = Branch.open_containing('.')[0].get_config()
2504
c = config.GlobalConfig()
2505
c.set_user_option('email', name)
2508
class cmd_nick(Command):
2509
"""Print or set the branch nickname.
2511
If unset, the tree root directory name is used as the nickname
2512
To print the current nickname, execute with no argument.
2515
_see_also = ['info']
2516
takes_args = ['nickname?']
2517
def run(self, nickname=None):
2518
branch = Branch.open_containing(u'.')[0]
2519
if nickname is None:
2520
self.printme(branch)
2522
branch.nick = nickname
2525
def printme(self, branch):
2529
class cmd_alias(Command):
2530
"""Set/unset and display aliases.
2533
Show the current aliases::
2537
Show the alias specified for 'll'::
2541
Set an alias for 'll'::
2543
bzr alias ll="log --line -r-10..-1"
2545
To remove an alias for 'll'::
2547
bzr alias --remove ll
2550
takes_args = ['name?']
2552
Option('remove', help='Remove the alias.'),
2555
def run(self, name=None, remove=False):
2557
self.remove_alias(name)
2559
self.print_aliases()
2561
equal_pos = name.find('=')
2563
self.print_alias(name)
2565
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2567
def remove_alias(self, alias_name):
2568
if alias_name is None:
2569
raise errors.BzrCommandError(
2570
'bzr alias --remove expects an alias to remove.')
2571
# If alias is not found, print something like:
2572
# unalias: foo: not found
2573
c = config.GlobalConfig()
2574
c.unset_alias(alias_name)
2577
def print_aliases(self):
2578
"""Print out the defined aliases in a similar format to bash."""
2579
aliases = config.GlobalConfig().get_aliases()
2580
for key, value in sorted(aliases.iteritems()):
2581
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2584
def print_alias(self, alias_name):
2585
from bzrlib.commands import get_alias
2586
alias = get_alias(alias_name)
2588
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2591
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2593
def set_alias(self, alias_name, alias_command):
2594
"""Save the alias in the global config."""
2595
c = config.GlobalConfig()
2596
c.set_alias(alias_name, alias_command)
2599
class cmd_selftest(Command):
2600
"""Run internal test suite.
2602
If arguments are given, they are regular expressions that say which tests
2603
should run. Tests matching any expression are run, and other tests are
2606
Alternatively if --first is given, matching tests are run first and then
2607
all other tests are run. This is useful if you have been working in a
2608
particular area, but want to make sure nothing else was broken.
2610
If --exclude is given, tests that match that regular expression are
2611
excluded, regardless of whether they match --first or not.
2613
To help catch accidential dependencies between tests, the --randomize
2614
option is useful. In most cases, the argument used is the word 'now'.
2615
Note that the seed used for the random number generator is displayed
2616
when this option is used. The seed can be explicitly passed as the
2617
argument to this option if required. This enables reproduction of the
2618
actual ordering used if and when an order sensitive problem is encountered.
2620
If --list-only is given, the tests that would be run are listed. This is
2621
useful when combined with --first, --exclude and/or --randomize to
2622
understand their impact. The test harness reports "Listed nn tests in ..."
2623
instead of "Ran nn tests in ..." when list mode is enabled.
2625
If the global option '--no-plugins' is given, plugins are not loaded
2626
before running the selftests. This has two effects: features provided or
2627
modified by plugins will not be tested, and tests provided by plugins will
2630
Tests that need working space on disk use a common temporary directory,
2631
typically inside $TMPDIR or /tmp.
2634
Run only tests relating to 'ignore'::
2638
Disable plugins and list tests as they're run::
2640
bzr --no-plugins selftest -v
2642
# NB: this is used from the class without creating an instance, which is
2643
# why it does not have a self parameter.
2644
def get_transport_type(typestring):
2645
"""Parse and return a transport specifier."""
2646
if typestring == "sftp":
2647
from bzrlib.transport.sftp import SFTPAbsoluteServer
2648
return SFTPAbsoluteServer
2649
if typestring == "memory":
2650
from bzrlib.transport.memory import MemoryServer
2652
if typestring == "fakenfs":
2653
from bzrlib.transport.fakenfs import FakeNFSServer
2654
return FakeNFSServer
2655
msg = "No known transport type %s. Supported types are: sftp\n" %\
2657
raise errors.BzrCommandError(msg)
2660
takes_args = ['testspecs*']
2661
takes_options = ['verbose',
2663
help='Stop when one test fails.',
2667
help='Use a different transport by default '
2668
'throughout the test suite.',
2669
type=get_transport_type),
2671
help='Run the benchmarks rather than selftests.'),
2672
Option('lsprof-timed',
2673
help='Generate lsprof output for benchmarked'
2674
' sections of code.'),
2675
Option('cache-dir', type=str,
2676
help='Cache intermediate benchmark output in this '
2679
help='Run all tests, but run specified tests first.',
2683
help='List the tests instead of running them.'),
2684
Option('randomize', type=str, argname="SEED",
2685
help='Randomize the order of tests using the given'
2686
' seed or "now" for the current time.'),
2687
Option('exclude', type=str, argname="PATTERN",
2689
help='Exclude tests that match this regular'
2691
Option('strict', help='Fail on missing dependencies or '
2693
Option('load-list', type=str, argname='TESTLISTFILE',
2694
help='Load a test id list from a text file.'),
2695
ListOption('debugflag', type=str, short_name='E',
2696
help='Turn on a selftest debug flag.'),
2697
ListOption('starting-with', type=str, argname='TESTID',
2698
param_name='starting_with', short_name='s',
2700
'Load only the tests starting with TESTID.'),
2702
encoding_type = 'replace'
2704
def run(self, testspecs_list=None, verbose=False, one=False,
2705
transport=None, benchmark=None,
2706
lsprof_timed=None, cache_dir=None,
2707
first=False, list_only=False,
2708
randomize=None, exclude=None, strict=False,
2709
load_list=None, debugflag=None, starting_with=None):
2710
from bzrlib.tests import selftest
2711
import bzrlib.benchmarks as benchmarks
2712
from bzrlib.benchmarks import tree_creator
2714
# Make deprecation warnings visible, unless -Werror is set
2715
symbol_versioning.activate_deprecation_warnings(override=False)
2717
if cache_dir is not None:
2718
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2720
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2721
print ' %s (%s python%s)' % (
2723
bzrlib.version_string,
2724
bzrlib._format_version_tuple(sys.version_info),
2727
if testspecs_list is not None:
2728
pattern = '|'.join(testspecs_list)
2732
test_suite_factory = benchmarks.test_suite
2733
# Unless user explicitly asks for quiet, be verbose in benchmarks
2734
verbose = not is_quiet()
2735
# TODO: should possibly lock the history file...
2736
benchfile = open(".perf_history", "at", buffering=1)
2738
test_suite_factory = None
2741
result = selftest(verbose=verbose,
2743
stop_on_failure=one,
2744
transport=transport,
2745
test_suite_factory=test_suite_factory,
2746
lsprof_timed=lsprof_timed,
2747
bench_history=benchfile,
2748
matching_tests_first=first,
2749
list_only=list_only,
2750
random_seed=randomize,
2751
exclude_pattern=exclude,
2753
load_list=load_list,
2754
debug_flags=debugflag,
2755
starting_with=starting_with,
2758
if benchfile is not None:
2761
note('tests passed')
2763
note('tests failed')
2764
return int(not result)
2767
class cmd_version(Command):
2768
"""Show version of bzr."""
2770
encoding_type = 'replace'
2772
Option("short", help="Print just the version number."),
2776
def run(self, short=False):
2777
from bzrlib.version import show_version
2779
self.outf.write(bzrlib.version_string + '\n')
2781
show_version(to_file=self.outf)
2784
class cmd_rocks(Command):
2785
"""Statement of optimism."""
2791
print "It sure does!"
2794
class cmd_find_merge_base(Command):
2795
"""Find and print a base revision for merging two branches."""
2796
# TODO: Options to specify revisions on either side, as if
2797
# merging only part of the history.
2798
takes_args = ['branch', 'other']
2802
def run(self, branch, other):
2803
from bzrlib.revision import ensure_null
2805
branch1 = Branch.open_containing(branch)[0]
2806
branch2 = Branch.open_containing(other)[0]
2811
last1 = ensure_null(branch1.last_revision())
2812
last2 = ensure_null(branch2.last_revision())
2814
graph = branch1.repository.get_graph(branch2.repository)
2815
base_rev_id = graph.find_unique_lca(last1, last2)
2817
print 'merge base is revision %s' % base_rev_id
2824
class cmd_merge(Command):
2825
"""Perform a three-way merge.
2827
The source of the merge can be specified either in the form of a branch,
2828
or in the form of a path to a file containing a merge directive generated
2829
with bzr send. If neither is specified, the default is the upstream branch
2830
or the branch most recently merged using --remember.
2832
When merging a branch, by default the tip will be merged. To pick a different
2833
revision, pass --revision. If you specify two values, the first will be used as
2834
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2835
available revisions, like this is commonly referred to as "cherrypicking".
2837
Revision numbers are always relative to the branch being merged.
2839
By default, bzr will try to merge in all new work from the other
2840
branch, automatically determining an appropriate base. If this
2841
fails, you may need to give an explicit base.
2843
Merge will do its best to combine the changes in two branches, but there
2844
are some kinds of problems only a human can fix. When it encounters those,
2845
it will mark a conflict. A conflict means that you need to fix something,
2846
before you should commit.
2848
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2850
If there is no default branch set, the first merge will set it. After
2851
that, you can omit the branch to use the default. To change the
2852
default, use --remember. The value will only be saved if the remote
2853
location can be accessed.
2855
The results of the merge are placed into the destination working
2856
directory, where they can be reviewed (with bzr diff), tested, and then
2857
committed to record the result of the merge.
2859
merge refuses to run if there are any uncommitted changes, unless
2863
To merge the latest revision from bzr.dev::
2865
bzr merge ../bzr.dev
2867
To merge changes up to and including revision 82 from bzr.dev::
2869
bzr merge -r 82 ../bzr.dev
2871
To merge the changes introduced by 82, without previous changes::
2873
bzr merge -r 81..82 ../bzr.dev
2875
To apply a merge directive contained in in /tmp/merge:
2877
bzr merge /tmp/merge
2880
encoding_type = 'exact'
2881
_see_also = ['update', 'remerge', 'status-flags']
2882
takes_args = ['location?']
2887
help='Merge even if the destination tree has uncommitted changes.'),
2891
Option('show-base', help="Show base revision text in "
2893
Option('uncommitted', help='Apply uncommitted changes'
2894
' from a working copy, instead of branch changes.'),
2895
Option('pull', help='If the destination is already'
2896
' completely merged into the source, pull from the'
2897
' source rather than merging. When this happens,'
2898
' you do not need to commit the result.'),
2900
help='Branch to merge into, '
2901
'rather than the one containing the working directory.',
2905
Option('preview', help='Instead of merging, show a diff of the merge.')
2908
def run(self, location=None, revision=None, force=False,
2909
merge_type=None, show_base=False, reprocess=False, remember=False,
2910
uncommitted=False, pull=False,
2914
if merge_type is None:
2915
merge_type = _mod_merge.Merge3Merger
2917
if directory is None: directory = u'.'
2918
possible_transports = []
2920
allow_pending = True
2921
verified = 'inapplicable'
2922
tree = WorkingTree.open_containing(directory)[0]
2923
change_reporter = delta._ChangeReporter(
2924
unversioned_filter=tree.is_ignored)
2927
pb = ui.ui_factory.nested_progress_bar()
2928
cleanups.append(pb.finished)
2930
cleanups.append(tree.unlock)
2931
if location is not None:
2933
mergeable = bundle.read_mergeable_from_url(location,
2934
possible_transports=possible_transports)
2935
except errors.NotABundle:
2939
raise errors.BzrCommandError('Cannot use --uncommitted'
2940
' with bundles or merge directives.')
2942
if revision is not None:
2943
raise errors.BzrCommandError(
2944
'Cannot use -r with merge directives or bundles')
2945
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2948
if merger is None and uncommitted:
2949
if revision is not None and len(revision) > 0:
2950
raise errors.BzrCommandError('Cannot use --uncommitted and'
2951
' --revision at the same time.')
2952
location = self._select_branch_location(tree, location)[0]
2953
other_tree, other_path = WorkingTree.open_containing(location)
2954
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2956
allow_pending = False
2957
if other_path != '':
2958
merger.interesting_files = [other_path]
2961
merger, allow_pending = self._get_merger_from_branch(tree,
2962
location, revision, remember, possible_transports, pb)
2964
merger.merge_type = merge_type
2965
merger.reprocess = reprocess
2966
merger.show_base = show_base
2967
self.sanity_check_merger(merger)
2968
if (merger.base_rev_id == merger.other_rev_id and
2969
merger.other_rev_id is not None):
2970
note('Nothing to do.')
2973
if merger.interesting_files is not None:
2974
raise errors.BzrCommandError('Cannot pull individual files')
2975
if (merger.base_rev_id == tree.last_revision()):
2976
result = tree.pull(merger.other_branch, False,
2977
merger.other_rev_id)
2978
result.report(self.outf)
2980
merger.check_basis(not force)
2982
return self._do_preview(merger)
2984
return self._do_merge(merger, change_reporter, allow_pending,
2987
for cleanup in reversed(cleanups):
2990
def _do_preview(self, merger):
2991
from bzrlib.diff import show_diff_trees
2992
tree_merger = merger.make_merger()
2993
tt = tree_merger.make_preview_transform()
2995
result_tree = tt.get_preview_tree()
2996
show_diff_trees(merger.this_tree, result_tree, self.outf,
2997
old_label='', new_label='')
3001
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3002
merger.change_reporter = change_reporter
3003
conflict_count = merger.do_merge()
3005
merger.set_pending()
3006
if verified == 'failed':
3007
warning('Preview patch does not match changes')
3008
if conflict_count != 0:
3013
def sanity_check_merger(self, merger):
3014
if (merger.show_base and
3015
not merger.merge_type is _mod_merge.Merge3Merger):
3016
raise errors.BzrCommandError("Show-base is not supported for this"
3017
" merge type. %s" % merger.merge_type)
3018
if merger.reprocess and not merger.merge_type.supports_reprocess:
3019
raise errors.BzrCommandError("Conflict reduction is not supported"
3020
" for merge type %s." %
3022
if merger.reprocess and merger.show_base:
3023
raise errors.BzrCommandError("Cannot do conflict reduction and"
3026
def _get_merger_from_branch(self, tree, location, revision, remember,
3027
possible_transports, pb):
3028
"""Produce a merger from a location, assuming it refers to a branch."""
3029
from bzrlib.tag import _merge_tags_if_possible
3030
# find the branch locations
3031
other_loc, user_location = self._select_branch_location(tree, location,
3033
if revision is not None and len(revision) == 2:
3034
base_loc, _unused = self._select_branch_location(tree,
3035
location, revision, 0)
3037
base_loc = other_loc
3039
other_branch, other_path = Branch.open_containing(other_loc,
3040
possible_transports)
3041
if base_loc == other_loc:
3042
base_branch = other_branch
3044
base_branch, base_path = Branch.open_containing(base_loc,
3045
possible_transports)
3046
# Find the revision ids
3047
if revision is None or len(revision) < 1 or revision[-1] is None:
3048
other_revision_id = _mod_revision.ensure_null(
3049
other_branch.last_revision())
3051
other_revision_id = revision[-1].as_revision_id(other_branch)
3052
if (revision is not None and len(revision) == 2
3053
and revision[0] is not None):
3054
base_revision_id = revision[0].as_revision_id(base_branch)
3056
base_revision_id = None
3057
# Remember where we merge from
3058
if ((remember or tree.branch.get_submit_branch() is None) and
3059
user_location is not None):
3060
tree.branch.set_submit_branch(other_branch.base)
3061
_merge_tags_if_possible(other_branch, tree.branch)
3062
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3063
other_revision_id, base_revision_id, other_branch, base_branch)
3064
if other_path != '':
3065
allow_pending = False
3066
merger.interesting_files = [other_path]
3068
allow_pending = True
3069
return merger, allow_pending
3071
def _select_branch_location(self, tree, user_location, revision=None,
3073
"""Select a branch location, according to possible inputs.
3075
If provided, branches from ``revision`` are preferred. (Both
3076
``revision`` and ``index`` must be supplied.)
3078
Otherwise, the ``location`` parameter is used. If it is None, then the
3079
``submit`` or ``parent`` location is used, and a note is printed.
3081
:param tree: The working tree to select a branch for merging into
3082
:param location: The location entered by the user
3083
:param revision: The revision parameter to the command
3084
:param index: The index to use for the revision parameter. Negative
3085
indices are permitted.
3086
:return: (selected_location, user_location). The default location
3087
will be the user-entered location.
3089
if (revision is not None and index is not None
3090
and revision[index] is not None):
3091
branch = revision[index].get_branch()
3092
if branch is not None:
3093
return branch, branch
3094
if user_location is None:
3095
location = self._get_remembered(tree, 'Merging from')
3097
location = user_location
3098
return location, user_location
3100
def _get_remembered(self, tree, verb_string):
3101
"""Use tree.branch's parent if none was supplied.
3103
Report if the remembered location was used.
3105
stored_location = tree.branch.get_submit_branch()
3106
stored_location_type = "submit"
3107
if stored_location is None:
3108
stored_location = tree.branch.get_parent()
3109
stored_location_type = "parent"
3110
mutter("%s", stored_location)
3111
if stored_location is None:
3112
raise errors.BzrCommandError("No location specified or remembered")
3113
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3114
note(u"%s remembered %s location %s", verb_string,
3115
stored_location_type, display_url)
3116
return stored_location
3119
class cmd_remerge(Command):
3122
Use this if you want to try a different merge technique while resolving
3123
conflicts. Some merge techniques are better than others, and remerge
3124
lets you try different ones on different files.
3126
The options for remerge have the same meaning and defaults as the ones for
3127
merge. The difference is that remerge can (only) be run when there is a
3128
pending merge, and it lets you specify particular files.
3131
Re-do the merge of all conflicted files, and show the base text in
3132
conflict regions, in addition to the usual THIS and OTHER texts::
3134
bzr remerge --show-base
3136
Re-do the merge of "foobar", using the weave merge algorithm, with
3137
additional processing to reduce the size of conflict regions::
3139
bzr remerge --merge-type weave --reprocess foobar
3141
takes_args = ['file*']
3146
help="Show base revision text in conflicts."),
3149
def run(self, file_list=None, merge_type=None, show_base=False,
3151
if merge_type is None:
3152
merge_type = _mod_merge.Merge3Merger
3153
tree, file_list = tree_files(file_list)
3156
parents = tree.get_parent_ids()
3157
if len(parents) != 2:
3158
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3159
" merges. Not cherrypicking or"
3161
repository = tree.branch.repository
3162
interesting_ids = None
3164
conflicts = tree.conflicts()
3165
if file_list is not None:
3166
interesting_ids = set()
3167
for filename in file_list:
3168
file_id = tree.path2id(filename)
3170
raise errors.NotVersionedError(filename)
3171
interesting_ids.add(file_id)
3172
if tree.kind(file_id) != "directory":
3175
for name, ie in tree.inventory.iter_entries(file_id):
3176
interesting_ids.add(ie.file_id)
3177
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3179
# Remerge only supports resolving contents conflicts
3180
allowed_conflicts = ('text conflict', 'contents conflict')
3181
restore_files = [c.path for c in conflicts
3182
if c.typestring in allowed_conflicts]
3183
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3184
tree.set_conflicts(ConflictList(new_conflicts))
3185
if file_list is not None:
3186
restore_files = file_list
3187
for filename in restore_files:
3189
restore(tree.abspath(filename))
3190
except errors.NotConflicted:
3192
# Disable pending merges, because the file texts we are remerging
3193
# have not had those merges performed. If we use the wrong parents
3194
# list, we imply that the working tree text has seen and rejected
3195
# all the changes from the other tree, when in fact those changes
3196
# have not yet been seen.
3197
pb = ui.ui_factory.nested_progress_bar()
3198
tree.set_parent_ids(parents[:1])
3200
merger = _mod_merge.Merger.from_revision_ids(pb,
3202
merger.interesting_ids = interesting_ids
3203
merger.merge_type = merge_type
3204
merger.show_base = show_base
3205
merger.reprocess = reprocess
3206
conflicts = merger.do_merge()
3208
tree.set_parent_ids(parents)
3218
class cmd_revert(Command):
3219
"""Revert files to a previous revision.
3221
Giving a list of files will revert only those files. Otherwise, all files
3222
will be reverted. If the revision is not specified with '--revision', the
3223
last committed revision is used.
3225
To remove only some changes, without reverting to a prior version, use
3226
merge instead. For example, "merge . --revision -2..-3" will remove the
3227
changes introduced by -2, without affecting the changes introduced by -1.
3228
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3230
By default, any files that have been manually changed will be backed up
3231
first. (Files changed only by merge are not backed up.) Backup files have
3232
'.~#~' appended to their name, where # is a number.
3234
When you provide files, you can use their current pathname or the pathname
3235
from the target revision. So you can use revert to "undelete" a file by
3236
name. If you name a directory, all the contents of that directory will be
3239
Any files that have been newly added since that revision will be deleted,
3240
with a backup kept if appropriate. Directories containing unknown files
3241
will not be deleted.
3243
The working tree contains a list of pending merged revisions, which will
3244
be included as parents in the next commit. Normally, revert clears that
3245
list as well as reverting the files. If any files are specified, revert
3246
leaves the pending merge list alone and reverts only the files. Use "bzr
3247
revert ." in the tree root to revert all files but keep the merge record,
3248
and "bzr revert --forget-merges" to clear the pending merge list without
3249
reverting any files.
3252
_see_also = ['cat', 'export']
3255
Option('no-backup', "Do not save backups of reverted files."),
3256
Option('forget-merges',
3257
'Remove pending merge marker, without changing any files.'),
3259
takes_args = ['file*']
3261
def run(self, revision=None, no_backup=False, file_list=None,
3262
forget_merges=None):
3263
tree, file_list = tree_files(file_list)
3267
tree.set_parent_ids(tree.get_parent_ids()[:1])
3269
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3274
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3275
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3276
pb = ui.ui_factory.nested_progress_bar()
3278
tree.revert(file_list, rev_tree, not no_backup, pb,
3279
report_changes=True)
3284
class cmd_assert_fail(Command):
3285
"""Test reporting of assertion failures"""
3286
# intended just for use in testing
3291
raise AssertionError("always fails")
3294
class cmd_help(Command):
3295
"""Show help on a command or other topic.
3298
_see_also = ['topics']
3300
Option('long', 'Show help on all commands.'),
3302
takes_args = ['topic?']
3303
aliases = ['?', '--help', '-?', '-h']
3306
def run(self, topic=None, long=False):
3308
if topic is None and long:
3310
bzrlib.help.help(topic)
3313
class cmd_shell_complete(Command):
3314
"""Show appropriate completions for context.
3316
For a list of all available commands, say 'bzr shell-complete'.
3318
takes_args = ['context?']
3323
def run(self, context=None):
3324
import shellcomplete
3325
shellcomplete.shellcomplete(context)
3328
class cmd_missing(Command):
3329
"""Show unmerged/unpulled revisions between two branches.
3331
OTHER_BRANCH may be local or remote.
3334
_see_also = ['merge', 'pull']
3335
takes_args = ['other_branch?']
3337
Option('reverse', 'Reverse the order of revisions.'),
3339
'Display changes in the local branch only.'),
3340
Option('this' , 'Same as --mine-only.'),
3341
Option('theirs-only',
3342
'Display changes in the remote branch only.'),
3343
Option('other', 'Same as --theirs-only.'),
3347
Option('include-merges', 'Show merged revisions.'),
3349
encoding_type = 'replace'
3352
def run(self, other_branch=None, reverse=False, mine_only=False,
3354
log_format=None, long=False, short=False, line=False,
3355
show_ids=False, verbose=False, this=False, other=False,
3356
include_merges=False):
3357
from bzrlib.missing import find_unmerged, iter_log_revisions
3363
# TODO: We should probably check that we don't have mine-only and
3364
# theirs-only set, but it gets complicated because we also have
3365
# this and other which could be used.
3372
local_branch = Branch.open_containing(u".")[0]
3373
parent = local_branch.get_parent()
3374
if other_branch is None:
3375
other_branch = parent
3376
if other_branch is None:
3377
raise errors.BzrCommandError("No peer location known"
3379
display_url = urlutils.unescape_for_display(parent,
3381
self.outf.write("Using saved parent location: "
3382
+ display_url + "\n")
3384
remote_branch = Branch.open(other_branch)
3385
if remote_branch.base == local_branch.base:
3386
remote_branch = local_branch
3387
local_branch.lock_read()
3389
remote_branch.lock_read()
3391
local_extra, remote_extra = find_unmerged(
3392
local_branch, remote_branch, restrict,
3393
backward=not reverse,
3394
include_merges=include_merges)
3396
if log_format is None:
3397
registry = log.log_formatter_registry
3398
log_format = registry.get_default(local_branch)
3399
lf = log_format(to_file=self.outf,
3401
show_timezone='original')
3404
if local_extra and not theirs_only:
3405
self.outf.write("You have %d extra revision(s):\n" %
3407
for revision in iter_log_revisions(local_extra,
3408
local_branch.repository,
3410
lf.log_revision(revision)
3411
printed_local = True
3414
printed_local = False
3416
if remote_extra and not mine_only:
3417
if printed_local is True:
3418
self.outf.write("\n\n\n")
3419
self.outf.write("You are missing %d revision(s):\n" %
3421
for revision in iter_log_revisions(remote_extra,
3422
remote_branch.repository,
3424
lf.log_revision(revision)
3427
if mine_only and not local_extra:
3428
# We checked local, and found nothing extra
3429
self.outf.write('This branch is up to date.\n')
3430
elif theirs_only and not remote_extra:
3431
# We checked remote, and found nothing extra
3432
self.outf.write('Other branch is up to date.\n')
3433
elif not (mine_only or theirs_only or local_extra or
3435
# We checked both branches, and neither one had extra
3437
self.outf.write("Branches are up to date.\n")
3439
remote_branch.unlock()
3441
local_branch.unlock()
3442
if not status_code and parent is None and other_branch is not None:
3443
local_branch.lock_write()
3445
# handle race conditions - a parent might be set while we run.
3446
if local_branch.get_parent() is None:
3447
local_branch.set_parent(remote_branch.base)
3449
local_branch.unlock()
3453
class cmd_pack(Command):
3454
"""Compress the data within a repository."""
3456
_see_also = ['repositories']
3457
takes_args = ['branch_or_repo?']
3459
def run(self, branch_or_repo='.'):
3460
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3462
branch = dir.open_branch()
3463
repository = branch.repository
3464
except errors.NotBranchError:
3465
repository = dir.open_repository()
3469
class cmd_plugins(Command):
3470
"""List the installed plugins.
3472
This command displays the list of installed plugins including
3473
version of plugin and a short description of each.
3475
--verbose shows the path where each plugin is located.
3477
A plugin is an external component for Bazaar that extends the
3478
revision control system, by adding or replacing code in Bazaar.
3479
Plugins can do a variety of things, including overriding commands,
3480
adding new commands, providing additional network transports and
3481
customizing log output.
3483
See the Bazaar web site, http://bazaar-vcs.org, for further
3484
information on plugins including where to find them and how to
3485
install them. Instructions are also provided there on how to
3486
write new plugins using the Python programming language.
3488
takes_options = ['verbose']
3491
def run(self, verbose=False):
3492
import bzrlib.plugin
3493
from inspect import getdoc
3495
for name, plugin in bzrlib.plugin.plugins().items():
3496
version = plugin.__version__
3497
if version == 'unknown':
3499
name_ver = '%s %s' % (name, version)
3500
d = getdoc(plugin.module)
3502
doc = d.split('\n')[0]
3504
doc = '(no description)'
3505
result.append((name_ver, doc, plugin.path()))
3506
for name_ver, doc, path in sorted(result):
3514
class cmd_testament(Command):
3515
"""Show testament (signing-form) of a revision."""
3518
Option('long', help='Produce long-format testament.'),
3520
help='Produce a strict-format testament.')]
3521
takes_args = ['branch?']
3523
def run(self, branch=u'.', revision=None, long=False, strict=False):
3524
from bzrlib.testament import Testament, StrictTestament
3526
testament_class = StrictTestament
3528
testament_class = Testament
3530
b = Branch.open_containing(branch)[0]
3532
b = Branch.open(branch)
3535
if revision is None:
3536
rev_id = b.last_revision()
3538
rev_id = revision[0].as_revision_id(b)
3539
t = testament_class.from_revision(b.repository, rev_id)
3541
sys.stdout.writelines(t.as_text_lines())
3543
sys.stdout.write(t.as_short_text())
3548
class cmd_annotate(Command):
3549
"""Show the origin of each line in a file.
3551
This prints out the given file with an annotation on the left side
3552
indicating which revision, author and date introduced the change.
3554
If the origin is the same for a run of consecutive lines, it is
3555
shown only at the top, unless the --all option is given.
3557
# TODO: annotate directories; showing when each file was last changed
3558
# TODO: if the working copy is modified, show annotations on that
3559
# with new uncommitted lines marked
3560
aliases = ['ann', 'blame', 'praise']
3561
takes_args = ['filename']
3562
takes_options = [Option('all', help='Show annotations on all lines.'),
3563
Option('long', help='Show commit date in annotations.'),
3567
encoding_type = 'exact'
3570
def run(self, filename, all=False, long=False, revision=None,
3572
from bzrlib.annotate import annotate_file, annotate_file_tree
3573
wt, branch, relpath = \
3574
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3580
tree = _get_one_revision_tree('annotate', revision, branch=branch)
3582
file_id = wt.path2id(relpath)
3584
file_id = tree.path2id(relpath)
3586
raise errors.NotVersionedError(filename)
3587
file_version = tree.inventory[file_id].revision
3588
if wt is not None and revision is None:
3589
# If there is a tree and we're not annotating historical
3590
# versions, annotate the working tree's content.
3591
annotate_file_tree(wt, file_id, self.outf, long, all,
3594
annotate_file(branch, file_version, file_id, long, all, self.outf,
3603
class cmd_re_sign(Command):
3604
"""Create a digital signature for an existing revision."""
3605
# TODO be able to replace existing ones.
3607
hidden = True # is this right ?
3608
takes_args = ['revision_id*']
3609
takes_options = ['revision']
3611
def run(self, revision_id_list=None, revision=None):
3612
if revision_id_list is not None and revision is not None:
3613
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3614
if revision_id_list is None and revision is None:
3615
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3616
b = WorkingTree.open_containing(u'.')[0].branch
3619
return self._run(b, revision_id_list, revision)
3623
def _run(self, b, revision_id_list, revision):
3624
import bzrlib.gpg as gpg
3625
gpg_strategy = gpg.GPGStrategy(b.get_config())
3626
if revision_id_list is not None:
3627
b.repository.start_write_group()
3629
for revision_id in revision_id_list:
3630
b.repository.sign_revision(revision_id, gpg_strategy)
3632
b.repository.abort_write_group()
3635
b.repository.commit_write_group()
3636
elif revision is not None:
3637
if len(revision) == 1:
3638
revno, rev_id = revision[0].in_history(b)
3639
b.repository.start_write_group()
3641
b.repository.sign_revision(rev_id, gpg_strategy)
3643
b.repository.abort_write_group()
3646
b.repository.commit_write_group()
3647
elif len(revision) == 2:
3648
# are they both on rh- if so we can walk between them
3649
# might be nice to have a range helper for arbitrary
3650
# revision paths. hmm.
3651
from_revno, from_revid = revision[0].in_history(b)
3652
to_revno, to_revid = revision[1].in_history(b)
3653
if to_revid is None:
3654
to_revno = b.revno()
3655
if from_revno is None or to_revno is None:
3656
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3657
b.repository.start_write_group()
3659
for revno in range(from_revno, to_revno + 1):
3660
b.repository.sign_revision(b.get_rev_id(revno),
3663
b.repository.abort_write_group()
3666
b.repository.commit_write_group()
3668
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3671
class cmd_bind(Command):
3672
"""Convert the current branch into a checkout of the supplied branch.
3674
Once converted into a checkout, commits must succeed on the master branch
3675
before they will be applied to the local branch.
3678
_see_also = ['checkouts', 'unbind']
3679
takes_args = ['location?']
3682
def run(self, location=None):
3683
b, relpath = Branch.open_containing(u'.')
3684
if location is None:
3686
location = b.get_old_bound_location()
3687
except errors.UpgradeRequired:
3688
raise errors.BzrCommandError('No location supplied. '
3689
'This format does not remember old locations.')
3691
if location is None:
3692
raise errors.BzrCommandError('No location supplied and no '
3693
'previous location known')
3694
b_other = Branch.open(location)
3697
except errors.DivergedBranches:
3698
raise errors.BzrCommandError('These branches have diverged.'
3699
' Try merging, and then bind again.')
3702
class cmd_unbind(Command):
3703
"""Convert the current checkout into a regular branch.
3705
After unbinding, the local branch is considered independent and subsequent
3706
commits will be local only.
3709
_see_also = ['checkouts', 'bind']
3714
b, relpath = Branch.open_containing(u'.')
3716
raise errors.BzrCommandError('Local branch is not bound')
3719
class cmd_uncommit(Command):
3720
"""Remove the last committed revision.
3722
--verbose will print out what is being removed.
3723
--dry-run will go through all the motions, but not actually
3726
If --revision is specified, uncommit revisions to leave the branch at the
3727
specified revision. For example, "bzr uncommit -r 15" will leave the
3728
branch at revision 15.
3730
Uncommit leaves the working tree ready for a new commit. The only change
3731
it may make is to restore any pending merges that were present before
3735
# TODO: jam 20060108 Add an option to allow uncommit to remove
3736
# unreferenced information in 'branch-as-repository' branches.
3737
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3738
# information in shared branches as well.
3739
_see_also = ['commit']
3740
takes_options = ['verbose', 'revision',
3741
Option('dry-run', help='Don\'t actually make changes.'),
3742
Option('force', help='Say yes to all questions.'),
3744
help="Only remove the commits from the local branch"
3745
" when in a checkout."
3748
takes_args = ['location?']
3750
encoding_type = 'replace'
3752
def run(self, location=None,
3753
dry_run=False, verbose=False,
3754
revision=None, force=False, local=False):
3755
if location is None:
3757
control, relpath = bzrdir.BzrDir.open_containing(location)
3759
tree = control.open_workingtree()
3761
except (errors.NoWorkingTree, errors.NotLocalUrl):
3763
b = control.open_branch()
3765
if tree is not None:
3770
return self._run(b, tree, dry_run, verbose, revision, force,
3773
if tree is not None:
3778
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3779
from bzrlib.log import log_formatter, show_log
3780
from bzrlib.uncommit import uncommit
3782
last_revno, last_rev_id = b.last_revision_info()
3785
if revision is None:
3787
rev_id = last_rev_id
3789
# 'bzr uncommit -r 10' actually means uncommit
3790
# so that the final tree is at revno 10.
3791
# but bzrlib.uncommit.uncommit() actually uncommits
3792
# the revisions that are supplied.
3793
# So we need to offset it by one
3794
revno = revision[0].in_history(b).revno + 1
3795
if revno <= last_revno:
3796
rev_id = b.get_rev_id(revno)
3798
if rev_id is None or _mod_revision.is_null(rev_id):
3799
self.outf.write('No revisions to uncommit.\n')
3802
lf = log_formatter('short',
3804
show_timezone='original')
3809
direction='forward',
3810
start_revision=revno,
3811
end_revision=last_revno)
3814
print 'Dry-run, pretending to remove the above revisions.'
3816
val = raw_input('Press <enter> to continue')
3818
print 'The above revision(s) will be removed.'
3820
val = raw_input('Are you sure [y/N]? ')
3821
if val.lower() not in ('y', 'yes'):
3825
mutter('Uncommitting from {%s} to {%s}',
3826
last_rev_id, rev_id)
3827
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3828
revno=revno, local=local)
3829
note('You can restore the old tip by running:\n'
3830
' bzr pull . -r revid:%s', last_rev_id)
3833
class cmd_break_lock(Command):
3834
"""Break a dead lock on a repository, branch or working directory.
3836
CAUTION: Locks should only be broken when you are sure that the process
3837
holding the lock has been stopped.
3839
You can get information on what locks are open via the 'bzr info' command.
3844
takes_args = ['location?']
3846
def run(self, location=None, show=False):
3847
if location is None:
3849
control, relpath = bzrdir.BzrDir.open_containing(location)
3851
control.break_lock()
3852
except NotImplementedError:
3856
class cmd_wait_until_signalled(Command):
3857
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3859
This just prints a line to signal when it is ready, then blocks on stdin.
3865
sys.stdout.write("running\n")
3867
sys.stdin.readline()
3870
class cmd_serve(Command):
3871
"""Run the bzr server."""
3873
aliases = ['server']
3877
help='Serve on stdin/out for use from inetd or sshd.'),
3879
help='Listen for connections on nominated port of the form '
3880
'[hostname:]portnumber. Passing 0 as the port number will '
3881
'result in a dynamically allocated port. The default port is '
3885
help='Serve contents of this directory.',
3887
Option('allow-writes',
3888
help='By default the server is a readonly server. Supplying '
3889
'--allow-writes enables write access to the contents of '
3890
'the served directory and below.'
3894
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3895
from bzrlib import lockdir
3896
from bzrlib.smart import medium, server
3897
from bzrlib.transport import get_transport
3898
from bzrlib.transport.chroot import ChrootServer
3899
if directory is None:
3900
directory = os.getcwd()
3901
url = urlutils.local_path_to_url(directory)
3902
if not allow_writes:
3903
url = 'readonly+' + url
3904
chroot_server = ChrootServer(get_transport(url))
3905
chroot_server.setUp()
3906
t = get_transport(chroot_server.get_url())
3908
smart_server = medium.SmartServerPipeStreamMedium(
3909
sys.stdin, sys.stdout, t)
3911
host = medium.BZR_DEFAULT_INTERFACE
3913
port = medium.BZR_DEFAULT_PORT
3916
host, port = port.split(':')
3918
smart_server = server.SmartTCPServer(t, host=host, port=port)
3919
print 'listening on port: ', smart_server.port
3921
# for the duration of this server, no UI output is permitted.
3922
# note that this may cause problems with blackbox tests. This should
3923
# be changed with care though, as we dont want to use bandwidth sending
3924
# progress over stderr to smart server clients!
3925
old_factory = ui.ui_factory
3926
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3928
ui.ui_factory = ui.SilentUIFactory()
3929
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3930
smart_server.serve()
3932
ui.ui_factory = old_factory
3933
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3936
class cmd_join(Command):
3937
"""Combine a subtree into its containing tree.
3939
This command is for experimental use only. It requires the target tree
3940
to be in dirstate-with-subtree format, which cannot be converted into
3943
The TREE argument should be an independent tree, inside another tree, but
3944
not part of it. (Such trees can be produced by "bzr split", but also by
3945
running "bzr branch" with the target inside a tree.)
3947
The result is a combined tree, with the subtree no longer an independant
3948
part. This is marked as a merge of the subtree into the containing tree,
3949
and all history is preserved.
3951
If --reference is specified, the subtree retains its independence. It can
3952
be branched by itself, and can be part of multiple projects at the same
3953
time. But operations performed in the containing tree, such as commit
3954
and merge, will recurse into the subtree.
3957
_see_also = ['split']
3958
takes_args = ['tree']
3960
Option('reference', help='Join by reference.'),
3964
def run(self, tree, reference=False):
3965
sub_tree = WorkingTree.open(tree)
3966
parent_dir = osutils.dirname(sub_tree.basedir)
3967
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3968
repo = containing_tree.branch.repository
3969
if not repo.supports_rich_root():
3970
raise errors.BzrCommandError(
3971
"Can't join trees because %s doesn't support rich root data.\n"
3972
"You can use bzr upgrade on the repository."
3976
containing_tree.add_reference(sub_tree)
3977
except errors.BadReferenceTarget, e:
3978
# XXX: Would be better to just raise a nicely printable
3979
# exception from the real origin. Also below. mbp 20070306
3980
raise errors.BzrCommandError("Cannot join %s. %s" %
3984
containing_tree.subsume(sub_tree)
3985
except errors.BadSubsumeSource, e:
3986
raise errors.BzrCommandError("Cannot join %s. %s" %
3990
class cmd_split(Command):
3991
"""Split a subdirectory of a tree into a separate tree.
3993
This command will produce a target tree in a format that supports
3994
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3995
converted into earlier formats like 'dirstate-tags'.
3997
The TREE argument should be a subdirectory of a working tree. That
3998
subdirectory will be converted into an independent tree, with its own
3999
branch. Commits in the top-level tree will not apply to the new subtree.
4002
# join is not un-hidden yet
4003
#_see_also = ['join']
4004
takes_args = ['tree']
4006
def run(self, tree):
4007
containing_tree, subdir = WorkingTree.open_containing(tree)
4008
sub_id = containing_tree.path2id(subdir)
4010
raise errors.NotVersionedError(subdir)
4012
containing_tree.extract(sub_id)
4013
except errors.RootNotRich:
4014
raise errors.UpgradeRequired(containing_tree.branch.base)
4017
class cmd_merge_directive(Command):
4018
"""Generate a merge directive for auto-merge tools.
4020
A directive requests a merge to be performed, and also provides all the
4021
information necessary to do so. This means it must either include a
4022
revision bundle, or the location of a branch containing the desired
4025
A submit branch (the location to merge into) must be supplied the first
4026
time the command is issued. After it has been supplied once, it will
4027
be remembered as the default.
4029
A public branch is optional if a revision bundle is supplied, but required
4030
if --diff or --plain is specified. It will be remembered as the default
4031
after the first use.
4034
takes_args = ['submit_branch?', 'public_branch?']
4038
_see_also = ['send']
4041
RegistryOption.from_kwargs('patch-type',
4042
'The type of patch to include in the directive.',
4044
value_switches=True,
4046
bundle='Bazaar revision bundle (default).',
4047
diff='Normal unified diff.',
4048
plain='No patch, just directive.'),
4049
Option('sign', help='GPG-sign the directive.'), 'revision',
4050
Option('mail-to', type=str,
4051
help='Instead of printing the directive, email to this address.'),
4052
Option('message', type=str, short_name='m',
4053
help='Message to use when committing this merge.')
4056
encoding_type = 'exact'
4058
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4059
sign=False, revision=None, mail_to=None, message=None):
4060
from bzrlib.revision import ensure_null, NULL_REVISION
4061
include_patch, include_bundle = {
4062
'plain': (False, False),
4063
'diff': (True, False),
4064
'bundle': (True, True),
4066
branch = Branch.open('.')
4067
stored_submit_branch = branch.get_submit_branch()
4068
if submit_branch is None:
4069
submit_branch = stored_submit_branch
4071
if stored_submit_branch is None:
4072
branch.set_submit_branch(submit_branch)
4073
if submit_branch is None:
4074
submit_branch = branch.get_parent()
4075
if submit_branch is None:
4076
raise errors.BzrCommandError('No submit branch specified or known')
4078
stored_public_branch = branch.get_public_branch()
4079
if public_branch is None:
4080
public_branch = stored_public_branch
4081
elif stored_public_branch is None:
4082
branch.set_public_branch(public_branch)
4083
if not include_bundle and public_branch is None:
4084
raise errors.BzrCommandError('No public branch specified or'
4086
base_revision_id = None
4087
if revision is not None:
4088
if len(revision) > 2:
4089
raise errors.BzrCommandError('bzr merge-directive takes '
4090
'at most two one revision identifiers')
4091
revision_id = revision[-1].as_revision_id(branch)
4092
if len(revision) == 2:
4093
base_revision_id = revision[0].as_revision_id(branch)
4095
revision_id = branch.last_revision()
4096
revision_id = ensure_null(revision_id)
4097
if revision_id == NULL_REVISION:
4098
raise errors.BzrCommandError('No revisions to bundle.')
4099
directive = merge_directive.MergeDirective2.from_objects(
4100
branch.repository, revision_id, time.time(),
4101
osutils.local_time_offset(), submit_branch,
4102
public_branch=public_branch, include_patch=include_patch,
4103
include_bundle=include_bundle, message=message,
4104
base_revision_id=base_revision_id)
4107
self.outf.write(directive.to_signed(branch))
4109
self.outf.writelines(directive.to_lines())
4111
message = directive.to_email(mail_to, branch, sign)
4112
s = SMTPConnection(branch.get_config())
4113
s.send_email(message)
4116
class cmd_send(Command):
4117
"""Mail or create a merge-directive for submiting changes.
4119
A merge directive provides many things needed for requesting merges:
4121
* A machine-readable description of the merge to perform
4123
* An optional patch that is a preview of the changes requested
4125
* An optional bundle of revision data, so that the changes can be applied
4126
directly from the merge directive, without retrieving data from a
4129
If --no-bundle is specified, then public_branch is needed (and must be
4130
up-to-date), so that the receiver can perform the merge using the
4131
public_branch. The public_branch is always included if known, so that
4132
people can check it later.
4134
The submit branch defaults to the parent, but can be overridden. Both
4135
submit branch and public branch will be remembered if supplied.
4137
If a public_branch is known for the submit_branch, that public submit
4138
branch is used in the merge instructions. This means that a local mirror
4139
can be used as your actual submit branch, once you have set public_branch
4142
Mail is sent using your preferred mail program. This should be transparent
4143
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4144
If the preferred client can't be found (or used), your editor will be used.
4146
To use a specific mail program, set the mail_client configuration option.
4147
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4148
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4149
generic options are "default", "editor", "emacsclient", "mapi", and
4150
"xdg-email". Plugins may also add supported clients.
4152
If mail is being sent, a to address is required. This can be supplied
4153
either on the commandline, by setting the submit_to configuration
4154
option in the branch itself or the child_submit_to configuration option
4155
in the submit branch.
4157
Two formats are currently supported: "4" uses revision bundle format 4 and
4158
merge directive format 2. It is significantly faster and smaller than
4159
older formats. It is compatible with Bazaar 0.19 and later. It is the
4160
default. "0.9" uses revision bundle format 0.9 and merge directive
4161
format 1. It is compatible with Bazaar 0.12 - 0.18.
4163
Merge directives are applied using the merge command or the pull command.
4166
encoding_type = 'exact'
4168
_see_also = ['merge', 'pull']
4170
takes_args = ['submit_branch?', 'public_branch?']
4174
help='Do not include a bundle in the merge directive.'),
4175
Option('no-patch', help='Do not include a preview patch in the merge'
4178
help='Remember submit and public branch.'),
4180
help='Branch to generate the submission from, '
4181
'rather than the one containing the working directory.',
4184
Option('output', short_name='o',
4185
help='Write merge directive to this file; '
4186
'use - for stdout.',
4188
Option('mail-to', help='Mail the request to this address.',
4192
RegistryOption.from_kwargs('format',
4193
'Use the specified output format.',
4194
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4195
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4198
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4199
no_patch=False, revision=None, remember=False, output=None,
4200
format='4', mail_to=None, message=None, **kwargs):
4201
return self._run(submit_branch, revision, public_branch, remember,
4202
format, no_bundle, no_patch, output,
4203
kwargs.get('from', '.'), mail_to, message)
4205
def _run(self, submit_branch, revision, public_branch, remember, format,
4206
no_bundle, no_patch, output, from_, mail_to, message):
4207
from bzrlib.revision import NULL_REVISION
4208
branch = Branch.open_containing(from_)[0]
4210
outfile = cStringIO.StringIO()
4214
outfile = open(output, 'wb')
4215
# we may need to write data into branch's repository to calculate
4220
config = branch.get_config()
4222
mail_to = config.get_user_option('submit_to')
4223
mail_client = config.get_mail_client()
4224
if remember and submit_branch is None:
4225
raise errors.BzrCommandError(
4226
'--remember requires a branch to be specified.')
4227
stored_submit_branch = branch.get_submit_branch()
4228
remembered_submit_branch = None
4229
if submit_branch is None:
4230
submit_branch = stored_submit_branch
4231
remembered_submit_branch = "submit"
4233
if stored_submit_branch is None or remember:
4234
branch.set_submit_branch(submit_branch)
4235
if submit_branch is None:
4236
submit_branch = branch.get_parent()
4237
remembered_submit_branch = "parent"
4238
if submit_branch is None:
4239
raise errors.BzrCommandError('No submit branch known or'
4241
if remembered_submit_branch is not None:
4242
note('Using saved %s location "%s" to determine what '
4243
'changes to submit.', remembered_submit_branch,
4247
submit_config = Branch.open(submit_branch).get_config()
4248
mail_to = submit_config.get_user_option("child_submit_to")
4250
stored_public_branch = branch.get_public_branch()
4251
if public_branch is None:
4252
public_branch = stored_public_branch
4253
elif stored_public_branch is None or remember:
4254
branch.set_public_branch(public_branch)
4255
if no_bundle and public_branch is None:
4256
raise errors.BzrCommandError('No public branch specified or'
4258
base_revision_id = None
4260
if revision is not None:
4261
if len(revision) > 2:
4262
raise errors.BzrCommandError('bzr send takes '
4263
'at most two one revision identifiers')
4264
revision_id = revision[-1].as_revision_id(branch)
4265
if len(revision) == 2:
4266
base_revision_id = revision[0].as_revision_id(branch)
4267
if revision_id is None:
4268
revision_id = branch.last_revision()
4269
if revision_id == NULL_REVISION:
4270
raise errors.BzrCommandError('No revisions to submit.')
4272
directive = merge_directive.MergeDirective2.from_objects(
4273
branch.repository, revision_id, time.time(),
4274
osutils.local_time_offset(), submit_branch,
4275
public_branch=public_branch, include_patch=not no_patch,
4276
include_bundle=not no_bundle, message=message,
4277
base_revision_id=base_revision_id)
4278
elif format == '0.9':
4281
patch_type = 'bundle'
4283
raise errors.BzrCommandError('Format 0.9 does not'
4284
' permit bundle with no patch')
4290
directive = merge_directive.MergeDirective.from_objects(
4291
branch.repository, revision_id, time.time(),
4292
osutils.local_time_offset(), submit_branch,
4293
public_branch=public_branch, patch_type=patch_type,
4296
outfile.writelines(directive.to_lines())
4298
subject = '[MERGE] '
4299
if message is not None:
4302
revision = branch.repository.get_revision(revision_id)
4303
subject += revision.get_summary()
4304
basename = directive.get_disk_name(branch)
4305
mail_client.compose_merge_request(mail_to, subject,
4306
outfile.getvalue(), basename)
4313
class cmd_bundle_revisions(cmd_send):
4315
"""Create a merge-directive for submiting changes.
4317
A merge directive provides many things needed for requesting merges:
4319
* A machine-readable description of the merge to perform
4321
* An optional patch that is a preview of the changes requested
4323
* An optional bundle of revision data, so that the changes can be applied
4324
directly from the merge directive, without retrieving data from a
4327
If --no-bundle is specified, then public_branch is needed (and must be
4328
up-to-date), so that the receiver can perform the merge using the
4329
public_branch. The public_branch is always included if known, so that
4330
people can check it later.
4332
The submit branch defaults to the parent, but can be overridden. Both
4333
submit branch and public branch will be remembered if supplied.
4335
If a public_branch is known for the submit_branch, that public submit
4336
branch is used in the merge instructions. This means that a local mirror
4337
can be used as your actual submit branch, once you have set public_branch
4340
Two formats are currently supported: "4" uses revision bundle format 4 and
4341
merge directive format 2. It is significantly faster and smaller than
4342
older formats. It is compatible with Bazaar 0.19 and later. It is the
4343
default. "0.9" uses revision bundle format 0.9 and merge directive
4344
format 1. It is compatible with Bazaar 0.12 - 0.18.
4349
help='Do not include a bundle in the merge directive.'),
4350
Option('no-patch', help='Do not include a preview patch in the merge'
4353
help='Remember submit and public branch.'),
4355
help='Branch to generate the submission from, '
4356
'rather than the one containing the working directory.',
4359
Option('output', short_name='o', help='Write directive to this file.',
4362
RegistryOption.from_kwargs('format',
4363
'Use the specified output format.',
4364
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4365
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4367
aliases = ['bundle']
4369
_see_also = ['send', 'merge']
4373
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4374
no_patch=False, revision=None, remember=False, output=None,
4375
format='4', **kwargs):
4378
return self._run(submit_branch, revision, public_branch, remember,
4379
format, no_bundle, no_patch, output,
4380
kwargs.get('from', '.'), None, None)
4383
class cmd_tag(Command):
4384
"""Create, remove or modify a tag naming a revision.
4386
Tags give human-meaningful names to revisions. Commands that take a -r
4387
(--revision) option can be given -rtag:X, where X is any previously
4390
Tags are stored in the branch. Tags are copied from one branch to another
4391
along when you branch, push, pull or merge.
4393
It is an error to give a tag name that already exists unless you pass
4394
--force, in which case the tag is moved to point to the new revision.
4396
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4397
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4400
_see_also = ['commit', 'tags']
4401
takes_args = ['tag_name']
4404
help='Delete this tag rather than placing it.',
4407
help='Branch in which to place the tag.',
4412
help='Replace existing tags.',
4417
def run(self, tag_name,
4423
branch, relpath = Branch.open_containing(directory)
4427
branch.tags.delete_tag(tag_name)
4428
self.outf.write('Deleted tag %s.\n' % tag_name)
4431
if len(revision) != 1:
4432
raise errors.BzrCommandError(
4433
"Tags can only be placed on a single revision, "
4435
revision_id = revision[0].as_revision_id(branch)
4437
revision_id = branch.last_revision()
4438
if (not force) and branch.tags.has_tag(tag_name):
4439
raise errors.TagAlreadyExists(tag_name)
4440
branch.tags.set_tag(tag_name, revision_id)
4441
self.outf.write('Created tag %s.\n' % tag_name)
4446
class cmd_tags(Command):
4449
This command shows a table of tag names and the revisions they reference.
4455
help='Branch whose tags should be displayed.',
4459
RegistryOption.from_kwargs('sort',
4460
'Sort tags by different criteria.', title='Sorting',
4461
alpha='Sort tags lexicographically (default).',
4462
time='Sort tags chronologically.',
4473
branch, relpath = Branch.open_containing(directory)
4474
tags = branch.tags.get_tag_dict().items()
4479
elif sort == 'time':
4481
for tag, revid in tags:
4483
revobj = branch.repository.get_revision(revid)
4484
except errors.NoSuchRevision:
4485
timestamp = sys.maxint # place them at the end
4487
timestamp = revobj.timestamp
4488
timestamps[revid] = timestamp
4489
tags.sort(key=lambda x: timestamps[x[1]])
4491
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4492
revno_map = branch.get_revision_id_to_revno_map()
4493
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4494
for tag, revid in tags ]
4495
for tag, revspec in tags:
4496
self.outf.write('%-20s %s\n' % (tag, revspec))
4499
class cmd_reconfigure(Command):
4500
"""Reconfigure the type of a bzr directory.
4502
A target configuration must be specified.
4504
For checkouts, the bind-to location will be auto-detected if not specified.
4505
The order of preference is
4506
1. For a lightweight checkout, the current bound location.
4507
2. For branches that used to be checkouts, the previously-bound location.
4508
3. The push location.
4509
4. The parent location.
4510
If none of these is available, --bind-to must be specified.
4513
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4514
takes_args = ['location?']
4515
takes_options = [RegistryOption.from_kwargs('target_type',
4516
title='Target type',
4517
help='The type to reconfigure the directory to.',
4518
value_switches=True, enum_switch=False,
4519
branch='Reconfigure to be an unbound branch '
4520
'with no working tree.',
4521
tree='Reconfigure to be an unbound branch '
4522
'with a working tree.',
4523
checkout='Reconfigure to be a bound branch '
4524
'with a working tree.',
4525
lightweight_checkout='Reconfigure to be a lightweight'
4526
' checkout (with no local history).',
4527
standalone='Reconfigure to be a standalone branch '
4528
'(i.e. stop using shared repository).',
4529
use_shared='Reconfigure to use a shared repository.'),
4530
Option('bind-to', help='Branch to bind checkout to.',
4533
help='Perform reconfiguration even if local changes'
4537
def run(self, location=None, target_type=None, bind_to=None, force=False):
4538
directory = bzrdir.BzrDir.open(location)
4539
if target_type is None:
4540
raise errors.BzrCommandError('No target configuration specified')
4541
elif target_type == 'branch':
4542
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4543
elif target_type == 'tree':
4544
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4545
elif target_type == 'checkout':
4546
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4548
elif target_type == 'lightweight-checkout':
4549
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4551
elif target_type == 'use-shared':
4552
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4553
elif target_type == 'standalone':
4554
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4555
reconfiguration.apply(force)
4558
class cmd_switch(Command):
4559
"""Set the branch of a checkout and update.
4561
For lightweight checkouts, this changes the branch being referenced.
4562
For heavyweight checkouts, this checks that there are no local commits
4563
versus the current bound branch, then it makes the local branch a mirror
4564
of the new location and binds to it.
4566
In both cases, the working tree is updated and uncommitted changes
4567
are merged. The user can commit or revert these as they desire.
4569
Pending merges need to be committed or reverted before using switch.
4571
The path to the branch to switch to can be specified relative to the parent
4572
directory of the current branch. For example, if you are currently in a
4573
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4577
takes_args = ['to_location']
4578
takes_options = [Option('force',
4579
help='Switch even if local commits will be lost.')
4582
def run(self, to_location, force=False):
4583
from bzrlib import switch
4585
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4587
to_branch = Branch.open(to_location)
4588
except errors.NotBranchError:
4589
this_branch = control_dir.open_branch()
4590
# This may be a heavy checkout, where we want the master branch
4591
this_url = this_branch.get_bound_location()
4592
# If not, use a local sibling
4593
if this_url is None:
4594
this_url = this_branch.base
4595
to_branch = Branch.open(
4596
urlutils.join(this_url, '..', to_location))
4597
switch.switch(control_dir, to_branch, force)
4598
note('Switched to branch: %s',
4599
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4602
class cmd_hooks(Command):
4603
"""Show a branch's currently registered hooks.
4607
takes_args = ['path?']
4609
def run(self, path=None):
4612
branch_hooks = Branch.open(path).hooks
4613
for hook_type in branch_hooks:
4614
hooks = branch_hooks[hook_type]
4615
self.outf.write("%s:\n" % (hook_type,))
4618
self.outf.write(" %s\n" %
4619
(branch_hooks.get_hook_name(hook),))
4621
self.outf.write(" <no hooks installed>\n")
4624
def _create_prefix(cur_transport):
4625
needed = [cur_transport]
4626
# Recurse upwards until we can create a directory successfully
4628
new_transport = cur_transport.clone('..')
4629
if new_transport.base == cur_transport.base:
4630
raise errors.BzrCommandError(
4631
"Failed to create path prefix for %s."
4632
% cur_transport.base)
4634
new_transport.mkdir('.')
4635
except errors.NoSuchFile:
4636
needed.append(new_transport)
4637
cur_transport = new_transport
4640
# Now we only need to create child directories
4642
cur_transport = needed.pop()
4643
cur_transport.ensure_base()
4646
# these get imported and then picked up by the scan for cmd_*
4647
# TODO: Some more consistent way to split command definitions across files;
4648
# we do need to load at least some information about them to know of
4649
# aliases. ideally we would avoid loading the implementation until the
4650
# details were needed.
4651
from bzrlib.cmd_version_info import cmd_version_info
4652
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4653
from bzrlib.bundle.commands import (
4656
from bzrlib.sign_my_commits import cmd_sign_my_commits
4657
from bzrlib.weave_commands import cmd_versionedfile_list, \
4658
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
