/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

Merge bzr.dev

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