To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
« back to all changes in this revision
Viewing changes to bzrlib/builtins.py
- browse files at revision 2743.3.6
- compare with another revision
- download diff
- download tarball
- view history from revision 2743.3.6
- Committer: Ian Clatworthy
- Date: 2007-08-30 02:02:21 UTC
- mfrom: (2768 +trunk)
- mto: (2772.2.1 ianc-integration)
- mto: This revision was merged to the branch mainline in revision 2774.
- Revision ID: ian.clatworthy@internode.on.net-20070830020221-92iai8t8tx4frqwk
Merge bzr.dev
- files added:
- .bzrignore
- bzrlib
- bzrlib/benchmarks
- bzrlib/benchmarks/tree_creator
- bzrlib/bundle
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins
- bzrlib/plugins/launchpad
- bzrlib/repofmt
- bzrlib/smart
- bzrlib/store
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/commands
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/intertree_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/per_lock
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/test_patches_data
- bzrlib/tests/tree_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/elementtree
- bzrlib/util/tests
- bzrlib/version_info_formats
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- doc
- doc/developers
- doc/en
- doc/en/developer-guide
- doc/en/mini-tutorial
- doc/en/quick-reference
- doc/en/release-notes
- doc/en/user-guide
- doc/en/user-reference
- man1
- tools
- tools/doc_generate
- tools/win32
- files removed:
- .bzrignore
- notes
- tests
added
removed
bzrlib/builtins.py
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
"""builtin bzr commands"""
18
19
import os
20
from StringIO import StringIO
21
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
24
import codecs
25
import errno
26
import sys
27
import tempfile
28
import time
29
30
import bzrlib
31
from bzrlib import (
32
branch,
33
bugtracker,
34
bundle,
35
bzrdir,
36
delta,
37
config,
38
errors,
39
globbing,
40
ignores,
41
log,
42
merge as _mod_merge,
43
merge_directive,
44
osutils,
45
registry,
46
repository,
47
revision as _mod_revision,
48
revisionspec,
49
symbol_versioning,
50
transport,
51
tree as _mod_tree,
52
ui,
53
urlutils,
54
)
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
60
""")
61
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
66
67
68
def tree_files(file_list, default_branch=u'.'):
69
try:
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
74
75
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
80
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
83
84
The filenames given are not required to exist.
85
86
:param file_list: Filenames to convert.
87
88
:param default_branch: Fallback tree path to use if file_list is empty or
89
None.
90
91
:return: workingtree, [relative_paths]
92
"""
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
96
new_list = []
97
for filename in file_list:
98
try:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
103
104
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
112
try:
113
return bzrdir.format_registry.make_bzrdir(typestring)
114
except KeyError:
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
117
118
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
123
# opens the branch?)
124
125
class cmd_status(Command):
126
"""Display status summary.
127
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
130
131
added
132
Versioned in the working copy but not in the previous revision.
133
134
removed
135
Versioned in the previous revision but removed or deleted
136
in the working copy.
137
138
renamed
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
142
143
modified
144
Text has changed since the previous revision.
145
146
kind changed
147
File kind has been changed (e.g. from file to directory).
148
149
unknown
150
Not versioned and not matching an ignore pattern.
151
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
154
155
--short gives a status flags for each item, similar to the SVN's status
156
command.
157
158
If no arguments are specified, the status of the entire working
159
directory is shown. Otherwise, only the status of the specified
160
files or directories is reported. If a directory is given, status
161
is reported for everything inside that directory.
162
163
If a revision argument is given, the status is calculated against
164
that revision, or between two revisions if two are provided.
165
"""
166
167
# TODO: --no-recurse, --recurse options
168
169
takes_args = ['file*']
170
takes_options = ['show-ids', 'revision',
171
Option('short', help='Give short SVN-style status lines.'),
172
Option('versioned', help='Only show versioned files.')]
173
aliases = ['st', 'stat']
174
175
encoding_type = 'replace'
176
_see_also = ['diff', 'revert', 'status-flags']
177
178
@display_command
179
def run(self, show_ids=False, file_list=None, revision=None, short=False,
180
versioned=False):
181
from bzrlib.status import show_tree_status
182
183
tree, file_list = tree_files(file_list)
184
185
show_tree_status(tree, show_ids=show_ids,
186
specific_files=file_list, revision=revision,
187
to_file=self.outf, short=short, versioned=versioned)
188
189
190
class cmd_cat_revision(Command):
191
"""Write out metadata for a revision.
192
193
The revision to print can either be specified by a specific
194
revision identifier, or you can use --revision.
195
"""
196
197
hidden = True
198
takes_args = ['revision_id?']
199
takes_options = ['revision']
200
# cat-revision is more for frontends so should be exact
201
encoding = 'strict'
202
203
@display_command
204
def run(self, revision_id=None, revision=None):
205
206
revision_id = osutils.safe_revision_id(revision_id, warn=False)
207
if revision_id is not None and revision is not None:
208
raise errors.BzrCommandError('You can only supply one of'
209
' revision_id or --revision')
210
if revision_id is None and revision is None:
211
raise errors.BzrCommandError('You must supply either'
212
' --revision or a revision_id')
213
b = WorkingTree.open_containing(u'.')[0].branch
214
215
# TODO: jam 20060112 should cat-revision always output utf-8?
216
if revision_id is not None:
217
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
218
elif revision is not None:
219
for rev in revision:
220
if rev is None:
221
raise errors.BzrCommandError('You cannot specify a NULL'
222
' revision.')
223
revno, rev_id = rev.in_history(b)
224
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
225
226
227
class cmd_remove_tree(Command):
228
"""Remove the working tree from a given branch/checkout.
229
230
Since a lightweight checkout is little more than a working tree
231
this will refuse to run against one.
232
233
To re-create the working tree, use "bzr checkout".
234
"""
235
_see_also = ['checkout', 'working-trees']
236
237
takes_args = ['location?']
238
239
def run(self, location='.'):
240
d = bzrdir.BzrDir.open(location)
241
242
try:
243
working = d.open_workingtree()
244
except errors.NoWorkingTree:
245
raise errors.BzrCommandError("No working tree to remove")
246
except errors.NotLocalUrl:
247
raise errors.BzrCommandError("You cannot remove the working tree of a "
248
"remote path")
249
250
working_path = working.bzrdir.root_transport.base
251
branch_path = working.branch.bzrdir.root_transport.base
252
if working_path != branch_path:
253
raise errors.BzrCommandError("You cannot remove the working tree from "
254
"a lightweight checkout")
255
256
d.destroy_workingtree()
257
258
259
class cmd_revno(Command):
260
"""Show current revision number.
261
262
This is equal to the number of revisions on this branch.
263
"""
264
265
_see_also = ['info']
266
takes_args = ['location?']
267
268
@display_command
269
def run(self, location=u'.'):
270
self.outf.write(str(Branch.open_containing(location)[0].revno()))
271
self.outf.write('\n')
272
273
274
class cmd_revision_info(Command):
275
"""Show revision number and revision id for a given revision identifier.
276
"""
277
hidden = True
278
takes_args = ['revision_info*']
279
takes_options = ['revision']
280
281
@display_command
282
def run(self, revision=None, revision_info_list=[]):
283
284
revs = []
285
if revision is not None:
286
revs.extend(revision)
287
if revision_info_list is not None:
288
for rev in revision_info_list:
289
revs.append(RevisionSpec.from_string(rev))
290
291
b = Branch.open_containing(u'.')[0]
292
293
if len(revs) == 0:
294
revs.append(RevisionSpec.from_string('-1'))
295
296
for rev in revs:
297
revinfo = rev.in_history(b)
298
if revinfo.revno is None:
299
dotted_map = b.get_revision_id_to_revno_map()
300
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
301
print '%s %s' % (revno, revinfo.rev_id)
302
else:
303
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
304
305
306
class cmd_add(Command):
307
"""Add specified files or directories.
308
309
In non-recursive mode, all the named items are added, regardless
310
of whether they were previously ignored. A warning is given if
311
any of the named files are already versioned.
312
313
In recursive mode (the default), files are treated the same way
314
but the behaviour for directories is different. Directories that
315
are already versioned do not give a warning. All directories,
316
whether already versioned or not, are searched for files or
317
subdirectories that are neither versioned or ignored, and these
318
are added. This search proceeds recursively into versioned
319
directories. If no names are given '.' is assumed.
320
321
Therefore simply saying 'bzr add' will version all files that
322
are currently unknown.
323
324
Adding a file whose parent directory is not versioned will
325
implicitly add the parent, and so on up to the root. This means
326
you should never need to explicitly add a directory, they'll just
327
get added when you add a file in the directory.
328
329
--dry-run will show which files would be added, but not actually
330
add them.
331
332
--file-ids-from will try to use the file ids from the supplied path.
333
It looks up ids trying to find a matching parent directory with the
334
same filename, and then by pure path. This option is rarely needed
335
but can be useful when adding the same logical file into two
336
branches that will be merged later (without showing the two different
337
adds as a conflict). It is also useful when merging another project
338
into a subdirectory of this one.
339
"""
340
takes_args = ['file*']
341
takes_options = [
342
Option('no-recurse',
343
help="Don't recursively add the contents of directories."),
344
Option('dry-run',
345
help="Show what would be done, but don't actually do anything."),
346
'verbose',
347
Option('file-ids-from',
348
type=unicode,
349
help='Lookup file ids from this tree.'),
350
]
351
encoding_type = 'replace'
352
_see_also = ['remove']
353
354
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
355
file_ids_from=None):
356
import bzrlib.add
357
358
base_tree = None
359
if file_ids_from is not None:
360
try:
361
base_tree, base_path = WorkingTree.open_containing(
362
file_ids_from)
363
except errors.NoWorkingTree:
364
base_branch, base_path = Branch.open_containing(
365
file_ids_from)
366
base_tree = base_branch.basis_tree()
367
368
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
369
to_file=self.outf, should_print=(not is_quiet()))
370
else:
371
action = bzrlib.add.AddAction(to_file=self.outf,
372
should_print=(not is_quiet()))
373
374
if base_tree:
375
base_tree.lock_read()
376
try:
377
file_list = self._maybe_expand_globs(file_list)
378
if file_list:
379
tree = WorkingTree.open_containing(file_list[0])[0]
380
else:
381
tree = WorkingTree.open_containing(u'.')[0]
382
added, ignored = tree.smart_add(file_list, not
383
no_recurse, action=action, save=not dry_run)
384
finally:
385
if base_tree is not None:
386
base_tree.unlock()
387
if len(ignored) > 0:
388
if verbose:
389
for glob in sorted(ignored.keys()):
390
for path in ignored[glob]:
391
self.outf.write("ignored %s matching \"%s\"\n"
392
% (path, glob))
393
else:
394
match_len = 0
395
for glob, paths in ignored.items():
396
match_len += len(paths)
397
self.outf.write("ignored %d file(s).\n" % match_len)
398
self.outf.write("If you wish to add some of these files,"
399
" please add them by name.\n")
400
401
402
class cmd_mkdir(Command):
403
"""Create a new versioned directory.
404
405
This is equivalent to creating the directory and then adding it.
406
"""
407
408
takes_args = ['dir+']
409
encoding_type = 'replace'
410
411
def run(self, dir_list):
412
for d in dir_list:
413
os.mkdir(d)
414
wt, dd = WorkingTree.open_containing(d)
415
wt.add([dd])
416
self.outf.write('added %s\n' % d)
417
418
419
class cmd_relpath(Command):
420
"""Show path of a file relative to root"""
421
422
takes_args = ['filename']
423
hidden = True
424
425
@display_command
426
def run(self, filename):
427
# TODO: jam 20050106 Can relpath return a munged path if
428
# sys.stdout encoding cannot represent it?
429
tree, relpath = WorkingTree.open_containing(filename)
430
self.outf.write(relpath)
431
self.outf.write('\n')
432
433
434
class cmd_inventory(Command):
435
"""Show inventory of the current working copy or a revision.
436
437
It is possible to limit the output to a particular entry
438
type using the --kind option. For example: --kind file.
439
440
It is also possible to restrict the list of files to a specific
441
set. For example: bzr inventory --show-ids this/file
442
"""
443
444
hidden = True
445
_see_also = ['ls']
446
takes_options = [
447
'revision',
448
'show-ids',
449
Option('kind',
450
help='List entries of a particular kind: file, directory, symlink.',
451
type=unicode),
452
]
453
takes_args = ['file*']
454
455
@display_command
456
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
457
if kind and kind not in ['file', 'directory', 'symlink']:
458
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
459
460
work_tree, file_list = tree_files(file_list)
461
work_tree.lock_read()
462
try:
463
if revision is not None:
464
if len(revision) > 1:
465
raise errors.BzrCommandError(
466
'bzr inventory --revision takes exactly one revision'
467
' identifier')
468
revision_id = revision[0].in_history(work_tree.branch).rev_id
469
tree = work_tree.branch.repository.revision_tree(revision_id)
470
471
extra_trees = [work_tree]
472
tree.lock_read()
473
else:
474
tree = work_tree
475
extra_trees = []
476
477
if file_list is not None:
478
file_ids = tree.paths2ids(file_list, trees=extra_trees,
479
require_versioned=True)
480
# find_ids_across_trees may include some paths that don't
481
# exist in 'tree'.
482
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
483
for file_id in file_ids if file_id in tree)
484
else:
485
entries = tree.inventory.entries()
486
finally:
487
tree.unlock()
488
if tree is not work_tree:
489
work_tree.unlock()
490
491
for path, entry in entries:
492
if kind and kind != entry.kind:
493
continue
494
if show_ids:
495
self.outf.write('%-50s %s\n' % (path, entry.file_id))
496
else:
497
self.outf.write(path)
498
self.outf.write('\n')
499
500
501
class cmd_mv(Command):
502
"""Move or rename a file.
503
504
:Usage:
505
bzr mv OLDNAME NEWNAME
506
507
bzr mv SOURCE... DESTINATION
508
509
If the last argument is a versioned directory, all the other names
510
are moved into it. Otherwise, there must be exactly two arguments
511
and the file is changed to a new name.
512
513
If OLDNAME does not exist on the filesystem but is versioned and
514
NEWNAME does exist on the filesystem but is not versioned, mv
515
assumes that the file has been manually moved and only updates
516
its internal inventory to reflect that change.
517
The same is valid when moving many SOURCE files to a DESTINATION.
518
519
Files cannot be moved between branches.
520
"""
521
522
takes_args = ['names*']
523
takes_options = [Option("after", help="Move only the bzr identifier"
524
" of the file, because the file has already been moved."),
525
]
526
aliases = ['move', 'rename']
527
encoding_type = 'replace'
528
529
def run(self, names_list, after=False):
530
if names_list is None:
531
names_list = []
532
533
if len(names_list) < 2:
534
raise errors.BzrCommandError("missing file argument")
535
tree, rel_names = tree_files(names_list)
536
537
if os.path.isdir(names_list[-1]):
538
# move into existing directory
539
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
540
self.outf.write("%s => %s\n" % pair)
541
else:
542
if len(names_list) != 2:
543
raise errors.BzrCommandError('to mv multiple files the'
544
' destination must be a versioned'
545
' directory')
546
tree.rename_one(rel_names[0], rel_names[1], after=after)
547
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
548
549
550
class cmd_pull(Command):
551
"""Turn this branch into a mirror of another branch.
552
553
This command only works on branches that have not diverged. Branches are
554
considered diverged if the destination branch's most recent commit is one
555
that has not been merged (directly or indirectly) into the parent.
556
557
If branches have diverged, you can use 'bzr merge' to integrate the changes
558
from one into the other. Once one branch has merged, the other should
559
be able to pull it again.
560
561
If you want to forget your local changes and just update your branch to
562
match the remote one, use pull --overwrite.
563
564
If there is no default location set, the first pull will set it. After
565
that, you can omit the location to use the default. To change the
566
default, use --remember. The value will only be saved if the remote
567
location can be accessed.
568
"""
569
570
_see_also = ['push', 'update', 'status-flags']
571
takes_options = ['remember', 'overwrite', 'revision',
572
Option('verbose', short_name='v',
573
help='Show logs of pulled revisions.'),
574
Option('directory',
575
help='Branch to pull into, '
576
'rather than the one containing the working directory.',
577
short_name='d',
578
type=unicode,
579
),
580
]
581
takes_args = ['location?']
582
encoding_type = 'replace'
583
584
def run(self, location=None, remember=False, overwrite=False,
585
revision=None, verbose=False,
586
directory=None):
587
# FIXME: too much stuff is in the command class
588
revision_id = None
589
mergeable = None
590
if directory is None:
591
directory = u'.'
592
try:
593
tree_to = WorkingTree.open_containing(directory)[0]
594
branch_to = tree_to.branch
595
except errors.NoWorkingTree:
596
tree_to = None
597
branch_to = Branch.open_containing(directory)[0]
598
599
if location is not None:
600
mergeable, location_transport = _get_mergeable_helper(location)
601
602
stored_loc = branch_to.get_parent()
603
if location is None:
604
if stored_loc is None:
605
raise errors.BzrCommandError("No pull location known or"
606
" specified.")
607
else:
608
display_url = urlutils.unescape_for_display(stored_loc,
609
self.outf.encoding)
610
self.outf.write("Using saved location: %s\n" % display_url)
611
location = stored_loc
612
location_transport = transport.get_transport(location)
613
614
if mergeable is not None:
615
if revision is not None:
616
raise errors.BzrCommandError(
617
'Cannot use -r with merge directives or bundles')
618
mergeable.install_revisions(branch_to.repository)
619
base_revision_id, revision_id, verified = \
620
mergeable.get_merge_request(branch_to.repository)
621
branch_from = branch_to
622
else:
623
branch_from = Branch.open_from_transport(location_transport)
624
625
if branch_to.get_parent() is None or remember:
626
branch_to.set_parent(branch_from.base)
627
628
if revision is not None:
629
if len(revision) == 1:
630
revision_id = revision[0].in_history(branch_from).rev_id
631
else:
632
raise errors.BzrCommandError(
633
'bzr pull --revision takes one value.')
634
635
if verbose:
636
old_rh = branch_to.revision_history()
637
if tree_to is not None:
638
result = tree_to.pull(branch_from, overwrite, revision_id,
639
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
640
else:
641
result = branch_to.pull(branch_from, overwrite, revision_id)
642
643
result.report(self.outf)
644
if verbose:
645
new_rh = branch_to.revision_history()
646
log.show_changed_revisions(branch_to, old_rh, new_rh,
647
to_file=self.outf)
648
649
650
class cmd_push(Command):
651
"""Update a mirror of this branch.
652
653
The target branch will not have its working tree populated because this
654
is both expensive, and is not supported on remote file systems.
655
656
Some smart servers or protocols *may* put the working tree in place in
657
the future.
658
659
This command only works on branches that have not diverged. Branches are
660
considered diverged if the destination branch's most recent commit is one
661
that has not been merged (directly or indirectly) by the source branch.
662
663
If branches have diverged, you can use 'bzr push --overwrite' to replace
664
the other branch completely, discarding its unmerged changes.
665
666
If you want to ensure you have the different changes in the other branch,
667
do a merge (see bzr help merge) from the other branch, and commit that.
668
After that you will be able to do a push without '--overwrite'.
669
670
If there is no default push location set, the first push will set it.
671
After that, you can omit the location to use the default. To change the
672
default, use --remember. The value will only be saved if the remote
673
location can be accessed.
674
"""
675
676
_see_also = ['pull', 'update', 'working-trees']
677
takes_options = ['remember', 'overwrite', 'verbose',
678
Option('create-prefix',
679
help='Create the path leading up to the branch '
680
'if it does not already exist.'),
681
Option('directory',
682
help='Branch to push from, '
683
'rather than the one containing the working directory.',
684
short_name='d',
685
type=unicode,
686
),
687
Option('use-existing-dir',
688
help='By default push will fail if the target'
689
' directory exists, but does not already'
690
' have a control directory. This flag will'
691
' allow push to proceed.'),
692
]
693
takes_args = ['location?']
694
encoding_type = 'replace'
695
696
def run(self, location=None, remember=False, overwrite=False,
697
create_prefix=False, verbose=False,
698
use_existing_dir=False,
699
directory=None):
700
# FIXME: Way too big! Put this into a function called from the
701
# command.
702
if directory is None:
703
directory = '.'
704
br_from = Branch.open_containing(directory)[0]
705
stored_loc = br_from.get_push_location()
706
if location is None:
707
if stored_loc is None:
708
raise errors.BzrCommandError("No push location known or specified.")
709
else:
710
display_url = urlutils.unescape_for_display(stored_loc,
711
self.outf.encoding)
712
self.outf.write("Using saved location: %s\n" % display_url)
713
location = stored_loc
714
715
to_transport = transport.get_transport(location)
716
717
br_to = repository_to = dir_to = None
718
try:
719
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
720
except errors.NotBranchError:
721
pass # Didn't find anything
722
else:
723
# If we can open a branch, use its direct repository, otherwise see
724
# if there is a repository without a branch.
725
try:
726
br_to = dir_to.open_branch()
727
except errors.NotBranchError:
728
# Didn't find a branch, can we find a repository?
729
try:
730
repository_to = dir_to.find_repository()
731
except errors.NoRepositoryPresent:
732
pass
733
else:
734
# Found a branch, so we must have found a repository
735
repository_to = br_to.repository
736
push_result = None
737
if verbose:
738
old_rh = []
739
if dir_to is None:
740
# The destination doesn't exist; create it.
741
# XXX: Refactor the create_prefix/no_create_prefix code into a
742
# common helper function
743
try:
744
to_transport.mkdir('.')
745
except errors.FileExists:
746
if not use_existing_dir:
747
raise errors.BzrCommandError("Target directory %s"
748
" already exists, but does not have a valid .bzr"
749
" directory. Supply --use-existing-dir to push"
750
" there anyway." % location)
751
except errors.NoSuchFile:
752
if not create_prefix:
753
raise errors.BzrCommandError("Parent directory of %s"
754
" does not exist."
755
"\nYou may supply --create-prefix to create all"
756
" leading parent directories."
757
% location)
758
_create_prefix(to_transport)
759
760
# Now the target directory exists, but doesn't have a .bzr
761
# directory. So we need to create it, along with any work to create
762
# all of the dependent branches, etc.
763
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
764
revision_id=br_from.last_revision())
765
br_to = dir_to.open_branch()
766
# TODO: Some more useful message about what was copied
767
note('Created new branch.')
768
# We successfully created the target, remember it
769
if br_from.get_push_location() is None or remember:
770
br_from.set_push_location(br_to.base)
771
elif repository_to is None:
772
# we have a bzrdir but no branch or repository
773
# XXX: Figure out what to do other than complain.
774
raise errors.BzrCommandError("At %s you have a valid .bzr control"
775
" directory, but not a branch or repository. This is an"
776
" unsupported configuration. Please move the target directory"
777
" out of the way and try again."
778
% location)
779
elif br_to is None:
780
# We have a repository but no branch, copy the revisions, and then
781
# create a branch.
782
last_revision_id = br_from.last_revision()
783
repository_to.fetch(br_from.repository,
784
revision_id=last_revision_id)
785
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
786
note('Created new branch.')
787
if br_from.get_push_location() is None or remember:
788
br_from.set_push_location(br_to.base)
789
else: # We have a valid to branch
790
# We were able to connect to the remote location, so remember it
791
# we don't need to successfully push because of possible divergence.
792
if br_from.get_push_location() is None or remember:
793
br_from.set_push_location(br_to.base)
794
if verbose:
795
old_rh = br_to.revision_history()
796
try:
797
try:
798
tree_to = dir_to.open_workingtree()
799
except errors.NotLocalUrl:
800
warning("This transport does not update the working "
801
"tree of: %s. See 'bzr help working-trees' for "
802
"more information." % br_to.base)
803
push_result = br_from.push(br_to, overwrite)
804
except errors.NoWorkingTree:
805
push_result = br_from.push(br_to, overwrite)
806
else:
807
tree_to.lock_write()
808
try:
809
push_result = br_from.push(tree_to.branch, overwrite)
810
tree_to.update()
811
finally:
812
tree_to.unlock()
813
except errors.DivergedBranches:
814
raise errors.BzrCommandError('These branches have diverged.'
815
' Try using "merge" and then "push".')
816
if push_result is not None:
817
push_result.report(self.outf)
818
elif verbose:
819
new_rh = br_to.revision_history()
820
if old_rh != new_rh:
821
# Something changed
822
from bzrlib.log import show_changed_revisions
823
show_changed_revisions(br_to, old_rh, new_rh,
824
to_file=self.outf)
825
else:
826
# we probably did a clone rather than a push, so a message was
827
# emitted above
828
pass
829
830
831
class cmd_branch(Command):
832
"""Create a new copy of a branch.
833
834
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
835
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
836
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
837
is derived from the FROM_LOCATION by stripping a leading scheme or drive
838
identifier, if any. For example, "branch lp:foo-bar" will attempt to
839
create ./foo-bar.
840
841
To retrieve the branch as of a particular revision, supply the --revision
842
parameter, as in "branch foo/bar -r 5".
843
"""
844
845
_see_also = ['checkout']
846
takes_args = ['from_location', 'to_location?']
847
takes_options = ['revision']
848
aliases = ['get', 'clone']
849
850
def run(self, from_location, to_location=None, revision=None):
851
from bzrlib.tag import _merge_tags_if_possible
852
if revision is None:
853
revision = [None]
854
elif len(revision) > 1:
855
raise errors.BzrCommandError(
856
'bzr branch --revision takes exactly 1 revision value')
857
858
br_from = Branch.open(from_location)
859
br_from.lock_read()
860
try:
861
if len(revision) == 1 and revision[0] is not None:
862
revision_id = revision[0].in_history(br_from)[1]
863
else:
864
# FIXME - wt.last_revision, fallback to branch, fall back to
865
# None or perhaps NULL_REVISION to mean copy nothing
866
# RBC 20060209
867
revision_id = br_from.last_revision()
868
if to_location is None:
869
to_location = urlutils.derive_to_location(from_location)
870
name = None
871
else:
872
name = os.path.basename(to_location) + '\n'
873
874
to_transport = transport.get_transport(to_location)
875
try:
876
to_transport.mkdir('.')
877
except errors.FileExists:
878
raise errors.BzrCommandError('Target directory "%s" already'
879
' exists.' % to_location)
880
except errors.NoSuchFile:
881
raise errors.BzrCommandError('Parent of "%s" does not exist.'
882
% to_location)
883
try:
884
# preserve whatever source format we have.
885
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
886
possible_transports=[to_transport])
887
branch = dir.open_branch()
888
except errors.NoSuchRevision:
889
to_transport.delete_tree('.')
890
msg = "The branch %s has no revision %s." % (from_location, revision[0])
891
raise errors.BzrCommandError(msg)
892
if name:
893
branch.control_files.put_utf8('branch-name', name)
894
_merge_tags_if_possible(br_from, branch)
895
note('Branched %d revision(s).' % branch.revno())
896
finally:
897
br_from.unlock()
898
899
900
class cmd_checkout(Command):
901
"""Create a new checkout of an existing branch.
902
903
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
904
the branch found in '.'. This is useful if you have removed the working tree
905
or if it was never created - i.e. if you pushed the branch to its current
906
location using SFTP.
907
908
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
909
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
910
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
911
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
912
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
913
create ./foo-bar.
914
915
To retrieve the branch as of a particular revision, supply the --revision
916
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
917
out of date [so you cannot commit] but it may be useful (i.e. to examine old
918
code.)
919
"""
920
921
_see_also = ['checkouts', 'branch']
922
takes_args = ['branch_location?', 'to_location?']
923
takes_options = ['revision',
924
Option('lightweight',
925
help="Perform a lightweight checkout. Lightweight "
926
"checkouts depend on access to the branch for "
927
"every operation. Normal checkouts can perform "
928
"common operations like diff and status without "
929
"such access, and also support local commits."
930
),
931
]
932
aliases = ['co']
933
934
def run(self, branch_location=None, to_location=None, revision=None,
935
lightweight=False):
936
if revision is None:
937
revision = [None]
938
elif len(revision) > 1:
939
raise errors.BzrCommandError(
940
'bzr checkout --revision takes exactly 1 revision value')
941
if branch_location is None:
942
branch_location = osutils.getcwd()
943
to_location = branch_location
944
source = Branch.open(branch_location)
945
if len(revision) == 1 and revision[0] is not None:
946
revision_id = _mod_revision.ensure_null(
947
revision[0].in_history(source)[1])
948
else:
949
revision_id = None
950
if to_location is None:
951
to_location = urlutils.derive_to_location(branch_location)
952
# if the source and to_location are the same,
953
# and there is no working tree,
954
# then reconstitute a branch
955
if (osutils.abspath(to_location) ==
956
osutils.abspath(branch_location)):
957
try:
958
source.bzrdir.open_workingtree()
959
except errors.NoWorkingTree:
960
source.bzrdir.create_workingtree(revision_id)
961
return
962
source.create_checkout(to_location, revision_id, lightweight)
963
964
965
class cmd_renames(Command):
966
"""Show list of renamed files.
967
"""
968
# TODO: Option to show renames between two historical versions.
969
970
# TODO: Only show renames under dir, rather than in the whole branch.
971
_see_also = ['status']
972
takes_args = ['dir?']
973
974
@display_command
975
def run(self, dir=u'.'):
976
tree = WorkingTree.open_containing(dir)[0]
977
tree.lock_read()
978
try:
979
new_inv = tree.inventory
980
old_tree = tree.basis_tree()
981
old_tree.lock_read()
982
try:
983
old_inv = old_tree.inventory
984
renames = list(_mod_tree.find_renames(old_inv, new_inv))
985
renames.sort()
986
for old_name, new_name in renames:
987
self.outf.write("%s => %s\n" % (old_name, new_name))
988
finally:
989
old_tree.unlock()
990
finally:
991
tree.unlock()
992
993
994
class cmd_update(Command):
995
"""Update a tree to have the latest code committed to its branch.
996
997
This will perform a merge into the working tree, and may generate
998
conflicts. If you have any local changes, you will still
999
need to commit them after the update for the update to be complete.
1000
1001
If you want to discard your local changes, you can just do a
1002
'bzr revert' instead of 'bzr commit' after the update.
1003
"""
1004
1005
_see_also = ['pull', 'working-trees', 'status-flags']
1006
takes_args = ['dir?']
1007
aliases = ['up']
1008
1009
def run(self, dir='.'):
1010
tree = WorkingTree.open_containing(dir)[0]
1011
master = tree.branch.get_master_branch()
1012
if master is not None:
1013
tree.lock_write()
1014
else:
1015
tree.lock_tree_write()
1016
try:
1017
existing_pending_merges = tree.get_parent_ids()[1:]
1018
last_rev = _mod_revision.ensure_null(tree.last_revision())
1019
if last_rev == _mod_revision.ensure_null(
1020
tree.branch.last_revision()):
1021
# may be up to date, check master too.
1022
if master is None or last_rev == _mod_revision.ensure_null(
1023
master.last_revision()):
1024
revno = tree.branch.revision_id_to_revno(last_rev)
1025
note("Tree is up to date at revision %d." % (revno,))
1026
return 0
1027
conflicts = tree.update(delta._ChangeReporter(
1028
unversioned_filter=tree.is_ignored))
1029
revno = tree.branch.revision_id_to_revno(
1030
_mod_revision.ensure_null(tree.last_revision()))
1031
note('Updated to revision %d.' % (revno,))
1032
if tree.get_parent_ids()[1:] != existing_pending_merges:
1033
note('Your local commits will now show as pending merges with '
1034
"'bzr status', and can be committed with 'bzr commit'.")
1035
if conflicts != 0:
1036
return 1
1037
else:
1038
return 0
1039
finally:
1040
tree.unlock()
1041
1042
1043
class cmd_info(Command):
1044
"""Show information about a working tree, branch or repository.
1045
1046
This command will show all known locations and formats associated to the
1047
tree, branch or repository. Statistical information is included with
1048
each report.
1049
1050
Branches and working trees will also report any missing revisions.
1051
"""
1052
_see_also = ['revno', 'working-trees', 'repositories']
1053
takes_args = ['location?']
1054
takes_options = ['verbose']
1055
1056
@display_command
1057
def run(self, location=None, verbose=0):
1058
from bzrlib.info import show_bzrdir_info
1059
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1060
verbose=verbose)
1061
1062
1063
class cmd_remove(Command):
1064
"""Remove files or directories.
1065
1066
This makes bzr stop tracking changes to the specified files and
1067
delete them if they can easily be recovered using revert.
1068
1069
You can specify one or more files, and/or --new. If you specify --new,
1070
only 'added' files will be removed. If you specify both, then new files
1071
in the specified directories will be removed. If the directories are
1072
also new, they will also be removed.
1073
"""
1074
takes_args = ['file*']
1075
takes_options = ['verbose',
1076
Option('new', help='Remove newly-added files.'),
1077
RegistryOption.from_kwargs('file-deletion-strategy',
1078
'The file deletion mode to be used.',
1079
title='Deletion Strategy', value_switches=True, enum_switch=False,
1080
safe='Only delete files if they can be'
1081
' safely recovered (default).',
1082
keep="Don't delete any files.",
1083
force='Delete all the specified files, even if they can not be '
1084
'recovered and even if they are non-empty directories.')]
1085
aliases = ['rm']
1086
encoding_type = 'replace'
1087
1088
def run(self, file_list, verbose=False, new=False,
1089
file_deletion_strategy='safe'):
1090
tree, file_list = tree_files(file_list)
1091
1092
if file_list is not None:
1093
file_list = [f for f in file_list if f != '']
1094
elif not new:
1095
raise errors.BzrCommandError('Specify one or more files to'
1096
' remove, or use --new.')
1097
1098
if new:
1099
added = tree.changes_from(tree.basis_tree(),
1100
specific_files=file_list).added
1101
file_list = sorted([f[0] for f in added], reverse=True)
1102
if len(file_list) == 0:
1103
raise errors.BzrCommandError('No matching files.')
1104
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1105
keep_files=file_deletion_strategy=='keep',
1106
force=file_deletion_strategy=='force')
1107
1108
1109
class cmd_file_id(Command):
1110
"""Print file_id of a particular file or directory.
1111
1112
The file_id is assigned when the file is first added and remains the
1113
same through all revisions where the file exists, even when it is
1114
moved or renamed.
1115
"""
1116
1117
hidden = True
1118
_see_also = ['inventory', 'ls']
1119
takes_args = ['filename']
1120
1121
@display_command
1122
def run(self, filename):
1123
tree, relpath = WorkingTree.open_containing(filename)
1124
i = tree.path2id(relpath)
1125
if i is None:
1126
raise errors.NotVersionedError(filename)
1127
else:
1128
self.outf.write(i + '\n')
1129
1130
1131
class cmd_file_path(Command):
1132
"""Print path of file_ids to a file or directory.
1133
1134
This prints one line for each directory down to the target,
1135
starting at the branch root.
1136
"""
1137
1138
hidden = True
1139
takes_args = ['filename']
1140
1141
@display_command
1142
def run(self, filename):
1143
tree, relpath = WorkingTree.open_containing(filename)
1144
fid = tree.path2id(relpath)
1145
if fid is None:
1146
raise errors.NotVersionedError(filename)
1147
segments = osutils.splitpath(relpath)
1148
for pos in range(1, len(segments) + 1):
1149
path = osutils.joinpath(segments[:pos])
1150
self.outf.write("%s\n" % tree.path2id(path))
1151
1152
1153
class cmd_reconcile(Command):
1154
"""Reconcile bzr metadata in a branch.
1155
1156
This can correct data mismatches that may have been caused by
1157
previous ghost operations or bzr upgrades. You should only
1158
need to run this command if 'bzr check' or a bzr developer
1159
advises you to run it.
1160
1161
If a second branch is provided, cross-branch reconciliation is
1162
also attempted, which will check that data like the tree root
1163
id which was not present in very early bzr versions is represented
1164
correctly in both branches.
1165
1166
At the same time it is run it may recompress data resulting in
1167
a potential saving in disk space or performance gain.
1168
1169
The branch *MUST* be on a listable system such as local disk or sftp.
1170
"""
1171
1172
_see_also = ['check']
1173
takes_args = ['branch?']
1174
1175
def run(self, branch="."):
1176
from bzrlib.reconcile import reconcile
1177
dir = bzrdir.BzrDir.open(branch)
1178
reconcile(dir)
1179
1180
1181
class cmd_revision_history(Command):
1182
"""Display the list of revision ids on a branch."""
1183
1184
_see_also = ['log']
1185
takes_args = ['location?']
1186
1187
hidden = True
1188
1189
@display_command
1190
def run(self, location="."):
1191
branch = Branch.open_containing(location)[0]
1192
for revid in branch.revision_history():
1193
self.outf.write(revid)
1194
self.outf.write('\n')
1195
1196
1197
class cmd_ancestry(Command):
1198
"""List all revisions merged into this branch."""
1199
1200
_see_also = ['log', 'revision-history']
1201
takes_args = ['location?']
1202
1203
hidden = True
1204
1205
@display_command
1206
def run(self, location="."):
1207
try:
1208
wt = WorkingTree.open_containing(location)[0]
1209
except errors.NoWorkingTree:
1210
b = Branch.open(location)
1211
last_revision = b.last_revision()
1212
else:
1213
b = wt.branch
1214
last_revision = wt.last_revision()
1215
1216
revision_ids = b.repository.get_ancestry(last_revision)
1217
assert revision_ids[0] is None
1218
revision_ids.pop(0)
1219
for revision_id in revision_ids:
1220
self.outf.write(revision_id + '\n')
1221
1222
1223
class cmd_init(Command):
1224
"""Make a directory into a versioned branch.
1225
1226
Use this to create an empty branch, or before importing an
1227
existing project.
1228
1229
If there is a repository in a parent directory of the location, then
1230
the history of the branch will be stored in the repository. Otherwise
1231
init creates a standalone branch which carries its own history
1232
in the .bzr directory.
1233
1234
If there is already a branch at the location but it has no working tree,
1235
the tree can be populated with 'bzr checkout'.
1236
1237
Recipe for importing a tree of files::
1238
1239
cd ~/project
1240
bzr init
1241
bzr add .
1242
bzr status
1243
bzr commit -m 'imported project'
1244
"""
1245
1246
_see_also = ['init-repository', 'branch', 'checkout']
1247
takes_args = ['location?']
1248
takes_options = [
1249
Option('create-prefix',
1250
help='Create the path leading up to the branch '
1251
'if it does not already exist.'),
1252
RegistryOption('format',
1253
help='Specify a format for this branch. '
1254
'See "help formats".',
1255
registry=bzrdir.format_registry,
1256
converter=bzrdir.format_registry.make_bzrdir,
1257
value_switches=True,
1258
title="Branch Format",
1259
),
1260
Option('append-revisions-only',
1261
help='Never change revnos or the existing log.'
1262
' Append revisions to it only.')
1263
]
1264
def run(self, location=None, format=None, append_revisions_only=False,
1265
create_prefix=False):
1266
if format is None:
1267
format = bzrdir.format_registry.make_bzrdir('default')
1268
if location is None:
1269
location = u'.'
1270
1271
to_transport = transport.get_transport(location)
1272
1273
# The path has to exist to initialize a
1274
# branch inside of it.
1275
# Just using os.mkdir, since I don't
1276
# believe that we want to create a bunch of
1277
# locations if the user supplies an extended path
1278
try:
1279
to_transport.ensure_base()
1280
except errors.NoSuchFile:
1281
if not create_prefix:
1282
raise errors.BzrCommandError("Parent directory of %s"
1283
" does not exist."
1284
"\nYou may supply --create-prefix to create all"
1285
" leading parent directories."
1286
% location)
1287
_create_prefix(to_transport)
1288
1289
try:
1290
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1291
except errors.NotBranchError:
1292
# really a NotBzrDir error...
1293
create_branch = bzrdir.BzrDir.create_branch_convenience
1294
branch = create_branch(to_transport.base, format=format,
1295
possible_transports=[to_transport])
1296
else:
1297
from bzrlib.transport.local import LocalTransport
1298
if existing_bzrdir.has_branch():
1299
if (isinstance(to_transport, LocalTransport)
1300
and not existing_bzrdir.has_workingtree()):
1301
raise errors.BranchExistsWithoutWorkingTree(location)
1302
raise errors.AlreadyBranchError(location)
1303
else:
1304
branch = existing_bzrdir.create_branch()
1305
existing_bzrdir.create_workingtree()
1306
if append_revisions_only:
1307
try:
1308
branch.set_append_revisions_only(True)
1309
except errors.UpgradeRequired:
1310
raise errors.BzrCommandError('This branch format cannot be set'
1311
' to append-revisions-only. Try --experimental-branch6')
1312
1313
1314
class cmd_init_repository(Command):
1315
"""Create a shared repository to hold branches.
1316
1317
New branches created under the repository directory will store their
1318
revisions in the repository, not in the branch directory.
1319
1320
If the --no-trees option is used then the branches in the repository
1321
will not have working trees by default.
1322
1323
:Examples:
1324
Create a shared repositories holding just branches::
1325
1326
bzr init-repo --no-trees repo
1327
bzr init repo/trunk
1328
1329
Make a lightweight checkout elsewhere::
1330
1331
bzr checkout --lightweight repo/trunk trunk-checkout
1332
cd trunk-checkout
1333
(add files here)
1334
"""
1335
1336
_see_also = ['init', 'branch', 'checkout', 'repositories']
1337
takes_args = ["location"]
1338
takes_options = [RegistryOption('format',
1339
help='Specify a format for this repository. See'
1340
' "bzr help formats" for details.',
1341
registry=bzrdir.format_registry,
1342
converter=bzrdir.format_registry.make_bzrdir,
1343
value_switches=True, title='Repository format'),
1344
Option('no-trees',
1345
help='Branches in the repository will default to'
1346
' not having a working tree.'),
1347
]
1348
aliases = ["init-repo"]
1349
1350
def run(self, location, format=None, no_trees=False):
1351
if format is None:
1352
format = bzrdir.format_registry.make_bzrdir('default')
1353
1354
if location is None:
1355
location = '.'
1356
1357
to_transport = transport.get_transport(location)
1358
to_transport.ensure_base()
1359
1360
newdir = format.initialize_on_transport(to_transport)
1361
repo = newdir.create_repository(shared=True)
1362
repo.set_make_working_trees(not no_trees)
1363
1364
1365
class cmd_diff(Command):
1366
"""Show differences in the working tree or between revisions.
1367
1368
If files are listed, only the changes in those files are listed.
1369
Otherwise, all changes for the tree are listed.
1370
1371
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1372
produces patches suitable for "patch -p1".
1373
1374
:Examples:
1375
Shows the difference in the working tree versus the last commit::
1376
1377
bzr diff
1378
1379
Difference between the working tree and revision 1::
1380
1381
bzr diff -r1
1382
1383
Difference between revision 2 and revision 1::
1384
1385
bzr diff -r1..2
1386
1387
Same as 'bzr diff' but prefix paths with old/ and new/::
1388
1389
bzr diff --prefix old/:new/
1390
1391
Show the differences between the two working trees::
1392
1393
bzr diff bzr.mine bzr.dev
1394
1395
Show just the differences for 'foo.c'::
1396
1397
bzr diff foo.c
1398
"""
1399
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1400
# or a graphical diff.
1401
1402
# TODO: Python difflib is not exactly the same as unidiff; should
1403
# either fix it up or prefer to use an external diff.
1404
1405
# TODO: Selected-file diff is inefficient and doesn't show you
1406
# deleted files.
1407
1408
# TODO: This probably handles non-Unix newlines poorly.
1409
1410
_see_also = ['status']
1411
takes_args = ['file*']
1412
takes_options = [
1413
Option('diff-options', type=str,
1414
help='Pass these options to the external diff program.'),
1415
Option('prefix', type=str,
1416
short_name='p',
1417
help='Set prefixes to added to old and new filenames, as '
1418
'two values separated by a colon. (eg "old/:new/").'),
1419
'revision',
1420
]
1421
aliases = ['di', 'dif']
1422
encoding_type = 'exact'
1423
1424
@display_command
1425
def run(self, revision=None, file_list=None, diff_options=None,
1426
prefix=None):
1427
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1428
1429
if (prefix is None) or (prefix == '0'):
1430
# diff -p0 format
1431
old_label = ''
1432
new_label = ''
1433
elif prefix == '1':
1434
old_label = 'old/'
1435
new_label = 'new/'
1436
elif ':' in prefix:
1437
old_label, new_label = prefix.split(":")
1438
else:
1439
raise errors.BzrCommandError(
1440
'--prefix expects two values separated by a colon'
1441
' (eg "old/:new/")')
1442
1443
if revision and len(revision) > 2:
1444
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1445
' one or two revision specifiers')
1446
1447
try:
1448
tree1, file_list = internal_tree_files(file_list)
1449
tree2 = None
1450
b = None
1451
b2 = None
1452
except errors.FileInWrongBranch:
1453
if len(file_list) != 2:
1454
raise errors.BzrCommandError("Files are in different branches")
1455
1456
tree1, file1 = WorkingTree.open_containing(file_list[0])
1457
tree2, file2 = WorkingTree.open_containing(file_list[1])
1458
if file1 != "" or file2 != "":
1459
# FIXME diff those two files. rbc 20051123
1460
raise errors.BzrCommandError("Files are in different branches")
1461
file_list = None
1462
except errors.NotBranchError:
1463
if (revision is not None and len(revision) == 2
1464
and not revision[0].needs_branch()
1465
and not revision[1].needs_branch()):
1466
# If both revision specs include a branch, we can
1467
# diff them without needing a local working tree
1468
tree1, tree2 = None, None
1469
else:
1470
raise
1471
1472
if tree2 is not None:
1473
if revision is not None:
1474
# FIXME: but there should be a clean way to diff between
1475
# non-default versions of two trees, it's not hard to do
1476
# internally...
1477
raise errors.BzrCommandError(
1478
"Sorry, diffing arbitrary revisions across branches "
1479
"is not implemented yet")
1480
return show_diff_trees(tree1, tree2, sys.stdout,
1481
specific_files=file_list,
1482
external_diff_options=diff_options,
1483
old_label=old_label, new_label=new_label)
1484
1485
return diff_cmd_helper(tree1, file_list, diff_options,
1486
revision_specs=revision,
1487
old_label=old_label, new_label=new_label)
1488
1489
1490
class cmd_deleted(Command):
1491
"""List files deleted in the working tree.
1492
"""
1493
# TODO: Show files deleted since a previous revision, or
1494
# between two revisions.
1495
# TODO: Much more efficient way to do this: read in new
1496
# directories with readdir, rather than stating each one. Same
1497
# level of effort but possibly much less IO. (Or possibly not,
1498
# if the directories are very large...)
1499
_see_also = ['status', 'ls']
1500
takes_options = ['show-ids']
1501
1502
@display_command
1503
def run(self, show_ids=False):
1504
tree = WorkingTree.open_containing(u'.')[0]
1505
tree.lock_read()
1506
try:
1507
old = tree.basis_tree()
1508
old.lock_read()
1509
try:
1510
for path, ie in old.inventory.iter_entries():
1511
if not tree.has_id(ie.file_id):
1512
self.outf.write(path)
1513
if show_ids:
1514
self.outf.write(' ')
1515
self.outf.write(ie.file_id)
1516
self.outf.write('\n')
1517
finally:
1518
old.unlock()
1519
finally:
1520
tree.unlock()
1521
1522
1523
class cmd_modified(Command):
1524
"""List files modified in working tree.
1525
"""
1526
1527
hidden = True
1528
_see_also = ['status', 'ls']
1529
1530
@display_command
1531
def run(self):
1532
tree = WorkingTree.open_containing(u'.')[0]
1533
td = tree.changes_from(tree.basis_tree())
1534
for path, id, kind, text_modified, meta_modified in td.modified:
1535
self.outf.write(path + '\n')
1536
1537
1538
class cmd_added(Command):
1539
"""List files added in working tree.
1540
"""
1541
1542
hidden = True
1543
_see_also = ['status', 'ls']
1544
1545
@display_command
1546
def run(self):
1547
wt = WorkingTree.open_containing(u'.')[0]
1548
wt.lock_read()
1549
try:
1550
basis = wt.basis_tree()
1551
basis.lock_read()
1552
try:
1553
basis_inv = basis.inventory
1554
inv = wt.inventory
1555
for file_id in inv:
1556
if file_id in basis_inv:
1557
continue
1558
if inv.is_root(file_id) and len(basis_inv) == 0:
1559
continue
1560
path = inv.id2path(file_id)
1561
if not os.access(osutils.abspath(path), os.F_OK):
1562
continue
1563
self.outf.write(path + '\n')
1564
finally:
1565
basis.unlock()
1566
finally:
1567
wt.unlock()
1568
1569
1570
class cmd_root(Command):
1571
"""Show the tree root directory.
1572
1573
The root is the nearest enclosing directory with a .bzr control
1574
directory."""
1575
1576
takes_args = ['filename?']
1577
@display_command
1578
def run(self, filename=None):
1579
"""Print the branch root."""
1580
tree = WorkingTree.open_containing(filename)[0]
1581
self.outf.write(tree.basedir + '\n')
1582
1583
1584
def _parse_limit(limitstring):
1585
try:
1586
return int(limitstring)
1587
except ValueError:
1588
msg = "The limit argument must be an integer."
1589
raise errors.BzrCommandError(msg)
1590
1591
1592
class cmd_log(Command):
1593
"""Show log of a branch, file, or directory.
1594
1595
By default show the log of the branch containing the working directory.
1596
1597
To request a range of logs, you can use the command -r begin..end
1598
-r revision requests a specific revision, -r ..end or -r begin.. are
1599
also valid.
1600
1601
:Examples:
1602
Log the current branch::
1603
1604
bzr log
1605
1606
Log a file::
1607
1608
bzr log foo.c
1609
1610
Log the last 10 revisions of a branch::
1611
1612
bzr log -r -10.. http://server/branch
1613
"""
1614
1615
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1616
1617
takes_args = ['location?']
1618
takes_options = [
1619
Option('forward',
1620
help='Show from oldest to newest.'),
1621
Option('timezone',
1622
type=str,
1623
help='Display timezone as local, original, or utc.'),
1624
Option('verbose',
1625
short_name='v',
1626
help='Show files changed in each revision.'),
1627
'show-ids',
1628
'revision',
1629
'log-format',
1630
Option('message',
1631
short_name='m',
1632
help='Show revisions whose message matches this '
1633
'regular expression.',
1634
type=str),
1635
Option('limit',
1636
help='Limit the output to the first N revisions.',
1637
argname='N',
1638
type=_parse_limit),
1639
]
1640
encoding_type = 'replace'
1641
1642
@display_command
1643
def run(self, location=None, timezone='original',
1644
verbose=False,
1645
show_ids=False,
1646
forward=False,
1647
revision=None,
1648
log_format=None,
1649
message=None,
1650
limit=None):
1651
from bzrlib.log import show_log
1652
assert message is None or isinstance(message, basestring), \
1653
"invalid message argument %r" % message
1654
direction = (forward and 'forward') or 'reverse'
1655
1656
# log everything
1657
file_id = None
1658
if location:
1659
# find the file id to log:
1660
1661
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1662
location)
1663
if fp != '':
1664
if tree is None:
1665
tree = b.basis_tree()
1666
file_id = tree.path2id(fp)
1667
if file_id is None:
1668
raise errors.BzrCommandError(
1669
"Path does not have any revision history: %s" %
1670
location)
1671
else:
1672
# local dir only
1673
# FIXME ? log the current subdir only RBC 20060203
1674
if revision is not None \
1675
and len(revision) > 0 and revision[0].get_branch():
1676
location = revision[0].get_branch()
1677
else:
1678
location = '.'
1679
dir, relpath = bzrdir.BzrDir.open_containing(location)
1680
b = dir.open_branch()
1681
1682
b.lock_read()
1683
try:
1684
if revision is None:
1685
rev1 = None
1686
rev2 = None
1687
elif len(revision) == 1:
1688
rev1 = rev2 = revision[0].in_history(b)
1689
elif len(revision) == 2:
1690
if revision[1].get_branch() != revision[0].get_branch():
1691
# b is taken from revision[0].get_branch(), and
1692
# show_log will use its revision_history. Having
1693
# different branches will lead to weird behaviors.
1694
raise errors.BzrCommandError(
1695
"Log doesn't accept two revisions in different"
1696
" branches.")
1697
rev1 = revision[0].in_history(b)
1698
rev2 = revision[1].in_history(b)
1699
else:
1700
raise errors.BzrCommandError(
1701
'bzr log --revision takes one or two values.')
1702
1703
if log_format is None:
1704
log_format = log.log_formatter_registry.get_default(b)
1705
1706
lf = log_format(show_ids=show_ids, to_file=self.outf,
1707
show_timezone=timezone)
1708
1709
show_log(b,
1710
lf,
1711
file_id,
1712
verbose=verbose,
1713
direction=direction,
1714
start_revision=rev1,
1715
end_revision=rev2,
1716
search=message,
1717
limit=limit)
1718
finally:
1719
b.unlock()
1720
1721
1722
def get_log_format(long=False, short=False, line=False, default='long'):
1723
log_format = default
1724
if long:
1725
log_format = 'long'
1726
if short:
1727
log_format = 'short'
1728
if line:
1729
log_format = 'line'
1730
return log_format
1731
1732
1733
class cmd_touching_revisions(Command):
1734
"""Return revision-ids which affected a particular file.
1735
1736
A more user-friendly interface is "bzr log FILE".
1737
"""
1738
1739
hidden = True
1740
takes_args = ["filename"]
1741
1742
@display_command
1743
def run(self, filename):
1744
tree, relpath = WorkingTree.open_containing(filename)
1745
b = tree.branch
1746
file_id = tree.path2id(relpath)
1747
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1748
self.outf.write("%6d %s\n" % (revno, what))
1749
1750
1751
class cmd_ls(Command):
1752
"""List files in a tree.
1753
"""
1754
1755
_see_also = ['status', 'cat']
1756
takes_args = ['path?']
1757
# TODO: Take a revision or remote path and list that tree instead.
1758
takes_options = [
1759
'verbose',
1760
'revision',
1761
Option('non-recursive',
1762
help='Don\'t recurse into subdirectories.'),
1763
Option('from-root',
1764
help='Print paths relative to the root of the branch.'),
1765
Option('unknown', help='Print unknown files.'),
1766
Option('versioned', help='Print versioned files.'),
1767
Option('ignored', help='Print ignored files.'),
1768
Option('null',
1769
help='Write an ascii NUL (\\0) separator '
1770
'between files rather than a newline.'),
1771
Option('kind',
1772
help='List entries of a particular kind: file, directory, symlink.',
1773
type=unicode),
1774
'show-ids',
1775
]
1776
@display_command
1777
def run(self, revision=None, verbose=False,
1778
non_recursive=False, from_root=False,
1779
unknown=False, versioned=False, ignored=False,
1780
null=False, kind=None, show_ids=False, path=None):
1781
1782
if kind and kind not in ('file', 'directory', 'symlink'):
1783
raise errors.BzrCommandError('invalid kind specified')
1784
1785
if verbose and null:
1786
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1787
all = not (unknown or versioned or ignored)
1788
1789
selection = {'I':ignored, '?':unknown, 'V':versioned}
1790
1791
if path is None:
1792
fs_path = '.'
1793
prefix = ''
1794
else:
1795
if from_root:
1796
raise errors.BzrCommandError('cannot specify both --from-root'
1797
' and PATH')
1798
fs_path = path
1799
prefix = path
1800
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1801
fs_path)
1802
if from_root:
1803
relpath = u''
1804
elif relpath:
1805
relpath += '/'
1806
if revision is not None:
1807
tree = branch.repository.revision_tree(
1808
revision[0].in_history(branch).rev_id)
1809
elif tree is None:
1810
tree = branch.basis_tree()
1811
1812
tree.lock_read()
1813
try:
1814
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1815
if fp.startswith(relpath):
1816
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1817
if non_recursive and '/' in fp:
1818
continue
1819
if not all and not selection[fc]:
1820
continue
1821
if kind is not None and fkind != kind:
1822
continue
1823
if verbose:
1824
kindch = entry.kind_character()
1825
outstring = '%-8s %s%s' % (fc, fp, kindch)
1826
if show_ids and fid is not None:
1827
outstring = "%-50s %s" % (outstring, fid)
1828
self.outf.write(outstring + '\n')
1829
elif null:
1830
self.outf.write(fp + '\0')
1831
if show_ids:
1832
if fid is not None:
1833
self.outf.write(fid)
1834
self.outf.write('\0')
1835
self.outf.flush()
1836
else:
1837
if fid is not None:
1838
my_id = fid
1839
else:
1840
my_id = ''
1841
if show_ids:
1842
self.outf.write('%-50s %s\n' % (fp, my_id))
1843
else:
1844
self.outf.write(fp + '\n')
1845
finally:
1846
tree.unlock()
1847
1848
1849
class cmd_unknowns(Command):
1850
"""List unknown files.
1851
"""
1852
1853
hidden = True
1854
_see_also = ['ls']
1855
1856
@display_command
1857
def run(self):
1858
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1859
self.outf.write(osutils.quotefn(f) + '\n')
1860
1861
1862
class cmd_ignore(Command):
1863
"""Ignore specified files or patterns.
1864
1865
To remove patterns from the ignore list, edit the .bzrignore file.
1866
1867
Trailing slashes on patterns are ignored.
1868
If the pattern contains a slash or is a regular expression, it is compared
1869
to the whole path from the branch root. Otherwise, it is compared to only
1870
the last component of the path. To match a file only in the root
1871
directory, prepend './'.
1872
1873
Ignore patterns specifying absolute paths are not allowed.
1874
1875
Ignore patterns may include globbing wildcards such as::
1876
1877
? - Matches any single character except '/'
1878
* - Matches 0 or more characters except '/'
1879
/**/ - Matches 0 or more directories in a path
1880
[a-z] - Matches a single character from within a group of characters
1881
1882
Ignore patterns may also be Python regular expressions.
1883
Regular expression ignore patterns are identified by a 'RE:' prefix
1884
followed by the regular expression. Regular expression ignore patterns
1885
may not include named or numbered groups.
1886
1887
Note: ignore patterns containing shell wildcards must be quoted from
1888
the shell on Unix.
1889
1890
:Examples:
1891
Ignore the top level Makefile::
1892
1893
bzr ignore ./Makefile
1894
1895
Ignore class files in all directories::
1896
1897
bzr ignore '*.class'
1898
1899
Ignore .o files under the lib directory::
1900
1901
bzr ignore 'lib/**/*.o'
1902
1903
Ignore .o files under the lib directory::
1904
1905
bzr ignore 'RE:lib/.*\.o'
1906
"""
1907
1908
_see_also = ['status', 'ignored']
1909
takes_args = ['name_pattern*']
1910
takes_options = [
1911
Option('old-default-rules',
1912
help='Write out the ignore rules bzr < 0.9 always used.')
1913
]
1914
1915
def run(self, name_pattern_list=None, old_default_rules=None):
1916
from bzrlib.atomicfile import AtomicFile
1917
if old_default_rules is not None:
1918
# dump the rules and exit
1919
for pattern in ignores.OLD_DEFAULTS:
1920
print pattern
1921
return
1922
if not name_pattern_list:
1923
raise errors.BzrCommandError("ignore requires at least one "
1924
"NAME_PATTERN or --old-default-rules")
1925
name_pattern_list = [globbing.normalize_pattern(p)
1926
for p in name_pattern_list]
1927
for name_pattern in name_pattern_list:
1928
if (name_pattern[0] == '/' or
1929
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1930
raise errors.BzrCommandError(
1931
"NAME_PATTERN should not be an absolute path")
1932
tree, relpath = WorkingTree.open_containing(u'.')
1933
ifn = tree.abspath('.bzrignore')
1934
if os.path.exists(ifn):
1935
f = open(ifn, 'rt')
1936
try:
1937
igns = f.read().decode('utf-8')
1938
finally:
1939
f.close()
1940
else:
1941
igns = ''
1942
1943
# TODO: If the file already uses crlf-style termination, maybe
1944
# we should use that for the newly added lines?
1945
1946
if igns and igns[-1] != '\n':
1947
igns += '\n'
1948
for name_pattern in name_pattern_list:
1949
igns += name_pattern + '\n'
1950
1951
f = AtomicFile(ifn, 'wb')
1952
try:
1953
f.write(igns.encode('utf-8'))
1954
f.commit()
1955
finally:
1956
f.close()
1957
1958
if not tree.path2id('.bzrignore'):
1959
tree.add(['.bzrignore'])
1960
1961
1962
class cmd_ignored(Command):
1963
"""List ignored files and the patterns that matched them.
1964
"""
1965
1966
_see_also = ['ignore']
1967
@display_command
1968
def run(self):
1969
tree = WorkingTree.open_containing(u'.')[0]
1970
tree.lock_read()
1971
try:
1972
for path, file_class, kind, file_id, entry in tree.list_files():
1973
if file_class != 'I':
1974
continue
1975
## XXX: Slightly inefficient since this was already calculated
1976
pat = tree.is_ignored(path)
1977
print '%-50s %s' % (path, pat)
1978
finally:
1979
tree.unlock()
1980
1981
1982
class cmd_lookup_revision(Command):
1983
"""Lookup the revision-id from a revision-number
1984
1985
:Examples:
1986
bzr lookup-revision 33
1987
"""
1988
hidden = True
1989
takes_args = ['revno']
1990
1991
@display_command
1992
def run(self, revno):
1993
try:
1994
revno = int(revno)
1995
except ValueError:
1996
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1997
1998
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1999
2000
2001
class cmd_export(Command):
2002
"""Export current or past revision to a destination directory or archive.
2003
2004
If no revision is specified this exports the last committed revision.
2005
2006
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2007
given, try to find the format with the extension. If no extension
2008
is found exports to a directory (equivalent to --format=dir).
2009
2010
If root is supplied, it will be used as the root directory inside
2011
container formats (tar, zip, etc). If it is not supplied it will default
2012
to the exported filename. The root option has no effect for 'dir' format.
2013
2014
If branch is omitted then the branch containing the current working
2015
directory will be used.
2016
2017
Note: Export of tree with non-ASCII filenames to zip is not supported.
2018
2019
================= =========================
2020
Supported formats Autodetected by extension
2021
================= =========================
2022
dir (none)
2023
tar .tar
2024
tbz2 .tar.bz2, .tbz2
2025
tgz .tar.gz, .tgz
2026
zip .zip
2027
================= =========================
2028
"""
2029
takes_args = ['dest', 'branch?']
2030
takes_options = [
2031
Option('format',
2032
help="Type of file to export to.",
2033
type=unicode),
2034
'revision',
2035
Option('root',
2036
type=str,
2037
help="Name of the root directory inside the exported file."),
2038
]
2039
def run(self, dest, branch=None, revision=None, format=None, root=None):
2040
from bzrlib.export import export
2041
2042
if branch is None:
2043
tree = WorkingTree.open_containing(u'.')[0]
2044
b = tree.branch
2045
else:
2046
b = Branch.open(branch)
2047
2048
if revision is None:
2049
# should be tree.last_revision FIXME
2050
rev_id = b.last_revision()
2051
else:
2052
if len(revision) != 1:
2053
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2054
rev_id = revision[0].in_history(b).rev_id
2055
t = b.repository.revision_tree(rev_id)
2056
try:
2057
export(t, dest, format, root)
2058
except errors.NoSuchExportFormat, e:
2059
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2060
2061
2062
class cmd_cat(Command):
2063
"""Write the contents of a file as of a given revision to standard output.
2064
2065
If no revision is nominated, the last revision is used.
2066
2067
Note: Take care to redirect standard output when using this command on a
2068
binary file.
2069
"""
2070
2071
_see_also = ['ls']
2072
takes_options = [
2073
Option('name-from-revision', help='The path name in the old tree.'),
2074
'revision',
2075
]
2076
takes_args = ['filename']
2077
encoding_type = 'exact'
2078
2079
@display_command
2080
def run(self, filename, revision=None, name_from_revision=False):
2081
if revision is not None and len(revision) != 1:
2082
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2083
" one number")
2084
2085
tree = None
2086
try:
2087
tree, b, relpath = \
2088
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2089
except errors.NotBranchError:
2090
pass
2091
2092
if revision is not None and revision[0].get_branch() is not None:
2093
b = Branch.open(revision[0].get_branch())
2094
if tree is None:
2095
tree = b.basis_tree()
2096
if revision is None:
2097
revision_id = b.last_revision()
2098
else:
2099
revision_id = revision[0].in_history(b).rev_id
2100
2101
cur_file_id = tree.path2id(relpath)
2102
rev_tree = b.repository.revision_tree(revision_id)
2103
old_file_id = rev_tree.path2id(relpath)
2104
2105
if name_from_revision:
2106
if old_file_id is None:
2107
raise errors.BzrCommandError("%r is not present in revision %s"
2108
% (filename, revision_id))
2109
else:
2110
rev_tree.print_file(old_file_id)
2111
elif cur_file_id is not None:
2112
rev_tree.print_file(cur_file_id)
2113
elif old_file_id is not None:
2114
rev_tree.print_file(old_file_id)
2115
else:
2116
raise errors.BzrCommandError("%r is not present in revision %s" %
2117
(filename, revision_id))
2118
2119
2120
class cmd_local_time_offset(Command):
2121
"""Show the offset in seconds from GMT to local time."""
2122
hidden = True
2123
@display_command
2124
def run(self):
2125
print osutils.local_time_offset()
2126
2127
2128
2129
class cmd_commit(Command):
2130
"""Commit changes into a new revision.
2131
2132
If no arguments are given, the entire tree is committed.
2133
2134
If selected files are specified, only changes to those files are
2135
committed. If a directory is specified then the directory and everything
2136
within it is committed.
2137
2138
If author of the change is not the same person as the committer, you can
2139
specify the author's name using the --author option. The name should be
2140
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2141
2142
A selected-file commit may fail in some cases where the committed
2143
tree would be invalid. Consider::
2144
2145
bzr init foo
2146
mkdir foo/bar
2147
bzr add foo/bar
2148
bzr commit foo -m "committing foo"
2149
bzr mv foo/bar foo/baz
2150
mkdir foo/bar
2151
bzr add foo/bar
2152
bzr commit foo/bar -m "committing bar but not baz"
2153
2154
In the example above, the last commit will fail by design. This gives
2155
the user the opportunity to decide whether they want to commit the
2156
rename at the same time, separately first, or not at all. (As a general
2157
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2158
2159
Note: A selected-file commit after a merge is not yet supported.
2160
"""
2161
# TODO: Run hooks on tree to-be-committed, and after commit.
2162
2163
# TODO: Strict commit that fails if there are deleted files.
2164
# (what does "deleted files" mean ??)
2165
2166
# TODO: Give better message for -s, --summary, used by tla people
2167
2168
# XXX: verbose currently does nothing
2169
2170
_see_also = ['bugs', 'uncommit']
2171
takes_args = ['selected*']
2172
takes_options = [
2173
Option('message', type=unicode,
2174
short_name='m',
2175
help="Description of the new revision."),
2176
'verbose',
2177
Option('unchanged',
2178
help='Commit even if nothing has changed.'),
2179
Option('file', type=str,
2180
short_name='F',
2181
argname='msgfile',
2182
help='Take commit message from this file.'),
2183
Option('strict',
2184
help="Refuse to commit if there are unknown "
2185
"files in the working tree."),
2186
ListOption('fixes', type=str,
2187
help="Mark a bug as being fixed by this revision."),
2188
Option('author', type=str,
2189
help="Set the author's name, if it's different "
2190
"from the committer."),
2191
Option('local',
2192
help="Perform a local commit in a bound "
2193
"branch. Local commits are not pushed to "
2194
"the master branch until a normal commit "
2195
"is performed."
2196
),
2197
]
2198
aliases = ['ci', 'checkin']
2199
2200
def _get_bug_fix_properties(self, fixes, branch):
2201
properties = []
2202
# Configure the properties for bug fixing attributes.
2203
for fixed_bug in fixes:
2204
tokens = fixed_bug.split(':')
2205
if len(tokens) != 2:
2206
raise errors.BzrCommandError(
2207
"Invalid bug %s. Must be in the form of 'tag:id'. "
2208
"Commit refused." % fixed_bug)
2209
tag, bug_id = tokens
2210
try:
2211
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2212
except errors.UnknownBugTrackerAbbreviation:
2213
raise errors.BzrCommandError(
2214
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2215
except errors.MalformedBugIdentifier:
2216
raise errors.BzrCommandError(
2217
"Invalid bug identifier for %s. Commit refused."
2218
% fixed_bug)
2219
properties.append('%s fixed' % bug_url)
2220
return '\n'.join(properties)
2221
2222
def run(self, message=None, file=None, verbose=True, selected_list=None,
2223
unchanged=False, strict=False, local=False, fixes=None,
2224
author=None):
2225
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2226
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2227
StrictCommitFailed)
2228
from bzrlib.msgeditor import edit_commit_message, \
2229
make_commit_message_template
2230
2231
# TODO: Need a blackbox test for invoking the external editor; may be
2232
# slightly problematic to run this cross-platform.
2233
2234
# TODO: do more checks that the commit will succeed before
2235
# spending the user's valuable time typing a commit message.
2236
2237
properties = {}
2238
2239
tree, selected_list = tree_files(selected_list)
2240
if selected_list == ['']:
2241
# workaround - commit of root of tree should be exactly the same
2242
# as just default commit in that tree, and succeed even though
2243
# selected-file merge commit is not done yet
2244
selected_list = []
2245
2246
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2247
if bug_property:
2248
properties['bugs'] = bug_property
2249
2250
if local and not tree.branch.get_bound_location():
2251
raise errors.LocalRequiresBoundBranch()
2252
2253
def get_message(commit_obj):
2254
"""Callback to get commit message"""
2255
my_message = message
2256
if my_message is None and not file:
2257
template = make_commit_message_template(tree, selected_list)
2258
my_message = edit_commit_message(template)
2259
if my_message is None:
2260
raise errors.BzrCommandError("please specify a commit"
2261
" message with either --message or --file")
2262
elif my_message and file:
2263
raise errors.BzrCommandError(
2264
"please specify either --message or --file")
2265
if file:
2266
my_message = codecs.open(file, 'rt',
2267
bzrlib.user_encoding).read()
2268
if my_message == "":
2269
raise errors.BzrCommandError("empty commit message specified")
2270
return my_message
2271
2272
if verbose:
2273
reporter = ReportCommitToLog()
2274
else:
2275
reporter = NullCommitReporter()
2276
2277
try:
2278
tree.commit(message_callback=get_message,
2279
specific_files=selected_list,
2280
allow_pointless=unchanged, strict=strict, local=local,
2281
reporter=reporter, revprops=properties,
2282
author=author)
2283
except PointlessCommit:
2284
# FIXME: This should really happen before the file is read in;
2285
# perhaps prepare the commit; get the message; then actually commit
2286
raise errors.BzrCommandError("no changes to commit."
2287
" use --unchanged to commit anyhow")
2288
except ConflictsInTree:
2289
raise errors.BzrCommandError('Conflicts detected in working '
2290
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2291
' resolve.')
2292
except StrictCommitFailed:
2293
raise errors.BzrCommandError("Commit refused because there are"
2294
" unknown files in the working tree.")
2295
except errors.BoundBranchOutOfDate, e:
2296
raise errors.BzrCommandError(str(e) + "\n"
2297
'To commit to master branch, run update and then commit.\n'
2298
'You can also pass --local to commit to continue working '
2299
'disconnected.')
2300
2301
2302
class cmd_check(Command):
2303
"""Validate consistency of branch history.
2304
2305
This command checks various invariants about the branch storage to
2306
detect data corruption or bzr bugs.
2307
"""
2308
2309
_see_also = ['reconcile']
2310
takes_args = ['branch?']
2311
takes_options = ['verbose']
2312
2313
def run(self, branch=None, verbose=False):
2314
from bzrlib.check import check
2315
if branch is None:
2316
tree = WorkingTree.open_containing()[0]
2317
branch = tree.branch
2318
else:
2319
branch = Branch.open(branch)
2320
check(branch, verbose)
2321
2322
2323
class cmd_upgrade(Command):
2324
"""Upgrade branch storage to current format.
2325
2326
The check command or bzr developers may sometimes advise you to run
2327
this command. When the default format has changed you may also be warned
2328
during other operations to upgrade.
2329
"""
2330
2331
_see_also = ['check']
2332
takes_args = ['url?']
2333
takes_options = [
2334
RegistryOption('format',
2335
help='Upgrade to a specific format. See "bzr help'
2336
' formats" for details.',
2337
registry=bzrdir.format_registry,
2338
converter=bzrdir.format_registry.make_bzrdir,
2339
value_switches=True, title='Branch format'),
2340
]
2341
2342
def run(self, url='.', format=None):
2343
from bzrlib.upgrade import upgrade
2344
if format is None:
2345
format = bzrdir.format_registry.make_bzrdir('default')
2346
upgrade(url, format)
2347
2348
2349
class cmd_whoami(Command):
2350
"""Show or set bzr user id.
2351
2352
:Examples:
2353
Show the email of the current user::
2354
2355
bzr whoami --email
2356
2357
Set the current user::
2358
2359
bzr whoami 'Frank Chu <fchu@example.com>'
2360
"""
2361
takes_options = [ Option('email',
2362
help='Display email address only.'),
2363
Option('branch',
2364
help='Set identity for the current branch instead of '
2365
'globally.'),
2366
]
2367
takes_args = ['name?']
2368
encoding_type = 'replace'
2369
2370
@display_command
2371
def run(self, email=False, branch=False, name=None):
2372
if name is None:
2373
# use branch if we're inside one; otherwise global config
2374
try:
2375
c = Branch.open_containing('.')[0].get_config()
2376
except errors.NotBranchError:
2377
c = config.GlobalConfig()
2378
if email:
2379
self.outf.write(c.user_email() + '\n')
2380
else:
2381
self.outf.write(c.username() + '\n')
2382
return
2383
2384
# display a warning if an email address isn't included in the given name.
2385
try:
2386
config.extract_email_address(name)
2387
except errors.NoEmailInUsername, e:
2388
warning('"%s" does not seem to contain an email address. '
2389
'This is allowed, but not recommended.', name)
2390
2391
# use global config unless --branch given
2392
if branch:
2393
c = Branch.open_containing('.')[0].get_config()
2394
else:
2395
c = config.GlobalConfig()
2396
c.set_user_option('email', name)
2397
2398
2399
class cmd_nick(Command):
2400
"""Print or set the branch nickname.
2401
2402
If unset, the tree root directory name is used as the nickname
2403
To print the current nickname, execute with no argument.
2404
"""
2405
2406
_see_also = ['info']
2407
takes_args = ['nickname?']
2408
def run(self, nickname=None):
2409
branch = Branch.open_containing(u'.')[0]
2410
if nickname is None:
2411
self.printme(branch)
2412
else:
2413
branch.nick = nickname
2414
2415
@display_command
2416
def printme(self, branch):
2417
print branch.nick
2418
2419
2420
class cmd_selftest(Command):
2421
"""Run internal test suite.
2422
2423
If arguments are given, they are regular expressions that say which tests
2424
should run. Tests matching any expression are run, and other tests are
2425
not run.
2426
2427
Alternatively if --first is given, matching tests are run first and then
2428
all other tests are run. This is useful if you have been working in a
2429
particular area, but want to make sure nothing else was broken.
2430
2431
If --exclude is given, tests that match that regular expression are
2432
excluded, regardless of whether they match --first or not.
2433
2434
To help catch accidential dependencies between tests, the --randomize
2435
option is useful. In most cases, the argument used is the word 'now'.
2436
Note that the seed used for the random number generator is displayed
2437
when this option is used. The seed can be explicitly passed as the
2438
argument to this option if required. This enables reproduction of the
2439
actual ordering used if and when an order sensitive problem is encountered.
2440
2441
If --list-only is given, the tests that would be run are listed. This is
2442
useful when combined with --first, --exclude and/or --randomize to
2443
understand their impact. The test harness reports "Listed nn tests in ..."
2444
instead of "Ran nn tests in ..." when list mode is enabled.
2445
2446
If the global option '--no-plugins' is given, plugins are not loaded
2447
before running the selftests. This has two effects: features provided or
2448
modified by plugins will not be tested, and tests provided by plugins will
2449
not be run.
2450
2451
Tests that need working space on disk use a common temporary directory,
2452
typically inside $TMPDIR or /tmp.
2453
2454
:Examples:
2455
Run only tests relating to 'ignore'::
2456
2457
bzr selftest ignore
2458
2459
Disable plugins and list tests as they're run::
2460
2461
bzr --no-plugins selftest -v
2462
"""
2463
# NB: this is used from the class without creating an instance, which is
2464
# why it does not have a self parameter.
2465
def get_transport_type(typestring):
2466
"""Parse and return a transport specifier."""
2467
if typestring == "sftp":
2468
from bzrlib.transport.sftp import SFTPAbsoluteServer
2469
return SFTPAbsoluteServer
2470
if typestring == "memory":
2471
from bzrlib.transport.memory import MemoryServer
2472
return MemoryServer
2473
if typestring == "fakenfs":
2474
from bzrlib.transport.fakenfs import FakeNFSServer
2475
return FakeNFSServer
2476
msg = "No known transport type %s. Supported types are: sftp\n" %\
2477
(typestring)
2478
raise errors.BzrCommandError(msg)
2479
2480
hidden = True
2481
takes_args = ['testspecs*']
2482
takes_options = ['verbose',
2483
Option('one',
2484
help='Stop when one test fails.',
2485
short_name='1',
2486
),
2487
Option('transport',
2488
help='Use a different transport by default '
2489
'throughout the test suite.',
2490
type=get_transport_type),
2491
Option('benchmark',
2492
help='Run the benchmarks rather than selftests.'),
2493
Option('lsprof-timed',
2494
help='Generate lsprof output for benchmarked'
2495
' sections of code.'),
2496
Option('cache-dir', type=str,
2497
help='Cache intermediate benchmark output in this '
2498
'directory.'),
2499
Option('first',
2500
help='Run all tests, but run specified tests first.',
2501
short_name='f',
2502
),
2503
Option('list-only',
2504
help='List the tests instead of running them.'),
2505
Option('randomize', type=str, argname="SEED",
2506
help='Randomize the order of tests using the given'
2507
' seed or "now" for the current time.'),
2508
Option('exclude', type=str, argname="PATTERN",
2509
short_name='x',
2510
help='Exclude tests that match this regular'
2511
' expression.'),
2512
Option('strict', help='Fail on missing dependencies or '
2513
'known failures.'),
2514
]
2515
encoding_type = 'replace'
2516
2517
def run(self, testspecs_list=None, verbose=None, one=False,
2518
transport=None, benchmark=None,
2519
lsprof_timed=None, cache_dir=None,
2520
first=False, list_only=False,
2521
randomize=None, exclude=None, strict=False):
2522
import bzrlib.ui
2523
from bzrlib.tests import selftest
2524
import bzrlib.benchmarks as benchmarks
2525
from bzrlib.benchmarks import tree_creator
2526
from bzrlib.version import show_version
2527
2528
if cache_dir is not None:
2529
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2530
if not list_only:
2531
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2532
print ' %s (%s python%s)' % (
2533
bzrlib.__path__[0],
2534
bzrlib.version_string,
2535
'.'.join(map(str, sys.version_info)),
2536
)
2537
print
2538
if testspecs_list is not None:
2539
pattern = '|'.join(testspecs_list)
2540
else:
2541
pattern = ".*"
2542
if benchmark:
2543
test_suite_factory = benchmarks.test_suite
2544
if verbose is None:
2545
verbose = True
2546
# TODO: should possibly lock the history file...
2547
benchfile = open(".perf_history", "at", buffering=1)
2548
else:
2549
test_suite_factory = None
2550
if verbose is None:
2551
verbose = False
2552
benchfile = None
2553
try:
2554
result = selftest(verbose=verbose,
2555
pattern=pattern,
2556
stop_on_failure=one,
2557
transport=transport,
2558
test_suite_factory=test_suite_factory,
2559
lsprof_timed=lsprof_timed,
2560
bench_history=benchfile,
2561
matching_tests_first=first,
2562
list_only=list_only,
2563
random_seed=randomize,
2564
exclude_pattern=exclude,
2565
strict=strict,
2566
)
2567
finally:
2568
if benchfile is not None:
2569
benchfile.close()
2570
if result:
2571
info('tests passed')
2572
else:
2573
info('tests failed')
2574
return int(not result)
2575
2576
2577
class cmd_version(Command):
2578
"""Show version of bzr."""
2579
2580
@display_command
2581
def run(self):
2582
from bzrlib.version import show_version
2583
show_version()
2584
2585
2586
class cmd_rocks(Command):
2587
"""Statement of optimism."""
2588
2589
hidden = True
2590
2591
@display_command
2592
def run(self):
2593
print "It sure does!"
2594
2595
2596
class cmd_find_merge_base(Command):
2597
"""Find and print a base revision for merging two branches."""
2598
# TODO: Options to specify revisions on either side, as if
2599
# merging only part of the history.
2600
takes_args = ['branch', 'other']
2601
hidden = True
2602
2603
@display_command
2604
def run(self, branch, other):
2605
from bzrlib.revision import ensure_null, MultipleRevisionSources
2606
2607
branch1 = Branch.open_containing(branch)[0]
2608
branch2 = Branch.open_containing(other)[0]
2609
2610
last1 = ensure_null(branch1.last_revision())
2611
last2 = ensure_null(branch2.last_revision())
2612
2613
graph = branch1.repository.get_graph(branch2.repository)
2614
base_rev_id = graph.find_unique_lca(last1, last2)
2615
2616
print 'merge base is revision %s' % base_rev_id
2617
2618
2619
class cmd_merge(Command):
2620
"""Perform a three-way merge.
2621
2622
The branch is the branch you will merge from. By default, it will merge
2623
the latest revision. If you specify a revision, that revision will be
2624
merged. If you specify two revisions, the first will be used as a BASE,
2625
and the second one as OTHER. Revision numbers are always relative to the
2626
specified branch.
2627
2628
By default, bzr will try to merge in all new work from the other
2629
branch, automatically determining an appropriate base. If this
2630
fails, you may need to give an explicit base.
2631
2632
Merge will do its best to combine the changes in two branches, but there
2633
are some kinds of problems only a human can fix. When it encounters those,
2634
it will mark a conflict. A conflict means that you need to fix something,
2635
before you should commit.
2636
2637
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2638
2639
If there is no default branch set, the first merge will set it. After
2640
that, you can omit the branch to use the default. To change the
2641
default, use --remember. The value will only be saved if the remote
2642
location can be accessed.
2643
2644
The results of the merge are placed into the destination working
2645
directory, where they can be reviewed (with bzr diff), tested, and then
2646
committed to record the result of the merge.
2647
2648
merge refuses to run if there are any uncommitted changes, unless
2649
--force is given.
2650
2651
:Examples:
2652
To merge the latest revision from bzr.dev::
2653
2654
bzr merge ../bzr.dev
2655
2656
To merge changes up to and including revision 82 from bzr.dev::
2657
2658
bzr merge -r 82 ../bzr.dev
2659
2660
To merge the changes introduced by 82, without previous changes::
2661
2662
bzr merge -r 81..82 ../bzr.dev
2663
"""
2664
2665
_see_also = ['update', 'remerge', 'status-flags']
2666
takes_args = ['branch?']
2667
takes_options = [
2668
'revision',
2669
Option('force',
2670
help='Merge even if the destination tree has uncommitted changes.'),
2671
'merge-type',
2672
'reprocess',
2673
'remember',
2674
Option('show-base', help="Show base revision text in "
2675
"conflicts."),
2676
Option('uncommitted', help='Apply uncommitted changes'
2677
' from a working copy, instead of branch changes.'),
2678
Option('pull', help='If the destination is already'
2679
' completely merged into the source, pull from the'
2680
' source rather than merging. When this happens,'
2681
' you do not need to commit the result.'),
2682
Option('directory',
2683
help='Branch to merge into, '
2684
'rather than the one containing the working directory.',
2685
short_name='d',
2686
type=unicode,
2687
),
2688
]
2689
2690
def run(self, branch=None, revision=None, force=False, merge_type=None,
2691
show_base=False, reprocess=False, remember=False,
2692
uncommitted=False, pull=False,
2693
directory=None,
2694
):
2695
from bzrlib.tag import _merge_tags_if_possible
2696
# This is actually a branch (or merge-directive) *location*.
2697
location = branch
2698
del branch
2699
2700
if merge_type is None:
2701
merge_type = _mod_merge.Merge3Merger
2702
2703
if directory is None: directory = u'.'
2704
possible_transports = []
2705
merger = None
2706
allow_pending = True
2707
verified = 'inapplicable'
2708
tree = WorkingTree.open_containing(directory)[0]
2709
change_reporter = delta._ChangeReporter(
2710
unversioned_filter=tree.is_ignored)
2711
cleanups = []
2712
try:
2713
pb = ui.ui_factory.nested_progress_bar()
2714
cleanups.append(pb.finished)
2715
tree.lock_write()
2716
cleanups.append(tree.unlock)
2717
if location is not None:
2718
mergeable, other_transport = _get_mergeable_helper(location)
2719
if mergeable:
2720
if uncommitted:
2721
raise errors.BzrCommandError('Cannot use --uncommitted'
2722
' with bundles or merge directives.')
2723
2724
if revision is not None:
2725
raise errors.BzrCommandError(
2726
'Cannot use -r with merge directives or bundles')
2727
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2728
mergeable, pb)
2729
possible_transports.append(other_transport)
2730
2731
if merger is None and uncommitted:
2732
if revision is not None and len(revision) > 0:
2733
raise errors.BzrCommandError('Cannot use --uncommitted and'
2734
' --revision at the same time.')
2735
location = self._select_branch_location(tree, location)[0]
2736
other_tree, other_path = WorkingTree.open_containing(location)
2737
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2738
pb)
2739
allow_pending = False
2740
2741
if merger is None:
2742
merger, allow_pending = self._get_merger_from_branch(tree,
2743
location, revision, remember, possible_transports, pb)
2744
2745
merger.merge_type = merge_type
2746
merger.reprocess = reprocess
2747
merger.show_base = show_base
2748
merger.change_reporter = change_reporter
2749
self.sanity_check_merger(merger)
2750
if (merger.base_rev_id == merger.other_rev_id and
2751
merger.other_rev_id != None):
2752
note('Nothing to do.')
2753
return 0
2754
if pull:
2755
if merger.interesting_files is not None:
2756
raise BzrCommandError('Cannot pull individual files')
2757
if (merger.base_rev_id == tree.last_revision()):
2758
result = tree.pull(merger.other_branch, False,
2759
merger.other_rev_id)
2760
result.report(self.outf)
2761
return 0
2762
merger.check_basis(not force)
2763
conflict_count = merger.do_merge()
2764
if allow_pending:
2765
merger.set_pending()
2766
if verified == 'failed':
2767
warning('Preview patch does not match changes')
2768
if conflict_count != 0:
2769
return 1
2770
else:
2771
return 0
2772
finally:
2773
for cleanup in reversed(cleanups):
2774
cleanup()
2775
2776
def sanity_check_merger(self, merger):
2777
if (merger.show_base and
2778
not merger.merge_type is _mod_merge.Merge3Merger):
2779
raise errors.BzrCommandError("Show-base is not supported for this"
2780
" merge type. %s" % merger.merge_type)
2781
if merger.reprocess and not merger.merge_type.supports_reprocess:
2782
raise errors.BzrCommandError("Conflict reduction is not supported"
2783
" for merge type %s." %
2784
merger.merge_type)
2785
if merger.reprocess and merger.show_base:
2786
raise errors.BzrCommandError("Cannot do conflict reduction and"
2787
" show base.")
2788
2789
def _get_merger_from_branch(self, tree, location, revision, remember,
2790
possible_transports, pb):
2791
"""Produce a merger from a location, assuming it refers to a branch."""
2792
from bzrlib.tag import _merge_tags_if_possible
2793
assert revision is None or len(revision) < 3
2794
# find the branch locations
2795
other_loc, location = self._select_branch_location(tree, location,
2796
revision, -1)
2797
if revision is not None and len(revision) == 2:
2798
base_loc, location = self._select_branch_location(tree, location,
2799
revision, 0)
2800
else:
2801
base_loc = other_loc
2802
# Open the branches
2803
other_branch, other_path = Branch.open_containing(other_loc,
2804
possible_transports)
2805
if base_loc == other_loc:
2806
base_branch = other_branch
2807
else:
2808
base_branch, base_path = Branch.open_containing(base_loc,
2809
possible_transports)
2810
# Find the revision ids
2811
if revision is None or len(revision) < 1 or revision[-1] is None:
2812
other_revision_id = _mod_revision.ensure_null(
2813
other_branch.last_revision())
2814
else:
2815
other_revision_id = \
2816
_mod_revision.ensure_null(
2817
revision[-1].in_history(other_branch).rev_id)
2818
if (revision is not None and len(revision) == 2
2819
and revision[0] is not None):
2820
base_revision_id = \
2821
_mod_revision.ensure_null(
2822
revision[0].in_history(base_branch).rev_id)
2823
else:
2824
base_revision_id = None
2825
# Remember where we merge from
2826
if ((tree.branch.get_parent() is None or remember) and
2827
other_branch is not None):
2828
tree.branch.set_parent(other_branch.base)
2829
_merge_tags_if_possible(other_branch, tree.branch)
2830
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2831
other_revision_id, base_revision_id, other_branch, base_branch)
2832
if other_path != '':
2833
allow_pending = False
2834
merger.interesting_files = [other_path]
2835
else:
2836
allow_pending = True
2837
return merger, allow_pending
2838
2839
def _select_branch_location(self, tree, location, revision=None,
2840
index=None):
2841
"""Select a branch location, according to possible inputs.
2842
2843
If provided, branches from ``revision`` are preferred. (Both
2844
``revision`` and ``index`` must be supplied.)
2845
2846
Otherwise, the ``location`` parameter is used. If it is None, then the
2847
``parent`` location is used, and a note is printed.
2848
2849
:param tree: The working tree to select a branch for merging into
2850
:param location: The location entered by the user
2851
:param revision: The revision parameter to the command
2852
:param index: The index to use for the revision parameter. Negative
2853
indices are permitted.
2854
:return: (selected_location, default_location). The default location
2855
will be the user-entered location, if any, or else the remembered
2856
location.
2857
"""
2858
if (revision is not None and index is not None
2859
and revision[index] is not None):
2860
branch = revision[index].get_branch()
2861
if branch is not None:
2862
return branch, location
2863
location = self._get_remembered_parent(tree, location, 'Merging from')
2864
return location, location
2865
2866
# TODO: move up to common parent; this isn't merge-specific anymore.
2867
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2868
"""Use tree.branch's parent if none was supplied.
2869
2870
Report if the remembered location was used.
2871
"""
2872
if supplied_location is not None:
2873
return supplied_location
2874
stored_location = tree.branch.get_parent()
2875
mutter("%s", stored_location)
2876
if stored_location is None:
2877
raise errors.BzrCommandError("No location specified or remembered")
2878
display_url = urlutils.unescape_for_display(stored_location,
2879
self.outf.encoding)
2880
self.outf.write("%s remembered location %s\n" % (verb_string,
2881
display_url))
2882
return stored_location
2883
2884
2885
class cmd_remerge(Command):
2886
"""Redo a merge.
2887
2888
Use this if you want to try a different merge technique while resolving
2889
conflicts. Some merge techniques are better than others, and remerge
2890
lets you try different ones on different files.
2891
2892
The options for remerge have the same meaning and defaults as the ones for
2893
merge. The difference is that remerge can (only) be run when there is a
2894
pending merge, and it lets you specify particular files.
2895
2896
:Examples:
2897
Re-do the merge of all conflicted files, and show the base text in
2898
conflict regions, in addition to the usual THIS and OTHER texts::
2899
2900
bzr remerge --show-base
2901
2902
Re-do the merge of "foobar", using the weave merge algorithm, with
2903
additional processing to reduce the size of conflict regions::
2904
2905
bzr remerge --merge-type weave --reprocess foobar
2906
"""
2907
takes_args = ['file*']
2908
takes_options = [
2909
'merge-type',
2910
'reprocess',
2911
Option('show-base',
2912
help="Show base revision text in conflicts."),
2913
]
2914
2915
def run(self, file_list=None, merge_type=None, show_base=False,
2916
reprocess=False):
2917
if merge_type is None:
2918
merge_type = _mod_merge.Merge3Merger
2919
tree, file_list = tree_files(file_list)
2920
tree.lock_write()
2921
try:
2922
parents = tree.get_parent_ids()
2923
if len(parents) != 2:
2924
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2925
" merges. Not cherrypicking or"
2926
" multi-merges.")
2927
repository = tree.branch.repository
2928
graph = repository.get_graph()
2929
base_revision = graph.find_unique_lca(parents[0], parents[1])
2930
base_tree = repository.revision_tree(base_revision)
2931
other_tree = repository.revision_tree(parents[1])
2932
interesting_ids = None
2933
new_conflicts = []
2934
conflicts = tree.conflicts()
2935
if file_list is not None:
2936
interesting_ids = set()
2937
for filename in file_list:
2938
file_id = tree.path2id(filename)
2939
if file_id is None:
2940
raise errors.NotVersionedError(filename)
2941
interesting_ids.add(file_id)
2942
if tree.kind(file_id) != "directory":
2943
continue
2944
2945
for name, ie in tree.inventory.iter_entries(file_id):
2946
interesting_ids.add(ie.file_id)
2947
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2948
else:
2949
# Remerge only supports resolving contents conflicts
2950
allowed_conflicts = ('text conflict', 'contents conflict')
2951
restore_files = [c.path for c in conflicts
2952
if c.typestring in allowed_conflicts]
2953
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2954
tree.set_conflicts(ConflictList(new_conflicts))
2955
if file_list is not None:
2956
restore_files = file_list
2957
for filename in restore_files:
2958
try:
2959
restore(tree.abspath(filename))
2960
except errors.NotConflicted:
2961
pass
2962
# Disable pending merges, because the file texts we are remerging
2963
# have not had those merges performed. If we use the wrong parents
2964
# list, we imply that the working tree text has seen and rejected
2965
# all the changes from the other tree, when in fact those changes
2966
# have not yet been seen.
2967
tree.set_parent_ids(parents[:1])
2968
try:
2969
conflicts = _mod_merge.merge_inner(
2970
tree.branch, other_tree, base_tree,
2971
this_tree=tree,
2972
interesting_ids=interesting_ids,
2973
other_rev_id=parents[1],
2974
merge_type=merge_type,
2975
show_base=show_base,
2976
reprocess=reprocess)
2977
finally:
2978
tree.set_parent_ids(parents)
2979
finally:
2980
tree.unlock()
2981
if conflicts > 0:
2982
return 1
2983
else:
2984
return 0
2985
2986
2987
class cmd_revert(Command):
2988
"""Revert files to a previous revision.
2989
2990
Giving a list of files will revert only those files. Otherwise, all files
2991
will be reverted. If the revision is not specified with '--revision', the
2992
last committed revision is used.
2993
2994
To remove only some changes, without reverting to a prior version, use
2995
merge instead. For example, "merge . --r-2..-3" will remove the changes
2996
introduced by -2, without affecting the changes introduced by -1. Or
2997
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2998
2999
By default, any files that have been manually changed will be backed up
3000
first. (Files changed only by merge are not backed up.) Backup files have
3001
'.~#~' appended to their name, where # is a number.
3002
3003
When you provide files, you can use their current pathname or the pathname
3004
from the target revision. So you can use revert to "undelete" a file by
3005
name. If you name a directory, all the contents of that directory will be
3006
reverted.
3007
"""
3008
3009
_see_also = ['cat', 'export']
3010
takes_options = [
3011
'revision',
3012
Option('no-backup', "Do not save backups of reverted files."),
3013
]
3014
takes_args = ['file*']
3015
3016
def run(self, revision=None, no_backup=False, file_list=None):
3017
if file_list is not None:
3018
if len(file_list) == 0:
3019
raise errors.BzrCommandError("No files specified")
3020
else:
3021
file_list = []
3022
3023
tree, file_list = tree_files(file_list)
3024
if revision is None:
3025
# FIXME should be tree.last_revision
3026
rev_id = tree.last_revision()
3027
elif len(revision) != 1:
3028
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3029
else:
3030
rev_id = revision[0].in_history(tree.branch).rev_id
3031
pb = ui.ui_factory.nested_progress_bar()
3032
try:
3033
tree.revert(file_list,
3034
tree.branch.repository.revision_tree(rev_id),
3035
not no_backup, pb, report_changes=True)
3036
finally:
3037
pb.finished()
3038
3039
3040
class cmd_assert_fail(Command):
3041
"""Test reporting of assertion failures"""
3042
# intended just for use in testing
3043
3044
hidden = True
3045
3046
def run(self):
3047
raise AssertionError("always fails")
3048
3049
3050
class cmd_help(Command):
3051
"""Show help on a command or other topic.
3052
"""
3053
3054
_see_also = ['topics']
3055
takes_options = [
3056
Option('long', 'Show help on all commands.'),
3057
]
3058
takes_args = ['topic?']
3059
aliases = ['?', '--help', '-?', '-h']
3060
3061
@display_command
3062
def run(self, topic=None, long=False):
3063
import bzrlib.help
3064
if topic is None and long:
3065
topic = "commands"
3066
bzrlib.help.help(topic)
3067
3068
3069
class cmd_shell_complete(Command):
3070
"""Show appropriate completions for context.
3071
3072
For a list of all available commands, say 'bzr shell-complete'.
3073
"""
3074
takes_args = ['context?']
3075
aliases = ['s-c']
3076
hidden = True
3077
3078
@display_command
3079
def run(self, context=None):
3080
import shellcomplete
3081
shellcomplete.shellcomplete(context)
3082
3083
3084
class cmd_fetch(Command):
3085
"""Copy in history from another branch but don't merge it.
3086
3087
This is an internal method used for pull and merge.
3088
"""
3089
hidden = True
3090
takes_args = ['from_branch', 'to_branch']
3091
def run(self, from_branch, to_branch):
3092
from bzrlib.fetch import Fetcher
3093
from_b = Branch.open(from_branch)
3094
to_b = Branch.open(to_branch)
3095
Fetcher(to_b, from_b)
3096
3097
3098
class cmd_missing(Command):
3099
"""Show unmerged/unpulled revisions between two branches.
3100
3101
OTHER_BRANCH may be local or remote.
3102
"""
3103
3104
_see_also = ['merge', 'pull']
3105
takes_args = ['other_branch?']
3106
takes_options = [
3107
Option('reverse', 'Reverse the order of revisions.'),
3108
Option('mine-only',
3109
'Display changes in the local branch only.'),
3110
Option('this' , 'Same as --mine-only.'),
3111
Option('theirs-only',
3112
'Display changes in the remote branch only.'),
3113
Option('other', 'Same as --theirs-only.'),
3114
'log-format',
3115
'show-ids',
3116
'verbose'
3117
]
3118
encoding_type = 'replace'
3119
3120
@display_command
3121
def run(self, other_branch=None, reverse=False, mine_only=False,
3122
theirs_only=False, log_format=None, long=False, short=False, line=False,
3123
show_ids=False, verbose=False, this=False, other=False):
3124
from bzrlib.missing import find_unmerged, iter_log_revisions
3125
from bzrlib.log import log_formatter
3126
3127
if this:
3128
mine_only = this
3129
if other:
3130
theirs_only = other
3131
3132
local_branch = Branch.open_containing(u".")[0]
3133
parent = local_branch.get_parent()
3134
if other_branch is None:
3135
other_branch = parent
3136
if other_branch is None:
3137
raise errors.BzrCommandError("No peer location known"
3138
" or specified.")
3139
display_url = urlutils.unescape_for_display(parent,
3140
self.outf.encoding)
3141
self.outf.write("Using last location: " + display_url + "\n")
3142
3143
remote_branch = Branch.open(other_branch)
3144
if remote_branch.base == local_branch.base:
3145
remote_branch = local_branch
3146
local_branch.lock_read()
3147
try:
3148
remote_branch.lock_read()
3149
try:
3150
local_extra, remote_extra = find_unmerged(local_branch,
3151
remote_branch)
3152
if log_format is None:
3153
registry = log.log_formatter_registry
3154
log_format = registry.get_default(local_branch)
3155
lf = log_format(to_file=self.outf,
3156
show_ids=show_ids,
3157
show_timezone='original')
3158
if reverse is False:
3159
local_extra.reverse()
3160
remote_extra.reverse()
3161
if local_extra and not theirs_only:
3162
self.outf.write("You have %d extra revision(s):\n" %
3163
len(local_extra))
3164
for revision in iter_log_revisions(local_extra,
3165
local_branch.repository,
3166
verbose):
3167
lf.log_revision(revision)
3168
printed_local = True
3169
else:
3170
printed_local = False
3171
if remote_extra and not mine_only:
3172
if printed_local is True:
3173
self.outf.write("\n\n\n")
3174
self.outf.write("You are missing %d revision(s):\n" %
3175
len(remote_extra))
3176
for revision in iter_log_revisions(remote_extra,
3177
remote_branch.repository,
3178
verbose):
3179
lf.log_revision(revision)
3180
if not remote_extra and not local_extra:
3181
status_code = 0
3182
self.outf.write("Branches are up to date.\n")
3183
else:
3184
status_code = 1
3185
finally:
3186
remote_branch.unlock()
3187
finally:
3188
local_branch.unlock()
3189
if not status_code and parent is None and other_branch is not None:
3190
local_branch.lock_write()
3191
try:
3192
# handle race conditions - a parent might be set while we run.
3193
if local_branch.get_parent() is None:
3194
local_branch.set_parent(remote_branch.base)
3195
finally:
3196
local_branch.unlock()
3197
return status_code
3198
3199
3200
class cmd_pack(Command):
3201
"""Compress the data within a repository."""
3202
3203
_see_also = ['repositories']
3204
takes_args = ['branch_or_repo?']
3205
3206
def run(self, branch_or_repo='.'):
3207
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3208
try:
3209
branch = dir.open_branch()
3210
repository = branch.repository
3211
except errors.NotBranchError:
3212
repository = dir.open_repository()
3213
repository.pack()
3214
3215
3216
class cmd_plugins(Command):
3217
"""List the installed plugins.
3218
3219
This command displays the list of installed plugins including the
3220
path where each one is located and a short description of each.
3221
3222
A plugin is an external component for Bazaar that extends the
3223
revision control system, by adding or replacing code in Bazaar.
3224
Plugins can do a variety of things, including overriding commands,
3225
adding new commands, providing additional network transports and
3226
customizing log output.
3227
3228
See the Bazaar web site, http://bazaar-vcs.org, for further
3229
information on plugins including where to find them and how to
3230
install them. Instructions are also provided there on how to
3231
write new plugins using the Python programming language.
3232
"""
3233
3234
@display_command
3235
def run(self):
3236
import bzrlib.plugin
3237
from inspect import getdoc
3238
for name, plugin in bzrlib.plugin.plugins().items():
3239
print plugin.path(), "[%s]" % plugin.__version__
3240
d = getdoc(plugin.module)
3241
if d:
3242
print '\t', d.split('\n')[0]
3243
3244
3245
class cmd_testament(Command):
3246
"""Show testament (signing-form) of a revision."""
3247
takes_options = [
3248
'revision',
3249
Option('long', help='Produce long-format testament.'),
3250
Option('strict',
3251
help='Produce a strict-format testament.')]
3252
takes_args = ['branch?']
3253
@display_command
3254
def run(self, branch=u'.', revision=None, long=False, strict=False):
3255
from bzrlib.testament import Testament, StrictTestament
3256
if strict is True:
3257
testament_class = StrictTestament
3258
else:
3259
testament_class = Testament
3260
b = WorkingTree.open_containing(branch)[0].branch
3261
b.lock_read()
3262
try:
3263
if revision is None:
3264
rev_id = b.last_revision()
3265
else:
3266
rev_id = revision[0].in_history(b).rev_id
3267
t = testament_class.from_revision(b.repository, rev_id)
3268
if long:
3269
sys.stdout.writelines(t.as_text_lines())
3270
else:
3271
sys.stdout.write(t.as_short_text())
3272
finally:
3273
b.unlock()
3274
3275
3276
class cmd_annotate(Command):
3277
"""Show the origin of each line in a file.
3278
3279
This prints out the given file with an annotation on the left side
3280
indicating which revision, author and date introduced the change.
3281
3282
If the origin is the same for a run of consecutive lines, it is
3283
shown only at the top, unless the --all option is given.
3284
"""
3285
# TODO: annotate directories; showing when each file was last changed
3286
# TODO: if the working copy is modified, show annotations on that
3287
# with new uncommitted lines marked
3288
aliases = ['ann', 'blame', 'praise']
3289
takes_args = ['filename']
3290
takes_options = [Option('all', help='Show annotations on all lines.'),
3291
Option('long', help='Show commit date in annotations.'),
3292
'revision',
3293
'show-ids',
3294
]
3295
encoding_type = 'exact'
3296
3297
@display_command
3298
def run(self, filename, all=False, long=False, revision=None,
3299
show_ids=False):
3300
from bzrlib.annotate import annotate_file
3301
tree, relpath = WorkingTree.open_containing(filename)
3302
branch = tree.branch
3303
branch.lock_read()
3304
try:
3305
if revision is None:
3306
revision_id = branch.last_revision()
3307
elif len(revision) != 1:
3308
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3309
else:
3310
revision_id = revision[0].in_history(branch).rev_id
3311
file_id = tree.path2id(relpath)
3312
if file_id is None:
3313
raise errors.NotVersionedError(filename)
3314
tree = branch.repository.revision_tree(revision_id)
3315
file_version = tree.inventory[file_id].revision
3316
annotate_file(branch, file_version, file_id, long, all, self.outf,
3317
show_ids=show_ids)
3318
finally:
3319
branch.unlock()
3320
3321
3322
class cmd_re_sign(Command):
3323
"""Create a digital signature for an existing revision."""
3324
# TODO be able to replace existing ones.
3325
3326
hidden = True # is this right ?
3327
takes_args = ['revision_id*']
3328
takes_options = ['revision']
3329
3330
def run(self, revision_id_list=None, revision=None):
3331
import bzrlib.gpg as gpg
3332
if revision_id_list is not None and revision is not None:
3333
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3334
if revision_id_list is None and revision is None:
3335
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3336
b = WorkingTree.open_containing(u'.')[0].branch
3337
gpg_strategy = gpg.GPGStrategy(b.get_config())
3338
if revision_id_list is not None:
3339
for revision_id in revision_id_list:
3340
b.repository.sign_revision(revision_id, gpg_strategy)
3341
elif revision is not None:
3342
if len(revision) == 1:
3343
revno, rev_id = revision[0].in_history(b)
3344
b.repository.sign_revision(rev_id, gpg_strategy)
3345
elif len(revision) == 2:
3346
# are they both on rh- if so we can walk between them
3347
# might be nice to have a range helper for arbitrary
3348
# revision paths. hmm.
3349
from_revno, from_revid = revision[0].in_history(b)
3350
to_revno, to_revid = revision[1].in_history(b)
3351
if to_revid is None:
3352
to_revno = b.revno()
3353
if from_revno is None or to_revno is None:
3354
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3355
for revno in range(from_revno, to_revno + 1):
3356
b.repository.sign_revision(b.get_rev_id(revno),
3357
gpg_strategy)
3358
else:
3359
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3360
3361
3362
class cmd_bind(Command):
3363
"""Convert the current branch into a checkout of the supplied branch.
3364
3365
Once converted into a checkout, commits must succeed on the master branch
3366
before they will be applied to the local branch.
3367
"""
3368
3369
_see_also = ['checkouts', 'unbind']
3370
takes_args = ['location?']
3371
takes_options = []
3372
3373
def run(self, location=None):
3374
b, relpath = Branch.open_containing(u'.')
3375
if location is None:
3376
try:
3377
location = b.get_old_bound_location()
3378
except errors.UpgradeRequired:
3379
raise errors.BzrCommandError('No location supplied. '
3380
'This format does not remember old locations.')
3381
else:
3382
if location is None:
3383
raise errors.BzrCommandError('No location supplied and no '
3384
'previous location known')
3385
b_other = Branch.open(location)
3386
try:
3387
b.bind(b_other)
3388
except errors.DivergedBranches:
3389
raise errors.BzrCommandError('These branches have diverged.'
3390
' Try merging, and then bind again.')
3391
3392
3393
class cmd_unbind(Command):
3394
"""Convert the current checkout into a regular branch.
3395
3396
After unbinding, the local branch is considered independent and subsequent
3397
commits will be local only.
3398
"""
3399
3400
_see_also = ['checkouts', 'bind']
3401
takes_args = []
3402
takes_options = []
3403
3404
def run(self):
3405
b, relpath = Branch.open_containing(u'.')
3406
if not b.unbind():
3407
raise errors.BzrCommandError('Local branch is not bound')
3408
3409
3410
class cmd_uncommit(Command):
3411
"""Remove the last committed revision.
3412
3413
--verbose will print out what is being removed.
3414
--dry-run will go through all the motions, but not actually
3415
remove anything.
3416
3417
If --revision is specified, uncommit revisions to leave the branch at the
3418
specified revision. For example, "bzr uncommit -r 15" will leave the
3419
branch at revision 15.
3420
3421
In the future, uncommit will create a revision bundle, which can then
3422
be re-applied.
3423
"""
3424
3425
# TODO: jam 20060108 Add an option to allow uncommit to remove
3426
# unreferenced information in 'branch-as-repository' branches.
3427
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3428
# information in shared branches as well.
3429
_see_also = ['commit']
3430
takes_options = ['verbose', 'revision',
3431
Option('dry-run', help='Don\'t actually make changes.'),
3432
Option('force', help='Say yes to all questions.')]
3433
takes_args = ['location?']
3434
aliases = []
3435
3436
def run(self, location=None,
3437
dry_run=False, verbose=False,
3438
revision=None, force=False):
3439
from bzrlib.log import log_formatter, show_log
3440
import sys
3441
from bzrlib.uncommit import uncommit
3442
3443
if location is None:
3444
location = u'.'
3445
control, relpath = bzrdir.BzrDir.open_containing(location)
3446
try:
3447
tree = control.open_workingtree()
3448
b = tree.branch
3449
except (errors.NoWorkingTree, errors.NotLocalUrl):
3450
tree = None
3451
b = control.open_branch()
3452
3453
rev_id = None
3454
if revision is None:
3455
revno = b.revno()
3456
else:
3457
# 'bzr uncommit -r 10' actually means uncommit
3458
# so that the final tree is at revno 10.
3459
# but bzrlib.uncommit.uncommit() actually uncommits
3460
# the revisions that are supplied.
3461
# So we need to offset it by one
3462
revno = revision[0].in_history(b).revno+1
3463
3464
if revno <= b.revno():
3465
rev_id = b.get_rev_id(revno)
3466
if rev_id is None:
3467
self.outf.write('No revisions to uncommit.\n')
3468
return 1
3469
3470
lf = log_formatter('short',
3471
to_file=self.outf,
3472
show_timezone='original')
3473
3474
show_log(b,
3475
lf,
3476
verbose=False,
3477
direction='forward',
3478
start_revision=revno,
3479
end_revision=b.revno())
3480
3481
if dry_run:
3482
print 'Dry-run, pretending to remove the above revisions.'
3483
if not force:
3484
val = raw_input('Press <enter> to continue')
3485
else:
3486
print 'The above revision(s) will be removed.'
3487
if not force:
3488
val = raw_input('Are you sure [y/N]? ')
3489
if val.lower() not in ('y', 'yes'):
3490
print 'Canceled'
3491
return 0
3492
3493
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3494
revno=revno)
3495
3496
3497
class cmd_break_lock(Command):
3498
"""Break a dead lock on a repository, branch or working directory.
3499
3500
CAUTION: Locks should only be broken when you are sure that the process
3501
holding the lock has been stopped.
3502
3503
You can get information on what locks are open via the 'bzr info' command.
3504
3505
:Examples:
3506
bzr break-lock
3507
"""
3508
takes_args = ['location?']
3509
3510
def run(self, location=None, show=False):
3511
if location is None:
3512
location = u'.'
3513
control, relpath = bzrdir.BzrDir.open_containing(location)
3514
try:
3515
control.break_lock()
3516
except NotImplementedError:
3517
pass
3518
3519
3520
class cmd_wait_until_signalled(Command):
3521
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3522
3523
This just prints a line to signal when it is ready, then blocks on stdin.
3524
"""
3525
3526
hidden = True
3527
3528
def run(self):
3529
sys.stdout.write("running\n")
3530
sys.stdout.flush()
3531
sys.stdin.readline()
3532
3533
3534
class cmd_serve(Command):
3535
"""Run the bzr server."""
3536
3537
aliases = ['server']
3538
3539
takes_options = [
3540
Option('inet',
3541
help='Serve on stdin/out for use from inetd or sshd.'),
3542
Option('port',
3543
help='Listen for connections on nominated port of the form '
3544
'[hostname:]portnumber. Passing 0 as the port number will '
3545
'result in a dynamically allocated port. The default port is '
3546
'4155.',
3547
type=str),
3548
Option('directory',
3549
help='Serve contents of this directory.',
3550
type=unicode),
3551
Option('allow-writes',
3552
help='By default the server is a readonly server. Supplying '
3553
'--allow-writes enables write access to the contents of '
3554
'the served directory and below.'
3555
),
3556
]
3557
3558
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3559
from bzrlib.smart import medium, server
3560
from bzrlib.transport import get_transport
3561
from bzrlib.transport.chroot import ChrootServer
3562
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3563
if directory is None:
3564
directory = os.getcwd()
3565
url = urlutils.local_path_to_url(directory)
3566
if not allow_writes:
3567
url = 'readonly+' + url
3568
chroot_server = ChrootServer(get_transport(url))
3569
chroot_server.setUp()
3570
t = get_transport(chroot_server.get_url())
3571
if inet:
3572
smart_server = medium.SmartServerPipeStreamMedium(
3573
sys.stdin, sys.stdout, t)
3574
else:
3575
host = BZR_DEFAULT_INTERFACE
3576
if port is None:
3577
port = BZR_DEFAULT_PORT
3578
else:
3579
if ':' in port:
3580
host, port = port.split(':')
3581
port = int(port)
3582
smart_server = server.SmartTCPServer(t, host=host, port=port)
3583
print 'listening on port: ', smart_server.port
3584
sys.stdout.flush()
3585
# for the duration of this server, no UI output is permitted.
3586
# note that this may cause problems with blackbox tests. This should
3587
# be changed with care though, as we dont want to use bandwidth sending
3588
# progress over stderr to smart server clients!
3589
old_factory = ui.ui_factory
3590
try:
3591
ui.ui_factory = ui.SilentUIFactory()
3592
smart_server.serve()
3593
finally:
3594
ui.ui_factory = old_factory
3595
3596
3597
class cmd_join(Command):
3598
"""Combine a subtree into its containing tree.
3599
3600
This command is for experimental use only. It requires the target tree
3601
to be in dirstate-with-subtree format, which cannot be converted into
3602
earlier formats.
3603
3604
The TREE argument should be an independent tree, inside another tree, but
3605
not part of it. (Such trees can be produced by "bzr split", but also by
3606
running "bzr branch" with the target inside a tree.)
3607
3608
The result is a combined tree, with the subtree no longer an independant
3609
part. This is marked as a merge of the subtree into the containing tree,
3610
and all history is preserved.
3611
3612
If --reference is specified, the subtree retains its independence. It can
3613
be branched by itself, and can be part of multiple projects at the same
3614
time. But operations performed in the containing tree, such as commit
3615
and merge, will recurse into the subtree.
3616
"""
3617
3618
_see_also = ['split']
3619
takes_args = ['tree']
3620
takes_options = [
3621
Option('reference', help='Join by reference.'),
3622
]
3623
hidden = True
3624
3625
def run(self, tree, reference=False):
3626
sub_tree = WorkingTree.open(tree)
3627
parent_dir = osutils.dirname(sub_tree.basedir)
3628
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3629
repo = containing_tree.branch.repository
3630
if not repo.supports_rich_root():
3631
raise errors.BzrCommandError(
3632
"Can't join trees because %s doesn't support rich root data.\n"
3633
"You can use bzr upgrade on the repository."
3634
% (repo,))
3635
if reference:
3636
try:
3637
containing_tree.add_reference(sub_tree)
3638
except errors.BadReferenceTarget, e:
3639
# XXX: Would be better to just raise a nicely printable
3640
# exception from the real origin. Also below. mbp 20070306
3641
raise errors.BzrCommandError("Cannot join %s. %s" %
3642
(tree, e.reason))
3643
else:
3644
try:
3645
containing_tree.subsume(sub_tree)
3646
except errors.BadSubsumeSource, e:
3647
raise errors.BzrCommandError("Cannot join %s. %s" %
3648
(tree, e.reason))
3649
3650
3651
class cmd_split(Command):
3652
"""Split a tree into two trees.
3653
3654
This command is for experimental use only. It requires the target tree
3655
to be in dirstate-with-subtree format, which cannot be converted into
3656
earlier formats.
3657
3658
The TREE argument should be a subdirectory of a working tree. That
3659
subdirectory will be converted into an independent tree, with its own
3660
branch. Commits in the top-level tree will not apply to the new subtree.
3661
If you want that behavior, do "bzr join --reference TREE".
3662
"""
3663
3664
_see_also = ['join']
3665
takes_args = ['tree']
3666
3667
hidden = True
3668
3669
def run(self, tree):
3670
containing_tree, subdir = WorkingTree.open_containing(tree)
3671
sub_id = containing_tree.path2id(subdir)
3672
if sub_id is None:
3673
raise errors.NotVersionedError(subdir)
3674
try:
3675
containing_tree.extract(sub_id)
3676
except errors.RootNotRich:
3677
raise errors.UpgradeRequired(containing_tree.branch.base)
3678
3679
3680
3681
class cmd_merge_directive(Command):
3682
"""Generate a merge directive for auto-merge tools.
3683
3684
A directive requests a merge to be performed, and also provides all the
3685
information necessary to do so. This means it must either include a
3686
revision bundle, or the location of a branch containing the desired
3687
revision.
3688
3689
A submit branch (the location to merge into) must be supplied the first
3690
time the command is issued. After it has been supplied once, it will
3691
be remembered as the default.
3692
3693
A public branch is optional if a revision bundle is supplied, but required
3694
if --diff or --plain is specified. It will be remembered as the default
3695
after the first use.
3696
"""
3697
3698
takes_args = ['submit_branch?', 'public_branch?']
3699
3700
hidden = True
3701
3702
_see_also = ['send']
3703
3704
takes_options = [
3705
RegistryOption.from_kwargs('patch-type',
3706
'The type of patch to include in the directive.',
3707
title='Patch type',
3708
value_switches=True,
3709
enum_switch=False,
3710
bundle='Bazaar revision bundle (default).',
3711
diff='Normal unified diff.',
3712
plain='No patch, just directive.'),
3713
Option('sign', help='GPG-sign the directive.'), 'revision',
3714
Option('mail-to', type=str,
3715
help='Instead of printing the directive, email to this address.'),
3716
Option('message', type=str, short_name='m',
3717
help='Message to use when committing this merge.')
3718
]
3719
3720
encoding_type = 'exact'
3721
3722
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3723
sign=False, revision=None, mail_to=None, message=None):
3724
from bzrlib.revision import ensure_null, NULL_REVISION
3725
include_patch, include_bundle = {
3726
'plain': (False, False),
3727
'diff': (True, False),
3728
'bundle': (True, True),
3729
}[patch_type]
3730
branch = Branch.open('.')
3731
stored_submit_branch = branch.get_submit_branch()
3732
if submit_branch is None:
3733
submit_branch = stored_submit_branch
3734
else:
3735
if stored_submit_branch is None:
3736
branch.set_submit_branch(submit_branch)
3737
if submit_branch is None:
3738
submit_branch = branch.get_parent()
3739
if submit_branch is None:
3740
raise errors.BzrCommandError('No submit branch specified or known')
3741
3742
stored_public_branch = branch.get_public_branch()
3743
if public_branch is None:
3744
public_branch = stored_public_branch
3745
elif stored_public_branch is None:
3746
branch.set_public_branch(public_branch)
3747
if not include_bundle and public_branch is None:
3748
raise errors.BzrCommandError('No public branch specified or'
3749
' known')
3750
base_revision_id = None
3751
if revision is not None:
3752
if len(revision) > 2:
3753
raise errors.BzrCommandError('bzr merge-directive takes '
3754
'at most two one revision identifiers')
3755
revision_id = revision[-1].in_history(branch).rev_id
3756
if len(revision) == 2:
3757
base_revision_id = revision[0].in_history(branch).rev_id
3758
base_revision_id = ensure_null(base_revision_id)
3759
else:
3760
revision_id = branch.last_revision()
3761
revision_id = ensure_null(revision_id)
3762
if revision_id == NULL_REVISION:
3763
raise errors.BzrCommandError('No revisions to bundle.')
3764
directive = merge_directive.MergeDirective2.from_objects(
3765
branch.repository, revision_id, time.time(),
3766
osutils.local_time_offset(), submit_branch,
3767
public_branch=public_branch, include_patch=include_patch,
3768
include_bundle=include_bundle, message=message,
3769
base_revision_id=base_revision_id)
3770
if mail_to is None:
3771
if sign:
3772
self.outf.write(directive.to_signed(branch))
3773
else:
3774
self.outf.writelines(directive.to_lines())
3775
else:
3776
message = directive.to_email(mail_to, branch, sign)
3777
s = SMTPConnection(branch.get_config())
3778
s.send_email(message)
3779
3780
3781
class cmd_send(Command):
3782
"""Mail or create a merge-directive for submiting changes.
3783
3784
A merge directive provides many things needed for requesting merges:
3785
3786
* A machine-readable description of the merge to perform
3787
3788
* An optional patch that is a preview of the changes requested
3789
3790
* An optional bundle of revision data, so that the changes can be applied
3791
directly from the merge directive, without retrieving data from a
3792
branch.
3793
3794
If --no-bundle is specified, then public_branch is needed (and must be
3795
up-to-date), so that the receiver can perform the merge using the
3796
public_branch. The public_branch is always included if known, so that
3797
people can check it later.
3798
3799
The submit branch defaults to the parent, but can be overridden. Both
3800
submit branch and public branch will be remembered if supplied.
3801
3802
If a public_branch is known for the submit_branch, that public submit
3803
branch is used in the merge instructions. This means that a local mirror
3804
can be used as your actual submit branch, once you have set public_branch
3805
for that mirror.
3806
3807
Mail is sent using your preferred mail program. This should be transparent
3808
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3809
the preferred client can't be found (or used), your editor will be used.
3810
3811
To use a specific mail program, set the mail_client configuration option.
3812
(For Thunderbird 1.5, this works around some bugs.) Supported values are
3813
"thunderbird", "evolution", "editor", "xdg-email", "mapi", "kmail" and
3814
"default".
3815
3816
If mail is being sent, a to address is required. This can be supplied
3817
either on the commandline, or by setting the submit_to configuration
3818
option.
3819
3820
Two formats are currently supported: "4" uses revision bundle format 4 and
3821
merge directive format 2. It is significantly faster and smaller than
3822
older formats. It is compatible with Bazaar 0.19 and later. It is the
3823
default. "0.9" uses revision bundle format 0.9 and merge directive
3824
format 1. It is compatible with Bazaar 0.12 - 0.18.
3825
"""
3826
3827
encoding_type = 'exact'
3828
3829
_see_also = ['merge', 'doc/configuration.txt']
3830
3831
takes_args = ['submit_branch?', 'public_branch?']
3832
3833
takes_options = [
3834
Option('no-bundle',
3835
help='Do not include a bundle in the merge directive.'),
3836
Option('no-patch', help='Do not include a preview patch in the merge'
3837
' directive.'),
3838
Option('remember',
3839
help='Remember submit and public branch.'),
3840
Option('from',
3841
help='Branch to generate the submission from, '
3842
'rather than the one containing the working directory.',
3843
short_name='f',
3844
type=unicode),
3845
Option('output', short_name='o', help='Write directive to this file.',
3846
type=unicode),
3847
Option('mail-to', help='Mail the request to this address.',
3848
type=unicode),
3849
'revision',
3850
'message',
3851
RegistryOption.from_kwargs('format',
3852
'Use the specified output format.',
3853
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3854
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3855
]
3856
3857
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3858
no_patch=False, revision=None, remember=False, output=None,
3859
format='4', mail_to=None, message=None, **kwargs):
3860
return self._run(submit_branch, revision, public_branch, remember,
3861
format, no_bundle, no_patch, output,
3862
kwargs.get('from', '.'), mail_to, message)
3863
3864
def _run(self, submit_branch, revision, public_branch, remember, format,
3865
no_bundle, no_patch, output, from_, mail_to, message):
3866
from bzrlib.revision import ensure_null, NULL_REVISION
3867
if output is None:
3868
outfile = StringIO()
3869
elif output == '-':
3870
outfile = self.outf
3871
else:
3872
outfile = open(output, 'wb')
3873
try:
3874
branch = Branch.open_containing(from_)[0]
3875
if output is None:
3876
config = branch.get_config()
3877
if mail_to is None:
3878
mail_to = config.get_user_option('submit_to')
3879
if mail_to is None:
3880
raise errors.BzrCommandError('No mail-to address'
3881
' specified')
3882
mail_client = config.get_mail_client()
3883
if remember and submit_branch is None:
3884
raise errors.BzrCommandError(
3885
'--remember requires a branch to be specified.')
3886
stored_submit_branch = branch.get_submit_branch()
3887
remembered_submit_branch = False
3888
if submit_branch is None:
3889
submit_branch = stored_submit_branch
3890
remembered_submit_branch = True
3891
else:
3892
if stored_submit_branch is None or remember:
3893
branch.set_submit_branch(submit_branch)
3894
if submit_branch is None:
3895
submit_branch = branch.get_parent()
3896
remembered_submit_branch = True
3897
if submit_branch is None:
3898
raise errors.BzrCommandError('No submit branch known or'
3899
' specified')
3900
if remembered_submit_branch:
3901
note('Using saved location: %s', submit_branch)
3902
3903
stored_public_branch = branch.get_public_branch()
3904
if public_branch is None:
3905
public_branch = stored_public_branch
3906
elif stored_public_branch is None or remember:
3907
branch.set_public_branch(public_branch)
3908
if no_bundle and public_branch is None:
3909
raise errors.BzrCommandError('No public branch specified or'
3910
' known')
3911
base_revision_id = None
3912
revision_id = None
3913
if revision is not None:
3914
if len(revision) > 2:
3915
raise errors.BzrCommandError('bzr send takes '
3916
'at most two one revision identifiers')
3917
revision_id = revision[-1].in_history(branch).rev_id
3918
if len(revision) == 2:
3919
base_revision_id = revision[0].in_history(branch).rev_id
3920
if revision_id is None:
3921
revision_id = branch.last_revision()
3922
if revision_id == NULL_REVISION:
3923
raise errors.BzrCommandError('No revisions to submit.')
3924
if format == '4':
3925
directive = merge_directive.MergeDirective2.from_objects(
3926
branch.repository, revision_id, time.time(),
3927
osutils.local_time_offset(), submit_branch,
3928
public_branch=public_branch, include_patch=not no_patch,
3929
include_bundle=not no_bundle, message=message,
3930
base_revision_id=base_revision_id)
3931
elif format == '0.9':
3932
if not no_bundle:
3933
if not no_patch:
3934
patch_type = 'bundle'
3935
else:
3936
raise errors.BzrCommandError('Format 0.9 does not'
3937
' permit bundle with no patch')
3938
else:
3939
if not no_patch:
3940
patch_type = 'diff'
3941
else:
3942
patch_type = None
3943
directive = merge_directive.MergeDirective.from_objects(
3944
branch.repository, revision_id, time.time(),
3945
osutils.local_time_offset(), submit_branch,
3946
public_branch=public_branch, patch_type=patch_type,
3947
message=message)
3948
3949
outfile.writelines(directive.to_lines())
3950
if output is None:
3951
subject = '[MERGE] '
3952
if message is not None:
3953
subject += message
3954
else:
3955
revision = branch.repository.get_revision(revision_id)
3956
subject += revision.get_summary()
3957
mail_client.compose_merge_request(mail_to, subject,
3958
outfile.getvalue())
3959
finally:
3960
if output != '-':
3961
outfile.close()
3962
3963
3964
class cmd_bundle_revisions(cmd_send):
3965
3966
"""Create a merge-directive for submiting changes.
3967
3968
A merge directive provides many things needed for requesting merges:
3969
3970
* A machine-readable description of the merge to perform
3971
3972
* An optional patch that is a preview of the changes requested
3973
3974
* An optional bundle of revision data, so that the changes can be applied
3975
directly from the merge directive, without retrieving data from a
3976
branch.
3977
3978
If --no-bundle is specified, then public_branch is needed (and must be
3979
up-to-date), so that the receiver can perform the merge using the
3980
public_branch. The public_branch is always included if known, so that
3981
people can check it later.
3982
3983
The submit branch defaults to the parent, but can be overridden. Both
3984
submit branch and public branch will be remembered if supplied.
3985
3986
If a public_branch is known for the submit_branch, that public submit
3987
branch is used in the merge instructions. This means that a local mirror
3988
can be used as your actual submit branch, once you have set public_branch
3989
for that mirror.
3990
3991
Two formats are currently supported: "4" uses revision bundle format 4 and
3992
merge directive format 2. It is significantly faster and smaller than
3993
older formats. It is compatible with Bazaar 0.19 and later. It is the
3994
default. "0.9" uses revision bundle format 0.9 and merge directive
3995
format 1. It is compatible with Bazaar 0.12 - 0.18.
3996
"""
3997
3998
takes_options = [
3999
Option('no-bundle',
4000
help='Do not include a bundle in the merge directive.'),
4001
Option('no-patch', help='Do not include a preview patch in the merge'
4002
' directive.'),
4003
Option('remember',
4004
help='Remember submit and public branch.'),
4005
Option('from',
4006
help='Branch to generate the submission from, '
4007
'rather than the one containing the working directory.',
4008
short_name='f',
4009
type=unicode),
4010
Option('output', short_name='o', help='Write directive to this file.',
4011
type=unicode),
4012
'revision',
4013
RegistryOption.from_kwargs('format',
4014
'Use the specified output format.',
4015
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4016
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4017
]
4018
aliases = ['bundle']
4019
4020
_see_also = ['send', 'merge']
4021
4022
hidden = True
4023
4024
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4025
no_patch=False, revision=None, remember=False, output=None,
4026
format='4', **kwargs):
4027
if output is None:
4028
output = '-'
4029
return self._run(submit_branch, revision, public_branch, remember,
4030
format, no_bundle, no_patch, output,
4031
kwargs.get('from', '.'), None, None)
4032
4033
4034
class cmd_tag(Command):
4035
"""Create, remove or modify a tag naming a revision.
4036
4037
Tags give human-meaningful names to revisions. Commands that take a -r
4038
(--revision) option can be given -rtag:X, where X is any previously
4039
created tag.
4040
4041
Tags are stored in the branch. Tags are copied from one branch to another
4042
along when you branch, push, pull or merge.
4043
4044
It is an error to give a tag name that already exists unless you pass
4045
--force, in which case the tag is moved to point to the new revision.
4046
"""
4047
4048
_see_also = ['commit', 'tags']
4049
takes_args = ['tag_name']
4050
takes_options = [
4051
Option('delete',
4052
help='Delete this tag rather than placing it.',
4053
),
4054
Option('directory',
4055
help='Branch in which to place the tag.',
4056
short_name='d',
4057
type=unicode,
4058
),
4059
Option('force',
4060
help='Replace existing tags.',
4061
),
4062
'revision',
4063
]
4064
4065
def run(self, tag_name,
4066
delete=None,
4067
directory='.',
4068
force=None,
4069
revision=None,
4070
):
4071
branch, relpath = Branch.open_containing(directory)
4072
branch.lock_write()
4073
try:
4074
if delete:
4075
branch.tags.delete_tag(tag_name)
4076
self.outf.write('Deleted tag %s.\n' % tag_name)
4077
else:
4078
if revision:
4079
if len(revision) != 1:
4080
raise errors.BzrCommandError(
4081
"Tags can only be placed on a single revision, "
4082
"not on a range")
4083
revision_id = revision[0].in_history(branch).rev_id
4084
else:
4085
revision_id = branch.last_revision()
4086
if (not force) and branch.tags.has_tag(tag_name):
4087
raise errors.TagAlreadyExists(tag_name)
4088
branch.tags.set_tag(tag_name, revision_id)
4089
self.outf.write('Created tag %s.\n' % tag_name)
4090
finally:
4091
branch.unlock()
4092
4093
4094
class cmd_tags(Command):
4095
"""List tags.
4096
4097
This tag shows a table of tag names and the revisions they reference.
4098
"""
4099
4100
_see_also = ['tag']
4101
takes_options = [
4102
Option('directory',
4103
help='Branch whose tags should be displayed.',
4104
short_name='d',
4105
type=unicode,
4106
),
4107
]
4108
4109
@display_command
4110
def run(self,
4111
directory='.',
4112
):
4113
branch, relpath = Branch.open_containing(directory)
4114
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4115
self.outf.write('%-20s %s\n' % (tag_name, target))
4116
4117
4118
def _create_prefix(cur_transport):
4119
needed = [cur_transport]
4120
# Recurse upwards until we can create a directory successfully
4121
while True:
4122
new_transport = cur_transport.clone('..')
4123
if new_transport.base == cur_transport.base:
4124
raise errors.BzrCommandError(
4125
"Failed to create path prefix for %s."
4126
% cur_transport.base)
4127
try:
4128
new_transport.mkdir('.')
4129
except errors.NoSuchFile:
4130
needed.append(new_transport)
4131
cur_transport = new_transport
4132
else:
4133
break
4134
# Now we only need to create child directories
4135
while needed:
4136
cur_transport = needed.pop()
4137
cur_transport.ensure_base()
4138
4139
4140
def _get_mergeable_helper(location):
4141
"""Get a merge directive or bundle if 'location' points to one.
4142
4143
Try try to identify a bundle and returns its mergeable form. If it's not,
4144
we return the tried transport anyway so that it can reused to access the
4145
branch
4146
4147
:param location: can point to a bundle or a branch.
4148
4149
:return: mergeable, transport
4150
"""
4151
mergeable = None
4152
url = urlutils.normalize_url(location)
4153
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4154
location_transport = transport.get_transport(url)
4155
if filename:
4156
try:
4157
# There may be redirections but we ignore the intermediate
4158
# and final transports used
4159
read = bundle.read_mergeable_from_transport
4160
mergeable, t = read(location_transport, filename)
4161
except errors.NotABundle:
4162
# Continue on considering this url a Branch but adjust the
4163
# location_transport
4164
location_transport = location_transport.clone(filename)
4165
return mergeable, location_transport
4166
4167
4168
# these get imported and then picked up by the scan for cmd_*
4169
# TODO: Some more consistent way to split command definitions across files;
4170
# we do need to load at least some information about them to know of
4171
# aliases. ideally we would avoid loading the implementation until the
4172
# details were needed.
4173
from bzrlib.cmd_version_info import cmd_version_info
4174
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4175
from bzrlib.bundle.commands import (
4176
cmd_bundle_info,
4177
)
4178
from bzrlib.sign_my_commits import cmd_sign_my_commits
4179
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4180
cmd_weave_plan_merge, cmd_weave_merge_text
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0