/brz/remove-bazaar

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

  • Committer: Ian Clatworthy
  • Date: 2008-06-25 07:17:14 UTC
  • mto: (3515.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3516.
  • Revision ID: ian.clatworthy@canonical.com-20080625071714-am1ya6mgo54ikrgv
jam feedback - make patterns a separate help topic

Show diffs side-by-side

added added

removed removed

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