633
172
Adding a file whose parent directory is not versioned will
634
173
implicitly add the parent, and so on up to the root. This means
635
you should never need to explicitly add a directory, they'll just
174
you should never need to explictly add a directory, they'll just
636
175
get added when you add a file in the directory.
638
--dry-run will show which files would be added, but not actually
641
--file-ids-from will try to use the file ids from the supplied path.
642
It looks up ids trying to find a matching parent directory with the
643
same filename, and then by pure path. This option is rarely needed
644
but can be useful when adding the same logical file into two
645
branches that will be merged later (without showing the two different
646
adds as a conflict). It is also useful when merging another project
647
into a subdirectory of this one.
649
Any files matching patterns in the ignore list will not be added
650
unless they are explicitly mentioned.
652
177
takes_args = ['file*']
655
help="Don't recursively add the contents of directories."),
657
help="Show what would be done, but don't actually do anything."),
659
Option('file-ids-from',
661
help='Lookup file ids from this tree.'),
663
encoding_type = 'replace'
664
_see_also = ['remove', 'ignore']
666
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
671
if file_ids_from is not None:
673
base_tree, base_path = WorkingTree.open_containing(
675
except errors.NoWorkingTree:
676
base_branch, base_path = Branch.open_containing(
678
base_tree = base_branch.basis_tree()
680
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
681
to_file=self.outf, should_print=(not is_quiet()))
683
action = bzrlib.add.AddAction(to_file=self.outf,
684
should_print=(not is_quiet()))
687
self.add_cleanup(base_tree.lock_read().unlock)
688
tree, file_list = tree_files_for_add(file_list)
689
added, ignored = tree.smart_add(file_list, not
690
no_recurse, action=action, save=not dry_run)
694
for glob in sorted(ignored.keys()):
695
for path in ignored[glob]:
696
self.outf.write("ignored %s matching \"%s\"\n"
178
takes_options = ['verbose', 'no-recurse']
180
def run(self, file_list, verbose=False, no_recurse=False):
181
# verbose currently has no effect
182
from bzrlib.add import smart_add, add_reporter_print
183
smart_add(file_list, not no_recurse, add_reporter_print)
700
187
class cmd_mkdir(Command):
701
__doc__ = """Create a new versioned directory.
188
"""Create a new versioned directory.
703
190
This is equivalent to creating the directory and then adding it.
706
192
takes_args = ['dir+']
707
encoding_type = 'replace'
709
194
def run(self, dir_list):
710
197
for d in dir_list:
711
wt, dd = WorkingTree.open_containing(d)
712
base = os.path.dirname(dd)
713
id = wt.path2id(base)
717
self.outf.write('added %s\n' % d)
719
raise errors.NotVersionedError(path=base)
200
b = Branch.open_containing(d)
722
205
class cmd_relpath(Command):
723
__doc__ = """Show path of a file relative to root"""
206
"""Show path of a file relative to root"""
725
207
takes_args = ['filename']
729
210
def run(self, filename):
730
# TODO: jam 20050106 Can relpath return a munged path if
731
# sys.stdout encoding cannot represent it?
732
tree, relpath = WorkingTree.open_containing(filename)
733
self.outf.write(relpath)
734
self.outf.write('\n')
211
print Branch.open_containing(filename).relpath(filename)
737
215
class cmd_inventory(Command):
738
__doc__ = """Show inventory of the current working copy or a revision.
740
It is possible to limit the output to a particular entry
741
type using the --kind option. For example: --kind file.
743
It is also possible to restrict the list of files to a specific
744
set. For example: bzr inventory --show-ids this/file
753
help='List entries of a particular kind: file, directory, symlink.',
756
takes_args = ['file*']
759
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
760
if kind and kind not in ['file', 'directory', 'symlink']:
761
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
763
revision = _get_one_revision('inventory', revision)
764
work_tree, file_list = tree_files(file_list)
765
self.add_cleanup(work_tree.lock_read().unlock)
766
if revision is not None:
767
tree = revision.as_tree(work_tree.branch)
769
extra_trees = [work_tree]
770
self.add_cleanup(tree.lock_read().unlock)
775
if file_list is not None:
776
file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
require_versioned=True)
778
# find_ids_across_trees may include some paths that don't
780
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
for file_id in file_ids if file_id in tree)
783
entries = tree.inventory.entries()
786
for path, entry in entries:
787
if kind and kind != entry.kind:
216
"""Show inventory of the current working copy or a revision."""
217
takes_options = ['revision', 'show-ids']
219
def run(self, revision=None, show_ids=False):
220
b = Branch.open_containing('.')
222
inv = b.read_working_inventory()
224
if len(revision) > 1:
225
raise BzrCommandError('bzr inventory --revision takes'
226
' exactly one revision identifier')
227
inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
229
for path, entry in inv.entries():
790
self.outf.write('%-50s %s\n' % (path, entry.file_id))
231
print '%-50s %s' % (path, entry.file_id)
792
self.outf.write(path)
793
self.outf.write('\n')
236
class cmd_move(Command):
237
"""Move files to a different directory.
242
The destination must be a versioned directory in the same branch.
244
takes_args = ['source$', 'dest']
245
def run(self, source_list, dest):
246
b = Branch.open_containing('.')
248
# TODO: glob expansion on windows?
249
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
252
class cmd_rename(Command):
253
"""Change the name of an entry.
256
bzr rename frob.c frobber.c
257
bzr rename src/frob.c lib/frob.c
259
It is an error if the destination name exists.
261
See also the 'move' command, which moves files into a different
262
directory without changing their name.
264
TODO: Some way to rename multiple files without invoking bzr for each
266
takes_args = ['from_name', 'to_name']
268
def run(self, from_name, to_name):
269
b = Branch.open_containing('.')
270
b.rename_one(b.relpath(from_name), b.relpath(to_name))
796
274
class cmd_mv(Command):
797
__doc__ = """Move or rename a file.
275
"""Move or rename a file.
800
278
bzr mv OLDNAME NEWNAME
802
279
bzr mv SOURCE... DESTINATION
804
281
If the last argument is a versioned directory, all the other names
805
282
are moved into it. Otherwise, there must be exactly two arguments
806
and the file is changed to a new name.
808
If OLDNAME does not exist on the filesystem but is versioned and
809
NEWNAME does exist on the filesystem but is not versioned, mv
810
assumes that the file has been manually moved and only updates
811
its internal inventory to reflect that change.
812
The same is valid when moving many SOURCE files to a DESTINATION.
283
and the file is changed to a new name, which must not already exist.
814
285
Files cannot be moved between branches.
817
287
takes_args = ['names*']
818
takes_options = [Option("after", help="Move only the bzr identifier"
819
" of the file, because the file has already been moved."),
820
Option('auto', help='Automatically guess renames.'),
821
Option('dry-run', help='Avoid making changes when guessing renames.'),
823
aliases = ['move', 'rename']
824
encoding_type = 'replace'
826
def run(self, names_list, after=False, auto=False, dry_run=False):
828
return self.run_auto(names_list, after, dry_run)
830
raise errors.BzrCommandError('--dry-run requires --auto.')
831
if names_list is None:
288
def run(self, names_list):
833
289
if len(names_list) < 2:
834
raise errors.BzrCommandError("missing file argument")
835
tree, rel_names = tree_files(names_list, canonicalize=False)
836
self.add_cleanup(tree.lock_tree_write().unlock)
837
self._run(tree, names_list, rel_names, after)
839
def run_auto(self, names_list, after, dry_run):
840
if names_list is not None and len(names_list) > 1:
841
raise errors.BzrCommandError('Only one path may be specified to'
844
raise errors.BzrCommandError('--after cannot be specified with'
846
work_tree, file_list = tree_files(names_list, default_branch='.')
847
self.add_cleanup(work_tree.lock_tree_write().unlock)
848
rename_map.RenameMap.guess_renames(work_tree, dry_run)
850
def _run(self, tree, names_list, rel_names, after):
851
into_existing = osutils.isdir(names_list[-1])
852
if into_existing and len(names_list) == 2:
854
# a. case-insensitive filesystem and change case of dir
855
# b. move directory after the fact (if the source used to be
856
# a directory, but now doesn't exist in the working tree
857
# and the target is an existing directory, just rename it)
858
if (not tree.case_sensitive
859
and rel_names[0].lower() == rel_names[1].lower()):
860
into_existing = False
863
# 'fix' the case of a potential 'from'
864
from_id = tree.path2id(
865
tree.get_canonical_inventory_path(rel_names[0]))
866
if (not osutils.lexists(names_list[0]) and
867
from_id and inv.get_file_kind(from_id) == "directory"):
868
into_existing = False
290
raise BzrCommandError("missing file argument")
291
b = Branch.open_containing(names_list[0])
293
rel_names = [b.relpath(x) for x in names_list]
295
if os.path.isdir(names_list[-1]):
871
296
# move into existing directory
872
# All entries reference existing inventory items, so fix them up
873
# for cicp file-systems.
874
rel_names = tree.get_canonical_inventory_paths(rel_names)
875
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
877
self.outf.write("%s => %s\n" % (src, dest))
297
for pair in b.move(rel_names[:-1], rel_names[-1]):
298
print "%s => %s" % pair
879
300
if len(names_list) != 2:
880
raise errors.BzrCommandError('to mv multiple files the'
881
' destination must be a versioned'
884
# for cicp file-systems: the src references an existing inventory
886
src = tree.get_canonical_inventory_path(rel_names[0])
887
# Find the canonical version of the destination: In all cases, the
888
# parent of the target must be in the inventory, so we fetch the
889
# canonical version from there (we do not always *use* the
890
# canonicalized tail portion - we may be attempting to rename the
892
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
893
dest_parent = osutils.dirname(canon_dest)
894
spec_tail = osutils.basename(rel_names[1])
895
# For a CICP file-system, we need to avoid creating 2 inventory
896
# entries that differ only by case. So regardless of the case
897
# we *want* to use (ie, specified by the user or the file-system),
898
# we must always choose to use the case of any existing inventory
899
# items. The only exception to this is when we are attempting a
900
# case-only rename (ie, canonical versions of src and dest are
902
dest_id = tree.path2id(canon_dest)
903
if dest_id is None or tree.path2id(src) == dest_id:
904
# No existing item we care about, so work out what case we
905
# are actually going to use.
907
# If 'after' is specified, the tail must refer to a file on disk.
909
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
911
# pathjoin with an empty tail adds a slash, which breaks
913
dest_parent_fq = tree.basedir
915
dest_tail = osutils.canonical_relpath(
917
osutils.pathjoin(dest_parent_fq, spec_tail))
919
# not 'after', so case as specified is used
920
dest_tail = spec_tail
922
# Use the existing item so 'mv' fails with AlreadyVersioned.
923
dest_tail = os.path.basename(canon_dest)
924
dest = osutils.pathjoin(dest_parent, dest_tail)
925
mutter("attempting to move %s => %s", src, dest)
926
tree.rename_one(src, dest, after=after)
928
self.outf.write("%s => %s\n" % (src, dest))
301
raise BzrCommandError('to mv multiple files the destination '
302
'must be a versioned directory')
303
b.rename_one(rel_names[0], rel_names[1])
304
print "%s => %s" % (rel_names[0], rel_names[1])
931
309
class cmd_pull(Command):
932
__doc__ = """Turn this branch into a mirror of another branch.
934
By default, this command only works on branches that have not diverged.
935
Branches are considered diverged if the destination branch's most recent
936
commit is one that has not been merged (directly or indirectly) into the
939
If branches have diverged, you can use 'bzr merge' to integrate the changes
940
from one into the other. Once one branch has merged, the other should
941
be able to pull it again.
943
If you want to replace your local changes and just want your branch to
944
match the remote one, use pull --overwrite. This will work even if the two
945
branches have diverged.
947
If there is no default location set, the first pull will set it. After
948
that, you can omit the location to use the default. To change the
949
default, use --remember. The value will only be saved if the remote
950
location can be accessed.
952
Note: The location can be specified either in the form of a branch,
953
or in the form of a path to a file containing a merge directive generated
957
_see_also = ['push', 'update', 'status-flags', 'send']
958
takes_options = ['remember', 'overwrite', 'revision',
959
custom_help('verbose',
960
help='Show logs of pulled revisions.'),
961
custom_help('directory',
962
help='Branch to pull into, '
963
'rather than the one containing the working directory.'),
965
help="Perform a local pull in a bound "
966
"branch. Local pulls are not applied to "
970
takes_args = ['location?']
971
encoding_type = 'replace'
973
def run(self, location=None, remember=False, overwrite=False,
974
revision=None, verbose=False,
975
directory=None, local=False):
976
# FIXME: too much stuff is in the command class
979
if directory is None:
982
tree_to = WorkingTree.open_containing(directory)[0]
983
branch_to = tree_to.branch
984
self.add_cleanup(tree_to.lock_write().unlock)
985
except errors.NoWorkingTree:
987
branch_to = Branch.open_containing(directory)[0]
988
self.add_cleanup(branch_to.lock_write().unlock)
990
if local and not branch_to.get_bound_location():
991
raise errors.LocalRequiresBoundBranch()
993
possible_transports = []
994
if location is not None:
996
mergeable = bundle.read_mergeable_from_url(location,
997
possible_transports=possible_transports)
998
except errors.NotABundle:
1001
stored_loc = branch_to.get_parent()
1002
if location is None:
1003
if stored_loc is None:
1004
raise errors.BzrCommandError("No pull location known or"
1007
display_url = urlutils.unescape_for_display(stored_loc,
1010
self.outf.write("Using saved parent location: %s\n" % display_url)
1011
location = stored_loc
1013
revision = _get_one_revision('pull', revision)
1014
if mergeable is not None:
1015
if revision is not None:
1016
raise errors.BzrCommandError(
1017
'Cannot use -r with merge directives or bundles')
1018
mergeable.install_revisions(branch_to.repository)
1019
base_revision_id, revision_id, verified = \
1020
mergeable.get_merge_request(branch_to.repository)
1021
branch_from = branch_to
1023
branch_from = Branch.open(location,
1024
possible_transports=possible_transports)
1025
self.add_cleanup(branch_from.lock_read().unlock)
1027
if branch_to.get_parent() is None or remember:
1028
branch_to.set_parent(branch_from.base)
1030
if revision is not None:
1031
revision_id = revision.as_revision_id(branch_from)
1033
if tree_to is not None:
1034
view_info = _get_view_info_for_change_reporter(tree_to)
1035
change_reporter = delta._ChangeReporter(
1036
unversioned_filter=tree_to.is_ignored,
1037
view_info=view_info)
1038
result = tree_to.pull(
1039
branch_from, overwrite, revision_id, change_reporter,
1040
possible_transports=possible_transports, local=local)
1042
result = branch_to.pull(
1043
branch_from, overwrite, revision_id, local=local)
1045
result.report(self.outf)
1046
if verbose and result.old_revid != result.new_revid:
1047
log.show_branch_change(
1048
branch_to, self.outf, result.old_revno,
1052
class cmd_push(Command):
1053
__doc__ = """Update a mirror of this branch.
1055
The target branch will not have its working tree populated because this
1056
is both expensive, and is not supported on remote file systems.
1058
Some smart servers or protocols *may* put the working tree in place in
310
"""Pull any changes from another branch into the current one.
312
If the location is omitted, the last-used location will be used.
313
Both the revision history and the working directory will be
1061
316
This command only works on branches that have not diverged. Branches are
1062
considered diverged if the destination branch's most recent commit is one
1063
that has not been merged (directly or indirectly) by the source branch.
1065
If branches have diverged, you can use 'bzr push --overwrite' to replace
1066
the other branch completely, discarding its unmerged changes.
1068
If you want to ensure you have the different changes in the other branch,
1069
do a merge (see bzr help merge) from the other branch, and commit that.
1070
After that you will be able to do a push without '--overwrite'.
1072
If there is no default push location set, the first push will set it.
1073
After that, you can omit the location to use the default. To change the
1074
default, use --remember. The value will only be saved if the remote
1075
location can be accessed.
317
considered diverged if both branches have had commits without first
318
pulling from the other.
320
If branches have diverged, you can use 'bzr merge' to pull the text changes
321
from one into the other.
1078
_see_also = ['pull', 'update', 'working-trees']
1079
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1080
Option('create-prefix',
1081
help='Create the path leading up to the branch '
1082
'if it does not already exist.'),
1083
custom_help('directory',
1084
help='Branch to push from, '
1085
'rather than the one containing the working directory.'),
1086
Option('use-existing-dir',
1087
help='By default push will fail if the target'
1088
' directory exists, but does not already'
1089
' have a control directory. This flag will'
1090
' allow push to proceed.'),
1092
help='Create a stacked branch that references the public location '
1093
'of the parent branch.'),
1094
Option('stacked-on',
1095
help='Create a stacked branch that refers to another branch '
1096
'for the commit history. Only the work not present in the '
1097
'referenced branch is included in the branch created.',
1100
help='Refuse to push if there are uncommitted changes in'
1101
' the working tree, --no-strict disables the check.'),
1103
323
takes_args = ['location?']
1104
encoding_type = 'replace'
1106
def run(self, location=None, remember=False, overwrite=False,
1107
create_prefix=False, verbose=False, revision=None,
1108
use_existing_dir=False, directory=None, stacked_on=None,
1109
stacked=False, strict=None):
1110
from bzrlib.push import _show_push_branch
1112
if directory is None:
1114
# Get the source branch
1116
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1117
# Get the tip's revision_id
1118
revision = _get_one_revision('push', revision)
1119
if revision is not None:
1120
revision_id = revision.in_history(br_from).rev_id
1123
if tree is not None and revision_id is None:
1124
tree.check_changed_or_out_of_date(
1125
strict, 'push_strict',
1126
more_error='Use --no-strict to force the push.',
1127
more_warning='Uncommitted changes will not be pushed.')
1128
# Get the stacked_on branch, if any
1129
if stacked_on is not None:
1130
stacked_on = urlutils.normalize_url(stacked_on)
1132
parent_url = br_from.get_parent()
1134
parent = Branch.open(parent_url)
1135
stacked_on = parent.get_public_branch()
1137
# I considered excluding non-http url's here, thus forcing
1138
# 'public' branches only, but that only works for some
1139
# users, so it's best to just depend on the user spotting an
1140
# error by the feedback given to them. RBC 20080227.
1141
stacked_on = parent_url
1143
raise errors.BzrCommandError(
1144
"Could not determine branch to refer to.")
1146
# Get the destination location
325
def run(self, location=None):
326
from bzrlib.merge import merge
328
from shutil import rmtree
331
br_to = Branch.open_containing('.')
332
stored_loc = br_to.get_parent()
1147
333
if location is None:
1148
stored_loc = br_from.get_push_location()
1149
334
if stored_loc is None:
1150
raise errors.BzrCommandError(
1151
"No push location known or specified.")
335
raise BzrCommandError("No pull location known or specified.")
1153
display_url = urlutils.unescape_for_display(stored_loc,
1155
self.outf.write("Using saved push location: %s\n" % display_url)
337
print "Using last location: %s" % stored_loc
1156
338
location = stored_loc
339
cache_root = tempfile.mkdtemp()
340
from bzrlib.errors import DivergedBranches
341
br_from = Branch.open_containing(location)
342
location = br_from.base
343
old_revno = br_to.revno()
345
from bzrlib.errors import DivergedBranches
346
br_from = Branch.open(location)
347
br_from.setup_caching(cache_root)
348
location = br_from.base
349
old_revno = br_to.revno()
351
br_to.update_revisions(br_from)
352
except DivergedBranches:
353
raise BzrCommandError("These branches have diverged."
356
merge(('.', -1), ('.', old_revno), check_clean=False)
357
if location != stored_loc:
358
br_to.set_parent(location)
1158
_show_push_branch(br_from, revision_id, location, self.outf,
1159
verbose=verbose, overwrite=overwrite, remember=remember,
1160
stacked_on=stacked_on, create_prefix=create_prefix,
1161
use_existing_dir=use_existing_dir)
1164
364
class cmd_branch(Command):
1165
__doc__ = """Create a new branch that is a copy of an existing branch.
365
"""Create a new copy of a branch.
1167
367
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1168
368
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1169
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1170
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1171
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1174
370
To retrieve the branch as of a particular revision, supply the --revision
1175
371
parameter, as in "branch foo/bar -r 5".
1178
_see_also = ['checkout']
1179
373
takes_args = ['from_location', 'to_location?']
1180
takes_options = ['revision', Option('hardlink',
1181
help='Hard-link working tree files where possible.'),
1183
help="Create a branch without a working-tree."),
1185
help="Switch the checkout in the current directory "
1186
"to the new branch."),
1188
help='Create a stacked branch referring to the source branch. '
1189
'The new branch will depend on the availability of the source '
1190
'branch for all operations.'),
1191
Option('standalone',
1192
help='Do not use a shared repository, even if available.'),
1193
Option('use-existing-dir',
1194
help='By default branch will fail if the target'
1195
' directory exists, but does not already'
1196
' have a control directory. This flag will'
1197
' allow branch to proceed.'),
1199
help="Bind new branch to from location."),
374
takes_options = ['revision']
1201
375
aliases = ['get', 'clone']
1203
def run(self, from_location, to_location=None, revision=None,
1204
hardlink=False, stacked=False, standalone=False, no_tree=False,
1205
use_existing_dir=False, switch=False, bind=False):
1206
from bzrlib import switch as _mod_switch
1207
from bzrlib.tag import _merge_tags_if_possible
1208
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1210
revision = _get_one_revision('branch', revision)
1211
self.add_cleanup(br_from.lock_read().unlock)
1212
if revision is not None:
1213
revision_id = revision.as_revision_id(br_from)
1215
# FIXME - wt.last_revision, fallback to branch, fall back to
1216
# None or perhaps NULL_REVISION to mean copy nothing
1218
revision_id = br_from.last_revision()
1219
if to_location is None:
1220
to_location = urlutils.derive_to_location(from_location)
1221
to_transport = transport.get_transport(to_location)
1223
to_transport.mkdir('.')
1224
except errors.FileExists:
1225
if not use_existing_dir:
1226
raise errors.BzrCommandError('Target directory "%s" '
1227
'already exists.' % to_location)
1230
bzrdir.BzrDir.open_from_transport(to_transport)
1231
except errors.NotBranchError:
1234
raise errors.AlreadyBranchError(to_location)
1235
except errors.NoSuchFile:
1236
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1239
# preserve whatever source format we have.
1240
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1241
possible_transports=[to_transport],
1242
accelerator_tree=accelerator_tree,
1243
hardlink=hardlink, stacked=stacked,
1244
force_new_repo=standalone,
1245
create_tree_if_local=not no_tree,
1246
source_branch=br_from)
1247
branch = dir.open_branch()
1248
except errors.NoSuchRevision:
1249
to_transport.delete_tree('.')
1250
msg = "The branch %s has no revision %s." % (from_location,
1252
raise errors.BzrCommandError(msg)
1253
_merge_tags_if_possible(br_from, branch)
1254
# If the source branch is stacked, the new branch may
1255
# be stacked whether we asked for that explicitly or not.
1256
# We therefore need a try/except here and not just 'if stacked:'
1258
note('Created new stacked branch referring to %s.' %
1259
branch.get_stacked_on_url())
1260
except (errors.NotStacked, errors.UnstackableBranchFormat,
1261
errors.UnstackableRepositoryFormat), e:
1262
note('Branched %d revision(s).' % branch.revno())
1264
# Bind to the parent
1265
parent_branch = Branch.open(from_location)
1266
branch.bind(parent_branch)
1267
note('New branch bound to %s' % from_location)
1269
# Switch to the new branch
1270
wt, _ = WorkingTree.open_containing('.')
1271
_mod_switch.switch(wt.bzrdir, branch)
1272
note('Switched to branch: %s',
1273
urlutils.unescape_for_display(branch.base, 'utf-8'))
1276
class cmd_checkout(Command):
1277
__doc__ = """Create a new checkout of an existing branch.
1279
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1280
the branch found in '.'. This is useful if you have removed the working tree
1281
or if it was never created - i.e. if you pushed the branch to its current
1282
location using SFTP.
1284
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1285
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1286
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1287
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1288
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1291
To retrieve the branch as of a particular revision, supply the --revision
1292
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1293
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1297
_see_also = ['checkouts', 'branch']
1298
takes_args = ['branch_location?', 'to_location?']
1299
takes_options = ['revision',
1300
Option('lightweight',
1301
help="Perform a lightweight checkout. Lightweight "
1302
"checkouts depend on access to the branch for "
1303
"every operation. Normal checkouts can perform "
1304
"common operations like diff and status without "
1305
"such access, and also support local commits."
1307
Option('files-from', type=str,
1308
help="Get file contents from this tree."),
1310
help='Hard-link working tree files where possible.'
1315
def run(self, branch_location=None, to_location=None, revision=None,
1316
lightweight=False, files_from=None, hardlink=False):
1317
if branch_location is None:
1318
branch_location = osutils.getcwd()
1319
to_location = branch_location
1320
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1322
revision = _get_one_revision('checkout', revision)
1323
if files_from is not None:
1324
accelerator_tree = WorkingTree.open(files_from)
1325
if revision is not None:
1326
revision_id = revision.as_revision_id(source)
1329
if to_location is None:
1330
to_location = urlutils.derive_to_location(branch_location)
1331
# if the source and to_location are the same,
1332
# and there is no working tree,
1333
# then reconstitute a branch
1334
if (osutils.abspath(to_location) ==
1335
osutils.abspath(branch_location)):
1337
source.bzrdir.open_workingtree()
1338
except errors.NoWorkingTree:
1339
source.bzrdir.create_workingtree(revision_id)
1341
source.create_checkout(to_location, revision_id, lightweight,
1342
accelerator_tree, hardlink)
377
def run(self, from_location, to_location=None, revision=None):
378
from bzrlib.branch import copy_branch
381
from shutil import rmtree
382
cache_root = tempfile.mkdtemp()
386
elif len(revision) > 1:
387
raise BzrCommandError(
388
'bzr branch --revision takes exactly 1 revision value')
390
br_from = Branch.open(from_location)
392
if e.errno == errno.ENOENT:
393
raise BzrCommandError('Source location "%s" does not'
394
' exist.' % to_location)
397
br_from.setup_caching(cache_root)
398
if to_location is None:
399
to_location = os.path.basename(from_location.rstrip("/\\"))
401
os.mkdir(to_location)
403
if e.errno == errno.EEXIST:
404
raise BzrCommandError('Target directory "%s" already'
405
' exists.' % to_location)
406
if e.errno == errno.ENOENT:
407
raise BzrCommandError('Parent of "%s" does not exist.' %
412
copy_branch(br_from, to_location, revision[0])
413
except bzrlib.errors.NoSuchRevision:
415
msg = "The branch %s has no revision %d." % (from_location, revision[0])
416
raise BzrCommandError(msg)
1345
421
class cmd_renames(Command):
1346
__doc__ = """Show list of renamed files.
422
"""Show list of renamed files.
424
TODO: Option to show renames between two historical versions.
426
TODO: Only show renames under dir, rather than in the whole branch.
1348
# TODO: Option to show renames between two historical versions.
1350
# TODO: Only show renames under dir, rather than in the whole branch.
1351
_see_also = ['status']
1352
428
takes_args = ['dir?']
1355
def run(self, dir=u'.'):
1356
tree = WorkingTree.open_containing(dir)[0]
1357
self.add_cleanup(tree.lock_read().unlock)
1358
new_inv = tree.inventory
1359
old_tree = tree.basis_tree()
1360
self.add_cleanup(old_tree.lock_read().unlock)
1361
old_inv = old_tree.inventory
1363
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1364
for f, paths, c, v, p, n, k, e in iterator:
1365
if paths[0] == paths[1]:
1369
renames.append(paths)
430
def run(self, dir='.'):
431
b = Branch.open_containing(dir)
432
old_inv = b.basis_tree().inventory
433
new_inv = b.read_working_inventory()
435
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
1371
437
for old_name, new_name in renames:
1372
self.outf.write("%s => %s\n" % (old_name, new_name))
1375
class cmd_update(Command):
1376
__doc__ = """Update a tree to have the latest code committed to its branch.
1378
This will perform a merge into the working tree, and may generate
1379
conflicts. If you have any local changes, you will still
1380
need to commit them after the update for the update to be complete.
1382
If you want to discard your local changes, you can just do a
1383
'bzr revert' instead of 'bzr commit' after the update.
1385
If the tree's branch is bound to a master branch, it will also update
1386
the branch from the master.
1389
_see_also = ['pull', 'working-trees', 'status-flags']
1390
takes_args = ['dir?']
1391
takes_options = ['revision']
1394
def run(self, dir='.', revision=None):
1395
if revision is not None and len(revision) != 1:
1396
raise errors.BzrCommandError(
1397
"bzr update --revision takes exactly one revision")
1398
tree = WorkingTree.open_containing(dir)[0]
1399
branch = tree.branch
1400
possible_transports = []
1401
master = branch.get_master_branch(
1402
possible_transports=possible_transports)
1403
if master is not None:
1404
branch_location = master.base
1407
branch_location = tree.branch.base
1408
tree.lock_tree_write()
1409
self.add_cleanup(tree.unlock)
1410
# get rid of the final '/' and be ready for display
1411
branch_location = urlutils.unescape_for_display(
1412
branch_location.rstrip('/'),
1414
existing_pending_merges = tree.get_parent_ids()[1:]
1418
# may need to fetch data into a heavyweight checkout
1419
# XXX: this may take some time, maybe we should display a
1421
old_tip = branch.update(possible_transports)
1422
if revision is not None:
1423
revision_id = revision[0].as_revision_id(branch)
1425
revision_id = branch.last_revision()
1426
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1427
revno = branch.revision_id_to_dotted_revno(revision_id)
1428
note("Tree is up to date at revision %s of branch %s" %
1429
('.'.join(map(str, revno)), branch_location))
1431
view_info = _get_view_info_for_change_reporter(tree)
1432
change_reporter = delta._ChangeReporter(
1433
unversioned_filter=tree.is_ignored,
1434
view_info=view_info)
1436
conflicts = tree.update(
1438
possible_transports=possible_transports,
1439
revision=revision_id,
1441
except errors.NoSuchRevision, e:
1442
raise errors.BzrCommandError(
1443
"branch has no revision %s\n"
1444
"bzr update --revision only works"
1445
" for a revision in the branch history"
1447
revno = tree.branch.revision_id_to_dotted_revno(
1448
_mod_revision.ensure_null(tree.last_revision()))
1449
note('Updated to revision %s of branch %s' %
1450
('.'.join(map(str, revno)), branch_location))
1451
parent_ids = tree.get_parent_ids()
1452
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1453
note('Your local commits will now show as pending merges with '
1454
"'bzr status', and can be committed with 'bzr commit'.")
438
print "%s => %s" % (old_name, new_name)
1461
441
class cmd_info(Command):
1462
__doc__ = """Show information about a working tree, branch or repository.
1464
This command will show all known locations and formats associated to the
1465
tree, branch or repository.
1467
In verbose mode, statistical information is included with each report.
1468
To see extended statistic information, use a verbosity level of 2 or
1469
higher by specifying the verbose option multiple times, e.g. -vv.
1471
Branches and working trees will also report any missing revisions.
1475
Display information on the format and related locations:
1479
Display the above together with extended format information and
1480
basic statistics (like the number of files in the working tree and
1481
number of revisions in the branch and repository):
1485
Display the above together with number of committers to the branch:
1489
_see_also = ['revno', 'working-trees', 'repositories']
1490
takes_args = ['location?']
1491
takes_options = ['verbose']
1492
encoding_type = 'replace'
1495
def run(self, location=None, verbose=False):
1497
noise_level = get_verbosity_level()
1500
from bzrlib.info import show_bzrdir_info
1501
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1502
verbose=noise_level, outfile=self.outf)
442
"""Show statistical information about a branch."""
443
takes_args = ['branch?']
445
def run(self, branch=None):
448
b = Branch.open_containing(branch)
1505
452
class cmd_remove(Command):
1506
__doc__ = """Remove files or directories.
453
"""Make a file unversioned.
1508
This makes bzr stop tracking changes to the specified files. bzr will delete
1509
them if they can easily be recovered using revert. If no options or
1510
parameters are given bzr will scan for files that are being tracked by bzr
1511
but missing in your tree and stop tracking them for you.
455
This makes bzr stop tracking changes to a versioned file. It does
456
not delete the working copy.
1513
takes_args = ['file*']
1514
takes_options = ['verbose',
1515
Option('new', help='Only remove files that have never been committed.'),
1516
RegistryOption.from_kwargs('file-deletion-strategy',
1517
'The file deletion mode to be used.',
1518
title='Deletion Strategy', value_switches=True, enum_switch=False,
1519
safe='Only delete files if they can be'
1520
' safely recovered (default).',
1521
keep='Delete from bzr but leave the working copy.',
1522
force='Delete all the specified files, even if they can not be '
1523
'recovered and even if they are non-empty directories.')]
1524
aliases = ['rm', 'del']
1525
encoding_type = 'replace'
1527
def run(self, file_list, verbose=False, new=False,
1528
file_deletion_strategy='safe'):
1529
tree, file_list = tree_files(file_list)
1531
if file_list is not None:
1532
file_list = [f for f in file_list]
1534
self.add_cleanup(tree.lock_write().unlock)
1535
# Heuristics should probably all move into tree.remove_smart or
1538
added = tree.changes_from(tree.basis_tree(),
1539
specific_files=file_list).added
1540
file_list = sorted([f[0] for f in added], reverse=True)
1541
if len(file_list) == 0:
1542
raise errors.BzrCommandError('No matching files.')
1543
elif file_list is None:
1544
# missing files show up in iter_changes(basis) as
1545
# versioned-with-no-kind.
1547
for change in tree.iter_changes(tree.basis_tree()):
1548
# Find paths in the working tree that have no kind:
1549
if change[1][1] is not None and change[6][1] is None:
1550
missing.append(change[1][1])
1551
file_list = sorted(missing, reverse=True)
1552
file_deletion_strategy = 'keep'
1553
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1554
keep_files=file_deletion_strategy=='keep',
1555
force=file_deletion_strategy=='force')
458
takes_args = ['file+']
459
takes_options = ['verbose']
461
def run(self, file_list, verbose=False):
462
b = Branch.open_containing(file_list[0])
463
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
1558
466
class cmd_file_id(Command):
1559
__doc__ = """Print file_id of a particular file or directory.
467
"""Print file_id of a particular file or directory.
1561
469
The file_id is assigned when the file is first added and remains the
1562
470
same through all revisions where the file exists, even when it is
1563
471
moved or renamed.
1567
_see_also = ['inventory', 'ls']
1568
474
takes_args = ['filename']
1571
475
def run(self, filename):
1572
tree, relpath = WorkingTree.open_containing(filename)
1573
i = tree.path2id(relpath)
1575
raise errors.NotVersionedError(filename)
476
b = Branch.open_containing(filename)
477
i = b.inventory.path2id(b.relpath(filename))
479
raise BzrError("%r is not a versioned file" % filename)
1577
self.outf.write(i + '\n')
1580
484
class cmd_file_path(Command):
1581
__doc__ = """Print path of file_ids to a file or directory.
485
"""Print path of file_ids to a file or directory.
1583
487
This prints one line for each directory down to the target,
1584
starting at the branch root.
488
starting at the branch root."""
1588
490
takes_args = ['filename']
1591
491
def run(self, filename):
1592
tree, relpath = WorkingTree.open_containing(filename)
1593
fid = tree.path2id(relpath)
1595
raise errors.NotVersionedError(filename)
1596
segments = osutils.splitpath(relpath)
1597
for pos in range(1, len(segments) + 1):
1598
path = osutils.joinpath(segments[:pos])
1599
self.outf.write("%s\n" % tree.path2id(path))
1602
class cmd_reconcile(Command):
1603
__doc__ = """Reconcile bzr metadata in a branch.
1605
This can correct data mismatches that may have been caused by
1606
previous ghost operations or bzr upgrades. You should only
1607
need to run this command if 'bzr check' or a bzr developer
1608
advises you to run it.
1610
If a second branch is provided, cross-branch reconciliation is
1611
also attempted, which will check that data like the tree root
1612
id which was not present in very early bzr versions is represented
1613
correctly in both branches.
1615
At the same time it is run it may recompress data resulting in
1616
a potential saving in disk space or performance gain.
1618
The branch *MUST* be on a listable system such as local disk or sftp.
1621
_see_also = ['check']
1622
takes_args = ['branch?']
1624
def run(self, branch="."):
1625
from bzrlib.reconcile import reconcile
1626
dir = bzrdir.BzrDir.open(branch)
492
b = Branch.open_containing(filename)
494
fid = inv.path2id(b.relpath(filename))
496
raise BzrError("%r is not a versioned file" % filename)
497
for fip in inv.get_idpath(fid):
1630
501
class cmd_revision_history(Command):
1631
__doc__ = """Display the list of revision ids on a branch."""
1634
takes_args = ['location?']
1639
def run(self, location="."):
1640
branch = Branch.open_containing(location)[0]
1641
for revid in branch.revision_history():
1642
self.outf.write(revid)
1643
self.outf.write('\n')
1646
class cmd_ancestry(Command):
1647
__doc__ = """List all revisions merged into this branch."""
1649
_see_also = ['log', 'revision-history']
1650
takes_args = ['location?']
1655
def run(self, location="."):
1657
wt = WorkingTree.open_containing(location)[0]
1658
except errors.NoWorkingTree:
1659
b = Branch.open(location)
1660
last_revision = b.last_revision()
1663
last_revision = wt.last_revision()
1665
revision_ids = b.repository.get_ancestry(last_revision)
1667
for revision_id in revision_ids:
1668
self.outf.write(revision_id + '\n')
502
"""Display list of revision ids on this branch."""
505
for patchid in Branch.open_containing('.').revision_history():
509
class cmd_directories(Command):
510
"""Display list of versioned directories in this branch."""
512
for name, ie in Branch.open_containing('.').read_working_inventory().directories():
1671
519
class cmd_init(Command):
1672
__doc__ = """Make a directory into a versioned branch.
520
"""Make a directory into a versioned branch.
1674
522
Use this to create an empty branch, or before importing an
1675
523
existing project.
1677
If there is a repository in a parent directory of the location, then
1678
the history of the branch will be stored in the repository. Otherwise
1679
init creates a standalone branch which carries its own history
1680
in the .bzr directory.
1682
If there is already a branch at the location but it has no working tree,
1683
the tree can be populated with 'bzr checkout'.
1685
Recipe for importing a tree of files::
525
Recipe for importing a tree of files:
1691
bzr commit -m "imported project"
1694
_see_also = ['init-repository', 'branch', 'checkout']
1695
takes_args = ['location?']
1697
Option('create-prefix',
1698
help='Create the path leading up to the branch '
1699
'if it does not already exist.'),
1700
RegistryOption('format',
1701
help='Specify a format for this branch. '
1702
'See "help formats".',
1703
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1704
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1705
value_switches=True,
1706
title="Branch format",
1708
Option('append-revisions-only',
1709
help='Never change revnos or the existing log.'
1710
' Append revisions to it only.')
1712
def run(self, location=None, format=None, append_revisions_only=False,
1713
create_prefix=False):
1715
format = bzrdir.format_registry.make_bzrdir('default')
1716
if location is None:
1719
to_transport = transport.get_transport(location)
1721
# The path has to exist to initialize a
1722
# branch inside of it.
1723
# Just using os.mkdir, since I don't
1724
# believe that we want to create a bunch of
1725
# locations if the user supplies an extended path
1727
to_transport.ensure_base()
1728
except errors.NoSuchFile:
1729
if not create_prefix:
1730
raise errors.BzrCommandError("Parent directory of %s"
1732
"\nYou may supply --create-prefix to create all"
1733
" leading parent directories."
1735
to_transport.create_prefix()
1738
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1739
except errors.NotBranchError:
1740
# really a NotBzrDir error...
1741
create_branch = bzrdir.BzrDir.create_branch_convenience
1742
branch = create_branch(to_transport.base, format=format,
1743
possible_transports=[to_transport])
1744
a_bzrdir = branch.bzrdir
1746
from bzrlib.transport.local import LocalTransport
1747
if a_bzrdir.has_branch():
1748
if (isinstance(to_transport, LocalTransport)
1749
and not a_bzrdir.has_workingtree()):
1750
raise errors.BranchExistsWithoutWorkingTree(location)
1751
raise errors.AlreadyBranchError(location)
1752
branch = a_bzrdir.create_branch()
1753
a_bzrdir.create_workingtree()
1754
if append_revisions_only:
1756
branch.set_append_revisions_only(True)
1757
except errors.UpgradeRequired:
1758
raise errors.BzrCommandError('This branch format cannot be set'
1759
' to append-revisions-only. Try --default.')
1761
from bzrlib.info import describe_layout, describe_format
1763
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1764
except (errors.NoWorkingTree, errors.NotLocalUrl):
1766
repository = branch.repository
1767
layout = describe_layout(repository, branch, tree).lower()
1768
format = describe_format(a_bzrdir, repository, branch, tree)
1769
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1770
if repository.is_shared():
1771
#XXX: maybe this can be refactored into transport.path_or_url()
1772
url = repository.bzrdir.root_transport.external_url()
1774
url = urlutils.local_path_from_url(url)
1775
except errors.InvalidURL:
1777
self.outf.write("Using shared repository: %s\n" % url)
1780
class cmd_init_repository(Command):
1781
__doc__ = """Create a shared repository for branches to share storage space.
1783
New branches created under the repository directory will store their
1784
revisions in the repository, not in the branch directory. For branches
1785
with shared history, this reduces the amount of storage needed and
1786
speeds up the creation of new branches.
1788
If the --no-trees option is given then the branches in the repository
1789
will not have working trees by default. They will still exist as
1790
directories on disk, but they will not have separate copies of the
1791
files at a certain revision. This can be useful for repositories that
1792
store branches which are interacted with through checkouts or remote
1793
branches, such as on a server.
1796
Create a shared repository holding just branches::
1798
bzr init-repo --no-trees repo
1801
Make a lightweight checkout elsewhere::
1803
bzr checkout --lightweight repo/trunk trunk-checkout
1808
_see_also = ['init', 'branch', 'checkout', 'repositories']
1809
takes_args = ["location"]
1810
takes_options = [RegistryOption('format',
1811
help='Specify a format for this repository. See'
1812
' "bzr help formats" for details.',
1813
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1814
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1815
value_switches=True, title='Repository format'),
1817
help='Branches in the repository will default to'
1818
' not having a working tree.'),
1820
aliases = ["init-repo"]
1822
def run(self, location, format=None, no_trees=False):
1824
format = bzrdir.format_registry.make_bzrdir('default')
1826
if location is None:
1829
to_transport = transport.get_transport(location)
1830
to_transport.ensure_base()
1832
newdir = format.initialize_on_transport(to_transport)
1833
repo = newdir.create_repository(shared=True)
1834
repo.set_make_working_trees(not no_trees)
1836
from bzrlib.info import show_bzrdir_info
1837
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
530
bzr commit -m 'imported project'
533
from bzrlib.branch import Branch
534
Branch.initialize('.')
1840
537
class cmd_diff(Command):
1841
__doc__ = """Show differences in the working tree, between revisions or branches.
1843
If no arguments are given, all changes for the current tree are listed.
1844
If files are given, only the changes in those files are listed.
1845
Remote and multiple branches can be compared by using the --old and
1846
--new options. If not provided, the default for both is derived from
1847
the first argument, if any, or the current tree if no arguments are
1850
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1851
produces patches suitable for "patch -p1".
1855
2 - unrepresentable changes
1860
Shows the difference in the working tree versus the last commit::
1864
Difference between the working tree and revision 1::
1868
Difference between revision 3 and revision 1::
1872
Difference between revision 3 and revision 1 for branch xxx::
1876
To see the changes introduced in revision X::
1880
Note that in the case of a merge, the -c option shows the changes
1881
compared to the left hand parent. To see the changes against
1882
another parent, use::
1884
bzr diff -r<chosen_parent>..X
1886
The changes introduced by revision 2 (equivalent to -r1..2)::
1890
Show just the differences for file NEWS::
1894
Show the differences in working tree xxx for file NEWS::
1898
Show the differences from branch xxx to this working tree:
1902
Show the differences between two branches for file NEWS::
1904
bzr diff --old xxx --new yyy NEWS
1906
Same as 'bzr diff' but prefix paths with old/ and new/::
1908
bzr diff --prefix old/:new/
538
"""Show differences in working tree.
540
If files are listed, only the changes in those files are listed.
541
Otherwise, all changes for the tree are listed.
543
TODO: Allow diff across branches.
545
TODO: Option to use external diff command; could be GNU diff, wdiff,
548
TODO: Python difflib is not exactly the same as unidiff; should
549
either fix it up or prefer to use an external diff.
551
TODO: If a directory is given, diff everything under that.
553
TODO: Selected-file diff is inefficient and doesn't show you
556
TODO: This probably handles non-Unix newlines poorly.
1910
_see_also = ['status']
1911
564
takes_args = ['file*']
1913
Option('diff-options', type=str,
1914
help='Pass these options to the external diff program.'),
1915
Option('prefix', type=str,
1917
help='Set prefixes added to old and new filenames, as '
1918
'two values separated by a colon. (eg "old/:new/").'),
1920
help='Branch/tree to compare from.',
1924
help='Branch/tree to compare to.',
1930
help='Use this command to compare files.',
1933
RegistryOption('format',
1934
help='Diff format to use.',
1935
lazy_registry=('bzrlib.diff', 'format_registry'),
1936
value_switches=False, title='Diff format'),
565
takes_options = ['revision', 'diff-options']
1938
566
aliases = ['di', 'dif']
1939
encoding_type = 'exact'
1942
def run(self, revision=None, file_list=None, diff_options=None,
1943
prefix=None, old=None, new=None, using=None, format=None):
1944
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1947
if (prefix is None) or (prefix == '0'):
1955
old_label, new_label = prefix.split(":")
1957
raise errors.BzrCommandError(
1958
'--prefix expects two values separated by a colon'
1959
' (eg "old/:new/")')
1961
if revision and len(revision) > 2:
1962
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1963
' one or two revision specifiers')
1965
if using is not None and format is not None:
1966
raise errors.BzrCommandError('--using and --format are mutually '
1969
(old_tree, new_tree,
1970
old_branch, new_branch,
1971
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1972
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1973
# GNU diff on Windows uses ANSI encoding for filenames
1974
path_encoding = osutils.get_diff_header_encoding()
1975
return show_diff_trees(old_tree, new_tree, sys.stdout,
1976
specific_files=specific_files,
1977
external_diff_options=diff_options,
1978
old_label=old_label, new_label=new_label,
1979
extra_trees=extra_trees,
1980
path_encoding=path_encoding,
568
def run(self, revision=None, file_list=None, diff_options=None):
569
from bzrlib.diff import show_diff
572
b = Branch.open_containing(file_list[0])
573
file_list = [b.relpath(f) for f in file_list]
574
if file_list == ['']:
575
# just pointing to top-of-tree
578
b = Branch.open_containing('.')
580
if revision is not None:
581
if len(revision) == 1:
582
show_diff(b, revision[0], specific_files=file_list,
583
external_diff_options=diff_options)
584
elif len(revision) == 2:
585
show_diff(b, revision[0], specific_files=file_list,
586
external_diff_options=diff_options,
587
revision2=revision[1])
589
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
591
show_diff(b, None, specific_files=file_list,
592
external_diff_options=diff_options)
1985
597
class cmd_deleted(Command):
1986
__doc__ = """List files deleted in the working tree.
598
"""List files deleted in the working tree.
600
TODO: Show files deleted since a previous revision, or between two revisions.
1988
# TODO: Show files deleted since a previous revision, or
1989
# between two revisions.
1990
# TODO: Much more efficient way to do this: read in new
1991
# directories with readdir, rather than stating each one. Same
1992
# level of effort but possibly much less IO. (Or possibly not,
1993
# if the directories are very large...)
1994
_see_also = ['status', 'ls']
1995
takes_options = ['directory', 'show-ids']
1998
def run(self, show_ids=False, directory=u'.'):
1999
tree = WorkingTree.open_containing(directory)[0]
2000
self.add_cleanup(tree.lock_read().unlock)
2001
old = tree.basis_tree()
2002
self.add_cleanup(old.lock_read().unlock)
602
def run(self, show_ids=False):
603
b = Branch.open_containing('.')
605
new = b.working_tree()
607
## TODO: Much more efficient way to do this: read in new
608
## directories with readdir, rather than stating each one. Same
609
## level of effort but possibly much less IO. (Or possibly not,
610
## if the directories are very large...)
2003
612
for path, ie in old.inventory.iter_entries():
2004
if not tree.has_id(ie.file_id):
2005
self.outf.write(path)
613
if not new.has_id(ie.file_id):
2007
self.outf.write(' ')
2008
self.outf.write(ie.file_id)
2009
self.outf.write('\n')
615
print '%-50s %s' % (path, ie.file_id)
2012
620
class cmd_modified(Command):
2013
__doc__ = """List files modified in working tree.
621
"""List files modified in working tree."""
2017
_see_also = ['status', 'ls']
2018
takes_options = ['directory', 'null']
2021
def run(self, null=False, directory=u'.'):
2022
tree = WorkingTree.open_containing(directory)[0]
2023
td = tree.changes_from(tree.basis_tree())
2024
for path, id, kind, text_modified, meta_modified in td.modified:
2026
self.outf.write(path + '\0')
2028
self.outf.write(osutils.quotefn(path) + '\n')
624
from bzrlib.delta import compare_trees
626
b = Branch.open_containing('.')
627
td = compare_trees(b.basis_tree(), b.working_tree())
629
for path, id, kind in td.modified:
2031
634
class cmd_added(Command):
2032
__doc__ = """List files added in working tree.
635
"""List files added in working tree."""
2036
_see_also = ['status', 'ls']
2037
takes_options = ['directory', 'null']
2040
def run(self, null=False, directory=u'.'):
2041
wt = WorkingTree.open_containing(directory)[0]
2042
self.add_cleanup(wt.lock_read().unlock)
2043
basis = wt.basis_tree()
2044
self.add_cleanup(basis.lock_read().unlock)
2045
basis_inv = basis.inventory
638
b = Branch.open_containing('.')
639
wt = b.working_tree()
640
basis_inv = b.basis_tree().inventory
2046
641
inv = wt.inventory
2047
642
for file_id in inv:
2048
643
if file_id in basis_inv:
2050
if inv.is_root(file_id) and len(basis_inv) == 0:
2052
645
path = inv.id2path(file_id)
2053
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
646
if not os.access(b.abspath(path), os.F_OK):
2056
self.outf.write(path + '\0')
2058
self.outf.write(osutils.quotefn(path) + '\n')
2061
652
class cmd_root(Command):
2062
__doc__ = """Show the tree root directory.
653
"""Show the tree root directory.
2064
655
The root is the nearest enclosing directory with a .bzr control
2067
657
takes_args = ['filename?']
2069
658
def run(self, filename=None):
2070
659
"""Print the branch root."""
2071
tree = WorkingTree.open_containing(filename)[0]
2072
self.outf.write(tree.basedir + '\n')
2075
def _parse_limit(limitstring):
2077
return int(limitstring)
2079
msg = "The limit argument must be an integer."
2080
raise errors.BzrCommandError(msg)
2083
def _parse_levels(s):
2087
msg = "The levels argument must be an integer."
2088
raise errors.BzrCommandError(msg)
660
b = Branch.open_containing(filename)
2091
664
class cmd_log(Command):
2092
__doc__ = """Show historical log for a branch or subset of a branch.
2094
log is bzr's default tool for exploring the history of a branch.
2095
The branch to use is taken from the first parameter. If no parameters
2096
are given, the branch containing the working directory is logged.
2097
Here are some simple examples::
2099
bzr log log the current branch
2100
bzr log foo.py log a file in its branch
2101
bzr log http://server/branch log a branch on a server
2103
The filtering, ordering and information shown for each revision can
2104
be controlled as explained below. By default, all revisions are
2105
shown sorted (topologically) so that newer revisions appear before
2106
older ones and descendants always appear before ancestors. If displayed,
2107
merged revisions are shown indented under the revision in which they
2112
The log format controls how information about each revision is
2113
displayed. The standard log formats are called ``long``, ``short``
2114
and ``line``. The default is long. See ``bzr help log-formats``
2115
for more details on log formats.
2117
The following options can be used to control what information is
2120
-l N display a maximum of N revisions
2121
-n N display N levels of revisions (0 for all, 1 for collapsed)
2122
-v display a status summary (delta) for each revision
2123
-p display a diff (patch) for each revision
2124
--show-ids display revision-ids (and file-ids), not just revnos
2126
Note that the default number of levels to display is a function of the
2127
log format. If the -n option is not used, the standard log formats show
2128
just the top level (mainline).
2130
Status summaries are shown using status flags like A, M, etc. To see
2131
the changes explained using words like ``added`` and ``modified``
2132
instead, use the -vv option.
2136
To display revisions from oldest to newest, use the --forward option.
2137
In most cases, using this option will have little impact on the total
2138
time taken to produce a log, though --forward does not incrementally
2139
display revisions like --reverse does when it can.
2141
:Revision filtering:
2143
The -r option can be used to specify what revision or range of revisions
2144
to filter against. The various forms are shown below::
2146
-rX display revision X
2147
-rX.. display revision X and later
2148
-r..Y display up to and including revision Y
2149
-rX..Y display from X to Y inclusive
2151
See ``bzr help revisionspec`` for details on how to specify X and Y.
2152
Some common examples are given below::
2154
-r-1 show just the tip
2155
-r-10.. show the last 10 mainline revisions
2156
-rsubmit:.. show what's new on this branch
2157
-rancestor:path.. show changes since the common ancestor of this
2158
branch and the one at location path
2159
-rdate:yesterday.. show changes since yesterday
2161
When logging a range of revisions using -rX..Y, log starts at
2162
revision Y and searches back in history through the primary
2163
("left-hand") parents until it finds X. When logging just the
2164
top level (using -n1), an error is reported if X is not found
2165
along the way. If multi-level logging is used (-n0), X may be
2166
a nested merge revision and the log will be truncated accordingly.
2170
If parameters are given and the first one is not a branch, the log
2171
will be filtered to show only those revisions that changed the
2172
nominated files or directories.
2174
Filenames are interpreted within their historical context. To log a
2175
deleted file, specify a revision range so that the file existed at
2176
the end or start of the range.
2178
Historical context is also important when interpreting pathnames of
2179
renamed files/directories. Consider the following example:
2181
* revision 1: add tutorial.txt
2182
* revision 2: modify tutorial.txt
2183
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2187
* ``bzr log guide.txt`` will log the file added in revision 1
2189
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2191
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2192
the original file in revision 2.
2194
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2195
was no file called guide.txt in revision 2.
2197
Renames are always followed by log. By design, there is no need to
2198
explicitly ask for this (and no way to stop logging a file back
2199
until it was last renamed).
2203
The --message option can be used for finding revisions that match a
2204
regular expression in a commit message.
2208
GUI tools and IDEs are often better at exploring history than command
2209
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2210
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2211
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2212
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2214
You may find it useful to add the aliases below to ``bazaar.conf``::
2218
top = log -l10 --line
2221
``bzr tip`` will then show the latest revision while ``bzr top``
2222
will show the last 10 mainline revisions. To see the details of a
2223
particular revision X, ``bzr show -rX``.
2225
If you are interested in looking deeper into a particular merge X,
2226
use ``bzr log -n0 -rX``.
2228
``bzr log -v`` on a branch with lots of history is currently
2229
very slow. A fix for this issue is currently under development.
2230
With or without that fix, it is recommended that a revision range
2231
be given when using the -v option.
2233
bzr has a generic full-text matching plugin, bzr-search, that can be
2234
used to find revisions matching user names, commit messages, etc.
2235
Among other features, this plugin can find all revisions containing
2236
a list of words but not others.
2238
When exploring non-mainline history on large projects with deep
2239
history, the performance of log can be greatly improved by installing
2240
the historycache plugin. This plugin buffers historical information
2241
trading disk space for faster speed.
665
"""Show log of this branch.
667
To request a range of logs, you can use the command -r begin:end
668
-r revision requests a specific revision, -r :end or -r begin: are
671
--message allows you to give a regular expression, which will be evaluated
672
so that only matching entries will be displayed.
674
TODO: Make --revision support uuid: and hash: [future tag:] notation.
2243
takes_args = ['file*']
2244
_see_also = ['log-formats', 'revisionspec']
2247
help='Show from oldest to newest.'),
2249
custom_help('verbose',
2250
help='Show files changed in each revision.'),
2254
type=bzrlib.option._parse_revision_str,
2256
help='Show just the specified revision.'
2257
' See also "help revisionspec".'),
2259
RegistryOption('authors',
2260
'What names to list as authors - first, all or committer.',
2262
lazy_registry=('bzrlib.log', 'author_list_registry'),
2266
help='Number of levels to display - 0 for all, 1 for flat.',
2268
type=_parse_levels),
2271
help='Show revisions whose message matches this '
2272
'regular expression.',
2276
help='Limit the output to the first N revisions.',
2281
help='Show changes made in each revision as a patch.'),
2282
Option('include-merges',
2283
help='Show merged revisions like --levels 0 does.'),
2284
Option('exclude-common-ancestry',
2285
help='Display only the revisions that are not part'
2286
' of both ancestries (require -rX..Y)'
2289
encoding_type = 'replace'
2292
def run(self, file_list=None, timezone='original',
678
takes_args = ['filename?']
679
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
680
'long', 'message', 'short',]
682
def run(self, filename=None, timezone='original',
2303
include_merges=False,
2305
exclude_common_ancestry=False,
2307
from bzrlib.log import (
2309
make_log_request_dict,
2310
_get_info_for_log_files,
690
from bzrlib.log import log_formatter, show_log
2312
693
direction = (forward and 'forward') or 'reverse'
2313
if (exclude_common_ancestry
2314
and (revision is None or len(revision) != 2)):
2315
raise errors.BzrCommandError(
2316
'--exclude-common-ancestry requires -r with two revisions')
2321
raise errors.BzrCommandError(
2322
'--levels and --include-merges are mutually exclusive')
2324
if change is not None:
2326
raise errors.RangeInChangeOption()
2327
if revision is not None:
2328
raise errors.BzrCommandError(
2329
'--revision and --change are mutually exclusive')
2334
filter_by_dir = False
2336
# find the file ids to log and check for directory filtering
2337
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2338
revision, file_list, self.add_cleanup)
2339
for relpath, file_id, kind in file_info_list:
2341
raise errors.BzrCommandError(
2342
"Path unknown at end or start of revision range: %s" %
2344
# If the relpath is the top of the tree, we log everything
2349
file_ids.append(file_id)
2350
filter_by_dir = filter_by_dir or (
2351
kind in ['directory', 'tree-reference'])
2354
# FIXME ? log the current subdir only RBC 20060203
2355
if revision is not None \
2356
and len(revision) > 0 and revision[0].get_branch():
2357
location = revision[0].get_branch()
2360
dir, relpath = bzrdir.BzrDir.open_containing(location)
2361
b = dir.open_branch()
2362
self.add_cleanup(b.lock_read().unlock)
2363
rev1, rev2 = _get_revision_range(revision, b, self.name())
2365
# Decide on the type of delta & diff filtering to use
2366
# TODO: add an --all-files option to make this configurable & consistent
2374
diff_type = 'partial'
2378
# Build the log formatter
2379
if log_format is None:
2380
log_format = log.log_formatter_registry.get_default(b)
2381
# Make a non-encoding output to include the diffs - bug 328007
2382
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2383
lf = log_format(show_ids=show_ids, to_file=self.outf,
2384
to_exact_file=unencoded_output,
2385
show_timezone=timezone,
2386
delta_format=get_verbosity_level(),
2388
show_advice=levels is None,
2389
author_list_handler=authors)
2391
# Choose the algorithm for doing the logging. It's annoying
2392
# having multiple code paths like this but necessary until
2393
# the underlying repository format is faster at generating
2394
# deltas or can provide everything we need from the indices.
2395
# The default algorithm - match-using-deltas - works for
2396
# multiple files and directories and is faster for small
2397
# amounts of history (200 revisions say). However, it's too
2398
# slow for logging a single file in a repository with deep
2399
# history, i.e. > 10K revisions. In the spirit of "do no
2400
# evil when adding features", we continue to use the
2401
# original algorithm - per-file-graph - for the "single
2402
# file that isn't a directory without showing a delta" case.
2403
partial_history = revision and b.repository._format.supports_chks
2404
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2405
or delta_type or partial_history)
2407
# Build the LogRequest and execute it
2408
if len(file_ids) == 0:
2410
rqst = make_log_request_dict(
2411
direction=direction, specific_fileids=file_ids,
2412
start_revision=rev1, end_revision=rev2, limit=limit,
2413
message_search=message, delta_type=delta_type,
2414
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2415
exclude_common_ancestry=exclude_common_ancestry,
2417
Logger(b, rqst).show(lf)
2420
def _get_revision_range(revisionspec_list, branch, command_name):
2421
"""Take the input of a revision option and turn it into a revision range.
2423
It returns RevisionInfo objects which can be used to obtain the rev_id's
2424
of the desired revisions. It does some user input validations.
2426
if revisionspec_list is None:
2429
elif len(revisionspec_list) == 1:
2430
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2431
elif len(revisionspec_list) == 2:
2432
start_spec = revisionspec_list[0]
2433
end_spec = revisionspec_list[1]
2434
if end_spec.get_branch() != start_spec.get_branch():
2435
# b is taken from revision[0].get_branch(), and
2436
# show_log will use its revision_history. Having
2437
# different branches will lead to weird behaviors.
2438
raise errors.BzrCommandError(
2439
"bzr %s doesn't accept two revisions in different"
2440
" branches." % command_name)
2441
if start_spec.spec is None:
2442
# Avoid loading all the history.
2443
rev1 = RevisionInfo(branch, None, None)
2445
rev1 = start_spec.in_history(branch)
2446
# Avoid loading all of history when we know a missing
2447
# end of range means the last revision ...
2448
if end_spec.spec is None:
2449
last_revno, last_revision_id = branch.last_revision_info()
2450
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2452
rev2 = end_spec.in_history(branch)
2454
raise errors.BzrCommandError(
2455
'bzr %s --revision takes one or two values.' % command_name)
2459
def _revision_range_to_revid_range(revision_range):
2462
if revision_range[0] is not None:
2463
rev_id1 = revision_range[0].rev_id
2464
if revision_range[1] is not None:
2465
rev_id2 = revision_range[1].rev_id
2466
return rev_id1, rev_id2
2468
def get_log_format(long=False, short=False, line=False, default='long'):
2469
log_format = default
2473
log_format = 'short'
696
b = Branch.open_containing(filename)
697
fp = b.relpath(filename)
699
file_id = b.read_working_inventory().path2id(fp)
701
file_id = None # points to branch root
703
b = Branch.open_containing('.')
709
elif len(revision) == 1:
710
rev1 = rev2 = revision[0].in_history(b).revno
711
elif len(revision) == 2:
712
rev1 = revision[0].in_history(b).revno
713
rev2 = revision[1].in_history(b).revno
715
raise BzrCommandError('bzr log --revision takes one or two values.')
722
mutter('encoding log as %r' % bzrlib.user_encoding)
724
# use 'replace' so that we don't abort if trying to write out
725
# in e.g. the default C locale.
726
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
732
lf = log_formatter(log_format,
735
show_timezone=timezone)
2479
748
class cmd_touching_revisions(Command):
2480
__doc__ = """Return revision-ids which affected a particular file.
2482
A more user-friendly interface is "bzr log FILE".
749
"""Return revision-ids which affected a particular file.
751
A more user-friendly interface is "bzr log FILE"."""
2486
753
takes_args = ["filename"]
2489
754
def run(self, filename):
2490
tree, relpath = WorkingTree.open_containing(filename)
2491
file_id = tree.path2id(relpath)
2493
self.add_cleanup(b.lock_read().unlock)
2494
touching_revs = log.find_touching_revisions(b, file_id)
2495
for revno, revision_id, what in touching_revs:
2496
self.outf.write("%6d %s\n" % (revno, what))
755
b = Branch.open_containing(filename)
756
inv = b.read_working_inventory()
757
file_id = inv.path2id(b.relpath(filename))
758
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
759
print "%6d %s" % (revno, what)
2499
762
class cmd_ls(Command):
2500
__doc__ = """List files in a tree.
763
"""List files in a tree.
765
TODO: Take a revision or remote path and list that tree instead.
2503
_see_also = ['status', 'cat']
2504
takes_args = ['path?']
2508
Option('recursive', short_name='R',
2509
help='Recurse into subdirectories.'),
2511
help='Print paths relative to the root of the branch.'),
2512
Option('unknown', short_name='u',
2513
help='Print unknown files.'),
2514
Option('versioned', help='Print versioned files.',
2516
Option('ignored', short_name='i',
2517
help='Print ignored files.'),
2518
Option('kind', short_name='k',
2519
help='List entries of a particular kind: file, directory, symlink.',
2526
def run(self, revision=None, verbose=False,
2527
recursive=False, from_root=False,
2528
unknown=False, versioned=False, ignored=False,
2529
null=False, kind=None, show_ids=False, path=None, directory=None):
2531
if kind and kind not in ('file', 'directory', 'symlink'):
2532
raise errors.BzrCommandError('invalid kind specified')
2534
if verbose and null:
2535
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2536
all = not (unknown or versioned or ignored)
2538
selection = {'I':ignored, '?':unknown, 'V':versioned}
768
def run(self, revision=None, verbose=False):
769
b = Branch.open_containing('.')
771
tree = b.working_tree()
2544
raise errors.BzrCommandError('cannot specify both --from-root'
2547
tree, branch, relpath = \
2548
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2550
# Calculate the prefix to use
2554
prefix = relpath + '/'
2555
elif fs_path != '.' and not fs_path.endswith('/'):
2556
prefix = fs_path + '/'
2558
if revision is not None or tree is None:
2559
tree = _get_one_revision_tree('ls', revision, branch=branch)
2562
if isinstance(tree, WorkingTree) and tree.supports_views():
2563
view_files = tree.views.lookup_view()
2566
view_str = views.view_display_str(view_files)
2567
note("Ignoring files outside view. View is %s" % view_str)
2569
self.add_cleanup(tree.lock_read().unlock)
2570
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2571
from_dir=relpath, recursive=recursive):
2572
# Apply additional masking
2573
if not all and not selection[fc]:
2575
if kind is not None and fkind != kind:
2580
fullpath = osutils.pathjoin(relpath, fp)
2583
views.check_path_in_view(tree, fullpath)
2584
except errors.FileOutsideView:
2589
fp = osutils.pathjoin(prefix, fp)
2590
kindch = entry.kind_character()
2591
outstring = fp + kindch
2592
ui.ui_factory.clear_term()
773
tree = b.revision_tree(revision.in_history(b).rev_id)
775
for fp, fc, kind, fid in tree.list_files():
2594
outstring = '%-8s %s' % (fc, outstring)
2595
if show_ids and fid is not None:
2596
outstring = "%-50s %s" % (outstring, fid)
2597
self.outf.write(outstring + '\n')
2599
self.outf.write(fp + '\0')
2602
self.outf.write(fid)
2603
self.outf.write('\0')
777
if kind == 'directory':
784
print '%-8s %s%s' % (fc, fp, kindch)
2611
self.outf.write('%-50s %s\n' % (outstring, my_id))
2613
self.outf.write(outstring + '\n')
2616
790
class cmd_unknowns(Command):
2617
__doc__ = """List unknown files.
2622
takes_options = ['directory']
2625
def run(self, directory=u'.'):
2626
for f in WorkingTree.open_containing(directory)[0].unknowns():
2627
self.outf.write(osutils.quotefn(f) + '\n')
791
"""List unknown files."""
793
from bzrlib.osutils import quotefn
794
for f in Branch.open_containing('.').unknowns():
2630
799
class cmd_ignore(Command):
2631
__doc__ = """Ignore specified files or patterns.
2633
See ``bzr help patterns`` for details on the syntax of patterns.
2635
If a .bzrignore file does not exist, the ignore command
2636
will create one and add the specified files or patterns to the newly
2637
created file. The ignore command will also automatically add the
2638
.bzrignore file to be versioned. Creating a .bzrignore file without
2639
the use of the ignore command will require an explicit add command.
800
"""Ignore a command or pattern.
2641
802
To remove patterns from the ignore list, edit the .bzrignore file.
2642
After adding, editing or deleting that file either indirectly by
2643
using this command or directly by using an editor, be sure to commit
2646
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2647
the global ignore file can be found in the application data directory as
2648
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2649
Global ignores are not touched by this command. The global ignore file
2650
can be edited directly using an editor.
2652
Patterns prefixed with '!' are exceptions to ignore patterns and take
2653
precedence over regular ignores. Such exceptions are used to specify
2654
files that should be versioned which would otherwise be ignored.
2656
Patterns prefixed with '!!' act as regular ignore patterns, but have
2657
precedence over the '!' exception patterns.
2659
Note: ignore patterns containing shell wildcards must be quoted from
2663
Ignore the top level Makefile::
2665
bzr ignore ./Makefile
2667
Ignore .class files in all directories...::
2669
bzr ignore "*.class"
2671
...but do not ignore "special.class"::
2673
bzr ignore "!special.class"
2675
Ignore .o files under the lib directory::
2677
bzr ignore "lib/**/*.o"
2679
Ignore .o files under the lib directory::
2681
bzr ignore "RE:lib/.*\.o"
2683
Ignore everything but the "debian" toplevel directory::
2685
bzr ignore "RE:(?!debian/).*"
2687
Ignore everything except the "local" toplevel directory,
2688
but always ignore "*~" autosave files, even under local/::
2691
bzr ignore "!./local"
804
If the pattern contains a slash, it is compared to the whole path
805
from the branch root. Otherwise, it is comapred to only the last
806
component of the path.
808
Ignore patterns are case-insensitive on case-insensitive systems.
810
Note: wildcards must be quoted from the shell on Unix.
813
bzr ignore ./Makefile
2695
_see_also = ['status', 'ignored', 'patterns']
2696
takes_args = ['name_pattern*']
2697
takes_options = ['directory',
2698
Option('default-rules',
2699
help='Display the default ignore rules that bzr uses.')
2702
def run(self, name_pattern_list=None, default_rules=None,
2704
from bzrlib import ignores
2705
if default_rules is not None:
2706
# dump the default rules and exit
2707
for pattern in ignores.USER_DEFAULTS:
2708
self.outf.write("%s\n" % pattern)
2710
if not name_pattern_list:
2711
raise errors.BzrCommandError("ignore requires at least one "
2712
"NAME_PATTERN or --default-rules.")
2713
name_pattern_list = [globbing.normalize_pattern(p)
2714
for p in name_pattern_list]
2716
for p in name_pattern_list:
2717
if not globbing.Globster.is_pattern_valid(p):
2718
bad_patterns += ('\n %s' % p)
2720
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2721
ui.ui_factory.show_error(msg)
2722
raise errors.InvalidPattern('')
2723
for name_pattern in name_pattern_list:
2724
if (name_pattern[0] == '/' or
2725
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2726
raise errors.BzrCommandError(
2727
"NAME_PATTERN should not be an absolute path")
2728
tree, relpath = WorkingTree.open_containing(directory)
2729
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2730
ignored = globbing.Globster(name_pattern_list)
2732
self.add_cleanup(tree.lock_read().unlock)
2733
for entry in tree.list_files():
2737
if ignored.match(filename):
2738
matches.append(filename)
2739
if len(matches) > 0:
2740
self.outf.write("Warning: the following files are version controlled and"
2741
" match your ignore pattern:\n%s"
2742
"\nThese files will continue to be version controlled"
2743
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
816
takes_args = ['name_pattern']
818
def run(self, name_pattern):
819
from bzrlib.atomicfile import AtomicFile
822
b = Branch.open_containing('.')
823
ifn = b.abspath('.bzrignore')
825
if os.path.exists(ifn):
828
igns = f.read().decode('utf-8')
834
# TODO: If the file already uses crlf-style termination, maybe
835
# we should use that for the newly added lines?
837
if igns and igns[-1] != '\n':
839
igns += name_pattern + '\n'
842
f = AtomicFile(ifn, 'wt')
843
f.write(igns.encode('utf-8'))
848
inv = b.working_tree().inventory
849
if inv.path2id('.bzrignore'):
850
mutter('.bzrignore is already versioned')
852
mutter('need to make new .bzrignore file versioned')
853
b.add(['.bzrignore'])
2746
857
class cmd_ignored(Command):
2747
__doc__ = """List ignored files and the patterns that matched them.
2749
List all the ignored files and the ignore pattern that caused the file to
2752
Alternatively, to list just the files::
2757
encoding_type = 'replace'
2758
_see_also = ['ignore', 'ls']
2759
takes_options = ['directory']
2762
def run(self, directory=u'.'):
2763
tree = WorkingTree.open_containing(directory)[0]
2764
self.add_cleanup(tree.lock_read().unlock)
2765
for path, file_class, kind, file_id, entry in tree.list_files():
858
"""List ignored files and the patterns that matched them.
860
See also: bzr ignore"""
862
tree = Branch.open_containing('.').working_tree()
863
for path, file_class, kind, file_id in tree.list_files():
2766
864
if file_class != 'I':
2768
866
## XXX: Slightly inefficient since this was already calculated
2769
867
pat = tree.is_ignored(path)
2770
self.outf.write('%-50s %s\n' % (path, pat))
868
print '%-50s %s' % (path, pat)
2773
871
class cmd_lookup_revision(Command):
2774
__doc__ = """Lookup the revision-id from a revision-number
872
"""Lookup the revision-id from a revision-number
2777
875
bzr lookup-revision 33
2780
878
takes_args = ['revno']
2781
takes_options = ['directory']
2784
def run(self, revno, directory=u'.'):
880
def run(self, revno):
2786
882
revno = int(revno)
2787
883
except ValueError:
2788
raise errors.BzrCommandError("not a valid revision-number: %r"
2790
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2791
self.outf.write("%s\n" % revid)
884
raise BzrCommandError("not a valid revision-number: %r" % revno)
886
print Branch.open_containing('.').get_rev_id(revno)
2794
889
class cmd_export(Command):
2795
__doc__ = """Export current or past revision to a destination directory or archive.
890
"""Export past revision to destination directory.
2797
892
If no revision is specified this exports the last committed revision.
2800
895
given, try to find the format with the extension. If no extension
2801
896
is found exports to a directory (equivalent to --format=dir).
2803
If root is supplied, it will be used as the root directory inside
2804
container formats (tar, zip, etc). If it is not supplied it will default
2805
to the exported filename. The root option has no effect for 'dir' format.
2807
If branch is omitted then the branch containing the current working
2808
directory will be used.
2810
Note: Export of tree with non-ASCII filenames to zip is not supported.
2812
================= =========================
2813
Supported formats Autodetected by extension
2814
================= =========================
2817
tbz2 .tar.bz2, .tbz2
2820
================= =========================
2822
takes_args = ['dest', 'branch_or_subdir?']
2823
takes_options = ['directory',
2825
help="Type of file to export to.",
2828
Option('filters', help='Apply content filters to export the '
2829
'convenient form.'),
2832
help="Name of the root directory inside the exported file."),
2833
Option('per-file-timestamps',
2834
help='Set modification time of files to that of the last '
2835
'revision in which it was changed.'),
2837
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2838
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2839
from bzrlib.export import export
2841
if branch_or_subdir is None:
2842
tree = WorkingTree.open_containing(directory)[0]
898
Root may be the top directory for tar, tgz and tbz2 formats. If none
899
is given, the top directory will be the root name of the file."""
900
# TODO: list known exporters
901
takes_args = ['dest']
902
takes_options = ['revision', 'format', 'root']
903
def run(self, dest, revision=None, format=None, root=None):
905
b = Branch.open_containing('.')
907
rev_id = b.last_patch()
2846
b, subdir = Branch.open_containing(branch_or_subdir)
2849
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2851
export(rev_tree, dest, format, root, subdir, filtered=filters,
2852
per_file_timestamps=per_file_timestamps)
2853
except errors.NoSuchExportFormat, e:
2854
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
909
if len(revision) != 1:
910
raise BzrError('bzr export --revision takes exactly 1 argument')
911
rev_id = revision[0].in_history(b).rev_id
912
t = b.revision_tree(rev_id)
913
root, ext = os.path.splitext(dest)
917
elif ext in (".gz", ".tgz"):
919
elif ext in (".bz2", ".tbz2"):
923
t.export(dest, format, root)
2857
926
class cmd_cat(Command):
2858
__doc__ = """Write the contents of a file as of a given revision to standard output.
2860
If no revision is nominated, the last revision is used.
2862
Note: Take care to redirect standard output when using this command on a
2867
takes_options = ['directory',
2868
Option('name-from-revision', help='The path name in the old tree.'),
2869
Option('filters', help='Apply content filters to display the '
2870
'convenience form.'),
927
"""Write a file's text from a previous revision."""
929
takes_options = ['revision']
2873
930
takes_args = ['filename']
2874
encoding_type = 'exact'
2877
def run(self, filename, revision=None, name_from_revision=False,
2878
filters=False, directory=None):
2879
if revision is not None and len(revision) != 1:
2880
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2881
" one revision specifier")
2882
tree, branch, relpath = \
2883
_open_directory_or_containing_tree_or_branch(filename, directory)
2884
self.add_cleanup(branch.lock_read().unlock)
2885
return self._run(tree, branch, relpath, filename, revision,
2886
name_from_revision, filters)
2888
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2891
tree = b.basis_tree()
2892
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2893
self.add_cleanup(rev_tree.lock_read().unlock)
2895
old_file_id = rev_tree.path2id(relpath)
2897
if name_from_revision:
2898
# Try in revision if requested
2899
if old_file_id is None:
2900
raise errors.BzrCommandError(
2901
"%r is not present in revision %s" % (
2902
filename, rev_tree.get_revision_id()))
2904
content = rev_tree.get_file_text(old_file_id)
2906
cur_file_id = tree.path2id(relpath)
2908
if cur_file_id is not None:
2909
# Then try with the actual file id
2911
content = rev_tree.get_file_text(cur_file_id)
2913
except errors.NoSuchId:
2914
# The actual file id didn't exist at that time
2916
if not found and old_file_id is not None:
2917
# Finally try with the old file id
2918
content = rev_tree.get_file_text(old_file_id)
2921
# Can't be found anywhere
2922
raise errors.BzrCommandError(
2923
"%r is not present in revision %s" % (
2924
filename, rev_tree.get_revision_id()))
2926
from bzrlib.filters import (
2927
ContentFilterContext,
2928
filtered_output_bytes,
2930
filters = rev_tree._content_filter_stack(relpath)
2931
chunks = content.splitlines(True)
2932
content = filtered_output_bytes(chunks, filters,
2933
ContentFilterContext(relpath, rev_tree))
2935
self.outf.writelines(content)
2938
self.outf.write(content)
932
def run(self, filename, revision=None):
934
raise BzrCommandError("bzr cat requires a revision number")
935
elif len(revision) != 1:
936
raise BzrCommandError("bzr cat --revision takes exactly one number")
937
b = Branch.open_containing('.')
938
b.print_file(b.relpath(filename), revision[0].in_history(b).revno)
2941
941
class cmd_local_time_offset(Command):
2942
__doc__ = """Show the offset in seconds from GMT to local time."""
942
"""Show the offset in seconds from GMT to local time."""
2946
self.outf.write("%s\n" % osutils.local_time_offset())
945
print bzrlib.osutils.local_time_offset()
2950
949
class cmd_commit(Command):
2951
__doc__ = """Commit changes into a new revision.
2953
An explanatory message needs to be given for each commit. This is
2954
often done by using the --message option (getting the message from the
2955
command line) or by using the --file option (getting the message from
2956
a file). If neither of these options is given, an editor is opened for
2957
the user to enter the message. To see the changed files in the
2958
boilerplate text loaded into the editor, use the --show-diff option.
2960
By default, the entire tree is committed and the person doing the
2961
commit is assumed to be the author. These defaults can be overridden
2966
If selected files are specified, only changes to those files are
2967
committed. If a directory is specified then the directory and
2968
everything within it is committed.
2970
When excludes are given, they take precedence over selected files.
2971
For example, to commit only changes within foo, but not changes
2974
bzr commit foo -x foo/bar
2976
A selective commit after a merge is not yet supported.
2980
If the author of the change is not the same person as the committer,
2981
you can specify the author's name using the --author option. The
2982
name should be in the same format as a committer-id, e.g.
2983
"John Doe <jdoe@example.com>". If there is more than one author of
2984
the change you can specify the option multiple times, once for each
2989
A common mistake is to forget to add a new file or directory before
2990
running the commit command. The --strict option checks for unknown
2991
files and aborts the commit if any are found. More advanced pre-commit
2992
checks can be implemented by defining hooks. See ``bzr help hooks``
2997
If you accidentially commit the wrong changes or make a spelling
2998
mistake in the commit message say, you can use the uncommit command
2999
to undo it. See ``bzr help uncommit`` for details.
3001
Hooks can also be configured to run after a commit. This allows you
3002
to trigger updates to external systems like bug trackers. The --fixes
3003
option can be used to record the association between a revision and
3004
one or more bugs. See ``bzr help bugs`` for details.
3006
A selective commit may fail in some cases where the committed
3007
tree would be invalid. Consider::
3012
bzr commit foo -m "committing foo"
3013
bzr mv foo/bar foo/baz
3016
bzr commit foo/bar -m "committing bar but not baz"
3018
In the example above, the last commit will fail by design. This gives
3019
the user the opportunity to decide whether they want to commit the
3020
rename at the same time, separately first, or not at all. (As a general
3021
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
950
"""Commit changes into a new revision.
952
If no arguments are given, the entire tree is committed.
954
If selected files are specified, only changes to those files are
955
committed. If a directory is specified then the directory and everything
956
within it is committed.
958
A selected-file commit may fail in some cases where the committed
959
tree would be invalid, such as trying to commit a file in a
960
newly-added directory that is not itself committed.
962
TODO: Run hooks on tree to-be-committed, and after commit.
964
TODO: Strict commit that fails if there are unknown or deleted files.
3023
# TODO: Run hooks on tree to-be-committed, and after commit.
3025
# TODO: Strict commit that fails if there are deleted files.
3026
# (what does "deleted files" mean ??)
3028
# TODO: Give better message for -s, --summary, used by tla people
3030
# XXX: verbose currently does nothing
3032
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3033
966
takes_args = ['selected*']
3035
ListOption('exclude', type=str, short_name='x',
3036
help="Do not consider changes made to a given path."),
3037
Option('message', type=unicode,
3039
help="Description of the new revision."),
3042
help='Commit even if nothing has changed.'),
3043
Option('file', type=str,
3046
help='Take commit message from this file.'),
3048
help="Refuse to commit if there are unknown "
3049
"files in the working tree."),
3050
Option('commit-time', type=str,
3051
help="Manually set a commit time using commit date "
3052
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3053
ListOption('fixes', type=str,
3054
help="Mark a bug as being fixed by this revision "
3055
"(see \"bzr help bugs\")."),
3056
ListOption('author', type=unicode,
3057
help="Set the author's name, if it's different "
3058
"from the committer."),
3060
help="Perform a local commit in a bound "
3061
"branch. Local commits are not pushed to "
3062
"the master branch until a normal commit "
3065
Option('show-diff', short_name='p',
3066
help='When no message is supplied, show the diff along'
3067
' with the status summary in the message editor.'),
967
takes_options = ['message', 'file', 'verbose', 'unchanged']
3069
968
aliases = ['ci', 'checkin']
3071
def _iter_bug_fix_urls(self, fixes, branch):
3072
# Configure the properties for bug fixing attributes.
3073
for fixed_bug in fixes:
3074
tokens = fixed_bug.split(':')
3075
if len(tokens) != 2:
3076
raise errors.BzrCommandError(
3077
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3078
"See \"bzr help bugs\" for more information on this "
3079
"feature.\nCommit refused." % fixed_bug)
3080
tag, bug_id = tokens
3082
yield bugtracker.get_bug_url(tag, branch, bug_id)
3083
except errors.UnknownBugTrackerAbbreviation:
3084
raise errors.BzrCommandError(
3085
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3086
except errors.MalformedBugIdentifier, e:
3087
raise errors.BzrCommandError(
3088
"%s\nCommit refused." % (str(e),))
3090
def run(self, message=None, file=None, verbose=False, selected_list=None,
3091
unchanged=False, strict=False, local=False, fixes=None,
3092
author=None, show_diff=False, exclude=None, commit_time=None):
3093
from bzrlib.errors import (
3098
from bzrlib.msgeditor import (
3099
edit_commit_message_encoded,
3100
generate_commit_message_template,
3101
make_commit_message_template_encoded
3104
commit_stamp = offset = None
3105
if commit_time is not None:
3107
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3108
except ValueError, e:
3109
raise errors.BzrCommandError(
3110
"Could not parse --commit-time: " + str(e))
3112
# TODO: Need a blackbox test for invoking the external editor; may be
3113
# slightly problematic to run this cross-platform.
3115
# TODO: do more checks that the commit will succeed before
3116
# spending the user's valuable time typing a commit message.
3120
tree, selected_list = tree_files(selected_list)
3121
if selected_list == ['']:
3122
# workaround - commit of root of tree should be exactly the same
3123
# as just default commit in that tree, and succeed even though
3124
# selected-file merge commit is not done yet
3129
bug_property = bugtracker.encode_fixes_bug_urls(
3130
self._iter_bug_fix_urls(fixes, tree.branch))
3132
properties['bugs'] = bug_property
3134
if local and not tree.branch.get_bound_location():
3135
raise errors.LocalRequiresBoundBranch()
3137
if message is not None:
3139
file_exists = osutils.lexists(message)
3140
except UnicodeError:
3141
# The commit message contains unicode characters that can't be
3142
# represented in the filesystem encoding, so that can't be a
3147
'The commit message is a file name: "%(f)s".\n'
3148
'(use --file "%(f)s" to take commit message from that file)'
3150
ui.ui_factory.show_warning(warning_msg)
3152
message = message.replace('\r\n', '\n')
3153
message = message.replace('\r', '\n')
3155
raise errors.BzrCommandError(
3156
"please specify either --message or --file")
3158
def get_message(commit_obj):
3159
"""Callback to get commit message"""
3161
f = codecs.open(file, 'rt', osutils.get_user_encoding())
3163
my_message = f.read()
3166
elif message is not None:
3167
my_message = message
3169
# No message supplied: make one up.
3170
# text is the status of the tree
3171
text = make_commit_message_template_encoded(tree,
3172
selected_list, diff=show_diff,
3173
output_encoding=osutils.get_user_encoding())
3174
# start_message is the template generated from hooks
3175
# XXX: Warning - looks like hooks return unicode,
3176
# make_commit_message_template_encoded returns user encoding.
3177
# We probably want to be using edit_commit_message instead to
3179
start_message = generate_commit_message_template(commit_obj)
3180
my_message = edit_commit_message_encoded(text,
3181
start_message=start_message)
3182
if my_message is None:
3183
raise errors.BzrCommandError("please specify a commit"
3184
" message with either --message or --file")
3185
if my_message == "":
3186
raise errors.BzrCommandError("empty commit message specified")
3189
# The API permits a commit with a filter of [] to mean 'select nothing'
3190
# but the command line should not do that.
3191
if not selected_list:
3192
selected_list = None
970
# TODO: Give better message for -s, --summary, used by tla people
972
def run(self, message=None, file=None, verbose=True, selected_list=None,
974
from bzrlib.errors import PointlessCommit
975
from bzrlib.msgeditor import edit_commit_message
976
from bzrlib.status import show_status
977
from cStringIO import StringIO
979
b = Branch.open_containing('.')
981
selected_list = [b.relpath(s) for s in selected_list]
983
if not message and not file:
985
show_status(b, specific_files=selected_list,
987
message = edit_commit_message(catcher.getvalue())
990
raise BzrCommandError("please specify a commit message"
991
" with either --message or --file")
992
elif message and file:
993
raise BzrCommandError("please specify either --message or --file")
997
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
3194
tree.commit(message_callback=get_message,
3195
specific_files=selected_list,
3196
allow_pointless=unchanged, strict=strict, local=local,
3197
reporter=None, verbose=verbose, revprops=properties,
3198
authors=author, timestamp=commit_stamp,
3200
exclude=safe_relpath_files(tree, exclude))
1000
b.commit(message, verbose=verbose,
1001
specific_files=selected_list,
1002
allow_pointless=unchanged)
3201
1003
except PointlessCommit:
3202
raise errors.BzrCommandError("No changes to commit."
3203
" Use --unchanged to commit anyhow.")
3204
except ConflictsInTree:
3205
raise errors.BzrCommandError('Conflicts detected in working '
3206
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3208
except StrictCommitFailed:
3209
raise errors.BzrCommandError("Commit refused because there are"
3210
" unknown files in the working tree.")
3211
except errors.BoundBranchOutOfDate, e:
3212
e.extra_help = ("\n"
3213
'To commit to master branch, run update and then commit.\n'
3214
'You can also pass --local to commit to continue working '
1004
# FIXME: This should really happen before the file is read in;
1005
# perhaps prepare the commit; get the message; then actually commit
1006
raise BzrCommandError("no changes to commit",
1007
["use --unchanged to commit anyhow"])
3219
1010
class cmd_check(Command):
3220
__doc__ = """Validate working tree structure, branch consistency and repository history.
3222
This command checks various invariants about branch and repository storage
3223
to detect data corruption or bzr bugs.
3225
The working tree and branch checks will only give output if a problem is
3226
detected. The output fields of the repository check are:
3229
This is just the number of revisions checked. It doesn't
3233
This is just the number of versionedfiles checked. It
3234
doesn't indicate a problem.
3236
unreferenced ancestors
3237
Texts that are ancestors of other texts, but
3238
are not properly referenced by the revision ancestry. This is a
3239
subtle problem that Bazaar can work around.
3242
This is the total number of unique file contents
3243
seen in the checked revisions. It does not indicate a problem.
3246
This is the total number of repeated texts seen
3247
in the checked revisions. Texts can be repeated when their file
3248
entries are modified, but the file contents are not. It does not
3251
If no restrictions are specified, all Bazaar data that is found at the given
3252
location will be checked.
3256
Check the tree and branch at 'foo'::
3258
bzr check --tree --branch foo
3260
Check only the repository at 'bar'::
3262
bzr check --repo bar
3264
Check everything at 'baz'::
1011
"""Validate consistency of branch history.
1013
This command checks various invariants about the branch storage to
1014
detect data corruption or bzr bugs.
3269
_see_also = ['reconcile']
3270
takes_args = ['path?']
3271
takes_options = ['verbose',
3272
Option('branch', help="Check the branch related to the"
3273
" current directory."),
3274
Option('repo', help="Check the repository related to the"
3275
" current directory."),
3276
Option('tree', help="Check the working tree related to"
3277
" the current directory.")]
3279
def run(self, path=None, verbose=False, branch=False, repo=False,
3281
from bzrlib.check import check_dwim
3284
if not branch and not repo and not tree:
3285
branch = repo = tree = True
3286
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
1016
takes_args = ['dir?']
1018
def run(self, dir='.'):
1019
from bzrlib.check import check
1021
check(Branch.open_containing(dir))
1024
class cmd_scan_cache(Command):
1027
from bzrlib.hashcache import HashCache
1033
print '%6d stats' % c.stat_count
1034
print '%6d in hashcache' % len(c._cache)
1035
print '%6d files removed from cache' % c.removed_count
1036
print '%6d hashes updated' % c.update_count
1037
print '%6d files changed too recently to cache' % c.danger_count
3289
1044
class cmd_upgrade(Command):
3290
__doc__ = """Upgrade branch storage to current format.
1045
"""Upgrade branch storage to current format.
3292
1047
The check command or bzr developers may sometimes advise you to run
3293
this command. When the default format has changed you may also be warned
3294
during other operations to upgrade.
3297
_see_also = ['check']
3298
takes_args = ['url?']
3300
RegistryOption('format',
3301
help='Upgrade to a specific format. See "bzr help'
3302
' formats" for details.',
3303
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3304
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3305
value_switches=True, title='Branch format'),
3308
def run(self, url='.', format=None):
1050
takes_args = ['dir?']
1052
def run(self, dir='.'):
3309
1053
from bzrlib.upgrade import upgrade
3310
upgrade(url, format)
1054
upgrade(Branch.open_containing(dir))
3313
1058
class cmd_whoami(Command):
3314
__doc__ = """Show or set bzr user id.
3317
Show the email of the current user::
3321
Set the current user::
3323
bzr whoami "Frank Chu <fchu@example.com>"
3325
takes_options = [ 'directory',
3327
help='Display email address only.'),
3329
help='Set identity for the current branch instead of '
3332
takes_args = ['name?']
3333
encoding_type = 'replace'
3336
def run(self, email=False, branch=False, name=None, directory=None):
3338
if directory is None:
3339
# use branch if we're inside one; otherwise global config
3341
c = Branch.open_containing(u'.')[0].get_config()
3342
except errors.NotBranchError:
3343
c = config.GlobalConfig()
3345
c = Branch.open(directory).get_config()
3347
self.outf.write(c.user_email() + '\n')
3349
self.outf.write(c.username() + '\n')
3352
# display a warning if an email address isn't included in the given name.
1059
"""Show bzr user id."""
1060
takes_options = ['email']
1062
def run(self, email=False):
3354
config.extract_email_address(name)
3355
except errors.NoEmailInUsername, e:
3356
warning('"%s" does not seem to contain an email address. '
3357
'This is allowed, but not recommended.', name)
3359
# use global config unless --branch given
3361
if directory is None:
3362
c = Branch.open_containing(u'.')[0].get_config()
3364
c = Branch.open(directory).get_config()
3366
c = config.GlobalConfig()
3367
c.set_user_option('email', name)
3370
class cmd_nick(Command):
3371
__doc__ = """Print or set the branch nickname.
3373
If unset, the tree root directory name is used as the nickname.
3374
To print the current nickname, execute with no argument.
3376
Bound branches use the nickname of its master branch unless it is set
3380
_see_also = ['info']
3381
takes_args = ['nickname?']
3382
takes_options = ['directory']
3383
def run(self, nickname=None, directory=u'.'):
3384
branch = Branch.open_containing(directory)[0]
3385
if nickname is None:
3386
self.printme(branch)
3388
branch.nick = nickname
3391
def printme(self, branch):
3392
self.outf.write('%s\n' % branch.nick)
3395
class cmd_alias(Command):
3396
__doc__ = """Set/unset and display aliases.
3399
Show the current aliases::
3403
Show the alias specified for 'll'::
3407
Set an alias for 'll'::
3409
bzr alias ll="log --line -r-10..-1"
3411
To remove an alias for 'll'::
3413
bzr alias --remove ll
3416
takes_args = ['name?']
3418
Option('remove', help='Remove the alias.'),
3421
def run(self, name=None, remove=False):
3423
self.remove_alias(name)
3425
self.print_aliases()
3427
equal_pos = name.find('=')
3429
self.print_alias(name)
3431
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3433
def remove_alias(self, alias_name):
3434
if alias_name is None:
3435
raise errors.BzrCommandError(
3436
'bzr alias --remove expects an alias to remove.')
3437
# If alias is not found, print something like:
3438
# unalias: foo: not found
3439
c = config.GlobalConfig()
3440
c.unset_alias(alias_name)
3443
def print_aliases(self):
3444
"""Print out the defined aliases in a similar format to bash."""
3445
aliases = config.GlobalConfig().get_aliases()
3446
for key, value in sorted(aliases.iteritems()):
3447
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3450
def print_alias(self, alias_name):
3451
from bzrlib.commands import get_alias
3452
alias = get_alias(alias_name)
3454
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3457
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3459
def set_alias(self, alias_name, alias_command):
3460
"""Save the alias in the global config."""
3461
c = config.GlobalConfig()
3462
c.set_alias(alias_name, alias_command)
1064
b = bzrlib.branch.Branch.open_containing('.')
1069
print bzrlib.osutils.user_email(b)
1071
print bzrlib.osutils.username(b)
3465
1074
class cmd_selftest(Command):
3466
__doc__ = """Run internal test suite.
3468
If arguments are given, they are regular expressions that say which tests
3469
should run. Tests matching any expression are run, and other tests are
3472
Alternatively if --first is given, matching tests are run first and then
3473
all other tests are run. This is useful if you have been working in a
3474
particular area, but want to make sure nothing else was broken.
3476
If --exclude is given, tests that match that regular expression are
3477
excluded, regardless of whether they match --first or not.
3479
To help catch accidential dependencies between tests, the --randomize
3480
option is useful. In most cases, the argument used is the word 'now'.
3481
Note that the seed used for the random number generator is displayed
3482
when this option is used. The seed can be explicitly passed as the
3483
argument to this option if required. This enables reproduction of the
3484
actual ordering used if and when an order sensitive problem is encountered.
3486
If --list-only is given, the tests that would be run are listed. This is
3487
useful when combined with --first, --exclude and/or --randomize to
3488
understand their impact. The test harness reports "Listed nn tests in ..."
3489
instead of "Ran nn tests in ..." when list mode is enabled.
3491
If the global option '--no-plugins' is given, plugins are not loaded
3492
before running the selftests. This has two effects: features provided or
3493
modified by plugins will not be tested, and tests provided by plugins will
3496
Tests that need working space on disk use a common temporary directory,
3497
typically inside $TMPDIR or /tmp.
3499
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
into a pdb postmortem session.
3503
Run only tests relating to 'ignore'::
3507
Disable plugins and list tests as they're run::
3509
bzr --no-plugins selftest -v
3511
# NB: this is used from the class without creating an instance, which is
3512
# why it does not have a self parameter.
3513
def get_transport_type(typestring):
3514
"""Parse and return a transport specifier."""
3515
if typestring == "sftp":
3516
from bzrlib.tests import stub_sftp
3517
return stub_sftp.SFTPAbsoluteServer
3518
if typestring == "memory":
3519
from bzrlib.tests import test_server
3520
return memory.MemoryServer
3521
if typestring == "fakenfs":
3522
from bzrlib.tests import test_server
3523
return test_server.FakeNFSServer
3524
msg = "No known transport type %s. Supported types are: sftp\n" %\
3526
raise errors.BzrCommandError(msg)
1075
"""Run internal test suite"""
3529
takes_args = ['testspecs*']
3530
takes_options = ['verbose',
3532
help='Stop when one test fails.',
3536
help='Use a different transport by default '
3537
'throughout the test suite.',
3538
type=get_transport_type),
3540
help='Run the benchmarks rather than selftests.',
3542
Option('lsprof-timed',
3543
help='Generate lsprof output for benchmarked'
3544
' sections of code.'),
3545
Option('lsprof-tests',
3546
help='Generate lsprof output for each test.'),
3548
help='Run all tests, but run specified tests first.',
3552
help='List the tests instead of running them.'),
3553
RegistryOption('parallel',
3554
help="Run the test suite in parallel.",
3555
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3556
value_switches=False,
3558
Option('randomize', type=str, argname="SEED",
3559
help='Randomize the order of tests using the given'
3560
' seed or "now" for the current time.'),
3561
Option('exclude', type=str, argname="PATTERN",
3563
help='Exclude tests that match this regular'
3566
help='Output test progress via subunit.'),
3567
Option('strict', help='Fail on missing dependencies or '
3569
Option('load-list', type=str, argname='TESTLISTFILE',
3570
help='Load a test id list from a text file.'),
3571
ListOption('debugflag', type=str, short_name='E',
3572
help='Turn on a selftest debug flag.'),
3573
ListOption('starting-with', type=str, argname='TESTID',
3574
param_name='starting_with', short_name='s',
3576
'Load only the tests starting with TESTID.'),
3578
encoding_type = 'replace'
3581
Command.__init__(self)
3582
self.additional_selftest_args = {}
3584
def run(self, testspecs_list=None, verbose=False, one=False,
3585
transport=None, benchmark=None,
3587
first=False, list_only=False,
3588
randomize=None, exclude=None, strict=False,
3589
load_list=None, debugflag=None, starting_with=None, subunit=False,
3590
parallel=None, lsprof_tests=False):
3591
from bzrlib.tests import selftest
3593
# Make deprecation warnings visible, unless -Werror is set
3594
symbol_versioning.activate_deprecation_warnings(override=False)
3596
if testspecs_list is not None:
3597
pattern = '|'.join(testspecs_list)
3602
from bzrlib.tests import SubUnitBzrRunner
3604
raise errors.BzrCommandError("subunit not available. subunit "
3605
"needs to be installed to use --subunit.")
3606
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3607
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3608
# stdout, which would corrupt the subunit stream.
3609
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3610
# following code can be deleted when it's sufficiently deployed
3611
# -- vila/mgz 20100514
3612
if (sys.platform == "win32"
3613
and getattr(sys.stdout, 'fileno', None) is not None):
3615
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3617
self.additional_selftest_args.setdefault(
3618
'suite_decorators', []).append(parallel)
3620
raise errors.BzrCommandError(
3621
"--benchmark is no longer supported from bzr 2.2; "
3622
"use bzr-usertest instead")
3623
test_suite_factory = None
3624
selftest_kwargs = {"verbose": verbose,
3626
"stop_on_failure": one,
3627
"transport": transport,
3628
"test_suite_factory": test_suite_factory,
3629
"lsprof_timed": lsprof_timed,
3630
"lsprof_tests": lsprof_tests,
3631
"matching_tests_first": first,
3632
"list_only": list_only,
3633
"random_seed": randomize,
3634
"exclude_pattern": exclude,
3636
"load_list": load_list,
3637
"debug_flags": debugflag,
3638
"starting_with": starting_with
3640
selftest_kwargs.update(self.additional_selftest_args)
3641
result = selftest(**selftest_kwargs)
3642
return int(not result)
1077
takes_options = ['verbose', 'pattern']
1078
def run(self, verbose=False, pattern=".*"):
1080
from bzrlib.selftest import selftest
1081
# we don't want progress meters from the tests to go to the
1082
# real output; and we don't want log messages cluttering up
1084
save_ui = bzrlib.ui.ui_factory
1085
bzrlib.trace.info('running tests...')
1087
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1088
result = selftest(verbose=verbose, pattern=pattern)
1090
bzrlib.trace.info('tests passed')
1092
bzrlib.trace.info('tests failed')
1093
return int(not result)
1095
bzrlib.ui.ui_factory = save_ui
1099
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1100
# is bzrlib itself in a branch?
1101
bzrrev = bzrlib.get_bzr_revision()
1103
print " (bzr checkout, revision %d {%s})" % bzrrev
1104
print bzrlib.__copyright__
1105
print "http://bazaar-ng.org/"
1107
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1108
print "you may use, modify and redistribute it under the terms of the GNU"
1109
print "General Public License version 2 or later."
3645
1112
class cmd_version(Command):
3646
__doc__ = """Show version of bzr."""
3648
encoding_type = 'replace'
3650
Option("short", help="Print just the version number."),
3654
def run(self, short=False):
3655
from bzrlib.version import show_version
3657
self.outf.write(bzrlib.version_string + '\n')
3659
show_version(to_file=self.outf)
1113
"""Show version of bzr."""
3662
1117
class cmd_rocks(Command):
3663
__doc__ = """Statement of optimism."""
1118
"""Statement of optimism."""
3669
self.outf.write("It sure does!\n")
1121
print "it sure does!"
3672
1124
class cmd_find_merge_base(Command):
3673
__doc__ = """Find and print a base revision for merging two branches."""
3674
# TODO: Options to specify revisions on either side, as if
3675
# merging only part of the history.
1125
"""Find and print a base revision for merging two branches.
1127
TODO: Options to specify revisions on either side, as if
1128
merging only part of the history.
3676
1130
takes_args = ['branch', 'other']
3680
1133
def run(self, branch, other):
3681
from bzrlib.revision import ensure_null
3683
branch1 = Branch.open_containing(branch)[0]
3684
branch2 = Branch.open_containing(other)[0]
3685
self.add_cleanup(branch1.lock_read().unlock)
3686
self.add_cleanup(branch2.lock_read().unlock)
3687
last1 = ensure_null(branch1.last_revision())
3688
last2 = ensure_null(branch2.last_revision())
3690
graph = branch1.repository.get_graph(branch2.repository)
3691
base_rev_id = graph.find_unique_lca(last1, last2)
3693
self.outf.write('merge base is revision %s\n' % base_rev_id)
1134
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1136
branch1 = Branch.open_containing(branch)
1137
branch2 = Branch.open_containing(other)
1139
history_1 = branch1.revision_history()
1140
history_2 = branch2.revision_history()
1142
last1 = branch1.last_patch()
1143
last2 = branch2.last_patch()
1145
source = MultipleRevisionSources(branch1, branch2)
1147
base_rev_id = common_ancestor(last1, last2, source)
1149
print 'merge base is revision %s' % base_rev_id
1153
if base_revno is None:
1154
raise bzrlib.errors.UnrelatedBranches()
1156
print ' r%-6d in %s' % (base_revno, branch)
1158
other_revno = branch2.revision_id_to_revno(base_revid)
1160
print ' r%-6d in %s' % (other_revno, other)
3696
1164
class cmd_merge(Command):
3697
__doc__ = """Perform a three-way merge.
3699
The source of the merge can be specified either in the form of a branch,
3700
or in the form of a path to a file containing a merge directive generated
3701
with bzr send. If neither is specified, the default is the upstream branch
3702
or the branch most recently merged using --remember.
3704
When merging a branch, by default the tip will be merged. To pick a different
3705
revision, pass --revision. If you specify two values, the first will be used as
3706
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3707
available revisions, like this is commonly referred to as "cherrypicking".
3709
Revision numbers are always relative to the branch being merged.
3711
By default, bzr will try to merge in all new work from the other
1165
"""Perform a three-way merge.
1167
The branch is the branch you will merge from. By default, it will
1168
merge the latest revision. If you specify a revision, that
1169
revision will be merged. If you specify two revisions, the first
1170
will be used as a BASE, and the second one as OTHER. Revision
1171
numbers are always relative to the specified branch.
1173
By default bzr will try to merge in all new work from the other
3712
1174
branch, automatically determining an appropriate base. If this
3713
1175
fails, you may need to give an explicit base.
3715
Merge will do its best to combine the changes in two branches, but there
3716
are some kinds of problems only a human can fix. When it encounters those,
3717
it will mark a conflict. A conflict means that you need to fix something,
3718
before you should commit.
3720
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3722
If there is no default branch set, the first merge will set it. After
3723
that, you can omit the branch to use the default. To change the
3724
default, use --remember. The value will only be saved if the remote
3725
location can be accessed.
3727
The results of the merge are placed into the destination working
3728
directory, where they can be reviewed (with bzr diff), tested, and then
3729
committed to record the result of the merge.
1179
To merge the latest revision from bzr.dev
1180
bzr merge ../bzr.dev
1182
To merge changes up to and including revision 82 from bzr.dev
1183
bzr merge -r 82 ../bzr.dev
1185
To merge the changes introduced by 82, without previous changes:
1186
bzr merge -r 81..82 ../bzr.dev
3731
1188
merge refuses to run if there are any uncommitted changes, unless
3732
--force is given. The --force option can also be used to create a
3733
merge revision which has more than two parents.
3735
If one would like to merge changes from the working tree of the other
3736
branch without merging any committed revisions, the --uncommitted option
3739
To select only some changes to merge, use "merge -i", which will prompt
3740
you to apply each diff hunk and file change, similar to "shelve".
3743
To merge the latest revision from bzr.dev::
3745
bzr merge ../bzr.dev
3747
To merge changes up to and including revision 82 from bzr.dev::
3749
bzr merge -r 82 ../bzr.dev
3751
To merge the changes introduced by 82, without previous changes::
3753
bzr merge -r 81..82 ../bzr.dev
3755
To apply a merge directive contained in /tmp/merge::
3757
bzr merge /tmp/merge
3759
To create a merge revision with three parents from two branches
3760
feature1a and feature1b:
3762
bzr merge ../feature1a
3763
bzr merge ../feature1b --force
3764
bzr commit -m 'revision with three parents'
3767
encoding_type = 'exact'
3768
_see_also = ['update', 'remerge', 'status-flags', 'send']
3769
takes_args = ['location?']
3774
help='Merge even if the destination tree has uncommitted changes.'),
3778
Option('show-base', help="Show base revision text in "
3780
Option('uncommitted', help='Apply uncommitted changes'
3781
' from a working copy, instead of branch changes.'),
3782
Option('pull', help='If the destination is already'
3783
' completely merged into the source, pull from the'
3784
' source rather than merging. When this happens,'
3785
' you do not need to commit the result.'),
3786
custom_help('directory',
3787
help='Branch to merge into, '
3788
'rather than the one containing the working directory.'),
3789
Option('preview', help='Instead of merging, show a diff of the'
3791
Option('interactive', help='Select changes interactively.',
3795
def run(self, location=None, revision=None, force=False,
3796
merge_type=None, show_base=False, reprocess=None, remember=False,
3797
uncommitted=False, pull=False,
3802
if merge_type is None:
3803
merge_type = _mod_merge.Merge3Merger
3805
if directory is None: directory = u'.'
3806
possible_transports = []
3808
allow_pending = True
3809
verified = 'inapplicable'
3810
tree = WorkingTree.open_containing(directory)[0]
3813
basis_tree = tree.revision_tree(tree.last_revision())
3814
except errors.NoSuchRevision:
3815
basis_tree = tree.basis_tree()
3817
# die as quickly as possible if there are uncommitted changes
3819
if tree.has_changes():
3820
raise errors.UncommittedChanges(tree)
3822
view_info = _get_view_info_for_change_reporter(tree)
3823
change_reporter = delta._ChangeReporter(
3824
unversioned_filter=tree.is_ignored, view_info=view_info)
3825
pb = ui.ui_factory.nested_progress_bar()
3826
self.add_cleanup(pb.finished)
3827
self.add_cleanup(tree.lock_write().unlock)
3828
if location is not None:
3830
mergeable = bundle.read_mergeable_from_url(location,
3831
possible_transports=possible_transports)
3832
except errors.NotABundle:
3836
raise errors.BzrCommandError('Cannot use --uncommitted'
3837
' with bundles or merge directives.')
3839
if revision is not None:
3840
raise errors.BzrCommandError(
3841
'Cannot use -r with merge directives or bundles')
3842
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3845
if merger is None and uncommitted:
3846
if revision is not None and len(revision) > 0:
3847
raise errors.BzrCommandError('Cannot use --uncommitted and'
3848
' --revision at the same time.')
3849
merger = self.get_merger_from_uncommitted(tree, location, None)
3850
allow_pending = False
3853
merger, allow_pending = self._get_merger_from_branch(tree,
3854
location, revision, remember, possible_transports, None)
3856
merger.merge_type = merge_type
3857
merger.reprocess = reprocess
3858
merger.show_base = show_base
3859
self.sanity_check_merger(merger)
3860
if (merger.base_rev_id == merger.other_rev_id and
3861
merger.other_rev_id is not None):
3862
note('Nothing to do.')
3865
if merger.interesting_files is not None:
3866
raise errors.BzrCommandError('Cannot pull individual files')
3867
if (merger.base_rev_id == tree.last_revision()):
3868
result = tree.pull(merger.other_branch, False,
3869
merger.other_rev_id)
3870
result.report(self.outf)
3872
if merger.this_basis is None:
3873
raise errors.BzrCommandError(
3874
"This branch has no commits."
3875
" (perhaps you would prefer 'bzr pull')")
3877
return self._do_preview(merger)
3879
return self._do_interactive(merger)
3881
return self._do_merge(merger, change_reporter, allow_pending,
3884
def _get_preview(self, merger):
3885
tree_merger = merger.make_merger()
3886
tt = tree_merger.make_preview_transform()
3887
self.add_cleanup(tt.finalize)
3888
result_tree = tt.get_preview_tree()
3891
def _do_preview(self, merger):
3892
from bzrlib.diff import show_diff_trees
3893
result_tree = self._get_preview(merger)
3894
path_encoding = osutils.get_diff_header_encoding()
3895
show_diff_trees(merger.this_tree, result_tree, self.outf,
3896
old_label='', new_label='',
3897
path_encoding=path_encoding)
3899
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3900
merger.change_reporter = change_reporter
3901
conflict_count = merger.do_merge()
3903
merger.set_pending()
3904
if verified == 'failed':
3905
warning('Preview patch does not match changes')
3906
if conflict_count != 0:
3911
def _do_interactive(self, merger):
3912
"""Perform an interactive merge.
3914
This works by generating a preview tree of the merge, then using
3915
Shelver to selectively remove the differences between the working tree
3916
and the preview tree.
3918
from bzrlib import shelf_ui
3919
result_tree = self._get_preview(merger)
3920
writer = bzrlib.option.diff_writer_registry.get()
3921
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3922
reporter=shelf_ui.ApplyReporter(),
3923
diff_writer=writer(sys.stdout))
3929
def sanity_check_merger(self, merger):
3930
if (merger.show_base and
3931
not merger.merge_type is _mod_merge.Merge3Merger):
3932
raise errors.BzrCommandError("Show-base is not supported for this"
3933
" merge type. %s" % merger.merge_type)
3934
if merger.reprocess is None:
3935
if merger.show_base:
3936
merger.reprocess = False
3938
# Use reprocess if the merger supports it
3939
merger.reprocess = merger.merge_type.supports_reprocess
3940
if merger.reprocess and not merger.merge_type.supports_reprocess:
3941
raise errors.BzrCommandError("Conflict reduction is not supported"
3942
" for merge type %s." %
3944
if merger.reprocess and merger.show_base:
3945
raise errors.BzrCommandError("Cannot do conflict reduction and"
3948
def _get_merger_from_branch(self, tree, location, revision, remember,
3949
possible_transports, pb):
3950
"""Produce a merger from a location, assuming it refers to a branch."""
3951
from bzrlib.tag import _merge_tags_if_possible
3952
# find the branch locations
3953
other_loc, user_location = self._select_branch_location(tree, location,
3955
if revision is not None and len(revision) == 2:
3956
base_loc, _unused = self._select_branch_location(tree,
3957
location, revision, 0)
3959
base_loc = other_loc
3961
other_branch, other_path = Branch.open_containing(other_loc,
3962
possible_transports)
3963
if base_loc == other_loc:
3964
base_branch = other_branch
3966
base_branch, base_path = Branch.open_containing(base_loc,
3967
possible_transports)
3968
# Find the revision ids
3969
other_revision_id = None
3970
base_revision_id = None
3971
if revision is not None:
3972
if len(revision) >= 1:
3973
other_revision_id = revision[-1].as_revision_id(other_branch)
3974
if len(revision) == 2:
3975
base_revision_id = revision[0].as_revision_id(base_branch)
3976
if other_revision_id is None:
3977
other_revision_id = _mod_revision.ensure_null(
3978
other_branch.last_revision())
3979
# Remember where we merge from
3980
if ((remember or tree.branch.get_submit_branch() is None) and
3981
user_location is not None):
3982
tree.branch.set_submit_branch(other_branch.base)
3983
_merge_tags_if_possible(other_branch, tree.branch)
3984
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3985
other_revision_id, base_revision_id, other_branch, base_branch)
3986
if other_path != '':
3987
allow_pending = False
3988
merger.interesting_files = [other_path]
3990
allow_pending = True
3991
return merger, allow_pending
3993
def get_merger_from_uncommitted(self, tree, location, pb):
3994
"""Get a merger for uncommitted changes.
3996
:param tree: The tree the merger should apply to.
3997
:param location: The location containing uncommitted changes.
3998
:param pb: The progress bar to use for showing progress.
4000
location = self._select_branch_location(tree, location)[0]
4001
other_tree, other_path = WorkingTree.open_containing(location)
4002
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4003
if other_path != '':
4004
merger.interesting_files = [other_path]
4007
def _select_branch_location(self, tree, user_location, revision=None,
4009
"""Select a branch location, according to possible inputs.
4011
If provided, branches from ``revision`` are preferred. (Both
4012
``revision`` and ``index`` must be supplied.)
4014
Otherwise, the ``location`` parameter is used. If it is None, then the
4015
``submit`` or ``parent`` location is used, and a note is printed.
4017
:param tree: The working tree to select a branch for merging into
4018
:param location: The location entered by the user
4019
:param revision: The revision parameter to the command
4020
:param index: The index to use for the revision parameter. Negative
4021
indices are permitted.
4022
:return: (selected_location, user_location). The default location
4023
will be the user-entered location.
4025
if (revision is not None and index is not None
4026
and revision[index] is not None):
4027
branch = revision[index].get_branch()
4028
if branch is not None:
4029
return branch, branch
4030
if user_location is None:
4031
location = self._get_remembered(tree, 'Merging from')
4033
location = user_location
4034
return location, user_location
4036
def _get_remembered(self, tree, verb_string):
4037
"""Use tree.branch's parent if none was supplied.
4039
Report if the remembered location was used.
4041
stored_location = tree.branch.get_submit_branch()
4042
stored_location_type = "submit"
4043
if stored_location is None:
4044
stored_location = tree.branch.get_parent()
4045
stored_location_type = "parent"
4046
mutter("%s", stored_location)
4047
if stored_location is None:
4048
raise errors.BzrCommandError("No location specified or remembered")
4049
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4050
note(u"%s remembered %s location %s", verb_string,
4051
stored_location_type, display_url)
4052
return stored_location
4055
class cmd_remerge(Command):
4056
__doc__ = """Redo a merge.
4058
Use this if you want to try a different merge technique while resolving
4059
conflicts. Some merge techniques are better than others, and remerge
4060
lets you try different ones on different files.
4062
The options for remerge have the same meaning and defaults as the ones for
4063
merge. The difference is that remerge can (only) be run when there is a
4064
pending merge, and it lets you specify particular files.
4067
Re-do the merge of all conflicted files, and show the base text in
4068
conflict regions, in addition to the usual THIS and OTHER texts::
4070
bzr remerge --show-base
4072
Re-do the merge of "foobar", using the weave merge algorithm, with
4073
additional processing to reduce the size of conflict regions::
4075
bzr remerge --merge-type weave --reprocess foobar
4077
takes_args = ['file*']
4082
help="Show base revision text in conflicts."),
4085
def run(self, file_list=None, merge_type=None, show_base=False,
4087
from bzrlib.conflicts import restore
4088
if merge_type is None:
4089
merge_type = _mod_merge.Merge3Merger
4090
tree, file_list = tree_files(file_list)
4091
self.add_cleanup(tree.lock_write().unlock)
4092
parents = tree.get_parent_ids()
4093
if len(parents) != 2:
4094
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4095
" merges. Not cherrypicking or"
4097
repository = tree.branch.repository
4098
interesting_ids = None
4100
conflicts = tree.conflicts()
4101
if file_list is not None:
4102
interesting_ids = set()
4103
for filename in file_list:
4104
file_id = tree.path2id(filename)
4106
raise errors.NotVersionedError(filename)
4107
interesting_ids.add(file_id)
4108
if tree.kind(file_id) != "directory":
4111
for name, ie in tree.inventory.iter_entries(file_id):
4112
interesting_ids.add(ie.file_id)
4113
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4115
# Remerge only supports resolving contents conflicts
4116
allowed_conflicts = ('text conflict', 'contents conflict')
4117
restore_files = [c.path for c in conflicts
4118
if c.typestring in allowed_conflicts]
4119
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4120
tree.set_conflicts(ConflictList(new_conflicts))
4121
if file_list is not None:
4122
restore_files = file_list
4123
for filename in restore_files:
4125
restore(tree.abspath(filename))
4126
except errors.NotConflicted:
4128
# Disable pending merges, because the file texts we are remerging
4129
# have not had those merges performed. If we use the wrong parents
4130
# list, we imply that the working tree text has seen and rejected
4131
# all the changes from the other tree, when in fact those changes
4132
# have not yet been seen.
4133
tree.set_parent_ids(parents[:1])
4135
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4136
merger.interesting_ids = interesting_ids
4137
merger.merge_type = merge_type
4138
merger.show_base = show_base
4139
merger.reprocess = reprocess
4140
conflicts = merger.do_merge()
4142
tree.set_parent_ids(parents)
1191
takes_args = ['branch?']
1192
takes_options = ['revision', 'force', 'merge-type']
1194
def run(self, branch='.', revision=None, force=False,
1196
from bzrlib.merge import merge
1197
from bzrlib.merge_core import ApplyMerge3
1198
if merge_type is None:
1199
merge_type = ApplyMerge3
1201
if revision is None or len(revision) < 1:
1203
other = [branch, -1]
1205
if len(revision) == 1:
1207
other = [branch, revision[0].in_history(branch).revno]
1209
assert len(revision) == 2
1210
if None in revision:
1211
raise BzrCommandError(
1212
"Merge doesn't permit that revision specifier.")
1213
from bzrlib.branch import Branch
1214
b = Branch.open(branch)
1216
base = [branch, revision[0].in_history(b).revno]
1217
other = [branch, revision[1].in_history(b).revno]
1220
merge(other, base, check_clean=(not force), merge_type=merge_type)
1221
except bzrlib.errors.AmbiguousBase, e:
1222
m = ("sorry, bzr can't determine the right merge base yet\n"
1223
"candidates are:\n "
1224
+ "\n ".join(e.bases)
1226
"please specify an explicit base with -r,\n"
1227
"and (if you want) report this to the bzr developers\n")
4149
1231
class cmd_revert(Command):
4150
__doc__ = """Revert files to a previous revision.
4152
Giving a list of files will revert only those files. Otherwise, all files
4153
will be reverted. If the revision is not specified with '--revision', the
4154
last committed revision is used.
4156
To remove only some changes, without reverting to a prior version, use
4157
merge instead. For example, "merge . --revision -2..-3" will remove the
4158
changes introduced by -2, without affecting the changes introduced by -1.
4159
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4161
By default, any files that have been manually changed will be backed up
4162
first. (Files changed only by merge are not backed up.) Backup files have
4163
'.~#~' appended to their name, where # is a number.
4165
When you provide files, you can use their current pathname or the pathname
4166
from the target revision. So you can use revert to "undelete" a file by
4167
name. If you name a directory, all the contents of that directory will be
4170
If you have newly added files since the target revision, they will be
4171
removed. If the files to be removed have been changed, backups will be
4172
created as above. Directories containing unknown files will not be
4175
The working tree contains a list of revisions that have been merged but
4176
not yet committed. These revisions will be included as additional parents
4177
of the next commit. Normally, using revert clears that list as well as
4178
reverting the files. If any files are specified, revert leaves the list
4179
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4180
.`` in the tree root to revert all files but keep the recorded merges,
4181
and ``bzr revert --forget-merges`` to clear the pending merge list without
4182
reverting any files.
4184
Using "bzr revert --forget-merges", it is possible to apply all of the
4185
changes from a branch in a single revision. To do this, perform the merge
4186
as desired. Then doing revert with the "--forget-merges" option will keep
4187
the content of the tree as it was, but it will clear the list of pending
4188
merges. The next commit will then contain all of the changes that are
4189
present in the other branch, but without any other parent revisions.
4190
Because this technique forgets where these changes originated, it may
4191
cause additional conflicts on later merges involving the same source and
1232
"""Reverse all changes since the last commit.
1234
Only versioned files are affected. Specify filenames to revert only
1235
those files. By default, any files that are changed will be backed up
1236
first. Backup files have a '~' appended to their name.
4195
_see_also = ['cat', 'export']
4198
Option('no-backup', "Do not save backups of reverted files."),
4199
Option('forget-merges',
4200
'Remove pending merge marker, without changing any files.'),
1238
takes_options = ['revision', 'no-backup']
4202
1239
takes_args = ['file*']
4204
def run(self, revision=None, no_backup=False, file_list=None,
4205
forget_merges=None):
4206
tree, file_list = tree_files(file_list)
4207
self.add_cleanup(tree.lock_tree_write().unlock)
4209
tree.set_parent_ids(tree.get_parent_ids()[:1])
1240
aliases = ['merge-revert']
1242
def run(self, revision=None, no_backup=False, file_list=None):
1243
from bzrlib.merge import merge
1244
from bzrlib.branch import Branch
1245
from bzrlib.commands import parse_spec
1247
if file_list is not None:
1248
if len(file_list) == 0:
1249
raise BzrCommandError("No files specified")
1250
if revision is None:
1252
elif len(revision) != 1:
1253
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
4211
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4214
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4215
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4216
tree.revert(file_list, rev_tree, not no_backup, None,
4217
report_changes=True)
1255
b = Branch.open_containing('.')
1256
revno = revision[0].in_history(b).revno
1257
merge(('.', revno), parse_spec('.'),
1260
backup_files=not no_backup,
1261
file_list=file_list)
1263
Branch.open_containing('.').set_pending_merges([])
4220
1266
class cmd_assert_fail(Command):
4221
__doc__ = """Test reporting of assertion failures"""
4222
# intended just for use in testing
1267
"""Test reporting of assertion failures"""
4227
raise AssertionError("always fails")
1270
assert False, "always fails"
4230
1273
class cmd_help(Command):
4231
__doc__ = """Show help on a command or other topic.
1274
"""Show help on a command or other topic.
4234
_see_also = ['topics']
4236
Option('long', 'Show help on all commands.'),
1276
For a list of all available commands, say 'bzr help commands'."""
1277
takes_options = ['long']
4238
1278
takes_args = ['topic?']
4239
aliases = ['?', '--help', '-?', '-h']
4242
1281
def run(self, topic=None, long=False):
4244
1283
if topic is None and long:
4245
1284
topic = "commands"
4246
bzrlib.help.help(topic)
4249
1288
class cmd_shell_complete(Command):
4250
__doc__ = """Show appropriate completions for context.
1289
"""Show appropriate completions for context.
4252
For a list of all available commands, say 'bzr shell-complete'.
1291
For a list of all available commands, say 'bzr shell-complete'."""
4254
1292
takes_args = ['context?']
4255
1293
aliases = ['s-c']
4259
1296
def run(self, context=None):
4260
1297
import shellcomplete
4261
1298
shellcomplete.shellcomplete(context)
4264
1301
class cmd_missing(Command):
4265
__doc__ = """Show unmerged/unpulled revisions between two branches.
4267
OTHER_BRANCH may be local or remote.
4269
To filter on a range of revisions, you can use the command -r begin..end
4270
-r revision requests a specific revision, -r ..end or -r begin.. are
4274
1 - some missing revisions
4275
0 - no missing revisions
4279
Determine the missing revisions between this and the branch at the
4280
remembered pull location::
4284
Determine the missing revisions between this and another branch::
4286
bzr missing http://server/branch
4288
Determine the missing revisions up to a specific revision on the other
4291
bzr missing -r ..-10
4293
Determine the missing revisions up to a specific revision on this
4296
bzr missing --my-revision ..-10
4299
_see_also = ['merge', 'pull']
4300
takes_args = ['other_branch?']
4303
Option('reverse', 'Reverse the order of revisions.'),
4305
'Display changes in the local branch only.'),
4306
Option('this' , 'Same as --mine-only.'),
4307
Option('theirs-only',
4308
'Display changes in the remote branch only.'),
4309
Option('other', 'Same as --theirs-only.'),
4313
custom_help('revision',
4314
help='Filter on other branch revisions (inclusive). '
4315
'See "help revisionspec" for details.'),
4316
Option('my-revision',
4317
type=_parse_revision_str,
4318
help='Filter on local branch revisions (inclusive). '
4319
'See "help revisionspec" for details.'),
4320
Option('include-merges',
4321
'Show all revisions in addition to the mainline ones.'),
4323
encoding_type = 'replace'
4326
def run(self, other_branch=None, reverse=False, mine_only=False,
4328
log_format=None, long=False, short=False, line=False,
4329
show_ids=False, verbose=False, this=False, other=False,
4330
include_merges=False, revision=None, my_revision=None,
4332
from bzrlib.missing import find_unmerged, iter_log_revisions
4341
# TODO: We should probably check that we don't have mine-only and
4342
# theirs-only set, but it gets complicated because we also have
4343
# this and other which could be used.
4350
local_branch = Branch.open_containing(directory)[0]
4351
self.add_cleanup(local_branch.lock_read().unlock)
4353
parent = local_branch.get_parent()
4354
if other_branch is None:
4355
other_branch = parent
4356
if other_branch is None:
4357
raise errors.BzrCommandError("No peer location known"
4359
display_url = urlutils.unescape_for_display(parent,
4361
message("Using saved parent location: "
4362
+ display_url + "\n")
4364
remote_branch = Branch.open(other_branch)
4365
if remote_branch.base == local_branch.base:
4366
remote_branch = local_branch
4368
self.add_cleanup(remote_branch.lock_read().unlock)
4370
local_revid_range = _revision_range_to_revid_range(
4371
_get_revision_range(my_revision, local_branch,
4374
remote_revid_range = _revision_range_to_revid_range(
4375
_get_revision_range(revision,
4376
remote_branch, self.name()))
4378
local_extra, remote_extra = find_unmerged(
4379
local_branch, remote_branch, restrict,
4380
backward=not reverse,
4381
include_merges=include_merges,
4382
local_revid_range=local_revid_range,
4383
remote_revid_range=remote_revid_range)
4385
if log_format is None:
4386
registry = log.log_formatter_registry
4387
log_format = registry.get_default(local_branch)
4388
lf = log_format(to_file=self.outf,
4390
show_timezone='original')
4393
if local_extra and not theirs_only:
4394
message("You have %d extra revision(s):\n" %
4396
for revision in iter_log_revisions(local_extra,
4397
local_branch.repository,
4399
lf.log_revision(revision)
4400
printed_local = True
4403
printed_local = False
4405
if remote_extra and not mine_only:
4406
if printed_local is True:
4408
message("You are missing %d revision(s):\n" %
4410
for revision in iter_log_revisions(remote_extra,
4411
remote_branch.repository,
4413
lf.log_revision(revision)
4416
if mine_only and not local_extra:
4417
# We checked local, and found nothing extra
4418
message('This branch is up to date.\n')
4419
elif theirs_only and not remote_extra:
4420
# We checked remote, and found nothing extra
4421
message('Other branch is up to date.\n')
4422
elif not (mine_only or theirs_only or local_extra or
4424
# We checked both branches, and neither one had extra
4426
message("Branches are up to date.\n")
4428
if not status_code and parent is None and other_branch is not None:
4429
self.add_cleanup(local_branch.lock_write().unlock)
4430
# handle race conditions - a parent might be set while we run.
4431
if local_branch.get_parent() is None:
4432
local_branch.set_parent(remote_branch.base)
4436
class cmd_pack(Command):
4437
__doc__ = """Compress the data within a repository.
4439
This operation compresses the data within a bazaar repository. As
4440
bazaar supports automatic packing of repository, this operation is
4441
normally not required to be done manually.
4443
During the pack operation, bazaar takes a backup of existing repository
4444
data, i.e. pack files. This backup is eventually removed by bazaar
4445
automatically when it is safe to do so. To save disk space by removing
4446
the backed up pack files, the --clean-obsolete-packs option may be
4449
Warning: If you use --clean-obsolete-packs and your machine crashes
4450
during or immediately after repacking, you may be left with a state
4451
where the deletion has been written to disk but the new packs have not
4452
been. In this case the repository may be unusable.
4455
_see_also = ['repositories']
4456
takes_args = ['branch_or_repo?']
4458
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4461
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4462
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4464
branch = dir.open_branch()
4465
repository = branch.repository
4466
except errors.NotBranchError:
4467
repository = dir.open_repository()
4468
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
1302
"""What is missing in this branch relative to other branch.
1304
takes_args = ['remote?']
1305
aliases = ['mis', 'miss']
1306
# We don't have to add quiet to the list, because
1307
# unknown options are parsed as booleans
1308
takes_options = ['verbose', 'quiet']
1310
def run(self, remote=None, verbose=False, quiet=False):
1311
from bzrlib.errors import BzrCommandError
1312
from bzrlib.missing import show_missing
1314
if verbose and quiet:
1315
raise BzrCommandError('Cannot pass both quiet and verbose')
1317
b = Branch.open_containing('.')
1318
parent = b.get_parent()
1321
raise BzrCommandError("No missing location known or specified.")
1324
print "Using last location: %s" % parent
1326
elif parent is None:
1327
# We only update parent if it did not exist, missing
1328
# should not change the parent
1329
b.set_parent(remote)
1330
br_remote = Branch.open_containing(remote)
1331
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
4471
1334
class cmd_plugins(Command):
4472
__doc__ = """List the installed plugins.
4474
This command displays the list of installed plugins including
4475
version of plugin and a short description of each.
4477
--verbose shows the path where each plugin is located.
4479
A plugin is an external component for Bazaar that extends the
4480
revision control system, by adding or replacing code in Bazaar.
4481
Plugins can do a variety of things, including overriding commands,
4482
adding new commands, providing additional network transports and
4483
customizing log output.
4485
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4486
for further information on plugins including where to find them and how to
4487
install them. Instructions are also provided there on how to write new
4488
plugins using the Python programming language.
4490
takes_options = ['verbose']
4493
def run(self, verbose=False):
4494
1338
import bzrlib.plugin
4495
1339
from inspect import getdoc
4497
for name, plugin in bzrlib.plugin.plugins().items():
4498
version = plugin.__version__
4499
if version == 'unknown':
4501
name_ver = '%s %s' % (name, version)
4502
d = getdoc(plugin.module)
1340
for plugin in bzrlib.plugin.all_plugins:
1341
if hasattr(plugin, '__path__'):
1342
print plugin.__path__[0]
1343
elif hasattr(plugin, '__file__'):
1344
print plugin.__file__
4504
doc = d.split('\n')[0]
4506
doc = '(no description)'
4507
result.append((name_ver, doc, plugin.path()))
4508
for name_ver, doc, path in sorted(result):
4509
self.outf.write("%s\n" % name_ver)
4510
self.outf.write(" %s\n" % doc)
4512
self.outf.write(" %s\n" % path)
4513
self.outf.write("\n")
4516
class cmd_testament(Command):
4517
__doc__ = """Show testament (signing-form) of a revision."""
4520
Option('long', help='Produce long-format testament.'),
4522
help='Produce a strict-format testament.')]
4523
takes_args = ['branch?']
4525
def run(self, branch=u'.', revision=None, long=False, strict=False):
4526
from bzrlib.testament import Testament, StrictTestament
4528
testament_class = StrictTestament
4530
testament_class = Testament
4532
b = Branch.open_containing(branch)[0]
4534
b = Branch.open(branch)
4535
self.add_cleanup(b.lock_read().unlock)
4536
if revision is None:
4537
rev_id = b.last_revision()
4539
rev_id = revision[0].as_revision_id(b)
4540
t = testament_class.from_revision(b.repository, rev_id)
4542
sys.stdout.writelines(t.as_text_lines())
4544
sys.stdout.write(t.as_short_text())
4547
class cmd_annotate(Command):
4548
__doc__ = """Show the origin of each line in a file.
4550
This prints out the given file with an annotation on the left side
4551
indicating which revision, author and date introduced the change.
4553
If the origin is the same for a run of consecutive lines, it is
4554
shown only at the top, unless the --all option is given.
4556
# TODO: annotate directories; showing when each file was last changed
4557
# TODO: if the working copy is modified, show annotations on that
4558
# with new uncommitted lines marked
4559
aliases = ['ann', 'blame', 'praise']
4560
takes_args = ['filename']
4561
takes_options = [Option('all', help='Show annotations on all lines.'),
4562
Option('long', help='Show commit date in annotations.'),
4567
encoding_type = 'exact'
4570
def run(self, filename, all=False, long=False, revision=None,
4571
show_ids=False, directory=None):
4572
from bzrlib.annotate import annotate_file, annotate_file_tree
4573
wt, branch, relpath = \
4574
_open_directory_or_containing_tree_or_branch(filename, directory)
4576
self.add_cleanup(wt.lock_read().unlock)
4578
self.add_cleanup(branch.lock_read().unlock)
4579
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4580
self.add_cleanup(tree.lock_read().unlock)
4582
file_id = wt.path2id(relpath)
4584
file_id = tree.path2id(relpath)
4586
raise errors.NotVersionedError(filename)
4587
file_version = tree.inventory[file_id].revision
4588
if wt is not None and revision is None:
4589
# If there is a tree and we're not annotating historical
4590
# versions, annotate the working tree's content.
4591
annotate_file_tree(wt, file_id, self.outf, long, all,
4594
annotate_file(branch, file_version, file_id, long, all, self.outf,
4598
class cmd_re_sign(Command):
4599
__doc__ = """Create a digital signature for an existing revision."""
4600
# TODO be able to replace existing ones.
4602
hidden = True # is this right ?
4603
takes_args = ['revision_id*']
4604
takes_options = ['directory', 'revision']
4606
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4607
if revision_id_list is not None and revision is not None:
4608
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4609
if revision_id_list is None and revision is None:
4610
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4611
b = WorkingTree.open_containing(directory)[0].branch
4612
self.add_cleanup(b.lock_write().unlock)
4613
return self._run(b, revision_id_list, revision)
4615
def _run(self, b, revision_id_list, revision):
4616
import bzrlib.gpg as gpg
4617
gpg_strategy = gpg.GPGStrategy(b.get_config())
4618
if revision_id_list is not None:
4619
b.repository.start_write_group()
4621
for revision_id in revision_id_list:
4622
b.repository.sign_revision(revision_id, gpg_strategy)
4624
b.repository.abort_write_group()
4627
b.repository.commit_write_group()
4628
elif revision is not None:
4629
if len(revision) == 1:
4630
revno, rev_id = revision[0].in_history(b)
4631
b.repository.start_write_group()
4633
b.repository.sign_revision(rev_id, gpg_strategy)
4635
b.repository.abort_write_group()
4638
b.repository.commit_write_group()
4639
elif len(revision) == 2:
4640
# are they both on rh- if so we can walk between them
4641
# might be nice to have a range helper for arbitrary
4642
# revision paths. hmm.
4643
from_revno, from_revid = revision[0].in_history(b)
4644
to_revno, to_revid = revision[1].in_history(b)
4645
if to_revid is None:
4646
to_revno = b.revno()
4647
if from_revno is None or to_revno is None:
4648
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4649
b.repository.start_write_group()
4651
for revno in range(from_revno, to_revno + 1):
4652
b.repository.sign_revision(b.get_rev_id(revno),
4655
b.repository.abort_write_group()
4658
b.repository.commit_write_group()
4660
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4663
class cmd_bind(Command):
4664
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4665
If no branch is supplied, rebind to the last bound location.
4667
Once converted into a checkout, commits must succeed on the master branch
4668
before they will be applied to the local branch.
4670
Bound branches use the nickname of its master branch unless it is set
4671
locally, in which case binding will update the local nickname to be
4675
_see_also = ['checkouts', 'unbind']
4676
takes_args = ['location?']
4677
takes_options = ['directory']
4679
def run(self, location=None, directory=u'.'):
4680
b, relpath = Branch.open_containing(directory)
4681
if location is None:
4683
location = b.get_old_bound_location()
4684
except errors.UpgradeRequired:
4685
raise errors.BzrCommandError('No location supplied. '
4686
'This format does not remember old locations.')
4688
if location is None:
4689
if b.get_bound_location() is not None:
4690
raise errors.BzrCommandError('Branch is already bound')
4692
raise errors.BzrCommandError('No location supplied '
4693
'and no previous location known')
4694
b_other = Branch.open(location)
4697
except errors.DivergedBranches:
4698
raise errors.BzrCommandError('These branches have diverged.'
4699
' Try merging, and then bind again.')
4700
if b.get_config().has_explicit_nickname():
4701
b.nick = b_other.nick
4704
class cmd_unbind(Command):
4705
__doc__ = """Convert the current checkout into a regular branch.
4707
After unbinding, the local branch is considered independent and subsequent
4708
commits will be local only.
4711
_see_also = ['checkouts', 'bind']
4713
takes_options = ['directory']
4715
def run(self, directory=u'.'):
4716
b, relpath = Branch.open_containing(directory)
4718
raise errors.BzrCommandError('Local branch is not bound')
4721
class cmd_uncommit(Command):
4722
__doc__ = """Remove the last committed revision.
4724
--verbose will print out what is being removed.
4725
--dry-run will go through all the motions, but not actually
4728
If --revision is specified, uncommit revisions to leave the branch at the
4729
specified revision. For example, "bzr uncommit -r 15" will leave the
4730
branch at revision 15.
4732
Uncommit leaves the working tree ready for a new commit. The only change
4733
it may make is to restore any pending merges that were present before
4737
# TODO: jam 20060108 Add an option to allow uncommit to remove
4738
# unreferenced information in 'branch-as-repository' branches.
4739
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4740
# information in shared branches as well.
4741
_see_also = ['commit']
4742
takes_options = ['verbose', 'revision',
4743
Option('dry-run', help='Don\'t actually make changes.'),
4744
Option('force', help='Say yes to all questions.'),
4746
help="Only remove the commits from the local branch"
4747
" when in a checkout."
4750
takes_args = ['location?']
4752
encoding_type = 'replace'
4754
def run(self, location=None,
4755
dry_run=False, verbose=False,
4756
revision=None, force=False, local=False):
4757
if location is None:
4759
control, relpath = bzrdir.BzrDir.open_containing(location)
4761
tree = control.open_workingtree()
4763
except (errors.NoWorkingTree, errors.NotLocalUrl):
4765
b = control.open_branch()
4767
if tree is not None:
4768
self.add_cleanup(tree.lock_write().unlock)
4770
self.add_cleanup(b.lock_write().unlock)
4771
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4773
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4774
from bzrlib.log import log_formatter, show_log
4775
from bzrlib.uncommit import uncommit
4777
last_revno, last_rev_id = b.last_revision_info()
4780
if revision is None:
4782
rev_id = last_rev_id
4784
# 'bzr uncommit -r 10' actually means uncommit
4785
# so that the final tree is at revno 10.
4786
# but bzrlib.uncommit.uncommit() actually uncommits
4787
# the revisions that are supplied.
4788
# So we need to offset it by one
4789
revno = revision[0].in_history(b).revno + 1
4790
if revno <= last_revno:
4791
rev_id = b.get_rev_id(revno)
4793
if rev_id is None or _mod_revision.is_null(rev_id):
4794
self.outf.write('No revisions to uncommit.\n')
4797
lf = log_formatter('short',
4799
show_timezone='original')
4804
direction='forward',
4805
start_revision=revno,
4806
end_revision=last_revno)
4809
self.outf.write('Dry-run, pretending to remove'
4810
' the above revisions.\n')
4812
self.outf.write('The above revision(s) will be removed.\n')
4815
if not ui.ui_factory.get_boolean('Are you sure'):
4816
self.outf.write('Canceled')
4819
mutter('Uncommitting from {%s} to {%s}',
4820
last_rev_id, rev_id)
4821
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4822
revno=revno, local=local)
4823
self.outf.write('You can restore the old tip by running:\n'
4824
' bzr pull . -r revid:%s\n' % last_rev_id)
4827
class cmd_break_lock(Command):
4828
__doc__ = """Break a dead lock on a repository, branch or working directory.
4830
CAUTION: Locks should only be broken when you are sure that the process
4831
holding the lock has been stopped.
4833
You can get information on what locks are open via the 'bzr info
4834
[location]' command.
4838
bzr break-lock bzr+ssh://example.com/bzr/foo
4840
takes_args = ['location?']
4842
def run(self, location=None, show=False):
4843
if location is None:
4845
control, relpath = bzrdir.BzrDir.open_containing(location)
4847
control.break_lock()
4848
except NotImplementedError:
4852
class cmd_wait_until_signalled(Command):
4853
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4855
This just prints a line to signal when it is ready, then blocks on stdin.
4861
sys.stdout.write("running\n")
4863
sys.stdin.readline()
4866
class cmd_serve(Command):
4867
__doc__ = """Run the bzr server."""
4869
aliases = ['server']
4873
help='Serve on stdin/out for use from inetd or sshd.'),
4874
RegistryOption('protocol',
4875
help="Protocol to serve.",
4876
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4877
value_switches=True),
4879
help='Listen for connections on nominated port of the form '
4880
'[hostname:]portnumber. Passing 0 as the port number will '
4881
'result in a dynamically allocated port. The default port '
4882
'depends on the protocol.',
4884
custom_help('directory',
4885
help='Serve contents of this directory.'),
4886
Option('allow-writes',
4887
help='By default the server is a readonly server. Supplying '
4888
'--allow-writes enables write access to the contents of '
4889
'the served directory and below. Note that ``bzr serve`` '
4890
'does not perform authentication, so unless some form of '
4891
'external authentication is arranged supplying this '
4892
'option leads to global uncontrolled write access to your '
4897
def get_host_and_port(self, port):
4898
"""Return the host and port to run the smart server on.
4900
If 'port' is None, None will be returned for the host and port.
4902
If 'port' has a colon in it, the string before the colon will be
4903
interpreted as the host.
4905
:param port: A string of the port to run the server on.
4906
:return: A tuple of (host, port), where 'host' is a host name or IP,
4907
and port is an integer TCP/IP port.
4910
if port is not None:
4912
host, port = port.split(':')
4916
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4918
from bzrlib import transport
4919
if directory is None:
4920
directory = os.getcwd()
4921
if protocol is None:
4922
protocol = transport.transport_server_registry.get()
4923
host, port = self.get_host_and_port(port)
4924
url = urlutils.local_path_to_url(directory)
4925
if not allow_writes:
4926
url = 'readonly+' + url
4927
t = transport.get_transport(url)
4928
protocol(t, host, port, inet)
4931
class cmd_join(Command):
4932
__doc__ = """Combine a tree into its containing tree.
4934
This command requires the target tree to be in a rich-root format.
4936
The TREE argument should be an independent tree, inside another tree, but
4937
not part of it. (Such trees can be produced by "bzr split", but also by
4938
running "bzr branch" with the target inside a tree.)
4940
The result is a combined tree, with the subtree no longer an independant
4941
part. This is marked as a merge of the subtree into the containing tree,
4942
and all history is preserved.
4945
_see_also = ['split']
4946
takes_args = ['tree']
4948
Option('reference', help='Join by reference.', hidden=True),
4951
def run(self, tree, reference=False):
4952
sub_tree = WorkingTree.open(tree)
4953
parent_dir = osutils.dirname(sub_tree.basedir)
4954
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4955
repo = containing_tree.branch.repository
4956
if not repo.supports_rich_root():
4957
raise errors.BzrCommandError(
4958
"Can't join trees because %s doesn't support rich root data.\n"
4959
"You can use bzr upgrade on the repository."
4963
containing_tree.add_reference(sub_tree)
4964
except errors.BadReferenceTarget, e:
4965
# XXX: Would be better to just raise a nicely printable
4966
# exception from the real origin. Also below. mbp 20070306
4967
raise errors.BzrCommandError("Cannot join %s. %s" %
4971
containing_tree.subsume(sub_tree)
4972
except errors.BadSubsumeSource, e:
4973
raise errors.BzrCommandError("Cannot join %s. %s" %
4977
class cmd_split(Command):
4978
__doc__ = """Split a subdirectory of a tree into a separate tree.
4980
This command will produce a target tree in a format that supports
4981
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4982
converted into earlier formats like 'dirstate-tags'.
4984
The TREE argument should be a subdirectory of a working tree. That
4985
subdirectory will be converted into an independent tree, with its own
4986
branch. Commits in the top-level tree will not apply to the new subtree.
4989
_see_also = ['join']
4990
takes_args = ['tree']
4992
def run(self, tree):
4993
containing_tree, subdir = WorkingTree.open_containing(tree)
4994
sub_id = containing_tree.path2id(subdir)
4996
raise errors.NotVersionedError(subdir)
4998
containing_tree.extract(sub_id)
4999
except errors.RootNotRich:
5000
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5003
class cmd_merge_directive(Command):
5004
__doc__ = """Generate a merge directive for auto-merge tools.
5006
A directive requests a merge to be performed, and also provides all the
5007
information necessary to do so. This means it must either include a
5008
revision bundle, or the location of a branch containing the desired
5011
A submit branch (the location to merge into) must be supplied the first
5012
time the command is issued. After it has been supplied once, it will
5013
be remembered as the default.
5015
A public branch is optional if a revision bundle is supplied, but required
5016
if --diff or --plain is specified. It will be remembered as the default
5017
after the first use.
5020
takes_args = ['submit_branch?', 'public_branch?']
5024
_see_also = ['send']
5028
RegistryOption.from_kwargs('patch-type',
5029
'The type of patch to include in the directive.',
5031
value_switches=True,
5033
bundle='Bazaar revision bundle (default).',
5034
diff='Normal unified diff.',
5035
plain='No patch, just directive.'),
5036
Option('sign', help='GPG-sign the directive.'), 'revision',
5037
Option('mail-to', type=str,
5038
help='Instead of printing the directive, email to this address.'),
5039
Option('message', type=str, short_name='m',
5040
help='Message to use when committing this merge.')
5043
encoding_type = 'exact'
5045
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5046
sign=False, revision=None, mail_to=None, message=None,
5048
from bzrlib.revision import ensure_null, NULL_REVISION
5049
include_patch, include_bundle = {
5050
'plain': (False, False),
5051
'diff': (True, False),
5052
'bundle': (True, True),
5054
branch = Branch.open(directory)
5055
stored_submit_branch = branch.get_submit_branch()
5056
if submit_branch is None:
5057
submit_branch = stored_submit_branch
5059
if stored_submit_branch is None:
5060
branch.set_submit_branch(submit_branch)
5061
if submit_branch is None:
5062
submit_branch = branch.get_parent()
5063
if submit_branch is None:
5064
raise errors.BzrCommandError('No submit branch specified or known')
5066
stored_public_branch = branch.get_public_branch()
5067
if public_branch is None:
5068
public_branch = stored_public_branch
5069
elif stored_public_branch is None:
5070
branch.set_public_branch(public_branch)
5071
if not include_bundle and public_branch is None:
5072
raise errors.BzrCommandError('No public branch specified or'
5074
base_revision_id = None
5075
if revision is not None:
5076
if len(revision) > 2:
5077
raise errors.BzrCommandError('bzr merge-directive takes '
5078
'at most two one revision identifiers')
5079
revision_id = revision[-1].as_revision_id(branch)
5080
if len(revision) == 2:
5081
base_revision_id = revision[0].as_revision_id(branch)
5083
revision_id = branch.last_revision()
5084
revision_id = ensure_null(revision_id)
5085
if revision_id == NULL_REVISION:
5086
raise errors.BzrCommandError('No revisions to bundle.')
5087
directive = merge_directive.MergeDirective2.from_objects(
5088
branch.repository, revision_id, time.time(),
5089
osutils.local_time_offset(), submit_branch,
5090
public_branch=public_branch, include_patch=include_patch,
5091
include_bundle=include_bundle, message=message,
5092
base_revision_id=base_revision_id)
5095
self.outf.write(directive.to_signed(branch))
5097
self.outf.writelines(directive.to_lines())
5099
message = directive.to_email(mail_to, branch, sign)
5100
s = SMTPConnection(branch.get_config())
5101
s.send_email(message)
5104
class cmd_send(Command):
5105
__doc__ = """Mail or create a merge-directive for submitting changes.
5107
A merge directive provides many things needed for requesting merges:
5109
* A machine-readable description of the merge to perform
5111
* An optional patch that is a preview of the changes requested
5113
* An optional bundle of revision data, so that the changes can be applied
5114
directly from the merge directive, without retrieving data from a
5117
`bzr send` creates a compact data set that, when applied using bzr
5118
merge, has the same effect as merging from the source branch.
5120
By default the merge directive is self-contained and can be applied to any
5121
branch containing submit_branch in its ancestory without needing access to
5124
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5125
revisions, but only a structured request to merge from the
5126
public_location. In that case the public_branch is needed and it must be
5127
up-to-date and accessible to the recipient. The public_branch is always
5128
included if known, so that people can check it later.
5130
The submit branch defaults to the parent of the source branch, but can be
5131
overridden. Both submit branch and public branch will be remembered in
5132
branch.conf the first time they are used for a particular branch. The
5133
source branch defaults to that containing the working directory, but can
5134
be changed using --from.
5136
In order to calculate those changes, bzr must analyse the submit branch.
5137
Therefore it is most efficient for the submit branch to be a local mirror.
5138
If a public location is known for the submit_branch, that location is used
5139
in the merge directive.
5141
The default behaviour is to send the merge directive by mail, unless -o is
5142
given, in which case it is sent to a file.
5144
Mail is sent using your preferred mail program. This should be transparent
5145
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5146
If the preferred client can't be found (or used), your editor will be used.
5148
To use a specific mail program, set the mail_client configuration option.
5149
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5150
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5151
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5152
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5155
If mail is being sent, a to address is required. This can be supplied
5156
either on the commandline, by setting the submit_to configuration
5157
option in the branch itself or the child_submit_to configuration option
5158
in the submit branch.
5160
Two formats are currently supported: "4" uses revision bundle format 4 and
5161
merge directive format 2. It is significantly faster and smaller than
5162
older formats. It is compatible with Bazaar 0.19 and later. It is the
5163
default. "0.9" uses revision bundle format 0.9 and merge directive
5164
format 1. It is compatible with Bazaar 0.12 - 0.18.
5166
The merge directives created by bzr send may be applied using bzr merge or
5167
bzr pull by specifying a file containing a merge directive as the location.
5169
bzr send makes extensive use of public locations to map local locations into
5170
URLs that can be used by other people. See `bzr help configuration` to
5171
set them, and use `bzr info` to display them.
5174
encoding_type = 'exact'
5176
_see_also = ['merge', 'pull']
5178
takes_args = ['submit_branch?', 'public_branch?']
5182
help='Do not include a bundle in the merge directive.'),
5183
Option('no-patch', help='Do not include a preview patch in the merge'
5186
help='Remember submit and public branch.'),
5188
help='Branch to generate the submission from, '
5189
'rather than the one containing the working directory.',
5192
Option('output', short_name='o',
5193
help='Write merge directive to this file or directory; '
5194
'use - for stdout.',
5197
help='Refuse to send if there are uncommitted changes in'
5198
' the working tree, --no-strict disables the check.'),
5199
Option('mail-to', help='Mail the request to this address.',
5203
Option('body', help='Body for the email.', type=unicode),
5204
RegistryOption('format',
5205
help='Use the specified output format.',
5206
lazy_registry=('bzrlib.send', 'format_registry')),
5209
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5210
no_patch=False, revision=None, remember=False, output=None,
5211
format=None, mail_to=None, message=None, body=None,
5212
strict=None, **kwargs):
5213
from bzrlib.send import send
5214
return send(submit_branch, revision, public_branch, remember,
5215
format, no_bundle, no_patch, output,
5216
kwargs.get('from', '.'), mail_to, message, body,
5221
class cmd_bundle_revisions(cmd_send):
5222
__doc__ = """Create a merge-directive for submitting changes.
5224
A merge directive provides many things needed for requesting merges:
5226
* A machine-readable description of the merge to perform
5228
* An optional patch that is a preview of the changes requested
5230
* An optional bundle of revision data, so that the changes can be applied
5231
directly from the merge directive, without retrieving data from a
5234
If --no-bundle is specified, then public_branch is needed (and must be
5235
up-to-date), so that the receiver can perform the merge using the
5236
public_branch. The public_branch is always included if known, so that
5237
people can check it later.
5239
The submit branch defaults to the parent, but can be overridden. Both
5240
submit branch and public branch will be remembered if supplied.
5242
If a public_branch is known for the submit_branch, that public submit
5243
branch is used in the merge instructions. This means that a local mirror
5244
can be used as your actual submit branch, once you have set public_branch
5247
Two formats are currently supported: "4" uses revision bundle format 4 and
5248
merge directive format 2. It is significantly faster and smaller than
5249
older formats. It is compatible with Bazaar 0.19 and later. It is the
5250
default. "0.9" uses revision bundle format 0.9 and merge directive
5251
format 1. It is compatible with Bazaar 0.12 - 0.18.
5256
help='Do not include a bundle in the merge directive.'),
5257
Option('no-patch', help='Do not include a preview patch in the merge'
5260
help='Remember submit and public branch.'),
5262
help='Branch to generate the submission from, '
5263
'rather than the one containing the working directory.',
5266
Option('output', short_name='o', help='Write directive to this file.',
5269
help='Refuse to bundle revisions if there are uncommitted'
5270
' changes in the working tree, --no-strict disables the check.'),
5272
RegistryOption('format',
5273
help='Use the specified output format.',
5274
lazy_registry=('bzrlib.send', 'format_registry')),
5276
aliases = ['bundle']
5278
_see_also = ['send', 'merge']
5282
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5283
no_patch=False, revision=None, remember=False, output=None,
5284
format=None, strict=None, **kwargs):
5287
from bzrlib.send import send
5288
return send(submit_branch, revision, public_branch, remember,
5289
format, no_bundle, no_patch, output,
5290
kwargs.get('from', '.'), None, None, None,
5291
self.outf, strict=strict)
5294
class cmd_tag(Command):
5295
__doc__ = """Create, remove or modify a tag naming a revision.
5297
Tags give human-meaningful names to revisions. Commands that take a -r
5298
(--revision) option can be given -rtag:X, where X is any previously
5301
Tags are stored in the branch. Tags are copied from one branch to another
5302
along when you branch, push, pull or merge.
5304
It is an error to give a tag name that already exists unless you pass
5305
--force, in which case the tag is moved to point to the new revision.
5307
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5308
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5310
If no tag name is specified it will be determined through the
5311
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5312
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5316
_see_also = ['commit', 'tags']
5317
takes_args = ['tag_name?']
5320
help='Delete this tag rather than placing it.',
5322
custom_help('directory',
5323
help='Branch in which to place the tag.'),
5325
help='Replace existing tags.',
5330
def run(self, tag_name=None,
5336
branch, relpath = Branch.open_containing(directory)
5337
self.add_cleanup(branch.lock_write().unlock)
5339
if tag_name is None:
5340
raise errors.BzrCommandError("No tag specified to delete.")
5341
branch.tags.delete_tag(tag_name)
5342
self.outf.write('Deleted tag %s.\n' % tag_name)
5345
if len(revision) != 1:
5346
raise errors.BzrCommandError(
5347
"Tags can only be placed on a single revision, "
5349
revision_id = revision[0].as_revision_id(branch)
5351
revision_id = branch.last_revision()
5352
if tag_name is None:
5353
tag_name = branch.automatic_tag_name(revision_id)
5354
if tag_name is None:
5355
raise errors.BzrCommandError(
5356
"Please specify a tag name.")
5357
if (not force) and branch.tags.has_tag(tag_name):
5358
raise errors.TagAlreadyExists(tag_name)
5359
branch.tags.set_tag(tag_name, revision_id)
5360
self.outf.write('Created tag %s.\n' % tag_name)
5363
class cmd_tags(Command):
5364
__doc__ = """List tags.
5366
This command shows a table of tag names and the revisions they reference.
5371
custom_help('directory',
5372
help='Branch whose tags should be displayed.'),
5373
RegistryOption.from_kwargs('sort',
5374
'Sort tags by different criteria.', title='Sorting',
5375
alpha='Sort tags lexicographically (default).',
5376
time='Sort tags chronologically.',
5389
branch, relpath = Branch.open_containing(directory)
5391
tags = branch.tags.get_tag_dict().items()
5395
self.add_cleanup(branch.lock_read().unlock)
5397
graph = branch.repository.get_graph()
5398
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5399
revid1, revid2 = rev1.rev_id, rev2.rev_id
5400
# only show revisions between revid1 and revid2 (inclusive)
5401
tags = [(tag, revid) for tag, revid in tags if
5402
graph.is_between(revid, revid1, revid2)]
5405
elif sort == 'time':
5407
for tag, revid in tags:
5409
revobj = branch.repository.get_revision(revid)
5410
except errors.NoSuchRevision:
5411
timestamp = sys.maxint # place them at the end
5413
timestamp = revobj.timestamp
5414
timestamps[revid] = timestamp
5415
tags.sort(key=lambda x: timestamps[x[1]])
5417
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5418
for index, (tag, revid) in enumerate(tags):
5420
revno = branch.revision_id_to_dotted_revno(revid)
5421
if isinstance(revno, tuple):
5422
revno = '.'.join(map(str, revno))
5423
except errors.NoSuchRevision:
5424
# Bad tag data/merges can lead to tagged revisions
5425
# which are not in this branch. Fail gracefully ...
5427
tags[index] = (tag, revno)
5429
for tag, revspec in tags:
5430
self.outf.write('%-20s %s\n' % (tag, revspec))
5433
class cmd_reconfigure(Command):
5434
__doc__ = """Reconfigure the type of a bzr directory.
5436
A target configuration must be specified.
5438
For checkouts, the bind-to location will be auto-detected if not specified.
5439
The order of preference is
5440
1. For a lightweight checkout, the current bound location.
5441
2. For branches that used to be checkouts, the previously-bound location.
5442
3. The push location.
5443
4. The parent location.
5444
If none of these is available, --bind-to must be specified.
5447
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5448
takes_args = ['location?']
5450
RegistryOption.from_kwargs(
5452
title='Target type',
5453
help='The type to reconfigure the directory to.',
5454
value_switches=True, enum_switch=False,
5455
branch='Reconfigure to be an unbound branch with no working tree.',
5456
tree='Reconfigure to be an unbound branch with a working tree.',
5457
checkout='Reconfigure to be a bound branch with a working tree.',
5458
lightweight_checkout='Reconfigure to be a lightweight'
5459
' checkout (with no local history).',
5460
standalone='Reconfigure to be a standalone branch '
5461
'(i.e. stop using shared repository).',
5462
use_shared='Reconfigure to use a shared repository.',
5463
with_trees='Reconfigure repository to create '
5464
'working trees on branches by default.',
5465
with_no_trees='Reconfigure repository to not create '
5466
'working trees on branches by default.'
5468
Option('bind-to', help='Branch to bind checkout to.', type=str),
5470
help='Perform reconfiguration even if local changes'
5472
Option('stacked-on',
5473
help='Reconfigure a branch to be stacked on another branch.',
5477
help='Reconfigure a branch to be unstacked. This '
5478
'may require copying substantial data into it.',
5482
def run(self, location=None, target_type=None, bind_to=None, force=False,
5485
directory = bzrdir.BzrDir.open(location)
5486
if stacked_on and unstacked:
5487
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5488
elif stacked_on is not None:
5489
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5491
reconfigure.ReconfigureUnstacked().apply(directory)
5492
# At the moment you can use --stacked-on and a different
5493
# reconfiguration shape at the same time; there seems no good reason
5495
if target_type is None:
5496
if stacked_on or unstacked:
5499
raise errors.BzrCommandError('No target configuration '
5501
elif target_type == 'branch':
5502
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5503
elif target_type == 'tree':
5504
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5505
elif target_type == 'checkout':
5506
reconfiguration = reconfigure.Reconfigure.to_checkout(
5508
elif target_type == 'lightweight-checkout':
5509
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5511
elif target_type == 'use-shared':
5512
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5513
elif target_type == 'standalone':
5514
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5515
elif target_type == 'with-trees':
5516
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5518
elif target_type == 'with-no-trees':
5519
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5521
reconfiguration.apply(force)
5524
class cmd_switch(Command):
5525
__doc__ = """Set the branch of a checkout and update.
5527
For lightweight checkouts, this changes the branch being referenced.
5528
For heavyweight checkouts, this checks that there are no local commits
5529
versus the current bound branch, then it makes the local branch a mirror
5530
of the new location and binds to it.
5532
In both cases, the working tree is updated and uncommitted changes
5533
are merged. The user can commit or revert these as they desire.
5535
Pending merges need to be committed or reverted before using switch.
5537
The path to the branch to switch to can be specified relative to the parent
5538
directory of the current branch. For example, if you are currently in a
5539
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5542
Bound branches use the nickname of its master branch unless it is set
5543
locally, in which case switching will update the local nickname to be
5547
takes_args = ['to_location?']
5548
takes_options = ['directory',
5550
help='Switch even if local commits will be lost.'),
5552
Option('create-branch', short_name='b',
5553
help='Create the target branch from this one before'
5554
' switching to it.'),
5557
def run(self, to_location=None, force=False, create_branch=False,
5558
revision=None, directory=u'.'):
5559
from bzrlib import switch
5560
tree_location = directory
5561
revision = _get_one_revision('switch', revision)
5562
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5563
if to_location is None:
5564
if revision is None:
5565
raise errors.BzrCommandError('You must supply either a'
5566
' revision or a location')
5567
to_location = tree_location
5569
branch = control_dir.open_branch()
5570
had_explicit_nick = branch.get_config().has_explicit_nickname()
5571
except errors.NotBranchError:
5573
had_explicit_nick = False
5576
raise errors.BzrCommandError('cannot create branch without'
5578
to_location = directory_service.directories.dereference(
5580
if '/' not in to_location and '\\' not in to_location:
5581
# This path is meant to be relative to the existing branch
5582
this_url = self._get_branch_location(control_dir)
5583
to_location = urlutils.join(this_url, '..', to_location)
5584
to_branch = branch.bzrdir.sprout(to_location,
5585
possible_transports=[branch.bzrdir.root_transport],
5586
source_branch=branch).open_branch()
5589
to_branch = Branch.open(to_location)
5590
except errors.NotBranchError:
5591
this_url = self._get_branch_location(control_dir)
5592
to_branch = Branch.open(
5593
urlutils.join(this_url, '..', to_location))
5594
if revision is not None:
5595
revision = revision.as_revision_id(to_branch)
5596
switch.switch(control_dir, to_branch, force, revision_id=revision)
5597
if had_explicit_nick:
5598
branch = control_dir.open_branch() #get the new branch!
5599
branch.nick = to_branch.nick
5600
note('Switched to branch: %s',
5601
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5603
def _get_branch_location(self, control_dir):
5604
"""Return location of branch for this control dir."""
5606
this_branch = control_dir.open_branch()
5607
# This may be a heavy checkout, where we want the master branch
5608
master_location = this_branch.get_bound_location()
5609
if master_location is not None:
5610
return master_location
5611
# If not, use a local sibling
5612
return this_branch.base
5613
except errors.NotBranchError:
5614
format = control_dir.find_branch_format()
5615
if getattr(format, 'get_reference', None) is not None:
5616
return format.get_reference(control_dir)
5618
return control_dir.root_transport.base
5621
class cmd_view(Command):
5622
__doc__ = """Manage filtered views.
5624
Views provide a mask over the tree so that users can focus on
5625
a subset of a tree when doing their work. After creating a view,
5626
commands that support a list of files - status, diff, commit, etc -
5627
effectively have that list of files implicitly given each time.
5628
An explicit list of files can still be given but those files
5629
must be within the current view.
5631
In most cases, a view has a short life-span: it is created to make
5632
a selected change and is deleted once that change is committed.
5633
At other times, you may wish to create one or more named views
5634
and switch between them.
5636
To disable the current view without deleting it, you can switch to
5637
the pseudo view called ``off``. This can be useful when you need
5638
to see the whole tree for an operation or two (e.g. merge) but
5639
want to switch back to your view after that.
5642
To define the current view::
5644
bzr view file1 dir1 ...
5646
To list the current view::
5650
To delete the current view::
5654
To disable the current view without deleting it::
5656
bzr view --switch off
5658
To define a named view and switch to it::
5660
bzr view --name view-name file1 dir1 ...
5662
To list a named view::
5664
bzr view --name view-name
5666
To delete a named view::
5668
bzr view --name view-name --delete
5670
To switch to a named view::
5672
bzr view --switch view-name
5674
To list all views defined::
5678
To delete all views::
5680
bzr view --delete --all
5684
takes_args = ['file*']
5687
help='Apply list or delete action to all views.',
5690
help='Delete the view.',
5693
help='Name of the view to define, list or delete.',
5697
help='Name of the view to switch to.',
5702
def run(self, file_list,
5708
tree, file_list = tree_files(file_list, apply_view=False)
5709
current_view, view_dict = tree.views.get_view_info()
5714
raise errors.BzrCommandError(
5715
"Both --delete and a file list specified")
5717
raise errors.BzrCommandError(
5718
"Both --delete and --switch specified")
5720
tree.views.set_view_info(None, {})
5721
self.outf.write("Deleted all views.\n")
5723
raise errors.BzrCommandError("No current view to delete")
5725
tree.views.delete_view(name)
5726
self.outf.write("Deleted '%s' view.\n" % name)
5729
raise errors.BzrCommandError(
5730
"Both --switch and a file list specified")
5732
raise errors.BzrCommandError(
5733
"Both --switch and --all specified")
5734
elif switch == 'off':
5735
if current_view is None:
5736
raise errors.BzrCommandError("No current view to disable")
5737
tree.views.set_view_info(None, view_dict)
5738
self.outf.write("Disabled '%s' view.\n" % (current_view))
5740
tree.views.set_view_info(switch, view_dict)
5741
view_str = views.view_display_str(tree.views.lookup_view())
5742
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5745
self.outf.write('Views defined:\n')
5746
for view in sorted(view_dict):
5747
if view == current_view:
5751
view_str = views.view_display_str(view_dict[view])
5752
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5754
self.outf.write('No views defined.\n')
5757
# No name given and no current view set
5760
raise errors.BzrCommandError(
5761
"Cannot change the 'off' pseudo view")
5762
tree.views.set_view(name, sorted(file_list))
5763
view_str = views.view_display_str(tree.views.lookup_view())
5764
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5768
# No name given and no current view set
5769
self.outf.write('No current view.\n')
5771
view_str = views.view_display_str(tree.views.lookup_view(name))
5772
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5775
class cmd_hooks(Command):
5776
__doc__ = """Show hooks."""
5781
for hook_key in sorted(hooks.known_hooks.keys()):
5782
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5783
self.outf.write("%s:\n" % type(some_hooks).__name__)
5784
for hook_name, hook_point in sorted(some_hooks.items()):
5785
self.outf.write(" %s:\n" % (hook_name,))
5786
found_hooks = list(hook_point)
5788
for hook in found_hooks:
5789
self.outf.write(" %s\n" %
5790
(some_hooks.get_hook_name(hook),))
5792
self.outf.write(" <no hooks installed>\n")
5795
class cmd_remove_branch(Command):
5796
__doc__ = """Remove a branch.
5798
This will remove the branch from the specified location but
5799
will keep any working tree or repository in place.
5803
Remove the branch at repo/trunk::
5805
bzr remove-branch repo/trunk
5809
takes_args = ["location?"]
5811
aliases = ["rmbranch"]
5813
def run(self, location=None):
5814
if location is None:
5816
branch = Branch.open_containing(location)[0]
5817
branch.bzrdir.destroy_branch()
5820
class cmd_shelve(Command):
5821
__doc__ = """Temporarily set aside some changes from the current tree.
5823
Shelve allows you to temporarily put changes you've made "on the shelf",
5824
ie. out of the way, until a later time when you can bring them back from
5825
the shelf with the 'unshelve' command. The changes are stored alongside
5826
your working tree, and so they aren't propagated along with your branch nor
5827
will they survive its deletion.
5829
If shelve --list is specified, previously-shelved changes are listed.
5831
Shelve is intended to help separate several sets of changes that have
5832
been inappropriately mingled. If you just want to get rid of all changes
5833
and you don't need to restore them later, use revert. If you want to
5834
shelve all text changes at once, use shelve --all.
5836
If filenames are specified, only the changes to those files will be
5837
shelved. Other files will be left untouched.
5839
If a revision is specified, changes since that revision will be shelved.
5841
You can put multiple items on the shelf, and by default, 'unshelve' will
5842
restore the most recently shelved changes.
5845
takes_args = ['file*']
5850
Option('all', help='Shelve all changes.'),
5852
RegistryOption('writer', 'Method to use for writing diffs.',
5853
bzrlib.option.diff_writer_registry,
5854
value_switches=True, enum_switch=False),
5856
Option('list', help='List shelved changes.'),
5858
help='Destroy removed changes instead of shelving them.'),
5860
_see_also = ['unshelve']
5862
def run(self, revision=None, all=False, file_list=None, message=None,
5863
writer=None, list=False, destroy=False, directory=u'.'):
5865
return self.run_for_list()
5866
from bzrlib.shelf_ui import Shelver
5868
writer = bzrlib.option.diff_writer_registry.get()
5870
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5871
file_list, message, destroy=destroy, directory=directory)
5876
except errors.UserAbort:
5879
def run_for_list(self):
5880
tree = WorkingTree.open_containing('.')[0]
5881
self.add_cleanup(tree.lock_read().unlock)
5882
manager = tree.get_shelf_manager()
5883
shelves = manager.active_shelves()
5884
if len(shelves) == 0:
5885
note('No shelved changes.')
5887
for shelf_id in reversed(shelves):
5888
message = manager.get_metadata(shelf_id).get('message')
5890
message = '<no message>'
5891
self.outf.write('%3d: %s\n' % (shelf_id, message))
5895
class cmd_unshelve(Command):
5896
__doc__ = """Restore shelved changes.
5898
By default, the most recently shelved changes are restored. However if you
5899
specify a shelf by id those changes will be restored instead. This works
5900
best when the changes don't depend on each other.
5903
takes_args = ['shelf_id?']
5906
RegistryOption.from_kwargs(
5907
'action', help="The action to perform.",
5908
enum_switch=False, value_switches=True,
5909
apply="Apply changes and remove from the shelf.",
5910
dry_run="Show changes, but do not apply or remove them.",
5911
preview="Instead of unshelving the changes, show the diff that "
5912
"would result from unshelving.",
5913
delete_only="Delete changes without applying them.",
5914
keep="Apply changes but don't delete them.",
5917
_see_also = ['shelve']
5919
def run(self, shelf_id=None, action='apply', directory=u'.'):
5920
from bzrlib.shelf_ui import Unshelver
5921
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5925
unshelver.tree.unlock()
5928
class cmd_clean_tree(Command):
5929
__doc__ = """Remove unwanted files from working tree.
5931
By default, only unknown files, not ignored files, are deleted. Versioned
5932
files are never deleted.
5934
Another class is 'detritus', which includes files emitted by bzr during
5935
normal operations and selftests. (The value of these files decreases with
5938
If no options are specified, unknown files are deleted. Otherwise, option
5939
flags are respected, and may be combined.
5941
To check what clean-tree will do, use --dry-run.
5943
takes_options = ['directory',
5944
Option('ignored', help='Delete all ignored files.'),
5945
Option('detritus', help='Delete conflict files, merge'
5946
' backups, and failed selftest dirs.'),
5948
help='Delete files unknown to bzr (default).'),
5949
Option('dry-run', help='Show files to delete instead of'
5951
Option('force', help='Do not prompt before deleting.')]
5952
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5953
force=False, directory=u'.'):
5954
from bzrlib.clean_tree import clean_tree
5955
if not (unknown or ignored or detritus):
5959
clean_tree(directory, unknown=unknown, ignored=ignored,
5960
detritus=detritus, dry_run=dry_run, no_prompt=force)
5963
class cmd_reference(Command):
5964
__doc__ = """list, view and set branch locations for nested trees.
5966
If no arguments are provided, lists the branch locations for nested trees.
5967
If one argument is provided, display the branch location for that tree.
5968
If two arguments are provided, set the branch location for that tree.
5973
takes_args = ['path?', 'location?']
5975
def run(self, path=None, location=None):
5977
if path is not None:
5979
tree, branch, relpath =(
5980
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5981
if path is not None:
5984
tree = branch.basis_tree()
5986
info = branch._get_all_reference_info().iteritems()
5987
self._display_reference_info(tree, branch, info)
5989
file_id = tree.path2id(path)
5991
raise errors.NotVersionedError(path)
5992
if location is None:
5993
info = [(file_id, branch.get_reference_info(file_id))]
5994
self._display_reference_info(tree, branch, info)
5996
branch.set_reference_info(file_id, path, location)
5998
def _display_reference_info(self, tree, branch, info):
6000
for file_id, (path, location) in info:
6002
path = tree.id2path(file_id)
6003
except errors.NoSuchId:
6005
ref_list.append((path, location))
6006
for path, location in sorted(ref_list):
6007
self.outf.write('%s %s\n' % (path, location))
6010
def _register_lazy_builtins():
6011
# register lazy builtins from other modules; called at startup and should
6012
# be only called once.
6013
for (name, aliases, module_name) in [
6014
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6015
('cmd_dpush', [], 'bzrlib.foreign'),
6016
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6017
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6018
('cmd_conflicts', [], 'bzrlib.conflicts'),
6019
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6021
builtin_command_registry.register_lazy(name, aliases, module_name)
1350
print '\t', d.split('\n')[0]