/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: Aaron Bentley
  • Date: 2007-03-02 20:27:06 UTC
  • mto: (2323.6.9 0.15-integration)
  • mto: This revision was merged to the branch mainline in revision 2330.
  • Revision ID: abentley@panoramicfeedback.com-20070302202706-mriia2sdekme12af
Add RegistryOption.from_swargs to simplify simple registry options

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