/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2007-03-01 04:15:28 UTC
  • mto: (2220.2.48 tags)
  • mto: This revision was merged to the branch mainline in revision 2309.
  • Revision ID: mbp@sourcefrog.net-20070301041528-14my1q8v0buynzut
Add docs for Results, give some members cleaner names

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