← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-22 00:37:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050322003717-7b1d4a370c237846
lift out tracefile creation code

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