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