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