~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2005-10-24 13:59:18 UTC
  • mfrom: (1185.20.1)
  • Revision ID: robertc@robertcollins.net-20051024135918-024629d7ee347b5c
fix upgrading of trees with no commits

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005 by 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
# DO NOT change this to cStringIO - it results in control files 
 
18
# written as UCS4
 
19
# FIXIT! (Only deal with byte streams OR unicode at any one layer.)
 
20
# RBC 20051018
 
21
from StringIO import StringIO
 
22
import sys
 
23
import os
 
24
 
 
25
import bzrlib
 
26
from bzrlib import BZRDIR
 
27
from bzrlib.commands import Command, display_command
 
28
from bzrlib.branch import Branch
 
29
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
 
30
from bzrlib.errors import DivergedBranches
 
31
from bzrlib.option import Option
 
32
from bzrlib.revisionspec import RevisionSpec
 
33
import bzrlib.trace
 
34
from bzrlib.trace import mutter, note, log_error, warning
 
35
from bzrlib.workingtree import WorkingTree
 
36
 
 
37
 
 
38
class cmd_status(Command):
 
39
    """Display status summary.
 
40
 
 
41
    This reports on versioned and unknown files, reporting them
 
42
    grouped by state.  Possible states are:
 
43
 
 
44
    added
 
45
        Versioned in the working copy but not in the previous revision.
 
46
 
 
47
    removed
 
48
        Versioned in the previous revision but removed or deleted
 
49
        in the working copy.
 
50
 
 
51
    renamed
 
52
        Path of this file changed from the previous revision;
 
53
        the text may also have changed.  This includes files whose
 
54
        parent directory was renamed.
 
55
 
 
56
    modified
 
57
        Text has changed since the previous revision.
 
58
 
 
59
    unchanged
 
60
        Nothing about this file has changed since the previous revision.
 
61
        Only shown with --all.
 
62
 
 
63
    unknown
 
64
        Not versioned and not matching an ignore pattern.
 
65
 
 
66
    To see ignored files use 'bzr ignored'.  For details in the
 
67
    changes to file texts, use 'bzr diff'.
 
68
 
 
69
    If no arguments are specified, the status of the entire working
 
70
    directory is shown.  Otherwise, only the status of the specified
 
71
    files or directories is reported.  If a directory is given, status
 
72
    is reported for everything inside that directory.
 
73
 
 
74
    If a revision argument is given, the status is calculated against
 
75
    that revision, or between two revisions if two are provided.
 
76
    """
 
77
    
 
78
    # XXX: FIXME: bzr status should accept a -r option to show changes
 
79
    # relative to a revision, or between revisions
 
80
 
 
81
    # TODO: --no-recurse, --recurse options
 
82
    
 
83
    takes_args = ['file*']
 
84
    takes_options = ['all', 'show-ids']
 
85
    aliases = ['st', 'stat']
 
86
    
 
87
    @display_command
 
88
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
 
89
        if file_list:
 
90
            b, relpath = Branch.open_containing(file_list[0])
 
91
            if relpath == '' and len(file_list) == 1:
 
92
                file_list = None
 
93
            else:
 
94
                # generate relative paths.
 
95
                # note that if this is a remote branch, we would want
 
96
                # relpath against the transport. RBC 20051018
 
97
                tree = WorkingTree(b.base, b)
 
98
                file_list = [tree.relpath(x) for x in file_list]
 
99
        else:
 
100
            b = Branch.open_containing('.')[0]
 
101
            
 
102
        from bzrlib.status import show_status
 
103
        show_status(b, show_unchanged=all, show_ids=show_ids,
 
104
                    specific_files=file_list, revision=revision)
 
105
 
 
106
 
 
107
class cmd_cat_revision(Command):
 
108
    """Write out metadata for a revision.
 
109
    
 
110
    The revision to print can either be specified by a specific
 
111
    revision identifier, or you can use --revision.
 
112
    """
 
113
 
 
114
    hidden = True
 
115
    takes_args = ['revision_id?']
 
116
    takes_options = ['revision']
 
117
    
 
118
    @display_command
 
119
    def run(self, revision_id=None, revision=None):
 
120
 
 
121
        if revision_id is not None and revision is not None:
 
122
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
123
        if revision_id is None and revision is None:
 
124
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
125
        b = Branch.open_containing('.')[0]
 
126
        if revision_id is not None:
 
127
            sys.stdout.write(b.get_revision_xml_file(revision_id).read())
 
128
        elif revision is not None:
 
129
            for rev in revision:
 
130
                if rev is None:
 
131
                    raise BzrCommandError('You cannot specify a NULL revision.')
 
132
                revno, rev_id = rev.in_history(b)
 
133
                sys.stdout.write(b.get_revision_xml_file(rev_id).read())
 
134
    
 
135
 
 
136
class cmd_revno(Command):
 
137
    """Show current revision number.
 
138
 
 
139
    This is equal to the number of revisions on this branch."""
 
140
    @display_command
 
141
    def run(self):
 
142
        print Branch.open_containing('.')[0].revno()
 
143
 
 
144
 
 
145
class cmd_revision_info(Command):
 
146
    """Show revision number and revision id for a given revision identifier.
 
147
    """
 
148
    hidden = True
 
149
    takes_args = ['revision_info*']
 
150
    takes_options = ['revision']
 
151
    @display_command
 
152
    def run(self, revision=None, revision_info_list=[]):
 
153
 
 
154
        revs = []
 
155
        if revision is not None:
 
156
            revs.extend(revision)
 
157
        if revision_info_list is not None:
 
158
            for rev in revision_info_list:
 
159
                revs.append(RevisionSpec(rev))
 
160
        if len(revs) == 0:
 
161
            raise BzrCommandError('You must supply a revision identifier')
 
162
 
 
163
        b = Branch.open_containing('.')[0]
 
164
 
 
165
        for rev in revs:
 
166
            revinfo = rev.in_history(b)
 
167
            if revinfo.revno is None:
 
168
                print '     %s' % revinfo.rev_id
 
169
            else:
 
170
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
171
 
 
172
    
 
173
class cmd_add(Command):
 
174
    """Add specified files or directories.
 
175
 
 
176
    In non-recursive mode, all the named items are added, regardless
 
177
    of whether they were previously ignored.  A warning is given if
 
178
    any of the named files are already versioned.
 
179
 
 
180
    In recursive mode (the default), files are treated the same way
 
181
    but the behaviour for directories is different.  Directories that
 
182
    are already versioned do not give a warning.  All directories,
 
183
    whether already versioned or not, are searched for files or
 
184
    subdirectories that are neither versioned or ignored, and these
 
185
    are added.  This search proceeds recursively into versioned
 
186
    directories.  If no names are given '.' is assumed.
 
187
 
 
188
    Therefore simply saying 'bzr add' will version all files that
 
189
    are currently unknown.
 
190
 
 
191
    Adding a file whose parent directory is not versioned will
 
192
    implicitly add the parent, and so on up to the root. This means
 
193
    you should never need to explictly add a directory, they'll just
 
194
    get added when you add a file in the directory.
 
195
    """
 
196
    takes_args = ['file*']
 
197
    takes_options = ['no-recurse', 'quiet']
 
198
    
 
199
    def run(self, file_list, no_recurse=False, quiet=False):
 
200
        from bzrlib.add import smart_add, add_reporter_print, add_reporter_null
 
201
        if quiet:
 
202
            reporter = add_reporter_null
 
203
        else:
 
204
            reporter = add_reporter_print
 
205
        smart_add(file_list, not no_recurse, reporter)
 
206
 
 
207
 
 
208
class cmd_mkdir(Command):
 
209
    """Create a new versioned directory.
 
210
 
 
211
    This is equivalent to creating the directory and then adding it.
 
212
    """
 
213
    takes_args = ['dir+']
 
214
 
 
215
    def run(self, dir_list):
 
216
        b = None
 
217
        
 
218
        for d in dir_list:
 
219
            os.mkdir(d)
 
220
            if not b:
 
221
                b = Branch.open_containing(d)[0]
 
222
            b.add([d])
 
223
            print 'added', d
 
224
 
 
225
 
 
226
class cmd_relpath(Command):
 
227
    """Show path of a file relative to root"""
 
228
    takes_args = ['filename']
 
229
    hidden = True
 
230
    
 
231
    @display_command
 
232
    def run(self, filename):
 
233
        branch, relpath = Branch.open_containing(filename)
 
234
        print relpath
 
235
 
 
236
 
 
237
class cmd_inventory(Command):
 
238
    """Show inventory of the current working copy or a revision."""
 
239
    takes_options = ['revision', 'show-ids']
 
240
    
 
241
    @display_command
 
242
    def run(self, revision=None, show_ids=False):
 
243
        b = Branch.open_containing('.')[0]
 
244
        if revision is None:
 
245
            inv = b.read_working_inventory()
 
246
        else:
 
247
            if len(revision) > 1:
 
248
                raise BzrCommandError('bzr inventory --revision takes'
 
249
                    ' exactly one revision identifier')
 
250
            inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
 
251
 
 
252
        for path, entry in inv.entries():
 
253
            if show_ids:
 
254
                print '%-50s %s' % (path, entry.file_id)
 
255
            else:
 
256
                print path
 
257
 
 
258
 
 
259
class cmd_move(Command):
 
260
    """Move files to a different directory.
 
261
 
 
262
    examples:
 
263
        bzr move *.txt doc
 
264
 
 
265
    The destination must be a versioned directory in the same branch.
 
266
    """
 
267
    takes_args = ['source$', 'dest']
 
268
    def run(self, source_list, dest):
 
269
        b = Branch.open_containing('.')[0]
 
270
 
 
271
        # TODO: glob expansion on windows?
 
272
        tree = WorkingTree(b.base, b)
 
273
        b.move([tree.relpath(s) for s in source_list], tree.relpath(dest))
 
274
 
 
275
 
 
276
class cmd_rename(Command):
 
277
    """Change the name of an entry.
 
278
 
 
279
    examples:
 
280
      bzr rename frob.c frobber.c
 
281
      bzr rename src/frob.c lib/frob.c
 
282
 
 
283
    It is an error if the destination name exists.
 
284
 
 
285
    See also the 'move' command, which moves files into a different
 
286
    directory without changing their name.
 
287
    """
 
288
    # TODO: Some way to rename multiple files without invoking 
 
289
    # bzr for each one?"""
 
290
    takes_args = ['from_name', 'to_name']
 
291
    
 
292
    def run(self, from_name, to_name):
 
293
        b = Branch.open_containing('.')[0]
 
294
        tree = WorkingTree(b.base, b)
 
295
        b.rename_one(tree.relpath(from_name), tree.relpath(to_name))
 
296
 
 
297
 
 
298
class cmd_mv(Command):
 
299
    """Move or rename a file.
 
300
 
 
301
    usage:
 
302
        bzr mv OLDNAME NEWNAME
 
303
        bzr mv SOURCE... DESTINATION
 
304
 
 
305
    If the last argument is a versioned directory, all the other names
 
306
    are moved into it.  Otherwise, there must be exactly two arguments
 
307
    and the file is changed to a new name, which must not already exist.
 
308
 
 
309
    Files cannot be moved between branches.
 
310
    """
 
311
    takes_args = ['names*']
 
312
    def run(self, names_list):
 
313
        if len(names_list) < 2:
 
314
            raise BzrCommandError("missing file argument")
 
315
        b = Branch.open_containing(names_list[0])[0]
 
316
        tree = WorkingTree(b.base, b)
 
317
        rel_names = [tree.relpath(x) for x in names_list]
 
318
        
 
319
        if os.path.isdir(names_list[-1]):
 
320
            # move into existing directory
 
321
            for pair in b.move(rel_names[:-1], rel_names[-1]):
 
322
                print "%s => %s" % pair
 
323
        else:
 
324
            if len(names_list) != 2:
 
325
                raise BzrCommandError('to mv multiple files the destination '
 
326
                                      'must be a versioned directory')
 
327
            b.rename_one(rel_names[0], rel_names[1])
 
328
            print "%s => %s" % (rel_names[0], rel_names[1])
 
329
            
 
330
    
 
331
 
 
332
 
 
333
class cmd_pull(Command):
 
334
    """Pull any changes from another branch into the current one.
 
335
 
 
336
    If the location is omitted, the last-used location will be used.
 
337
    Both the revision history and the working directory will be
 
338
    updated.
 
339
 
 
340
    This command only works on branches that have not diverged.  Branches are
 
341
    considered diverged if both branches have had commits without first
 
342
    pulling from the other.
 
343
 
 
344
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
345
    from one into the other.
 
346
    """
 
347
    takes_options = ['remember', 'clobber']
 
348
    takes_args = ['location?']
 
349
 
 
350
    def run(self, location=None, remember=False, clobber=False):
 
351
        from bzrlib.merge import merge
 
352
        from shutil import rmtree
 
353
        import errno
 
354
        
 
355
        br_to = Branch.open_containing('.')[0]
 
356
        stored_loc = br_to.get_parent()
 
357
        if location is None:
 
358
            if stored_loc is None:
 
359
                raise BzrCommandError("No pull location known or specified.")
 
360
            else:
 
361
                print "Using saved location: %s" % stored_loc
 
362
                location = stored_loc
 
363
        br_from = Branch.open(location)
 
364
        try:
 
365
            br_to.working_tree().pull(br_from, remember, clobber)
 
366
        except DivergedBranches:
 
367
            raise BzrCommandError("These branches have diverged."
 
368
                                  "  Try merge.")
 
369
 
 
370
 
 
371
class cmd_branch(Command):
 
372
    """Create a new copy of a branch.
 
373
 
 
374
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
375
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
376
 
 
377
    To retrieve the branch as of a particular revision, supply the --revision
 
378
    parameter, as in "branch foo/bar -r 5".
 
379
 
 
380
    --basis is to speed up branching from remote branches.  When specified, it
 
381
    copies all the file-contents, inventory and revision data from the basis
 
382
    branch before copying anything from the remote branch.
 
383
    """
 
384
    takes_args = ['from_location', 'to_location?']
 
385
    takes_options = ['revision', 'basis']
 
386
    aliases = ['get', 'clone']
 
387
 
 
388
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
389
        from bzrlib.clone import copy_branch
 
390
        import errno
 
391
        from shutil import rmtree
 
392
        if revision is None:
 
393
            revision = [None]
 
394
        elif len(revision) > 1:
 
395
            raise BzrCommandError(
 
396
                'bzr branch --revision takes exactly 1 revision value')
 
397
        try:
 
398
            br_from = Branch.open(from_location)
 
399
        except OSError, e:
 
400
            if e.errno == errno.ENOENT:
 
401
                raise BzrCommandError('Source location "%s" does not'
 
402
                                      ' exist.' % to_location)
 
403
            else:
 
404
                raise
 
405
        br_from.lock_read()
 
406
        try:
 
407
            if basis is not None:
 
408
                basis_branch = Branch.open_containing(basis)[0]
 
409
            else:
 
410
                basis_branch = None
 
411
            if len(revision) == 1 and revision[0] is not None:
 
412
                revision_id = revision[0].in_history(br_from)[1]
 
413
            else:
 
414
                revision_id = None
 
415
            if to_location is None:
 
416
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
417
                name = None
 
418
            else:
 
419
                name = os.path.basename(to_location) + '\n'
 
420
            try:
 
421
                os.mkdir(to_location)
 
422
            except OSError, e:
 
423
                if e.errno == errno.EEXIST:
 
424
                    raise BzrCommandError('Target directory "%s" already'
 
425
                                          ' exists.' % to_location)
 
426
                if e.errno == errno.ENOENT:
 
427
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
428
                                          to_location)
 
429
                else:
 
430
                    raise
 
431
            try:
 
432
                copy_branch(br_from, to_location, revision_id, basis_branch)
 
433
            except bzrlib.errors.NoSuchRevision:
 
434
                rmtree(to_location)
 
435
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
436
                raise BzrCommandError(msg)
 
437
            except bzrlib.errors.UnlistableBranch:
 
438
                rmtree(to_location)
 
439
                msg = "The branch %s cannot be used as a --basis"
 
440
                raise BzrCommandError(msg)
 
441
            if name:
 
442
                branch = Branch.open(to_location)
 
443
                name = StringIO(name)
 
444
                branch.put_controlfile('branch-name', name)
 
445
        finally:
 
446
            br_from.unlock()
 
447
 
 
448
 
 
449
class cmd_renames(Command):
 
450
    """Show list of renamed files.
 
451
    """
 
452
    # TODO: Option to show renames between two historical versions.
 
453
 
 
454
    # TODO: Only show renames under dir, rather than in the whole branch.
 
455
    takes_args = ['dir?']
 
456
 
 
457
    @display_command
 
458
    def run(self, dir='.'):
 
459
        b = Branch.open_containing(dir)[0]
 
460
        old_inv = b.basis_tree().inventory
 
461
        new_inv = b.read_working_inventory()
 
462
 
 
463
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
464
        renames.sort()
 
465
        for old_name, new_name in renames:
 
466
            print "%s => %s" % (old_name, new_name)        
 
467
 
 
468
 
 
469
class cmd_info(Command):
 
470
    """Show statistical information about a branch."""
 
471
    takes_args = ['branch?']
 
472
    
 
473
    @display_command
 
474
    def run(self, branch=None):
 
475
        import info
 
476
        b = Branch.open_containing(branch)[0]
 
477
        info.show_info(b)
 
478
 
 
479
 
 
480
class cmd_remove(Command):
 
481
    """Make a file unversioned.
 
482
 
 
483
    This makes bzr stop tracking changes to a versioned file.  It does
 
484
    not delete the working copy.
 
485
    """
 
486
    takes_args = ['file+']
 
487
    takes_options = ['verbose']
 
488
    aliases = ['rm']
 
489
    
 
490
    def run(self, file_list, verbose=False):
 
491
        b = Branch.open_containing(file_list[0])[0]
 
492
        tree = WorkingTree(b.base, b)
 
493
        tree.remove([tree.relpath(f) for f in file_list], verbose=verbose)
 
494
 
 
495
 
 
496
class cmd_file_id(Command):
 
497
    """Print file_id of a particular file or directory.
 
498
 
 
499
    The file_id is assigned when the file is first added and remains the
 
500
    same through all revisions where the file exists, even when it is
 
501
    moved or renamed.
 
502
    """
 
503
    hidden = True
 
504
    takes_args = ['filename']
 
505
    @display_command
 
506
    def run(self, filename):
 
507
        b, relpath = Branch.open_containing(filename)
 
508
        i = b.inventory.path2id(relpath)
 
509
        if i == None:
 
510
            raise BzrError("%r is not a versioned file" % filename)
 
511
        else:
 
512
            print i
 
513
 
 
514
 
 
515
class cmd_file_path(Command):
 
516
    """Print path of file_ids to a file or directory.
 
517
 
 
518
    This prints one line for each directory down to the target,
 
519
    starting at the branch root."""
 
520
    hidden = True
 
521
    takes_args = ['filename']
 
522
    @display_command
 
523
    def run(self, filename):
 
524
        b, relpath = Branch.open_containing(filename)
 
525
        inv = b.inventory
 
526
        fid = inv.path2id(relpath)
 
527
        if fid == None:
 
528
            raise BzrError("%r is not a versioned file" % filename)
 
529
        for fip in inv.get_idpath(fid):
 
530
            print fip
 
531
 
 
532
 
 
533
class cmd_revision_history(Command):
 
534
    """Display list of revision ids on this branch."""
 
535
    hidden = True
 
536
    @display_command
 
537
    def run(self):
 
538
        for patchid in Branch.open_containing('.')[0].revision_history():
 
539
            print patchid
 
540
 
 
541
 
 
542
class cmd_ancestry(Command):
 
543
    """List all revisions merged into this branch."""
 
544
    hidden = True
 
545
    @display_command
 
546
    def run(self):
 
547
        b = Branch.open_containing('.')[0]
 
548
        for revision_id in b.get_ancestry(b.last_revision()):
 
549
            print revision_id
 
550
 
 
551
 
 
552
class cmd_directories(Command):
 
553
    """Display list of versioned directories in this branch."""
 
554
    @display_command
 
555
    def run(self):
 
556
        for name, ie in Branch.open_containing('.')[0].read_working_inventory().directories():
 
557
            if name == '':
 
558
                print '.'
 
559
            else:
 
560
                print name
 
561
 
 
562
 
 
563
class cmd_init(Command):
 
564
    """Make a directory into a versioned branch.
 
565
 
 
566
    Use this to create an empty branch, or before importing an
 
567
    existing project.
 
568
 
 
569
    Recipe for importing a tree of files:
 
570
        cd ~/project
 
571
        bzr init
 
572
        bzr add -v .
 
573
        bzr status
 
574
        bzr commit -m 'imported project'
 
575
    """
 
576
    def run(self):
 
577
        Branch.initialize('.')
 
578
 
 
579
 
 
580
class cmd_diff(Command):
 
581
    """Show differences in working tree.
 
582
    
 
583
    If files are listed, only the changes in those files are listed.
 
584
    Otherwise, all changes for the tree are listed.
 
585
 
 
586
    examples:
 
587
        bzr diff
 
588
        bzr diff -r1
 
589
        bzr diff -r1..2
 
590
    """
 
591
    # TODO: Allow diff across branches.
 
592
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
593
    #       or a graphical diff.
 
594
 
 
595
    # TODO: Python difflib is not exactly the same as unidiff; should
 
596
    #       either fix it up or prefer to use an external diff.
 
597
 
 
598
    # TODO: If a directory is given, diff everything under that.
 
599
 
 
600
    # TODO: Selected-file diff is inefficient and doesn't show you
 
601
    #       deleted files.
 
602
 
 
603
    # TODO: This probably handles non-Unix newlines poorly.
 
604
    
 
605
    takes_args = ['file*']
 
606
    takes_options = ['revision', 'diff-options']
 
607
    aliases = ['di', 'dif']
 
608
 
 
609
    @display_command
 
610
    def run(self, revision=None, file_list=None, diff_options=None):
 
611
        from bzrlib.diff import show_diff
 
612
 
 
613
        if file_list:
 
614
            b = Branch.open_containing(file_list[0])[0]
 
615
            tree = WorkingTree(b.base, b)
 
616
            file_list = [tree.relpath(f) for f in file_list]
 
617
            if file_list == ['']:
 
618
                # just pointing to top-of-tree
 
619
                file_list = None
 
620
        else:
 
621
            b = Branch.open_containing('.')[0]
 
622
 
 
623
        if revision is not None:
 
624
            if len(revision) == 1:
 
625
                show_diff(b, revision[0], specific_files=file_list,
 
626
                          external_diff_options=diff_options)
 
627
            elif len(revision) == 2:
 
628
                show_diff(b, revision[0], specific_files=file_list,
 
629
                          external_diff_options=diff_options,
 
630
                          revision2=revision[1])
 
631
            else:
 
632
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
633
        else:
 
634
            show_diff(b, None, specific_files=file_list,
 
635
                      external_diff_options=diff_options)
 
636
 
 
637
        
 
638
 
 
639
 
 
640
class cmd_deleted(Command):
 
641
    """List files deleted in the working tree.
 
642
    """
 
643
    # TODO: Show files deleted since a previous revision, or
 
644
    # between two revisions.
 
645
    # TODO: Much more efficient way to do this: read in new
 
646
    # directories with readdir, rather than stating each one.  Same
 
647
    # level of effort but possibly much less IO.  (Or possibly not,
 
648
    # if the directories are very large...)
 
649
    @display_command
 
650
    def run(self, show_ids=False):
 
651
        b = Branch.open_containing('.')[0]
 
652
        old = b.basis_tree()
 
653
        new = b.working_tree()
 
654
        for path, ie in old.inventory.iter_entries():
 
655
            if not new.has_id(ie.file_id):
 
656
                if show_ids:
 
657
                    print '%-50s %s' % (path, ie.file_id)
 
658
                else:
 
659
                    print path
 
660
 
 
661
 
 
662
class cmd_modified(Command):
 
663
    """List files modified in working tree."""
 
664
    hidden = True
 
665
    @display_command
 
666
    def run(self):
 
667
        from bzrlib.delta import compare_trees
 
668
 
 
669
        b = Branch.open_containing('.')[0]
 
670
        td = compare_trees(b.basis_tree(), b.working_tree())
 
671
 
 
672
        for path, id, kind, text_modified, meta_modified in td.modified:
 
673
            print path
 
674
 
 
675
 
 
676
 
 
677
class cmd_added(Command):
 
678
    """List files added in working tree."""
 
679
    hidden = True
 
680
    @display_command
 
681
    def run(self):
 
682
        b = Branch.open_containing('.')[0]
 
683
        wt = b.working_tree()
 
684
        basis_inv = b.basis_tree().inventory
 
685
        inv = wt.inventory
 
686
        for file_id in inv:
 
687
            if file_id in basis_inv:
 
688
                continue
 
689
            path = inv.id2path(file_id)
 
690
            if not os.access(b.abspath(path), os.F_OK):
 
691
                continue
 
692
            print path
 
693
                
 
694
        
 
695
 
 
696
class cmd_root(Command):
 
697
    """Show the tree root directory.
 
698
 
 
699
    The root is the nearest enclosing directory with a .bzr control
 
700
    directory."""
 
701
    takes_args = ['filename?']
 
702
    @display_command
 
703
    def run(self, filename=None):
 
704
        """Print the branch root."""
 
705
        b = Branch.open_containing(filename)[0]
 
706
        print b.base
 
707
 
 
708
 
 
709
class cmd_log(Command):
 
710
    """Show log of this branch.
 
711
 
 
712
    To request a range of logs, you can use the command -r begin:end
 
713
    -r revision requests a specific revision, -r :end or -r begin: are
 
714
    also valid.
 
715
    """
 
716
 
 
717
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
718
 
 
719
    takes_args = ['filename?']
 
720
    takes_options = [Option('forward', 
 
721
                            help='show from oldest to newest'),
 
722
                     'timezone', 'verbose', 
 
723
                     'show-ids', 'revision',
 
724
                     Option('line', help='format with one line per revision'),
 
725
                     'long', 
 
726
                     Option('message',
 
727
                            help='show revisions whose message matches this regexp',
 
728
                            type=str),
 
729
                     Option('short', help='use moderately short format'),
 
730
                     ]
 
731
    @display_command
 
732
    def run(self, filename=None, timezone='original',
 
733
            verbose=False,
 
734
            show_ids=False,
 
735
            forward=False,
 
736
            revision=None,
 
737
            message=None,
 
738
            long=False,
 
739
            short=False,
 
740
            line=False):
 
741
        from bzrlib.log import log_formatter, show_log
 
742
        import codecs
 
743
        assert message is None or isinstance(message, basestring), \
 
744
            "invalid message argument %r" % message
 
745
        direction = (forward and 'forward') or 'reverse'
 
746
        
 
747
        if filename:
 
748
            b, fp = Branch.open_containing(filename)
 
749
            if fp != '':
 
750
                file_id = b.read_working_inventory().path2id(fp)
 
751
            else:
 
752
                file_id = None  # points to branch root
 
753
        else:
 
754
            b, relpath = Branch.open_containing('.')
 
755
            file_id = None
 
756
 
 
757
        if revision is None:
 
758
            rev1 = None
 
759
            rev2 = None
 
760
        elif len(revision) == 1:
 
761
            rev1 = rev2 = revision[0].in_history(b).revno
 
762
        elif len(revision) == 2:
 
763
            rev1 = revision[0].in_history(b).revno
 
764
            rev2 = revision[1].in_history(b).revno
 
765
        else:
 
766
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
767
 
 
768
        if rev1 == 0:
 
769
            rev1 = None
 
770
        if rev2 == 0:
 
771
            rev2 = None
 
772
 
 
773
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
774
 
 
775
        # use 'replace' so that we don't abort if trying to write out
 
776
        # in e.g. the default C locale.
 
777
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
778
 
 
779
        log_format = 'long'
 
780
        if short:
 
781
            log_format = 'short'
 
782
        if line:
 
783
            log_format = 'line'
 
784
        lf = log_formatter(log_format,
 
785
                           show_ids=show_ids,
 
786
                           to_file=outf,
 
787
                           show_timezone=timezone)
 
788
 
 
789
        show_log(b,
 
790
                 lf,
 
791
                 file_id,
 
792
                 verbose=verbose,
 
793
                 direction=direction,
 
794
                 start_revision=rev1,
 
795
                 end_revision=rev2,
 
796
                 search=message)
 
797
 
 
798
 
 
799
 
 
800
class cmd_touching_revisions(Command):
 
801
    """Return revision-ids which affected a particular file.
 
802
 
 
803
    A more user-friendly interface is "bzr log FILE"."""
 
804
    hidden = True
 
805
    takes_args = ["filename"]
 
806
    @display_command
 
807
    def run(self, filename):
 
808
        b, relpath = Branch.open_containing(filename)[0]
 
809
        inv = b.read_working_inventory()
 
810
        file_id = inv.path2id(relpath)
 
811
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
812
            print "%6d %s" % (revno, what)
 
813
 
 
814
 
 
815
class cmd_ls(Command):
 
816
    """List files in a tree.
 
817
    """
 
818
    # TODO: Take a revision or remote path and list that tree instead.
 
819
    hidden = True
 
820
    @display_command
 
821
    def run(self, revision=None, verbose=False):
 
822
        b, relpath = Branch.open_containing('.')[0]
 
823
        if revision == None:
 
824
            tree = b.working_tree()
 
825
        else:
 
826
            tree = b.revision_tree(revision.in_history(b).rev_id)
 
827
        for fp, fc, kind, fid, entry in tree.list_files():
 
828
            if verbose:
 
829
                kindch = entry.kind_character()
 
830
                print '%-8s %s%s' % (fc, fp, kindch)
 
831
            else:
 
832
                print fp
 
833
 
 
834
 
 
835
 
 
836
class cmd_unknowns(Command):
 
837
    """List unknown files."""
 
838
    @display_command
 
839
    def run(self):
 
840
        from bzrlib.osutils import quotefn
 
841
        for f in Branch.open_containing('.')[0].unknowns():
 
842
            print quotefn(f)
 
843
 
 
844
 
 
845
 
 
846
class cmd_ignore(Command):
 
847
    """Ignore a command or pattern.
 
848
 
 
849
    To remove patterns from the ignore list, edit the .bzrignore file.
 
850
 
 
851
    If the pattern contains a slash, it is compared to the whole path
 
852
    from the branch root.  Otherwise, it is compared to only the last
 
853
    component of the path.  To match a file only in the root directory,
 
854
    prepend './'.
 
855
 
 
856
    Ignore patterns are case-insensitive on case-insensitive systems.
 
857
 
 
858
    Note: wildcards must be quoted from the shell on Unix.
 
859
 
 
860
    examples:
 
861
        bzr ignore ./Makefile
 
862
        bzr ignore '*.class'
 
863
    """
 
864
    # TODO: Complain if the filename is absolute
 
865
    takes_args = ['name_pattern']
 
866
    
 
867
    def run(self, name_pattern):
 
868
        from bzrlib.atomicfile import AtomicFile
 
869
        import os.path
 
870
 
 
871
        b, relpath = Branch.open_containing('.')
 
872
        ifn = b.abspath('.bzrignore')
 
873
 
 
874
        if os.path.exists(ifn):
 
875
            f = open(ifn, 'rt')
 
876
            try:
 
877
                igns = f.read().decode('utf-8')
 
878
            finally:
 
879
                f.close()
 
880
        else:
 
881
            igns = ''
 
882
 
 
883
        # TODO: If the file already uses crlf-style termination, maybe
 
884
        # we should use that for the newly added lines?
 
885
 
 
886
        if igns and igns[-1] != '\n':
 
887
            igns += '\n'
 
888
        igns += name_pattern + '\n'
 
889
 
 
890
        try:
 
891
            f = AtomicFile(ifn, 'wt')
 
892
            f.write(igns.encode('utf-8'))
 
893
            f.commit()
 
894
        finally:
 
895
            f.close()
 
896
 
 
897
        inv = b.working_tree().inventory
 
898
        if inv.path2id('.bzrignore'):
 
899
            mutter('.bzrignore is already versioned')
 
900
        else:
 
901
            mutter('need to make new .bzrignore file versioned')
 
902
            b.add(['.bzrignore'])
 
903
 
 
904
 
 
905
 
 
906
class cmd_ignored(Command):
 
907
    """List ignored files and the patterns that matched them.
 
908
 
 
909
    See also: bzr ignore"""
 
910
    @display_command
 
911
    def run(self):
 
912
        tree = Branch.open_containing('.')[0].working_tree()
 
913
        for path, file_class, kind, file_id, entry in tree.list_files():
 
914
            if file_class != 'I':
 
915
                continue
 
916
            ## XXX: Slightly inefficient since this was already calculated
 
917
            pat = tree.is_ignored(path)
 
918
            print '%-50s %s' % (path, pat)
 
919
 
 
920
 
 
921
class cmd_lookup_revision(Command):
 
922
    """Lookup the revision-id from a revision-number
 
923
 
 
924
    example:
 
925
        bzr lookup-revision 33
 
926
    """
 
927
    hidden = True
 
928
    takes_args = ['revno']
 
929
    
 
930
    @display_command
 
931
    def run(self, revno):
 
932
        try:
 
933
            revno = int(revno)
 
934
        except ValueError:
 
935
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
936
 
 
937
        print Branch.open_containing('.')[0].get_rev_id(revno)
 
938
 
 
939
 
 
940
class cmd_export(Command):
 
941
    """Export past revision to destination directory.
 
942
 
 
943
    If no revision is specified this exports the last committed revision.
 
944
 
 
945
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
946
    given, try to find the format with the extension. If no extension
 
947
    is found exports to a directory (equivalent to --format=dir).
 
948
 
 
949
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
950
    is given, the top directory will be the root name of the file."""
 
951
    # TODO: list known exporters
 
952
    takes_args = ['dest']
 
953
    takes_options = ['revision', 'format', 'root']
 
954
    def run(self, dest, revision=None, format=None, root=None):
 
955
        import os.path
 
956
        b = Branch.open_containing('.')[0]
 
957
        if revision is None:
 
958
            rev_id = b.last_revision()
 
959
        else:
 
960
            if len(revision) != 1:
 
961
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
962
            rev_id = revision[0].in_history(b).rev_id
 
963
        t = b.revision_tree(rev_id)
 
964
        arg_root, ext = os.path.splitext(os.path.basename(dest))
 
965
        if ext in ('.gz', '.bz2'):
 
966
            new_root, new_ext = os.path.splitext(arg_root)
 
967
            if new_ext == '.tar':
 
968
                arg_root = new_root
 
969
                ext = new_ext + ext
 
970
        if root is None:
 
971
            root = arg_root
 
972
        if not format:
 
973
            if ext in (".tar",):
 
974
                format = "tar"
 
975
            elif ext in (".tar.gz", ".tgz"):
 
976
                format = "tgz"
 
977
            elif ext in (".tar.bz2", ".tbz2"):
 
978
                format = "tbz2"
 
979
            else:
 
980
                format = "dir"
 
981
        t.export(dest, format, root)
 
982
 
 
983
 
 
984
class cmd_cat(Command):
 
985
    """Write a file's text from a previous revision."""
 
986
 
 
987
    takes_options = ['revision']
 
988
    takes_args = ['filename']
 
989
 
 
990
    @display_command
 
991
    def run(self, filename, revision=None):
 
992
        if revision is None:
 
993
            raise BzrCommandError("bzr cat requires a revision number")
 
994
        elif len(revision) != 1:
 
995
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
996
        b, relpath = Branch.open_containing(filename)
 
997
        b.print_file(relpath, revision[0].in_history(b).revno)
 
998
 
 
999
 
 
1000
class cmd_local_time_offset(Command):
 
1001
    """Show the offset in seconds from GMT to local time."""
 
1002
    hidden = True    
 
1003
    @display_command
 
1004
    def run(self):
 
1005
        print bzrlib.osutils.local_time_offset()
 
1006
 
 
1007
 
 
1008
 
 
1009
class cmd_commit(Command):
 
1010
    """Commit changes into a new revision.
 
1011
    
 
1012
    If no arguments are given, the entire tree is committed.
 
1013
 
 
1014
    If selected files are specified, only changes to those files are
 
1015
    committed.  If a directory is specified then the directory and everything 
 
1016
    within it is committed.
 
1017
 
 
1018
    A selected-file commit may fail in some cases where the committed
 
1019
    tree would be invalid, such as trying to commit a file in a
 
1020
    newly-added directory that is not itself committed.
 
1021
    """
 
1022
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
1023
 
 
1024
    # TODO: Strict commit that fails if there are deleted files.
 
1025
    #       (what does "deleted files" mean ??)
 
1026
 
 
1027
    # TODO: Give better message for -s, --summary, used by tla people
 
1028
 
 
1029
    # XXX: verbose currently does nothing
 
1030
 
 
1031
    takes_args = ['selected*']
 
1032
    takes_options = ['message', 'verbose', 
 
1033
                     Option('unchanged',
 
1034
                            help='commit even if nothing has changed'),
 
1035
                     Option('file', type=str, 
 
1036
                            argname='msgfile',
 
1037
                            help='file containing commit message'),
 
1038
                     Option('strict',
 
1039
                            help="refuse to commit if there are unknown "
 
1040
                            "files in the working tree."),
 
1041
                     ]
 
1042
    aliases = ['ci', 'checkin']
 
1043
 
 
1044
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1045
            unchanged=False, strict=False):
 
1046
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
1047
                StrictCommitFailed)
 
1048
        from bzrlib.msgeditor import edit_commit_message
 
1049
        from bzrlib.status import show_status
 
1050
        from cStringIO import StringIO
 
1051
 
 
1052
        b = Branch.open_containing('.')[0]
 
1053
        tree = WorkingTree(b.base, b)
 
1054
        if selected_list:
 
1055
            selected_list = [tree.relpath(s) for s in selected_list]
 
1056
        if message is None and not file:
 
1057
            catcher = StringIO()
 
1058
            show_status(b, specific_files=selected_list,
 
1059
                        to_file=catcher)
 
1060
            message = edit_commit_message(catcher.getvalue())
 
1061
 
 
1062
            if message is None:
 
1063
                raise BzrCommandError("please specify a commit message"
 
1064
                                      " with either --message or --file")
 
1065
        elif message and file:
 
1066
            raise BzrCommandError("please specify either --message or --file")
 
1067
        
 
1068
        if file:
 
1069
            import codecs
 
1070
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1071
 
 
1072
        if message == "":
 
1073
                raise BzrCommandError("empty commit message specified")
 
1074
            
 
1075
        try:
 
1076
            b.commit(message, specific_files=selected_list,
 
1077
                     allow_pointless=unchanged, strict=strict)
 
1078
        except PointlessCommit:
 
1079
            # FIXME: This should really happen before the file is read in;
 
1080
            # perhaps prepare the commit; get the message; then actually commit
 
1081
            raise BzrCommandError("no changes to commit",
 
1082
                                  ["use --unchanged to commit anyhow"])
 
1083
        except ConflictsInTree:
 
1084
            raise BzrCommandError("Conflicts detected in working tree.  "
 
1085
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
1086
        except StrictCommitFailed:
 
1087
            raise BzrCommandError("Commit refused because there are unknown "
 
1088
                                  "files in the working tree.")
 
1089
 
 
1090
 
 
1091
class cmd_check(Command):
 
1092
    """Validate consistency of branch history.
 
1093
 
 
1094
    This command checks various invariants about the branch storage to
 
1095
    detect data corruption or bzr bugs.
 
1096
    """
 
1097
    takes_args = ['dir?']
 
1098
    takes_options = ['verbose']
 
1099
 
 
1100
    def run(self, dir='.', verbose=False):
 
1101
        from bzrlib.check import check
 
1102
        check(Branch.open_containing(dir)[0], verbose)
 
1103
 
 
1104
 
 
1105
class cmd_scan_cache(Command):
 
1106
    hidden = True
 
1107
    def run(self):
 
1108
        from bzrlib.hashcache import HashCache
 
1109
 
 
1110
        c = HashCache('.')
 
1111
        c.read()
 
1112
        c.scan()
 
1113
            
 
1114
        print '%6d stats' % c.stat_count
 
1115
        print '%6d in hashcache' % len(c._cache)
 
1116
        print '%6d files removed from cache' % c.removed_count
 
1117
        print '%6d hashes updated' % c.update_count
 
1118
        print '%6d files changed too recently to cache' % c.danger_count
 
1119
 
 
1120
        if c.needs_write:
 
1121
            c.write()
 
1122
            
 
1123
 
 
1124
 
 
1125
class cmd_upgrade(Command):
 
1126
    """Upgrade branch storage to current format.
 
1127
 
 
1128
    The check command or bzr developers may sometimes advise you to run
 
1129
    this command.
 
1130
 
 
1131
    This version of this command upgrades from the full-text storage
 
1132
    used by bzr 0.0.8 and earlier to the weave format (v5).
 
1133
    """
 
1134
    takes_args = ['dir?']
 
1135
 
 
1136
    def run(self, dir='.'):
 
1137
        from bzrlib.upgrade import upgrade
 
1138
        upgrade(dir)
 
1139
 
 
1140
 
 
1141
class cmd_whoami(Command):
 
1142
    """Show bzr user id."""
 
1143
    takes_options = ['email']
 
1144
    
 
1145
    @display_command
 
1146
    def run(self, email=False):
 
1147
        try:
 
1148
            b = bzrlib.branch.Branch.open_containing('.')[0]
 
1149
            config = bzrlib.config.BranchConfig(b)
 
1150
        except NotBranchError:
 
1151
            config = bzrlib.config.GlobalConfig()
 
1152
        
 
1153
        if email:
 
1154
            print config.user_email()
 
1155
        else:
 
1156
            print config.username()
 
1157
 
 
1158
 
 
1159
class cmd_selftest(Command):
 
1160
    """Run internal test suite.
 
1161
    
 
1162
    This creates temporary test directories in the working directory,
 
1163
    but not existing data is affected.  These directories are deleted
 
1164
    if the tests pass, or left behind to help in debugging if they
 
1165
    fail.
 
1166
    
 
1167
    If arguments are given, they are regular expressions that say
 
1168
    which tests should run.
 
1169
    """
 
1170
    # TODO: --list should give a list of all available tests
 
1171
    hidden = True
 
1172
    takes_args = ['testspecs*']
 
1173
    takes_options = ['verbose', 
 
1174
                     Option('one', help='stop when one test fails'),
 
1175
                    ]
 
1176
 
 
1177
    def run(self, testspecs_list=None, verbose=False, one=False):
 
1178
        import bzrlib.ui
 
1179
        from bzrlib.selftest import selftest
 
1180
        # we don't want progress meters from the tests to go to the
 
1181
        # real output; and we don't want log messages cluttering up
 
1182
        # the real logs.
 
1183
        save_ui = bzrlib.ui.ui_factory
 
1184
        bzrlib.trace.info('running tests...')
 
1185
        try:
 
1186
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
1187
            if testspecs_list is not None:
 
1188
                pattern = '|'.join(testspecs_list)
 
1189
            else:
 
1190
                pattern = ".*"
 
1191
            result = selftest(verbose=verbose, 
 
1192
                              pattern=pattern,
 
1193
                              stop_on_failure=one)
 
1194
            if result:
 
1195
                bzrlib.trace.info('tests passed')
 
1196
            else:
 
1197
                bzrlib.trace.info('tests failed')
 
1198
            return int(not result)
 
1199
        finally:
 
1200
            bzrlib.ui.ui_factory = save_ui
 
1201
 
 
1202
 
 
1203
def show_version():
 
1204
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1205
    # is bzrlib itself in a branch?
 
1206
    bzrrev = bzrlib.get_bzr_revision()
 
1207
    if bzrrev:
 
1208
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
1209
    print bzrlib.__copyright__
 
1210
    print "http://bazaar-ng.org/"
 
1211
    print
 
1212
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1213
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1214
    print "General Public License version 2 or later."
 
1215
 
 
1216
 
 
1217
class cmd_version(Command):
 
1218
    """Show version of bzr."""
 
1219
    @display_command
 
1220
    def run(self):
 
1221
        show_version()
 
1222
 
 
1223
class cmd_rocks(Command):
 
1224
    """Statement of optimism."""
 
1225
    hidden = True
 
1226
    @display_command
 
1227
    def run(self):
 
1228
        print "it sure does!"
 
1229
 
 
1230
 
 
1231
class cmd_find_merge_base(Command):
 
1232
    """Find and print a base revision for merging two branches.
 
1233
    """
 
1234
    # TODO: Options to specify revisions on either side, as if
 
1235
    #       merging only part of the history.
 
1236
    takes_args = ['branch', 'other']
 
1237
    hidden = True
 
1238
    
 
1239
    @display_command
 
1240
    def run(self, branch, other):
 
1241
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
1242
        
 
1243
        branch1 = Branch.open_containing(branch)[0]
 
1244
        branch2 = Branch.open_containing(other)[0]
 
1245
 
 
1246
        history_1 = branch1.revision_history()
 
1247
        history_2 = branch2.revision_history()
 
1248
 
 
1249
        last1 = branch1.last_revision()
 
1250
        last2 = branch2.last_revision()
 
1251
 
 
1252
        source = MultipleRevisionSources(branch1, branch2)
 
1253
        
 
1254
        base_rev_id = common_ancestor(last1, last2, source)
 
1255
 
 
1256
        print 'merge base is revision %s' % base_rev_id
 
1257
        
 
1258
        return
 
1259
 
 
1260
        if base_revno is None:
 
1261
            raise bzrlib.errors.UnrelatedBranches()
 
1262
 
 
1263
        print ' r%-6d in %s' % (base_revno, branch)
 
1264
 
 
1265
        other_revno = branch2.revision_id_to_revno(base_revid)
 
1266
        
 
1267
        print ' r%-6d in %s' % (other_revno, other)
 
1268
 
 
1269
 
 
1270
 
 
1271
class cmd_merge(Command):
 
1272
    """Perform a three-way merge.
 
1273
    
 
1274
    The branch is the branch you will merge from.  By default, it will
 
1275
    merge the latest revision.  If you specify a revision, that
 
1276
    revision will be merged.  If you specify two revisions, the first
 
1277
    will be used as a BASE, and the second one as OTHER.  Revision
 
1278
    numbers are always relative to the specified branch.
 
1279
 
 
1280
    By default bzr will try to merge in all new work from the other
 
1281
    branch, automatically determining an appropriate base.  If this
 
1282
    fails, you may need to give an explicit base.
 
1283
    
 
1284
    Examples:
 
1285
 
 
1286
    To merge the latest revision from bzr.dev
 
1287
    bzr merge ../bzr.dev
 
1288
 
 
1289
    To merge changes up to and including revision 82 from bzr.dev
 
1290
    bzr merge -r 82 ../bzr.dev
 
1291
 
 
1292
    To merge the changes introduced by 82, without previous changes:
 
1293
    bzr merge -r 81..82 ../bzr.dev
 
1294
    
 
1295
    merge refuses to run if there are any uncommitted changes, unless
 
1296
    --force is given.
 
1297
    """
 
1298
    takes_args = ['branch?']
 
1299
    takes_options = ['revision', 'force', 'merge-type', 
 
1300
                     Option('show-base', help="Show base revision text in "
 
1301
                            "conflicts")]
 
1302
 
 
1303
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
1304
            show_base=False):
 
1305
        from bzrlib.merge import merge
 
1306
        from bzrlib.merge_core import ApplyMerge3
 
1307
        if merge_type is None:
 
1308
            merge_type = ApplyMerge3
 
1309
        if branch is None:
 
1310
            branch = Branch.open_containing('.')[0].get_parent()
 
1311
            if branch is None:
 
1312
                raise BzrCommandError("No merge location known or specified.")
 
1313
            else:
 
1314
                print "Using saved location: %s" % branch 
 
1315
        if revision is None or len(revision) < 1:
 
1316
            base = [None, None]
 
1317
            other = [branch, -1]
 
1318
        else:
 
1319
            if len(revision) == 1:
 
1320
                base = [None, None]
 
1321
                other_branch = Branch.open_containing(branch)[0]
 
1322
                revno = revision[0].in_history(other_branch).revno
 
1323
                other = [branch, revno]
 
1324
            else:
 
1325
                assert len(revision) == 2
 
1326
                if None in revision:
 
1327
                    raise BzrCommandError(
 
1328
                        "Merge doesn't permit that revision specifier.")
 
1329
                b = Branch.open_containing(branch)[0]
 
1330
 
 
1331
                base = [branch, revision[0].in_history(b).revno]
 
1332
                other = [branch, revision[1].in_history(b).revno]
 
1333
 
 
1334
        try:
 
1335
            conflict_count = merge(other, base, check_clean=(not force),
 
1336
                                   merge_type=merge_type,
 
1337
                                   show_base=show_base)
 
1338
            if conflict_count != 0:
 
1339
                return 1
 
1340
            else:
 
1341
                return 0
 
1342
        except bzrlib.errors.AmbiguousBase, e:
 
1343
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
1344
                 "candidates are:\n  "
 
1345
                 + "\n  ".join(e.bases)
 
1346
                 + "\n"
 
1347
                 "please specify an explicit base with -r,\n"
 
1348
                 "and (if you want) report this to the bzr developers\n")
 
1349
            log_error(m)
 
1350
 
 
1351
 
 
1352
class cmd_revert(Command):
 
1353
    """Reverse all changes since the last commit.
 
1354
 
 
1355
    Only versioned files are affected.  Specify filenames to revert only 
 
1356
    those files.  By default, any files that are changed will be backed up
 
1357
    first.  Backup files have a '~' appended to their name.
 
1358
    """
 
1359
    takes_options = ['revision', 'no-backup']
 
1360
    takes_args = ['file*']
 
1361
    aliases = ['merge-revert']
 
1362
 
 
1363
    def run(self, revision=None, no_backup=False, file_list=None):
 
1364
        from bzrlib.merge import merge
 
1365
        from bzrlib.commands import parse_spec
 
1366
 
 
1367
        if file_list is not None:
 
1368
            if len(file_list) == 0:
 
1369
                raise BzrCommandError("No files specified")
 
1370
        if revision is None:
 
1371
            revno = -1
 
1372
        elif len(revision) != 1:
 
1373
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
1374
        else:
 
1375
            b = Branch.open_containing('.')[0]
 
1376
            revno = revision[0].in_history(b).revno
 
1377
        merge(('.', revno), parse_spec('.'),
 
1378
              check_clean=False,
 
1379
              ignore_zero=True,
 
1380
              backup_files=not no_backup,
 
1381
              file_list=file_list)
 
1382
        if not file_list:
 
1383
            Branch.open_containing('.')[0].set_pending_merges([])
 
1384
 
 
1385
 
 
1386
class cmd_assert_fail(Command):
 
1387
    """Test reporting of assertion failures"""
 
1388
    hidden = True
 
1389
    def run(self):
 
1390
        assert False, "always fails"
 
1391
 
 
1392
 
 
1393
class cmd_help(Command):
 
1394
    """Show help on a command or other topic.
 
1395
 
 
1396
    For a list of all available commands, say 'bzr help commands'."""
 
1397
    takes_options = ['long']
 
1398
    takes_args = ['topic?']
 
1399
    aliases = ['?']
 
1400
    
 
1401
    @display_command
 
1402
    def run(self, topic=None, long=False):
 
1403
        import help
 
1404
        if topic is None and long:
 
1405
            topic = "commands"
 
1406
        help.help(topic)
 
1407
 
 
1408
 
 
1409
class cmd_shell_complete(Command):
 
1410
    """Show appropriate completions for context.
 
1411
 
 
1412
    For a list of all available commands, say 'bzr shell-complete'."""
 
1413
    takes_args = ['context?']
 
1414
    aliases = ['s-c']
 
1415
    hidden = True
 
1416
    
 
1417
    @display_command
 
1418
    def run(self, context=None):
 
1419
        import shellcomplete
 
1420
        shellcomplete.shellcomplete(context)
 
1421
 
 
1422
 
 
1423
class cmd_fetch(Command):
 
1424
    """Copy in history from another branch but don't merge it.
 
1425
 
 
1426
    This is an internal method used for pull and merge."""
 
1427
    hidden = True
 
1428
    takes_args = ['from_branch', 'to_branch']
 
1429
    def run(self, from_branch, to_branch):
 
1430
        from bzrlib.fetch import Fetcher
 
1431
        from bzrlib.branch import Branch
 
1432
        from_b = Branch(from_branch)
 
1433
        to_b = Branch(to_branch)
 
1434
        Fetcher(to_b, from_b)
 
1435
        
 
1436
 
 
1437
 
 
1438
class cmd_missing(Command):
 
1439
    """What is missing in this branch relative to other branch.
 
1440
    """
 
1441
    # TODO: rewrite this in terms of ancestry so that it shows only
 
1442
    # unmerged things
 
1443
    
 
1444
    takes_args = ['remote?']
 
1445
    aliases = ['mis', 'miss']
 
1446
    # We don't have to add quiet to the list, because 
 
1447
    # unknown options are parsed as booleans
 
1448
    takes_options = ['verbose', 'quiet']
 
1449
 
 
1450
    @display_command
 
1451
    def run(self, remote=None, verbose=False, quiet=False):
 
1452
        from bzrlib.errors import BzrCommandError
 
1453
        from bzrlib.missing import show_missing
 
1454
 
 
1455
        if verbose and quiet:
 
1456
            raise BzrCommandError('Cannot pass both quiet and verbose')
 
1457
 
 
1458
        b = Branch.open_containing('.')[0]
 
1459
        parent = b.get_parent()
 
1460
        if remote is None:
 
1461
            if parent is None:
 
1462
                raise BzrCommandError("No missing location known or specified.")
 
1463
            else:
 
1464
                if not quiet:
 
1465
                    print "Using last location: %s" % parent
 
1466
                remote = parent
 
1467
        elif parent is None:
 
1468
            # We only update parent if it did not exist, missing
 
1469
            # should not change the parent
 
1470
            b.set_parent(remote)
 
1471
        br_remote = Branch.open_containing(remote)[0]
 
1472
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
 
1473
 
 
1474
 
 
1475
class cmd_plugins(Command):
 
1476
    """List plugins"""
 
1477
    hidden = True
 
1478
    @display_command
 
1479
    def run(self):
 
1480
        import bzrlib.plugin
 
1481
        from inspect import getdoc
 
1482
        for plugin in bzrlib.plugin.all_plugins:
 
1483
            if hasattr(plugin, '__path__'):
 
1484
                print plugin.__path__[0]
 
1485
            elif hasattr(plugin, '__file__'):
 
1486
                print plugin.__file__
 
1487
            else:
 
1488
                print `plugin`
 
1489
                
 
1490
            d = getdoc(plugin)
 
1491
            if d:
 
1492
                print '\t', d.split('\n')[0]
 
1493
 
 
1494
 
 
1495
class cmd_testament(Command):
 
1496
    """Show testament (signing-form) of a revision."""
 
1497
    takes_options = ['revision', 'long']
 
1498
    takes_args = ['branch?']
 
1499
    @display_command
 
1500
    def run(self, branch='.', revision=None, long=False):
 
1501
        from bzrlib.testament import Testament
 
1502
        b = Branch.open_containing(branch)[0]
 
1503
        b.lock_read()
 
1504
        try:
 
1505
            if revision is None:
 
1506
                rev_id = b.last_revision()
 
1507
            else:
 
1508
                rev_id = revision[0].in_history(b).rev_id
 
1509
            t = Testament.from_revision(b, rev_id)
 
1510
            if long:
 
1511
                sys.stdout.writelines(t.as_text_lines())
 
1512
            else:
 
1513
                sys.stdout.write(t.as_short_text())
 
1514
        finally:
 
1515
            b.unlock()
 
1516
 
 
1517
 
 
1518
class cmd_annotate(Command):
 
1519
    """Show the origin of each line in a file.
 
1520
 
 
1521
    This prints out the given file with an annotation on the left side
 
1522
    indicating which revision, author and date introduced the change.
 
1523
 
 
1524
    If the origin is the same for a run of consecutive lines, it is 
 
1525
    shown only at the top, unless the --all option is given.
 
1526
    """
 
1527
    # TODO: annotate directories; showing when each file was last changed
 
1528
    # TODO: annotate a previous version of a file
 
1529
    # TODO: if the working copy is modified, show annotations on that 
 
1530
    #       with new uncommitted lines marked
 
1531
    aliases = ['blame', 'praise']
 
1532
    takes_args = ['filename']
 
1533
    takes_options = [Option('all', help='show annotations on all lines'),
 
1534
                     Option('long', help='show date in annotations'),
 
1535
                     ]
 
1536
 
 
1537
    @display_command
 
1538
    def run(self, filename, all=False, long=False):
 
1539
        from bzrlib.annotate import annotate_file
 
1540
        b, relpath = Branch.open_containing(filename)
 
1541
        b.lock_read()
 
1542
        try:
 
1543
            tree = WorkingTree(b.base, b)
 
1544
            tree = b.revision_tree(b.last_revision())
 
1545
            file_id = tree.inventory.path2id(relpath)
 
1546
            file_version = tree.inventory[file_id].revision
 
1547
            annotate_file(b, file_version, file_id, long, all, sys.stdout)
 
1548
        finally:
 
1549
            b.unlock()
 
1550
 
 
1551
 
 
1552
class cmd_re_sign(Command):
 
1553
    """Create a digital signature for an existing revision."""
 
1554
    # TODO be able to replace existing ones.
 
1555
 
 
1556
    hidden = True # is this right ?
 
1557
    takes_args = ['revision_id?']
 
1558
    takes_options = ['revision']
 
1559
    
 
1560
    def run(self, revision_id=None, revision=None):
 
1561
        import bzrlib.config as config
 
1562
        import bzrlib.gpg as gpg
 
1563
        if revision_id is not None and revision is not None:
 
1564
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
1565
        if revision_id is None and revision is None:
 
1566
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
1567
        b = Branch.open_containing('.')[0]
 
1568
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
1569
        if revision_id is not None:
 
1570
            b.sign_revision(revision_id, gpg_strategy)
 
1571
        elif revision is not None:
 
1572
            if len(revision) == 1:
 
1573
                revno, rev_id = revision[0].in_history(b)
 
1574
                b.sign_revision(rev_id, gpg_strategy)
 
1575
            elif len(revision) == 2:
 
1576
                # are they both on rh- if so we can walk between them
 
1577
                # might be nice to have a range helper for arbitrary
 
1578
                # revision paths. hmm.
 
1579
                from_revno, from_revid = revision[0].in_history(b)
 
1580
                to_revno, to_revid = revision[1].in_history(b)
 
1581
                if to_revid is None:
 
1582
                    to_revno = b.revno()
 
1583
                if from_revno is None or to_revno is None:
 
1584
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
1585
                for revno in range(from_revno, to_revno + 1):
 
1586
                    b.sign_revision(b.get_rev_id(revno), gpg_strategy)
 
1587
            else:
 
1588
                raise BzrCommandError('Please supply either one revision, or a range.')
 
1589
 
 
1590
 
 
1591
# these get imported and then picked up by the scan for cmd_*
 
1592
# TODO: Some more consistent way to split command definitions across files;
 
1593
# we do need to load at least some information about them to know of 
 
1594
# aliases.
 
1595
from bzrlib.conflicts import cmd_resolve, cmd_conflicts