/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: Vincent Ladeuil
  • Date: 2007-11-05 13:21:30 UTC
  • mfrom: (2955.2.1 160012)
  • mto: This revision was merged to the branch mainline in revision 2965.
  • Revision ID: v.ladeuil+lp@free.fr-20071105132130-es2vb5ltorlgvoh2
https://launchpad.net/bugs/160012
Fix #160012 by leaving the http pipeline related exceptions raise

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
import os
 
20
from StringIO import StringIO
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import codecs
 
25
import sys
 
26
import time
 
27
 
 
28
import bzrlib
 
29
from bzrlib import (
 
30
    bugtracker,
 
31
    bundle,
 
32
    bzrdir,
 
33
    delta,
 
34
    config,
 
35
    errors,
 
36
    globbing,
 
37
    ignores,
 
38
    log,
 
39
    merge as _mod_merge,
 
40
    merge_directive,
 
41
    osutils,
 
42
    reconfigure,
 
43
    revision as _mod_revision,
 
44
    symbol_versioning,
 
45
    transport,
 
46
    tree as _mod_tree,
 
47
    ui,
 
48
    urlutils,
 
49
    )
 
50
from bzrlib.branch import Branch
 
51
from bzrlib.conflicts import ConflictList
 
52
from bzrlib.revisionspec import RevisionSpec
 
53
from bzrlib.smtp_connection import SMTPConnection
 
54
from bzrlib.workingtree import WorkingTree
 
55
""")
 
56
 
 
57
from bzrlib.commands import Command, display_command
 
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
 
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
 
60
 
 
61
 
 
62
def tree_files(file_list, default_branch=u'.'):
 
63
    try:
 
64
        return internal_tree_files(file_list, default_branch)
 
65
    except errors.FileInWrongBranch, e:
 
66
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
67
                                     (e.path, file_list[0]))
 
68
 
 
69
 
 
70
# XXX: Bad function name; should possibly also be a class method of
 
71
# WorkingTree rather than a function.
 
72
def internal_tree_files(file_list, default_branch=u'.'):
 
73
    """Convert command-line paths to a WorkingTree and relative paths.
 
74
 
 
75
    This is typically used for command-line processors that take one or
 
76
    more filenames, and infer the workingtree that contains them.
 
77
 
 
78
    The filenames given are not required to exist.
 
79
 
 
80
    :param file_list: Filenames to convert.  
 
81
 
 
82
    :param default_branch: Fallback tree path to use if file_list is empty or
 
83
        None.
 
84
 
 
85
    :return: workingtree, [relative_paths]
 
86
    """
 
87
    if file_list is None or len(file_list) == 0:
 
88
        return WorkingTree.open_containing(default_branch)[0], file_list
 
89
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
90
    new_list = []
 
91
    for filename in file_list:
 
92
        try:
 
93
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
94
        except errors.PathNotChild:
 
95
            raise errors.FileInWrongBranch(tree.branch, filename)
 
96
    return tree, new_list
 
97
 
 
98
 
 
99
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
 
100
def get_format_type(typestring):
 
101
    """Parse and return a format specifier."""
 
102
    # Have to use BzrDirMetaFormat1 directly, so that
 
103
    # RepositoryFormat.set_default_format works
 
104
    if typestring == "default":
 
105
        return bzrdir.BzrDirMetaFormat1()
 
106
    try:
 
107
        return bzrdir.format_registry.make_bzrdir(typestring)
 
108
    except KeyError:
 
109
        msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
 
110
        raise errors.BzrCommandError(msg)
 
111
 
 
112
 
 
113
# TODO: Make sure no commands unconditionally use the working directory as a
 
114
# branch.  If a filename argument is used, the first of them should be used to
 
115
# specify the branch.  (Perhaps this can be factored out into some kind of
 
116
# Argument class, representing a file in a branch, where the first occurrence
 
117
# opens the branch?)
 
118
 
 
119
class cmd_status(Command):
 
120
    """Display status summary.
 
121
 
 
122
    This reports on versioned and unknown files, reporting them
 
123
    grouped by state.  Possible states are:
 
124
 
 
125
    added
 
126
        Versioned in the working copy but not in the previous revision.
 
127
 
 
128
    removed
 
129
        Versioned in the previous revision but removed or deleted
 
130
        in the working copy.
 
131
 
 
132
    renamed
 
133
        Path of this file changed from the previous revision;
 
134
        the text may also have changed.  This includes files whose
 
135
        parent directory was renamed.
 
136
 
 
137
    modified
 
138
        Text has changed since the previous revision.
 
139
 
 
140
    kind changed
 
141
        File kind has been changed (e.g. from file to directory).
 
142
 
 
143
    unknown
 
144
        Not versioned and not matching an ignore pattern.
 
145
 
 
146
    To see ignored files use 'bzr ignored'.  For details on the
 
147
    changes to file texts, use 'bzr diff'.
 
148
    
 
149
    Note that --short or -S gives status flags for each item, similar
 
150
    to Subversion's status command. To get output similar to svn -q,
 
151
    use bzr -SV.
 
152
 
 
153
    If no arguments are specified, the status of the entire working
 
154
    directory is shown.  Otherwise, only the status of the specified
 
155
    files or directories is reported.  If a directory is given, status
 
156
    is reported for everything inside that directory.
 
157
 
 
158
    If a revision argument is given, the status is calculated against
 
159
    that revision, or between two revisions if two are provided.
 
160
    """
 
161
    
 
162
    # TODO: --no-recurse, --recurse options
 
163
    
 
164
    takes_args = ['file*']
 
165
    takes_options = ['show-ids', 'revision', 'change',
 
166
                     Option('short', help='Use short status indicators.',
 
167
                            short_name='S'),
 
168
                     Option('versioned', help='Only show versioned files.',
 
169
                            short_name='V')
 
170
                     ]
 
171
    aliases = ['st', 'stat']
 
172
 
 
173
    encoding_type = 'replace'
 
174
    _see_also = ['diff', 'revert', 'status-flags']
 
175
    
 
176
    @display_command
 
177
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
178
            versioned=False):
 
179
        from bzrlib.status import show_tree_status
 
180
 
 
181
        if revision and len(revision) > 2:
 
182
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
183
                                         ' one or two revision specifiers')
 
184
 
 
185
        tree, file_list = tree_files(file_list)
 
186
            
 
187
        show_tree_status(tree, show_ids=show_ids,
 
188
                         specific_files=file_list, revision=revision,
 
189
                         to_file=self.outf, short=short, versioned=versioned)
 
190
 
 
191
 
 
192
class cmd_cat_revision(Command):
 
193
    """Write out metadata for a revision.
 
194
    
 
195
    The revision to print can either be specified by a specific
 
196
    revision identifier, or you can use --revision.
 
197
    """
 
198
 
 
199
    hidden = True
 
200
    takes_args = ['revision_id?']
 
201
    takes_options = ['revision']
 
202
    # cat-revision is more for frontends so should be exact
 
203
    encoding = 'strict'
 
204
    
 
205
    @display_command
 
206
    def run(self, revision_id=None, revision=None):
 
207
        if revision_id is not None and revision is not None:
 
208
            raise errors.BzrCommandError('You can only supply one of'
 
209
                                         ' revision_id or --revision')
 
210
        if revision_id is None and revision is None:
 
211
            raise errors.BzrCommandError('You must supply either'
 
212
                                         ' --revision or a revision_id')
 
213
        b = WorkingTree.open_containing(u'.')[0].branch
 
214
 
 
215
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
216
        if revision_id is not None:
 
217
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
218
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
219
        elif revision is not None:
 
220
            for rev in revision:
 
221
                if rev is None:
 
222
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
223
                                                 ' revision.')
 
224
                revno, rev_id = rev.in_history(b)
 
225
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
226
    
 
227
 
 
228
class cmd_remove_tree(Command):
 
229
    """Remove the working tree from a given branch/checkout.
 
230
 
 
231
    Since a lightweight checkout is little more than a working tree
 
232
    this will refuse to run against one.
 
233
 
 
234
    To re-create the working tree, use "bzr checkout".
 
235
    """
 
236
    _see_also = ['checkout', 'working-trees']
 
237
 
 
238
    takes_args = ['location?']
 
239
 
 
240
    def run(self, location='.'):
 
241
        d = bzrdir.BzrDir.open(location)
 
242
        
 
243
        try:
 
244
            working = d.open_workingtree()
 
245
        except errors.NoWorkingTree:
 
246
            raise errors.BzrCommandError("No working tree to remove")
 
247
        except errors.NotLocalUrl:
 
248
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
249
                                         "remote path")
 
250
        
 
251
        working_path = working.bzrdir.root_transport.base
 
252
        branch_path = working.branch.bzrdir.root_transport.base
 
253
        if working_path != branch_path:
 
254
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
255
                                         "a lightweight checkout")
 
256
        
 
257
        d.destroy_workingtree()
 
258
        
 
259
 
 
260
class cmd_revno(Command):
 
261
    """Show current revision number.
 
262
 
 
263
    This is equal to the number of revisions on this branch.
 
264
    """
 
265
 
 
266
    _see_also = ['info']
 
267
    takes_args = ['location?']
 
268
 
 
269
    @display_command
 
270
    def run(self, location=u'.'):
 
271
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
272
        self.outf.write('\n')
 
273
 
 
274
 
 
275
class cmd_revision_info(Command):
 
276
    """Show revision number and revision id for a given revision identifier.
 
277
    """
 
278
    hidden = True
 
279
    takes_args = ['revision_info*']
 
280
    takes_options = ['revision']
 
281
 
 
282
    @display_command
 
283
    def run(self, revision=None, revision_info_list=[]):
 
284
 
 
285
        revs = []
 
286
        if revision is not None:
 
287
            revs.extend(revision)
 
288
        if revision_info_list is not None:
 
289
            for rev in revision_info_list:
 
290
                revs.append(RevisionSpec.from_string(rev))
 
291
 
 
292
        b = Branch.open_containing(u'.')[0]
 
293
 
 
294
        if len(revs) == 0:
 
295
            revs.append(RevisionSpec.from_string('-1'))
 
296
 
 
297
        for rev in revs:
 
298
            revinfo = rev.in_history(b)
 
299
            if revinfo.revno is None:
 
300
                dotted_map = b.get_revision_id_to_revno_map()
 
301
                revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
 
302
                print '%s %s' % (revno, revinfo.rev_id)
 
303
            else:
 
304
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
305
 
 
306
    
 
307
class cmd_add(Command):
 
308
    """Add specified files or directories.
 
309
 
 
310
    In non-recursive mode, all the named items are added, regardless
 
311
    of whether they were previously ignored.  A warning is given if
 
312
    any of the named files are already versioned.
 
313
 
 
314
    In recursive mode (the default), files are treated the same way
 
315
    but the behaviour for directories is different.  Directories that
 
316
    are already versioned do not give a warning.  All directories,
 
317
    whether already versioned or not, are searched for files or
 
318
    subdirectories that are neither versioned or ignored, and these
 
319
    are added.  This search proceeds recursively into versioned
 
320
    directories.  If no names are given '.' is assumed.
 
321
 
 
322
    Therefore simply saying 'bzr add' will version all files that
 
323
    are currently unknown.
 
324
 
 
325
    Adding a file whose parent directory is not versioned will
 
326
    implicitly add the parent, and so on up to the root. This means
 
327
    you should never need to explicitly add a directory, they'll just
 
328
    get added when you add a file in the directory.
 
329
 
 
330
    --dry-run will show which files would be added, but not actually 
 
331
    add them.
 
332
 
 
333
    --file-ids-from will try to use the file ids from the supplied path.
 
334
    It looks up ids trying to find a matching parent directory with the
 
335
    same filename, and then by pure path. This option is rarely needed
 
336
    but can be useful when adding the same logical file into two
 
337
    branches that will be merged later (without showing the two different
 
338
    adds as a conflict). It is also useful when merging another project
 
339
    into a subdirectory of this one.
 
340
    """
 
341
    takes_args = ['file*']
 
342
    takes_options = [
 
343
        Option('no-recurse',
 
344
               help="Don't recursively add the contents of directories."),
 
345
        Option('dry-run',
 
346
               help="Show what would be done, but don't actually do anything."),
 
347
        'verbose',
 
348
        Option('file-ids-from',
 
349
               type=unicode,
 
350
               help='Lookup file ids from this tree.'),
 
351
        ]
 
352
    encoding_type = 'replace'
 
353
    _see_also = ['remove']
 
354
 
 
355
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
356
            file_ids_from=None):
 
357
        import bzrlib.add
 
358
 
 
359
        base_tree = None
 
360
        if file_ids_from is not None:
 
361
            try:
 
362
                base_tree, base_path = WorkingTree.open_containing(
 
363
                                            file_ids_from)
 
364
            except errors.NoWorkingTree:
 
365
                base_branch, base_path = Branch.open_containing(
 
366
                                            file_ids_from)
 
367
                base_tree = base_branch.basis_tree()
 
368
 
 
369
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
370
                          to_file=self.outf, should_print=(not is_quiet()))
 
371
        else:
 
372
            action = bzrlib.add.AddAction(to_file=self.outf,
 
373
                should_print=(not is_quiet()))
 
374
 
 
375
        if base_tree:
 
376
            base_tree.lock_read()
 
377
        try:
 
378
            file_list = self._maybe_expand_globs(file_list)
 
379
            if file_list:
 
380
                tree = WorkingTree.open_containing(file_list[0])[0]
 
381
            else:
 
382
                tree = WorkingTree.open_containing(u'.')[0]
 
383
            added, ignored = tree.smart_add(file_list, not
 
384
                no_recurse, action=action, save=not dry_run)
 
385
        finally:
 
386
            if base_tree is not None:
 
387
                base_tree.unlock()
 
388
        if len(ignored) > 0:
 
389
            if verbose:
 
390
                for glob in sorted(ignored.keys()):
 
391
                    for path in ignored[glob]:
 
392
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
393
                                        % (path, glob))
 
394
            else:
 
395
                match_len = 0
 
396
                for glob, paths in ignored.items():
 
397
                    match_len += len(paths)
 
398
                self.outf.write("ignored %d file(s).\n" % match_len)
 
399
            self.outf.write("If you wish to add some of these files,"
 
400
                            " please add them by name.\n")
 
401
 
 
402
 
 
403
class cmd_mkdir(Command):
 
404
    """Create a new versioned directory.
 
405
 
 
406
    This is equivalent to creating the directory and then adding it.
 
407
    """
 
408
 
 
409
    takes_args = ['dir+']
 
410
    encoding_type = 'replace'
 
411
 
 
412
    def run(self, dir_list):
 
413
        for d in dir_list:
 
414
            os.mkdir(d)
 
415
            wt, dd = WorkingTree.open_containing(d)
 
416
            wt.add([dd])
 
417
            self.outf.write('added %s\n' % d)
 
418
 
 
419
 
 
420
class cmd_relpath(Command):
 
421
    """Show path of a file relative to root"""
 
422
 
 
423
    takes_args = ['filename']
 
424
    hidden = True
 
425
    
 
426
    @display_command
 
427
    def run(self, filename):
 
428
        # TODO: jam 20050106 Can relpath return a munged path if
 
429
        #       sys.stdout encoding cannot represent it?
 
430
        tree, relpath = WorkingTree.open_containing(filename)
 
431
        self.outf.write(relpath)
 
432
        self.outf.write('\n')
 
433
 
 
434
 
 
435
class cmd_inventory(Command):
 
436
    """Show inventory of the current working copy or a revision.
 
437
 
 
438
    It is possible to limit the output to a particular entry
 
439
    type using the --kind option.  For example: --kind file.
 
440
 
 
441
    It is also possible to restrict the list of files to a specific
 
442
    set. For example: bzr inventory --show-ids this/file
 
443
    """
 
444
 
 
445
    hidden = True
 
446
    _see_also = ['ls']
 
447
    takes_options = [
 
448
        'revision',
 
449
        'show-ids',
 
450
        Option('kind',
 
451
               help='List entries of a particular kind: file, directory, symlink.',
 
452
               type=unicode),
 
453
        ]
 
454
    takes_args = ['file*']
 
455
 
 
456
    @display_command
 
457
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
458
        if kind and kind not in ['file', 'directory', 'symlink']:
 
459
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
460
 
 
461
        work_tree, file_list = tree_files(file_list)
 
462
        work_tree.lock_read()
 
463
        try:
 
464
            if revision is not None:
 
465
                if len(revision) > 1:
 
466
                    raise errors.BzrCommandError(
 
467
                        'bzr inventory --revision takes exactly one revision'
 
468
                        ' identifier')
 
469
                revision_id = revision[0].in_history(work_tree.branch).rev_id
 
470
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
471
 
 
472
                extra_trees = [work_tree]
 
473
                tree.lock_read()
 
474
            else:
 
475
                tree = work_tree
 
476
                extra_trees = []
 
477
 
 
478
            if file_list is not None:
 
479
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
480
                                          require_versioned=True)
 
481
                # find_ids_across_trees may include some paths that don't
 
482
                # exist in 'tree'.
 
483
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
484
                                 for file_id in file_ids if file_id in tree)
 
485
            else:
 
486
                entries = tree.inventory.entries()
 
487
        finally:
 
488
            tree.unlock()
 
489
            if tree is not work_tree:
 
490
                work_tree.unlock()
 
491
 
 
492
        for path, entry in entries:
 
493
            if kind and kind != entry.kind:
 
494
                continue
 
495
            if show_ids:
 
496
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
497
            else:
 
498
                self.outf.write(path)
 
499
                self.outf.write('\n')
 
500
 
 
501
 
 
502
class cmd_mv(Command):
 
503
    """Move or rename a file.
 
504
 
 
505
    :Usage:
 
506
        bzr mv OLDNAME NEWNAME
 
507
 
 
508
        bzr mv SOURCE... DESTINATION
 
509
 
 
510
    If the last argument is a versioned directory, all the other names
 
511
    are moved into it.  Otherwise, there must be exactly two arguments
 
512
    and the file is changed to a new name.
 
513
 
 
514
    If OLDNAME does not exist on the filesystem but is versioned and
 
515
    NEWNAME does exist on the filesystem but is not versioned, mv
 
516
    assumes that the file has been manually moved and only updates
 
517
    its internal inventory to reflect that change.
 
518
    The same is valid when moving many SOURCE files to a DESTINATION.
 
519
 
 
520
    Files cannot be moved between branches.
 
521
    """
 
522
 
 
523
    takes_args = ['names*']
 
524
    takes_options = [Option("after", help="Move only the bzr identifier"
 
525
        " of the file, because the file has already been moved."),
 
526
        ]
 
527
    aliases = ['move', 'rename']
 
528
    encoding_type = 'replace'
 
529
 
 
530
    def run(self, names_list, after=False):
 
531
        if names_list is None:
 
532
            names_list = []
 
533
 
 
534
        if len(names_list) < 2:
 
535
            raise errors.BzrCommandError("missing file argument")
 
536
        tree, rel_names = tree_files(names_list)
 
537
        
 
538
        if os.path.isdir(names_list[-1]):
 
539
            # move into existing directory
 
540
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
541
                self.outf.write("%s => %s\n" % pair)
 
542
        else:
 
543
            if len(names_list) != 2:
 
544
                raise errors.BzrCommandError('to mv multiple files the'
 
545
                                             ' destination must be a versioned'
 
546
                                             ' directory')
 
547
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
548
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
549
            
 
550
    
 
551
class cmd_pull(Command):
 
552
    """Turn this branch into a mirror of another branch.
 
553
 
 
554
    This command only works on branches that have not diverged.  Branches are
 
555
    considered diverged if the destination branch's most recent commit is one
 
556
    that has not been merged (directly or indirectly) into the parent.
 
557
 
 
558
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
559
    from one into the other.  Once one branch has merged, the other should
 
560
    be able to pull it again.
 
561
 
 
562
    If you want to forget your local changes and just update your branch to
 
563
    match the remote one, use pull --overwrite.
 
564
 
 
565
    If there is no default location set, the first pull will set it.  After
 
566
    that, you can omit the location to use the default.  To change the
 
567
    default, use --remember. The value will only be saved if the remote
 
568
    location can be accessed.
 
569
    """
 
570
 
 
571
    _see_also = ['push', 'update', 'status-flags']
 
572
    takes_options = ['remember', 'overwrite', 'revision',
 
573
        custom_help('verbose',
 
574
            help='Show logs of pulled revisions.'),
 
575
        Option('directory',
 
576
            help='Branch to pull into, '
 
577
                 'rather than the one containing the working directory.',
 
578
            short_name='d',
 
579
            type=unicode,
 
580
            ),
 
581
        ]
 
582
    takes_args = ['location?']
 
583
    encoding_type = 'replace'
 
584
 
 
585
    def run(self, location=None, remember=False, overwrite=False,
 
586
            revision=None, verbose=False,
 
587
            directory=None):
 
588
        # FIXME: too much stuff is in the command class
 
589
        revision_id = None
 
590
        mergeable = None
 
591
        if directory is None:
 
592
            directory = u'.'
 
593
        try:
 
594
            tree_to = WorkingTree.open_containing(directory)[0]
 
595
            branch_to = tree_to.branch
 
596
        except errors.NoWorkingTree:
 
597
            tree_to = None
 
598
            branch_to = Branch.open_containing(directory)[0]
 
599
 
 
600
        possible_transports = []
 
601
        if location is not None:
 
602
            mergeable, location_transport = _get_mergeable_helper(location)
 
603
            possible_transports.append(location_transport)
 
604
 
 
605
        stored_loc = branch_to.get_parent()
 
606
        if location is None:
 
607
            if stored_loc is None:
 
608
                raise errors.BzrCommandError("No pull location known or"
 
609
                                             " specified.")
 
610
            else:
 
611
                display_url = urlutils.unescape_for_display(stored_loc,
 
612
                        self.outf.encoding)
 
613
                self.outf.write("Using saved location: %s\n" % display_url)
 
614
                location = stored_loc
 
615
                location_transport = transport.get_transport(
 
616
                    location, possible_transports=possible_transports)
 
617
 
 
618
        if mergeable is not None:
 
619
            if revision is not None:
 
620
                raise errors.BzrCommandError(
 
621
                    'Cannot use -r with merge directives or bundles')
 
622
            mergeable.install_revisions(branch_to.repository)
 
623
            base_revision_id, revision_id, verified = \
 
624
                mergeable.get_merge_request(branch_to.repository)
 
625
            branch_from = branch_to
 
626
        else:
 
627
            branch_from = Branch.open_from_transport(location_transport)
 
628
 
 
629
            if branch_to.get_parent() is None or remember:
 
630
                branch_to.set_parent(branch_from.base)
 
631
 
 
632
        if revision is not None:
 
633
            if len(revision) == 1:
 
634
                revision_id = revision[0].in_history(branch_from).rev_id
 
635
            else:
 
636
                raise errors.BzrCommandError(
 
637
                    'bzr pull --revision takes one value.')
 
638
 
 
639
        if verbose:
 
640
            old_rh = branch_to.revision_history()
 
641
        if tree_to is not None:
 
642
            change_reporter = delta._ChangeReporter(
 
643
                unversioned_filter=tree_to.is_ignored)
 
644
            result = tree_to.pull(branch_from, overwrite, revision_id,
 
645
                                  change_reporter,
 
646
                                  possible_transports=possible_transports)
 
647
        else:
 
648
            result = branch_to.pull(branch_from, overwrite, revision_id)
 
649
 
 
650
        result.report(self.outf)
 
651
        if verbose:
 
652
            new_rh = branch_to.revision_history()
 
653
            log.show_changed_revisions(branch_to, old_rh, new_rh,
 
654
                                       to_file=self.outf)
 
655
 
 
656
 
 
657
class cmd_push(Command):
 
658
    """Update a mirror of this branch.
 
659
    
 
660
    The target branch will not have its working tree populated because this
 
661
    is both expensive, and is not supported on remote file systems.
 
662
    
 
663
    Some smart servers or protocols *may* put the working tree in place in
 
664
    the future.
 
665
 
 
666
    This command only works on branches that have not diverged.  Branches are
 
667
    considered diverged if the destination branch's most recent commit is one
 
668
    that has not been merged (directly or indirectly) by the source branch.
 
669
 
 
670
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
671
    the other branch completely, discarding its unmerged changes.
 
672
    
 
673
    If you want to ensure you have the different changes in the other branch,
 
674
    do a merge (see bzr help merge) from the other branch, and commit that.
 
675
    After that you will be able to do a push without '--overwrite'.
 
676
 
 
677
    If there is no default push location set, the first push will set it.
 
678
    After that, you can omit the location to use the default.  To change the
 
679
    default, use --remember. The value will only be saved if the remote
 
680
    location can be accessed.
 
681
    """
 
682
 
 
683
    _see_also = ['pull', 'update', 'working-trees']
 
684
    takes_options = ['remember', 'overwrite', 'verbose',
 
685
        Option('create-prefix',
 
686
               help='Create the path leading up to the branch '
 
687
                    'if it does not already exist.'),
 
688
        Option('directory',
 
689
            help='Branch to push from, '
 
690
                 'rather than the one containing the working directory.',
 
691
            short_name='d',
 
692
            type=unicode,
 
693
            ),
 
694
        Option('use-existing-dir',
 
695
               help='By default push will fail if the target'
 
696
                    ' directory exists, but does not already'
 
697
                    ' have a control directory.  This flag will'
 
698
                    ' allow push to proceed.'),
 
699
        ]
 
700
    takes_args = ['location?']
 
701
    encoding_type = 'replace'
 
702
 
 
703
    def run(self, location=None, remember=False, overwrite=False,
 
704
            create_prefix=False, verbose=False,
 
705
            use_existing_dir=False,
 
706
            directory=None):
 
707
        # FIXME: Way too big!  Put this into a function called from the
 
708
        # command.
 
709
        if directory is None:
 
710
            directory = '.'
 
711
        br_from = Branch.open_containing(directory)[0]
 
712
        stored_loc = br_from.get_push_location()
 
713
        if location is None:
 
714
            if stored_loc is None:
 
715
                raise errors.BzrCommandError("No push location known or specified.")
 
716
            else:
 
717
                display_url = urlutils.unescape_for_display(stored_loc,
 
718
                        self.outf.encoding)
 
719
                self.outf.write("Using saved location: %s\n" % display_url)
 
720
                location = stored_loc
 
721
 
 
722
        to_transport = transport.get_transport(location)
 
723
 
 
724
        br_to = repository_to = dir_to = None
 
725
        try:
 
726
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
727
        except errors.NotBranchError:
 
728
            pass # Didn't find anything
 
729
        else:
 
730
            # If we can open a branch, use its direct repository, otherwise see
 
731
            # if there is a repository without a branch.
 
732
            try:
 
733
                br_to = dir_to.open_branch()
 
734
            except errors.NotBranchError:
 
735
                # Didn't find a branch, can we find a repository?
 
736
                try:
 
737
                    repository_to = dir_to.find_repository()
 
738
                except errors.NoRepositoryPresent:
 
739
                    pass
 
740
            else:
 
741
                # Found a branch, so we must have found a repository
 
742
                repository_to = br_to.repository
 
743
        push_result = None
 
744
        if verbose:
 
745
            old_rh = []
 
746
        if dir_to is None:
 
747
            # The destination doesn't exist; create it.
 
748
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
749
            #      common helper function
 
750
            try:
 
751
                to_transport.mkdir('.')
 
752
            except errors.FileExists:
 
753
                if not use_existing_dir:
 
754
                    raise errors.BzrCommandError("Target directory %s"
 
755
                         " already exists, but does not have a valid .bzr"
 
756
                         " directory. Supply --use-existing-dir to push"
 
757
                         " there anyway." % location)
 
758
            except errors.NoSuchFile:
 
759
                if not create_prefix:
 
760
                    raise errors.BzrCommandError("Parent directory of %s"
 
761
                        " does not exist."
 
762
                        "\nYou may supply --create-prefix to create all"
 
763
                        " leading parent directories."
 
764
                        % location)
 
765
                _create_prefix(to_transport)
 
766
 
 
767
            # Now the target directory exists, but doesn't have a .bzr
 
768
            # directory. So we need to create it, along with any work to create
 
769
            # all of the dependent branches, etc.
 
770
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
771
                revision_id=br_from.last_revision())
 
772
            br_to = dir_to.open_branch()
 
773
            # TODO: Some more useful message about what was copied
 
774
            note('Created new branch.')
 
775
            # We successfully created the target, remember it
 
776
            if br_from.get_push_location() is None or remember:
 
777
                br_from.set_push_location(br_to.base)
 
778
        elif repository_to is None:
 
779
            # we have a bzrdir but no branch or repository
 
780
            # XXX: Figure out what to do other than complain.
 
781
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
782
                " directory, but not a branch or repository. This is an"
 
783
                " unsupported configuration. Please move the target directory"
 
784
                " out of the way and try again."
 
785
                % location)
 
786
        elif br_to is None:
 
787
            # We have a repository but no branch, copy the revisions, and then
 
788
            # create a branch.
 
789
            last_revision_id = br_from.last_revision()
 
790
            repository_to.fetch(br_from.repository,
 
791
                                revision_id=last_revision_id)
 
792
            br_to = br_from.clone(dir_to, revision_id=last_revision_id)
 
793
            note('Created new branch.')
 
794
            if br_from.get_push_location() is None or remember:
 
795
                br_from.set_push_location(br_to.base)
 
796
        else: # We have a valid to branch
 
797
            # We were able to connect to the remote location, so remember it
 
798
            # we don't need to successfully push because of possible divergence.
 
799
            if br_from.get_push_location() is None or remember:
 
800
                br_from.set_push_location(br_to.base)
 
801
            if verbose:
 
802
                old_rh = br_to.revision_history()
 
803
            try:
 
804
                try:
 
805
                    tree_to = dir_to.open_workingtree()
 
806
                except errors.NotLocalUrl:
 
807
                    warning("This transport does not update the working " 
 
808
                            "tree of: %s. See 'bzr help working-trees' for "
 
809
                            "more information." % br_to.base)
 
810
                    push_result = br_from.push(br_to, overwrite)
 
811
                except errors.NoWorkingTree:
 
812
                    push_result = br_from.push(br_to, overwrite)
 
813
                else:
 
814
                    tree_to.lock_write()
 
815
                    try:
 
816
                        push_result = br_from.push(tree_to.branch, overwrite)
 
817
                        tree_to.update()
 
818
                    finally:
 
819
                        tree_to.unlock()
 
820
            except errors.DivergedBranches:
 
821
                raise errors.BzrCommandError('These branches have diverged.'
 
822
                                        '  Try using "merge" and then "push".')
 
823
        if push_result is not None:
 
824
            push_result.report(self.outf)
 
825
        elif verbose:
 
826
            new_rh = br_to.revision_history()
 
827
            if old_rh != new_rh:
 
828
                # Something changed
 
829
                from bzrlib.log import show_changed_revisions
 
830
                show_changed_revisions(br_to, old_rh, new_rh,
 
831
                                       to_file=self.outf)
 
832
        else:
 
833
            # we probably did a clone rather than a push, so a message was
 
834
            # emitted above
 
835
            pass
 
836
 
 
837
 
 
838
class cmd_branch(Command):
 
839
    """Create a new copy of a branch.
 
840
 
 
841
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
842
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
843
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
844
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
845
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
846
    create ./foo-bar.
 
847
 
 
848
    To retrieve the branch as of a particular revision, supply the --revision
 
849
    parameter, as in "branch foo/bar -r 5".
 
850
    """
 
851
 
 
852
    _see_also = ['checkout']
 
853
    takes_args = ['from_location', 'to_location?']
 
854
    takes_options = ['revision']
 
855
    aliases = ['get', 'clone']
 
856
 
 
857
    def run(self, from_location, to_location=None, revision=None):
 
858
        from bzrlib.tag import _merge_tags_if_possible
 
859
        if revision is None:
 
860
            revision = [None]
 
861
        elif len(revision) > 1:
 
862
            raise errors.BzrCommandError(
 
863
                'bzr branch --revision takes exactly 1 revision value')
 
864
 
 
865
        br_from = Branch.open(from_location)
 
866
        br_from.lock_read()
 
867
        try:
 
868
            if len(revision) == 1 and revision[0] is not None:
 
869
                revision_id = revision[0].in_history(br_from)[1]
 
870
            else:
 
871
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
872
                # None or perhaps NULL_REVISION to mean copy nothing
 
873
                # RBC 20060209
 
874
                revision_id = br_from.last_revision()
 
875
            if to_location is None:
 
876
                to_location = urlutils.derive_to_location(from_location)
 
877
                name = None
 
878
            else:
 
879
                name = os.path.basename(to_location) + '\n'
 
880
 
 
881
            to_transport = transport.get_transport(to_location)
 
882
            try:
 
883
                to_transport.mkdir('.')
 
884
            except errors.FileExists:
 
885
                raise errors.BzrCommandError('Target directory "%s" already'
 
886
                                             ' exists.' % to_location)
 
887
            except errors.NoSuchFile:
 
888
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
889
                                             % to_location)
 
890
            try:
 
891
                # preserve whatever source format we have.
 
892
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
893
                                            possible_transports=[to_transport])
 
894
                branch = dir.open_branch()
 
895
            except errors.NoSuchRevision:
 
896
                to_transport.delete_tree('.')
 
897
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
898
                raise errors.BzrCommandError(msg)
 
899
            if name:
 
900
                branch.control_files.put_utf8('branch-name', name)
 
901
            _merge_tags_if_possible(br_from, branch)
 
902
            note('Branched %d revision(s).' % branch.revno())
 
903
        finally:
 
904
            br_from.unlock()
 
905
 
 
906
 
 
907
class cmd_checkout(Command):
 
908
    """Create a new checkout of an existing branch.
 
909
 
 
910
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
911
    the branch found in '.'. This is useful if you have removed the working tree
 
912
    or if it was never created - i.e. if you pushed the branch to its current
 
913
    location using SFTP.
 
914
    
 
915
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
916
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
917
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
918
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
919
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
920
    create ./foo-bar.
 
921
 
 
922
    To retrieve the branch as of a particular revision, supply the --revision
 
923
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
924
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
925
    code.)
 
926
    """
 
927
 
 
928
    _see_also = ['checkouts', 'branch']
 
929
    takes_args = ['branch_location?', 'to_location?']
 
930
    takes_options = ['revision',
 
931
                     Option('lightweight',
 
932
                            help="Perform a lightweight checkout.  Lightweight "
 
933
                                 "checkouts depend on access to the branch for "
 
934
                                 "every operation.  Normal checkouts can perform "
 
935
                                 "common operations like diff and status without "
 
936
                                 "such access, and also support local commits."
 
937
                            ),
 
938
                     ]
 
939
    aliases = ['co']
 
940
 
 
941
    def run(self, branch_location=None, to_location=None, revision=None,
 
942
            lightweight=False):
 
943
        if revision is None:
 
944
            revision = [None]
 
945
        elif len(revision) > 1:
 
946
            raise errors.BzrCommandError(
 
947
                'bzr checkout --revision takes exactly 1 revision value')
 
948
        if branch_location is None:
 
949
            branch_location = osutils.getcwd()
 
950
            to_location = branch_location
 
951
        source = Branch.open(branch_location)
 
952
        if len(revision) == 1 and revision[0] is not None:
 
953
            revision_id = _mod_revision.ensure_null(
 
954
                revision[0].in_history(source)[1])
 
955
        else:
 
956
            revision_id = None
 
957
        if to_location is None:
 
958
            to_location = urlutils.derive_to_location(branch_location)
 
959
        # if the source and to_location are the same, 
 
960
        # and there is no working tree,
 
961
        # then reconstitute a branch
 
962
        if (osutils.abspath(to_location) ==
 
963
            osutils.abspath(branch_location)):
 
964
            try:
 
965
                source.bzrdir.open_workingtree()
 
966
            except errors.NoWorkingTree:
 
967
                source.bzrdir.create_workingtree(revision_id)
 
968
                return
 
969
        source.create_checkout(to_location, revision_id, lightweight)
 
970
 
 
971
 
 
972
class cmd_renames(Command):
 
973
    """Show list of renamed files.
 
974
    """
 
975
    # TODO: Option to show renames between two historical versions.
 
976
 
 
977
    # TODO: Only show renames under dir, rather than in the whole branch.
 
978
    _see_also = ['status']
 
979
    takes_args = ['dir?']
 
980
 
 
981
    @display_command
 
982
    def run(self, dir=u'.'):
 
983
        tree = WorkingTree.open_containing(dir)[0]
 
984
        tree.lock_read()
 
985
        try:
 
986
            new_inv = tree.inventory
 
987
            old_tree = tree.basis_tree()
 
988
            old_tree.lock_read()
 
989
            try:
 
990
                old_inv = old_tree.inventory
 
991
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
992
                renames.sort()
 
993
                for old_name, new_name in renames:
 
994
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
995
            finally:
 
996
                old_tree.unlock()
 
997
        finally:
 
998
            tree.unlock()
 
999
 
 
1000
 
 
1001
class cmd_update(Command):
 
1002
    """Update a tree to have the latest code committed to its branch.
 
1003
    
 
1004
    This will perform a merge into the working tree, and may generate
 
1005
    conflicts. If you have any local changes, you will still 
 
1006
    need to commit them after the update for the update to be complete.
 
1007
    
 
1008
    If you want to discard your local changes, you can just do a 
 
1009
    'bzr revert' instead of 'bzr commit' after the update.
 
1010
    """
 
1011
 
 
1012
    _see_also = ['pull', 'working-trees', 'status-flags']
 
1013
    takes_args = ['dir?']
 
1014
    aliases = ['up']
 
1015
 
 
1016
    def run(self, dir='.'):
 
1017
        tree = WorkingTree.open_containing(dir)[0]
 
1018
        possible_transports = []
 
1019
        master = tree.branch.get_master_branch(
 
1020
            possible_transports=possible_transports)
 
1021
        if master is not None:
 
1022
            tree.lock_write()
 
1023
        else:
 
1024
            tree.lock_tree_write()
 
1025
        try:
 
1026
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1027
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1028
            if last_rev == _mod_revision.ensure_null(
 
1029
                tree.branch.last_revision()):
 
1030
                # may be up to date, check master too.
 
1031
                if master is None or last_rev == _mod_revision.ensure_null(
 
1032
                    master.last_revision()):
 
1033
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1034
                    note("Tree is up to date at revision %d." % (revno,))
 
1035
                    return 0
 
1036
            conflicts = tree.update(
 
1037
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1038
                possible_transports=possible_transports)
 
1039
            revno = tree.branch.revision_id_to_revno(
 
1040
                _mod_revision.ensure_null(tree.last_revision()))
 
1041
            note('Updated to revision %d.' % (revno,))
 
1042
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1043
                note('Your local commits will now show as pending merges with '
 
1044
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1045
            if conflicts != 0:
 
1046
                return 1
 
1047
            else:
 
1048
                return 0
 
1049
        finally:
 
1050
            tree.unlock()
 
1051
 
 
1052
 
 
1053
class cmd_info(Command):
 
1054
    """Show information about a working tree, branch or repository.
 
1055
 
 
1056
    This command will show all known locations and formats associated to the
 
1057
    tree, branch or repository.  Statistical information is included with
 
1058
    each report.
 
1059
 
 
1060
    Branches and working trees will also report any missing revisions.
 
1061
    """
 
1062
    _see_also = ['revno', 'working-trees', 'repositories']
 
1063
    takes_args = ['location?']
 
1064
    takes_options = ['verbose']
 
1065
 
 
1066
    @display_command
 
1067
    def run(self, location=None, verbose=False):
 
1068
        if verbose:
 
1069
            noise_level = 2
 
1070
        else:
 
1071
            noise_level = 0
 
1072
        from bzrlib.info import show_bzrdir_info
 
1073
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1074
                         verbose=noise_level)
 
1075
 
 
1076
 
 
1077
class cmd_remove(Command):
 
1078
    """Remove files or directories.
 
1079
 
 
1080
    This makes bzr stop tracking changes to the specified files and
 
1081
    delete them if they can easily be recovered using revert.
 
1082
 
 
1083
    You can specify one or more files, and/or --new.  If you specify --new,
 
1084
    only 'added' files will be removed.  If you specify both, then new files
 
1085
    in the specified directories will be removed.  If the directories are
 
1086
    also new, they will also be removed.
 
1087
    """
 
1088
    takes_args = ['file*']
 
1089
    takes_options = ['verbose',
 
1090
        Option('new', help='Remove newly-added files.'),
 
1091
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1092
            'The file deletion mode to be used.',
 
1093
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1094
            safe='Only delete files if they can be'
 
1095
                 ' safely recovered (default).',
 
1096
            keep="Don't delete any files.",
 
1097
            force='Delete all the specified files, even if they can not be '
 
1098
                'recovered and even if they are non-empty directories.')]
 
1099
    aliases = ['rm']
 
1100
    encoding_type = 'replace'
 
1101
 
 
1102
    def run(self, file_list, verbose=False, new=False,
 
1103
        file_deletion_strategy='safe'):
 
1104
        tree, file_list = tree_files(file_list)
 
1105
 
 
1106
        if file_list is not None:
 
1107
            file_list = [f for f in file_list]
 
1108
        elif not new:
 
1109
            raise errors.BzrCommandError('Specify one or more files to'
 
1110
            ' remove, or use --new.')
 
1111
 
 
1112
        if new:
 
1113
            added = tree.changes_from(tree.basis_tree(),
 
1114
                specific_files=file_list).added
 
1115
            file_list = sorted([f[0] for f in added], reverse=True)
 
1116
            if len(file_list) == 0:
 
1117
                raise errors.BzrCommandError('No matching files.')
 
1118
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1119
            keep_files=file_deletion_strategy=='keep',
 
1120
            force=file_deletion_strategy=='force')
 
1121
 
 
1122
 
 
1123
class cmd_file_id(Command):
 
1124
    """Print file_id of a particular file or directory.
 
1125
 
 
1126
    The file_id is assigned when the file is first added and remains the
 
1127
    same through all revisions where the file exists, even when it is
 
1128
    moved or renamed.
 
1129
    """
 
1130
 
 
1131
    hidden = True
 
1132
    _see_also = ['inventory', 'ls']
 
1133
    takes_args = ['filename']
 
1134
 
 
1135
    @display_command
 
1136
    def run(self, filename):
 
1137
        tree, relpath = WorkingTree.open_containing(filename)
 
1138
        i = tree.path2id(relpath)
 
1139
        if i is None:
 
1140
            raise errors.NotVersionedError(filename)
 
1141
        else:
 
1142
            self.outf.write(i + '\n')
 
1143
 
 
1144
 
 
1145
class cmd_file_path(Command):
 
1146
    """Print path of file_ids to a file or directory.
 
1147
 
 
1148
    This prints one line for each directory down to the target,
 
1149
    starting at the branch root.
 
1150
    """
 
1151
 
 
1152
    hidden = True
 
1153
    takes_args = ['filename']
 
1154
 
 
1155
    @display_command
 
1156
    def run(self, filename):
 
1157
        tree, relpath = WorkingTree.open_containing(filename)
 
1158
        fid = tree.path2id(relpath)
 
1159
        if fid is None:
 
1160
            raise errors.NotVersionedError(filename)
 
1161
        segments = osutils.splitpath(relpath)
 
1162
        for pos in range(1, len(segments) + 1):
 
1163
            path = osutils.joinpath(segments[:pos])
 
1164
            self.outf.write("%s\n" % tree.path2id(path))
 
1165
 
 
1166
 
 
1167
class cmd_reconcile(Command):
 
1168
    """Reconcile bzr metadata in a branch.
 
1169
 
 
1170
    This can correct data mismatches that may have been caused by
 
1171
    previous ghost operations or bzr upgrades. You should only
 
1172
    need to run this command if 'bzr check' or a bzr developer 
 
1173
    advises you to run it.
 
1174
 
 
1175
    If a second branch is provided, cross-branch reconciliation is
 
1176
    also attempted, which will check that data like the tree root
 
1177
    id which was not present in very early bzr versions is represented
 
1178
    correctly in both branches.
 
1179
 
 
1180
    At the same time it is run it may recompress data resulting in 
 
1181
    a potential saving in disk space or performance gain.
 
1182
 
 
1183
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1184
    """
 
1185
 
 
1186
    _see_also = ['check']
 
1187
    takes_args = ['branch?']
 
1188
 
 
1189
    def run(self, branch="."):
 
1190
        from bzrlib.reconcile import reconcile
 
1191
        dir = bzrdir.BzrDir.open(branch)
 
1192
        reconcile(dir)
 
1193
 
 
1194
 
 
1195
class cmd_revision_history(Command):
 
1196
    """Display the list of revision ids on a branch."""
 
1197
 
 
1198
    _see_also = ['log']
 
1199
    takes_args = ['location?']
 
1200
 
 
1201
    hidden = True
 
1202
 
 
1203
    @display_command
 
1204
    def run(self, location="."):
 
1205
        branch = Branch.open_containing(location)[0]
 
1206
        for revid in branch.revision_history():
 
1207
            self.outf.write(revid)
 
1208
            self.outf.write('\n')
 
1209
 
 
1210
 
 
1211
class cmd_ancestry(Command):
 
1212
    """List all revisions merged into this branch."""
 
1213
 
 
1214
    _see_also = ['log', 'revision-history']
 
1215
    takes_args = ['location?']
 
1216
 
 
1217
    hidden = True
 
1218
 
 
1219
    @display_command
 
1220
    def run(self, location="."):
 
1221
        try:
 
1222
            wt = WorkingTree.open_containing(location)[0]
 
1223
        except errors.NoWorkingTree:
 
1224
            b = Branch.open(location)
 
1225
            last_revision = b.last_revision()
 
1226
        else:
 
1227
            b = wt.branch
 
1228
            last_revision = wt.last_revision()
 
1229
 
 
1230
        revision_ids = b.repository.get_ancestry(last_revision)
 
1231
        assert revision_ids[0] is None
 
1232
        revision_ids.pop(0)
 
1233
        for revision_id in revision_ids:
 
1234
            self.outf.write(revision_id + '\n')
 
1235
 
 
1236
 
 
1237
class cmd_init(Command):
 
1238
    """Make a directory into a versioned branch.
 
1239
 
 
1240
    Use this to create an empty branch, or before importing an
 
1241
    existing project.
 
1242
 
 
1243
    If there is a repository in a parent directory of the location, then 
 
1244
    the history of the branch will be stored in the repository.  Otherwise
 
1245
    init creates a standalone branch which carries its own history
 
1246
    in the .bzr directory.
 
1247
 
 
1248
    If there is already a branch at the location but it has no working tree,
 
1249
    the tree can be populated with 'bzr checkout'.
 
1250
 
 
1251
    Recipe for importing a tree of files::
 
1252
 
 
1253
        cd ~/project
 
1254
        bzr init
 
1255
        bzr add .
 
1256
        bzr status
 
1257
        bzr commit -m 'imported project'
 
1258
    """
 
1259
 
 
1260
    _see_also = ['init-repository', 'branch', 'checkout']
 
1261
    takes_args = ['location?']
 
1262
    takes_options = [
 
1263
        Option('create-prefix',
 
1264
               help='Create the path leading up to the branch '
 
1265
                    'if it does not already exist.'),
 
1266
         RegistryOption('format',
 
1267
                help='Specify a format for this branch. '
 
1268
                'See "help formats".',
 
1269
                registry=bzrdir.format_registry,
 
1270
                converter=bzrdir.format_registry.make_bzrdir,
 
1271
                value_switches=True,
 
1272
                title="Branch Format",
 
1273
                ),
 
1274
         Option('append-revisions-only',
 
1275
                help='Never change revnos or the existing log.'
 
1276
                '  Append revisions to it only.')
 
1277
         ]
 
1278
    def run(self, location=None, format=None, append_revisions_only=False,
 
1279
            create_prefix=False):
 
1280
        if format is None:
 
1281
            format = bzrdir.format_registry.make_bzrdir('default')
 
1282
        if location is None:
 
1283
            location = u'.'
 
1284
 
 
1285
        to_transport = transport.get_transport(location)
 
1286
 
 
1287
        # The path has to exist to initialize a
 
1288
        # branch inside of it.
 
1289
        # Just using os.mkdir, since I don't
 
1290
        # believe that we want to create a bunch of
 
1291
        # locations if the user supplies an extended path
 
1292
        try:
 
1293
            to_transport.ensure_base()
 
1294
        except errors.NoSuchFile:
 
1295
            if not create_prefix:
 
1296
                raise errors.BzrCommandError("Parent directory of %s"
 
1297
                    " does not exist."
 
1298
                    "\nYou may supply --create-prefix to create all"
 
1299
                    " leading parent directories."
 
1300
                    % location)
 
1301
            _create_prefix(to_transport)
 
1302
 
 
1303
        try:
 
1304
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1305
        except errors.NotBranchError:
 
1306
            # really a NotBzrDir error...
 
1307
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1308
            branch = create_branch(to_transport.base, format=format,
 
1309
                                   possible_transports=[to_transport])
 
1310
        else:
 
1311
            from bzrlib.transport.local import LocalTransport
 
1312
            if existing_bzrdir.has_branch():
 
1313
                if (isinstance(to_transport, LocalTransport)
 
1314
                    and not existing_bzrdir.has_workingtree()):
 
1315
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
1316
                raise errors.AlreadyBranchError(location)
 
1317
            else:
 
1318
                branch = existing_bzrdir.create_branch()
 
1319
                existing_bzrdir.create_workingtree()
 
1320
        if append_revisions_only:
 
1321
            try:
 
1322
                branch.set_append_revisions_only(True)
 
1323
            except errors.UpgradeRequired:
 
1324
                raise errors.BzrCommandError('This branch format cannot be set'
 
1325
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1326
 
 
1327
 
 
1328
class cmd_init_repository(Command):
 
1329
    """Create a shared repository to hold branches.
 
1330
 
 
1331
    New branches created under the repository directory will store their
 
1332
    revisions in the repository, not in the branch directory.
 
1333
 
 
1334
    If the --no-trees option is used then the branches in the repository
 
1335
    will not have working trees by default.
 
1336
 
 
1337
    :Examples:
 
1338
        Create a shared repositories holding just branches::
 
1339
 
 
1340
            bzr init-repo --no-trees repo
 
1341
            bzr init repo/trunk
 
1342
 
 
1343
        Make a lightweight checkout elsewhere::
 
1344
 
 
1345
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1346
            cd trunk-checkout
 
1347
            (add files here)
 
1348
    """
 
1349
 
 
1350
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
1351
    takes_args = ["location"]
 
1352
    takes_options = [RegistryOption('format',
 
1353
                            help='Specify a format for this repository. See'
 
1354
                                 ' "bzr help formats" for details.',
 
1355
                            registry=bzrdir.format_registry,
 
1356
                            converter=bzrdir.format_registry.make_bzrdir,
 
1357
                            value_switches=True, title='Repository format'),
 
1358
                     Option('no-trees',
 
1359
                             help='Branches in the repository will default to'
 
1360
                                  ' not having a working tree.'),
 
1361
                    ]
 
1362
    aliases = ["init-repo"]
 
1363
 
 
1364
    def run(self, location, format=None, no_trees=False):
 
1365
        if format is None:
 
1366
            format = bzrdir.format_registry.make_bzrdir('default')
 
1367
 
 
1368
        if location is None:
 
1369
            location = '.'
 
1370
 
 
1371
        to_transport = transport.get_transport(location)
 
1372
        to_transport.ensure_base()
 
1373
 
 
1374
        newdir = format.initialize_on_transport(to_transport)
 
1375
        repo = newdir.create_repository(shared=True)
 
1376
        repo.set_make_working_trees(not no_trees)
 
1377
 
 
1378
 
 
1379
class cmd_diff(Command):
 
1380
    """Show differences in the working tree or between revisions.
 
1381
    
 
1382
    If files are listed, only the changes in those files are listed.
 
1383
    Otherwise, all changes for the tree are listed.
 
1384
 
 
1385
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1386
    produces patches suitable for "patch -p1".
 
1387
 
 
1388
    :Exit values:
 
1389
        1 - changed
 
1390
        2 - unrepresentable changes
 
1391
        3 - error
 
1392
        0 - no change
 
1393
 
 
1394
    :Examples:
 
1395
        Shows the difference in the working tree versus the last commit::
 
1396
 
 
1397
            bzr diff
 
1398
 
 
1399
        Difference between the working tree and revision 1::
 
1400
 
 
1401
            bzr diff -r1
 
1402
 
 
1403
        Difference between revision 2 and revision 1::
 
1404
 
 
1405
            bzr diff -r1..2
 
1406
 
 
1407
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1408
 
 
1409
            bzr diff --prefix old/:new/
 
1410
 
 
1411
        Show the differences between the two working trees::
 
1412
 
 
1413
            bzr diff bzr.mine bzr.dev
 
1414
 
 
1415
        Show just the differences for 'foo.c'::
 
1416
 
 
1417
            bzr diff foo.c
 
1418
    """
 
1419
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
1420
    #       or a graphical diff.
 
1421
 
 
1422
    # TODO: Python difflib is not exactly the same as unidiff; should
 
1423
    #       either fix it up or prefer to use an external diff.
 
1424
 
 
1425
    # TODO: Selected-file diff is inefficient and doesn't show you
 
1426
    #       deleted files.
 
1427
 
 
1428
    # TODO: This probably handles non-Unix newlines poorly.
 
1429
 
 
1430
    _see_also = ['status']
 
1431
    takes_args = ['file*']
 
1432
    takes_options = [
 
1433
        Option('diff-options', type=str,
 
1434
               help='Pass these options to the external diff program.'),
 
1435
        Option('prefix', type=str,
 
1436
               short_name='p',
 
1437
               help='Set prefixes added to old and new filenames, as '
 
1438
                    'two values separated by a colon. (eg "old/:new/").'),
 
1439
        'revision',
 
1440
        'change',
 
1441
        ]
 
1442
    aliases = ['di', 'dif']
 
1443
    encoding_type = 'exact'
 
1444
 
 
1445
    @display_command
 
1446
    def run(self, revision=None, file_list=None, diff_options=None,
 
1447
            prefix=None):
 
1448
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
1449
 
 
1450
        if (prefix is None) or (prefix == '0'):
 
1451
            # diff -p0 format
 
1452
            old_label = ''
 
1453
            new_label = ''
 
1454
        elif prefix == '1':
 
1455
            old_label = 'old/'
 
1456
            new_label = 'new/'
 
1457
        elif ':' in prefix:
 
1458
            old_label, new_label = prefix.split(":")
 
1459
        else:
 
1460
            raise errors.BzrCommandError(
 
1461
                '--prefix expects two values separated by a colon'
 
1462
                ' (eg "old/:new/")')
 
1463
 
 
1464
        if revision and len(revision) > 2:
 
1465
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1466
                                         ' one or two revision specifiers')
 
1467
 
 
1468
        try:
 
1469
            tree1, file_list = internal_tree_files(file_list)
 
1470
            tree2 = None
 
1471
            b = None
 
1472
            b2 = None
 
1473
        except errors.FileInWrongBranch:
 
1474
            if len(file_list) != 2:
 
1475
                raise errors.BzrCommandError("Files are in different branches")
 
1476
 
 
1477
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
1478
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
1479
            if file1 != "" or file2 != "":
 
1480
                # FIXME diff those two files. rbc 20051123
 
1481
                raise errors.BzrCommandError("Files are in different branches")
 
1482
            file_list = None
 
1483
        except errors.NotBranchError:
 
1484
            if (revision is not None and len(revision) == 2
 
1485
                and not revision[0].needs_branch()
 
1486
                and not revision[1].needs_branch()):
 
1487
                # If both revision specs include a branch, we can
 
1488
                # diff them without needing a local working tree
 
1489
                tree1, tree2 = None, None
 
1490
            else:
 
1491
                raise
 
1492
 
 
1493
        if tree2 is not None:
 
1494
            if revision is not None:
 
1495
                # FIXME: but there should be a clean way to diff between
 
1496
                # non-default versions of two trees, it's not hard to do
 
1497
                # internally...
 
1498
                raise errors.BzrCommandError(
 
1499
                        "Sorry, diffing arbitrary revisions across branches "
 
1500
                        "is not implemented yet")
 
1501
            return show_diff_trees(tree1, tree2, sys.stdout, 
 
1502
                                   specific_files=file_list,
 
1503
                                   external_diff_options=diff_options,
 
1504
                                   old_label=old_label, new_label=new_label)
 
1505
 
 
1506
        return diff_cmd_helper(tree1, file_list, diff_options,
 
1507
                               revision_specs=revision,
 
1508
                               old_label=old_label, new_label=new_label)
 
1509
 
 
1510
 
 
1511
class cmd_deleted(Command):
 
1512
    """List files deleted in the working tree.
 
1513
    """
 
1514
    # TODO: Show files deleted since a previous revision, or
 
1515
    # between two revisions.
 
1516
    # TODO: Much more efficient way to do this: read in new
 
1517
    # directories with readdir, rather than stating each one.  Same
 
1518
    # level of effort but possibly much less IO.  (Or possibly not,
 
1519
    # if the directories are very large...)
 
1520
    _see_also = ['status', 'ls']
 
1521
    takes_options = ['show-ids']
 
1522
 
 
1523
    @display_command
 
1524
    def run(self, show_ids=False):
 
1525
        tree = WorkingTree.open_containing(u'.')[0]
 
1526
        tree.lock_read()
 
1527
        try:
 
1528
            old = tree.basis_tree()
 
1529
            old.lock_read()
 
1530
            try:
 
1531
                for path, ie in old.inventory.iter_entries():
 
1532
                    if not tree.has_id(ie.file_id):
 
1533
                        self.outf.write(path)
 
1534
                        if show_ids:
 
1535
                            self.outf.write(' ')
 
1536
                            self.outf.write(ie.file_id)
 
1537
                        self.outf.write('\n')
 
1538
            finally:
 
1539
                old.unlock()
 
1540
        finally:
 
1541
            tree.unlock()
 
1542
 
 
1543
 
 
1544
class cmd_modified(Command):
 
1545
    """List files modified in working tree.
 
1546
    """
 
1547
 
 
1548
    hidden = True
 
1549
    _see_also = ['status', 'ls']
 
1550
 
 
1551
    @display_command
 
1552
    def run(self):
 
1553
        tree = WorkingTree.open_containing(u'.')[0]
 
1554
        td = tree.changes_from(tree.basis_tree())
 
1555
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1556
            self.outf.write(path + '\n')
 
1557
 
 
1558
 
 
1559
class cmd_added(Command):
 
1560
    """List files added in working tree.
 
1561
    """
 
1562
 
 
1563
    hidden = True
 
1564
    _see_also = ['status', 'ls']
 
1565
 
 
1566
    @display_command
 
1567
    def run(self):
 
1568
        wt = WorkingTree.open_containing(u'.')[0]
 
1569
        wt.lock_read()
 
1570
        try:
 
1571
            basis = wt.basis_tree()
 
1572
            basis.lock_read()
 
1573
            try:
 
1574
                basis_inv = basis.inventory
 
1575
                inv = wt.inventory
 
1576
                for file_id in inv:
 
1577
                    if file_id in basis_inv:
 
1578
                        continue
 
1579
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1580
                        continue
 
1581
                    path = inv.id2path(file_id)
 
1582
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1583
                        continue
 
1584
                    self.outf.write(path + '\n')
 
1585
            finally:
 
1586
                basis.unlock()
 
1587
        finally:
 
1588
            wt.unlock()
 
1589
 
 
1590
 
 
1591
class cmd_root(Command):
 
1592
    """Show the tree root directory.
 
1593
 
 
1594
    The root is the nearest enclosing directory with a .bzr control
 
1595
    directory."""
 
1596
 
 
1597
    takes_args = ['filename?']
 
1598
    @display_command
 
1599
    def run(self, filename=None):
 
1600
        """Print the branch root."""
 
1601
        tree = WorkingTree.open_containing(filename)[0]
 
1602
        self.outf.write(tree.basedir + '\n')
 
1603
 
 
1604
 
 
1605
def _parse_limit(limitstring):
 
1606
    try:
 
1607
        return int(limitstring)
 
1608
    except ValueError:
 
1609
        msg = "The limit argument must be an integer."
 
1610
        raise errors.BzrCommandError(msg)
 
1611
 
 
1612
 
 
1613
class cmd_log(Command):
 
1614
    """Show log of a branch, file, or directory.
 
1615
 
 
1616
    By default show the log of the branch containing the working directory.
 
1617
 
 
1618
    To request a range of logs, you can use the command -r begin..end
 
1619
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1620
    also valid.
 
1621
 
 
1622
    :Examples:
 
1623
        Log the current branch::
 
1624
 
 
1625
            bzr log
 
1626
 
 
1627
        Log a file::
 
1628
 
 
1629
            bzr log foo.c
 
1630
 
 
1631
        Log the last 10 revisions of a branch::
 
1632
 
 
1633
            bzr log -r -10.. http://server/branch
 
1634
    """
 
1635
 
 
1636
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1637
 
 
1638
    takes_args = ['location?']
 
1639
    takes_options = [
 
1640
            Option('forward',
 
1641
                   help='Show from oldest to newest.'),
 
1642
            Option('timezone',
 
1643
                   type=str,
 
1644
                   help='Display timezone as local, original, or utc.'),
 
1645
            custom_help('verbose',
 
1646
                   help='Show files changed in each revision.'),
 
1647
            'show-ids',
 
1648
            'revision',
 
1649
            'log-format',
 
1650
            Option('message',
 
1651
                   short_name='m',
 
1652
                   help='Show revisions whose message matches this '
 
1653
                        'regular expression.',
 
1654
                   type=str),
 
1655
            Option('limit',
 
1656
                   help='Limit the output to the first N revisions.',
 
1657
                   argname='N',
 
1658
                   type=_parse_limit),
 
1659
            ]
 
1660
    encoding_type = 'replace'
 
1661
 
 
1662
    @display_command
 
1663
    def run(self, location=None, timezone='original',
 
1664
            verbose=False,
 
1665
            show_ids=False,
 
1666
            forward=False,
 
1667
            revision=None,
 
1668
            log_format=None,
 
1669
            message=None,
 
1670
            limit=None):
 
1671
        from bzrlib.log import show_log
 
1672
        assert message is None or isinstance(message, basestring), \
 
1673
            "invalid message argument %r" % message
 
1674
        direction = (forward and 'forward') or 'reverse'
 
1675
        
 
1676
        # log everything
 
1677
        file_id = None
 
1678
        if location:
 
1679
            # find the file id to log:
 
1680
 
 
1681
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1682
                location)
 
1683
            if fp != '':
 
1684
                if tree is None:
 
1685
                    tree = b.basis_tree()
 
1686
                file_id = tree.path2id(fp)
 
1687
                if file_id is None:
 
1688
                    raise errors.BzrCommandError(
 
1689
                        "Path does not have any revision history: %s" %
 
1690
                        location)
 
1691
        else:
 
1692
            # local dir only
 
1693
            # FIXME ? log the current subdir only RBC 20060203 
 
1694
            if revision is not None \
 
1695
                    and len(revision) > 0 and revision[0].get_branch():
 
1696
                location = revision[0].get_branch()
 
1697
            else:
 
1698
                location = '.'
 
1699
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
1700
            b = dir.open_branch()
 
1701
 
 
1702
        b.lock_read()
 
1703
        try:
 
1704
            if revision is None:
 
1705
                rev1 = None
 
1706
                rev2 = None
 
1707
            elif len(revision) == 1:
 
1708
                rev1 = rev2 = revision[0].in_history(b)
 
1709
            elif len(revision) == 2:
 
1710
                if revision[1].get_branch() != revision[0].get_branch():
 
1711
                    # b is taken from revision[0].get_branch(), and
 
1712
                    # show_log will use its revision_history. Having
 
1713
                    # different branches will lead to weird behaviors.
 
1714
                    raise errors.BzrCommandError(
 
1715
                        "Log doesn't accept two revisions in different"
 
1716
                        " branches.")
 
1717
                rev1 = revision[0].in_history(b)
 
1718
                rev2 = revision[1].in_history(b)
 
1719
            else:
 
1720
                raise errors.BzrCommandError(
 
1721
                    'bzr log --revision takes one or two values.')
 
1722
 
 
1723
            if log_format is None:
 
1724
                log_format = log.log_formatter_registry.get_default(b)
 
1725
 
 
1726
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1727
                            show_timezone=timezone)
 
1728
 
 
1729
            show_log(b,
 
1730
                     lf,
 
1731
                     file_id,
 
1732
                     verbose=verbose,
 
1733
                     direction=direction,
 
1734
                     start_revision=rev1,
 
1735
                     end_revision=rev2,
 
1736
                     search=message,
 
1737
                     limit=limit)
 
1738
        finally:
 
1739
            b.unlock()
 
1740
 
 
1741
 
 
1742
def get_log_format(long=False, short=False, line=False, default='long'):
 
1743
    log_format = default
 
1744
    if long:
 
1745
        log_format = 'long'
 
1746
    if short:
 
1747
        log_format = 'short'
 
1748
    if line:
 
1749
        log_format = 'line'
 
1750
    return log_format
 
1751
 
 
1752
 
 
1753
class cmd_touching_revisions(Command):
 
1754
    """Return revision-ids which affected a particular file.
 
1755
 
 
1756
    A more user-friendly interface is "bzr log FILE".
 
1757
    """
 
1758
 
 
1759
    hidden = True
 
1760
    takes_args = ["filename"]
 
1761
 
 
1762
    @display_command
 
1763
    def run(self, filename):
 
1764
        tree, relpath = WorkingTree.open_containing(filename)
 
1765
        b = tree.branch
 
1766
        file_id = tree.path2id(relpath)
 
1767
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
1768
            self.outf.write("%6d %s\n" % (revno, what))
 
1769
 
 
1770
 
 
1771
class cmd_ls(Command):
 
1772
    """List files in a tree.
 
1773
    """
 
1774
 
 
1775
    _see_also = ['status', 'cat']
 
1776
    takes_args = ['path?']
 
1777
    # TODO: Take a revision or remote path and list that tree instead.
 
1778
    takes_options = [
 
1779
            'verbose',
 
1780
            'revision',
 
1781
            Option('non-recursive',
 
1782
                   help='Don\'t recurse into subdirectories.'),
 
1783
            Option('from-root',
 
1784
                   help='Print paths relative to the root of the branch.'),
 
1785
            Option('unknown', help='Print unknown files.'),
 
1786
            Option('versioned', help='Print versioned files.'),
 
1787
            Option('ignored', help='Print ignored files.'),
 
1788
            Option('null',
 
1789
                   help='Write an ascii NUL (\\0) separator '
 
1790
                   'between files rather than a newline.'),
 
1791
            Option('kind',
 
1792
                   help='List entries of a particular kind: file, directory, symlink.',
 
1793
                   type=unicode),
 
1794
            'show-ids',
 
1795
            ]
 
1796
    @display_command
 
1797
    def run(self, revision=None, verbose=False,
 
1798
            non_recursive=False, from_root=False,
 
1799
            unknown=False, versioned=False, ignored=False,
 
1800
            null=False, kind=None, show_ids=False, path=None):
 
1801
 
 
1802
        if kind and kind not in ('file', 'directory', 'symlink'):
 
1803
            raise errors.BzrCommandError('invalid kind specified')
 
1804
 
 
1805
        if verbose and null:
 
1806
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
1807
        all = not (unknown or versioned or ignored)
 
1808
 
 
1809
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1810
 
 
1811
        if path is None:
 
1812
            fs_path = '.'
 
1813
            prefix = ''
 
1814
        else:
 
1815
            if from_root:
 
1816
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1817
                                             ' and PATH')
 
1818
            fs_path = path
 
1819
            prefix = path
 
1820
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1821
            fs_path)
 
1822
        if from_root:
 
1823
            relpath = u''
 
1824
        elif relpath:
 
1825
            relpath += '/'
 
1826
        if revision is not None:
 
1827
            tree = branch.repository.revision_tree(
 
1828
                revision[0].in_history(branch).rev_id)
 
1829
        elif tree is None:
 
1830
            tree = branch.basis_tree()
 
1831
 
 
1832
        tree.lock_read()
 
1833
        try:
 
1834
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1835
                if fp.startswith(relpath):
 
1836
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1837
                    if non_recursive and '/' in fp:
 
1838
                        continue
 
1839
                    if not all and not selection[fc]:
 
1840
                        continue
 
1841
                    if kind is not None and fkind != kind:
 
1842
                        continue
 
1843
                    if verbose:
 
1844
                        kindch = entry.kind_character()
 
1845
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1846
                        if show_ids and fid is not None:
 
1847
                            outstring = "%-50s %s" % (outstring, fid)
 
1848
                        self.outf.write(outstring + '\n')
 
1849
                    elif null:
 
1850
                        self.outf.write(fp + '\0')
 
1851
                        if show_ids:
 
1852
                            if fid is not None:
 
1853
                                self.outf.write(fid)
 
1854
                            self.outf.write('\0')
 
1855
                        self.outf.flush()
 
1856
                    else:
 
1857
                        if fid is not None:
 
1858
                            my_id = fid
 
1859
                        else:
 
1860
                            my_id = ''
 
1861
                        if show_ids:
 
1862
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1863
                        else:
 
1864
                            self.outf.write(fp + '\n')
 
1865
        finally:
 
1866
            tree.unlock()
 
1867
 
 
1868
 
 
1869
class cmd_unknowns(Command):
 
1870
    """List unknown files.
 
1871
    """
 
1872
 
 
1873
    hidden = True
 
1874
    _see_also = ['ls']
 
1875
 
 
1876
    @display_command
 
1877
    def run(self):
 
1878
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1879
            self.outf.write(osutils.quotefn(f) + '\n')
 
1880
 
 
1881
 
 
1882
class cmd_ignore(Command):
 
1883
    """Ignore specified files or patterns.
 
1884
 
 
1885
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1886
 
 
1887
    Trailing slashes on patterns are ignored. 
 
1888
    If the pattern contains a slash or is a regular expression, it is compared 
 
1889
    to the whole path from the branch root.  Otherwise, it is compared to only
 
1890
    the last component of the path.  To match a file only in the root 
 
1891
    directory, prepend './'.
 
1892
 
 
1893
    Ignore patterns specifying absolute paths are not allowed.
 
1894
 
 
1895
    Ignore patterns may include globbing wildcards such as::
 
1896
 
 
1897
      ? - Matches any single character except '/'
 
1898
      * - Matches 0 or more characters except '/'
 
1899
      /**/ - Matches 0 or more directories in a path
 
1900
      [a-z] - Matches a single character from within a group of characters
 
1901
 
 
1902
    Ignore patterns may also be Python regular expressions.  
 
1903
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
1904
    followed by the regular expression.  Regular expression ignore patterns
 
1905
    may not include named or numbered groups.
 
1906
 
 
1907
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1908
    the shell on Unix.
 
1909
 
 
1910
    :Examples:
 
1911
        Ignore the top level Makefile::
 
1912
 
 
1913
            bzr ignore ./Makefile
 
1914
 
 
1915
        Ignore class files in all directories::
 
1916
 
 
1917
            bzr ignore '*.class'
 
1918
 
 
1919
        Ignore .o files under the lib directory::
 
1920
 
 
1921
            bzr ignore 'lib/**/*.o'
 
1922
 
 
1923
        Ignore .o files under the lib directory::
 
1924
 
 
1925
            bzr ignore 'RE:lib/.*\.o'
 
1926
    """
 
1927
 
 
1928
    _see_also = ['status', 'ignored']
 
1929
    takes_args = ['name_pattern*']
 
1930
    takes_options = [
 
1931
        Option('old-default-rules',
 
1932
               help='Write out the ignore rules bzr < 0.9 always used.')
 
1933
        ]
 
1934
    
 
1935
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1936
        from bzrlib.atomicfile import AtomicFile
 
1937
        if old_default_rules is not None:
 
1938
            # dump the rules and exit
 
1939
            for pattern in ignores.OLD_DEFAULTS:
 
1940
                print pattern
 
1941
            return
 
1942
        if not name_pattern_list:
 
1943
            raise errors.BzrCommandError("ignore requires at least one "
 
1944
                                  "NAME_PATTERN or --old-default-rules")
 
1945
        name_pattern_list = [globbing.normalize_pattern(p) 
 
1946
                             for p in name_pattern_list]
 
1947
        for name_pattern in name_pattern_list:
 
1948
            if (name_pattern[0] == '/' or 
 
1949
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
1950
                raise errors.BzrCommandError(
 
1951
                    "NAME_PATTERN should not be an absolute path")
 
1952
        tree, relpath = WorkingTree.open_containing(u'.')
 
1953
        ifn = tree.abspath('.bzrignore')
 
1954
        if os.path.exists(ifn):
 
1955
            f = open(ifn, 'rt')
 
1956
            try:
 
1957
                igns = f.read().decode('utf-8')
 
1958
            finally:
 
1959
                f.close()
 
1960
        else:
 
1961
            igns = ''
 
1962
 
 
1963
        # TODO: If the file already uses crlf-style termination, maybe
 
1964
        # we should use that for the newly added lines?
 
1965
 
 
1966
        if igns and igns[-1] != '\n':
 
1967
            igns += '\n'
 
1968
        for name_pattern in name_pattern_list:
 
1969
            igns += name_pattern + '\n'
 
1970
 
 
1971
        f = AtomicFile(ifn, 'wb')
 
1972
        try:
 
1973
            f.write(igns.encode('utf-8'))
 
1974
            f.commit()
 
1975
        finally:
 
1976
            f.close()
 
1977
 
 
1978
        if not tree.path2id('.bzrignore'):
 
1979
            tree.add(['.bzrignore'])
 
1980
 
 
1981
        ignored = globbing.Globster(name_pattern_list)
 
1982
        matches = []
 
1983
        tree.lock_read()
 
1984
        for entry in tree.list_files():
 
1985
            id = entry[3]
 
1986
            if id is not None:
 
1987
                filename = entry[0]
 
1988
                if ignored.match(filename):
 
1989
                    matches.append(filename.encode('utf-8'))
 
1990
        tree.unlock()
 
1991
        if len(matches) > 0:
 
1992
            print "Warning: the following files are version controlled and" \
 
1993
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
1994
 
 
1995
class cmd_ignored(Command):
 
1996
    """List ignored files and the patterns that matched them.
 
1997
    """
 
1998
 
 
1999
    _see_also = ['ignore']
 
2000
    @display_command
 
2001
    def run(self):
 
2002
        tree = WorkingTree.open_containing(u'.')[0]
 
2003
        tree.lock_read()
 
2004
        try:
 
2005
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2006
                if file_class != 'I':
 
2007
                    continue
 
2008
                ## XXX: Slightly inefficient since this was already calculated
 
2009
                pat = tree.is_ignored(path)
 
2010
                print '%-50s %s' % (path, pat)
 
2011
        finally:
 
2012
            tree.unlock()
 
2013
 
 
2014
 
 
2015
class cmd_lookup_revision(Command):
 
2016
    """Lookup the revision-id from a revision-number
 
2017
 
 
2018
    :Examples:
 
2019
        bzr lookup-revision 33
 
2020
    """
 
2021
    hidden = True
 
2022
    takes_args = ['revno']
 
2023
    
 
2024
    @display_command
 
2025
    def run(self, revno):
 
2026
        try:
 
2027
            revno = int(revno)
 
2028
        except ValueError:
 
2029
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2030
 
 
2031
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2032
 
 
2033
 
 
2034
class cmd_export(Command):
 
2035
    """Export current or past revision to a destination directory or archive.
 
2036
 
 
2037
    If no revision is specified this exports the last committed revision.
 
2038
 
 
2039
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2040
    given, try to find the format with the extension. If no extension
 
2041
    is found exports to a directory (equivalent to --format=dir).
 
2042
 
 
2043
    If root is supplied, it will be used as the root directory inside
 
2044
    container formats (tar, zip, etc). If it is not supplied it will default
 
2045
    to the exported filename. The root option has no effect for 'dir' format.
 
2046
 
 
2047
    If branch is omitted then the branch containing the current working
 
2048
    directory will be used.
 
2049
 
 
2050
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2051
 
 
2052
      =================       =========================
 
2053
      Supported formats       Autodetected by extension
 
2054
      =================       =========================
 
2055
         dir                         (none)
 
2056
         tar                          .tar
 
2057
         tbz2                    .tar.bz2, .tbz2
 
2058
         tgz                      .tar.gz, .tgz
 
2059
         zip                          .zip
 
2060
      =================       =========================
 
2061
    """
 
2062
    takes_args = ['dest', 'branch?']
 
2063
    takes_options = [
 
2064
        Option('format',
 
2065
               help="Type of file to export to.",
 
2066
               type=unicode),
 
2067
        'revision',
 
2068
        Option('root',
 
2069
               type=str,
 
2070
               help="Name of the root directory inside the exported file."),
 
2071
        ]
 
2072
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
2073
        from bzrlib.export import export
 
2074
 
 
2075
        if branch is None:
 
2076
            tree = WorkingTree.open_containing(u'.')[0]
 
2077
            b = tree.branch
 
2078
        else:
 
2079
            b = Branch.open(branch)
 
2080
            
 
2081
        if revision is None:
 
2082
            # should be tree.last_revision  FIXME
 
2083
            rev_id = b.last_revision()
 
2084
        else:
 
2085
            if len(revision) != 1:
 
2086
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
2087
            rev_id = revision[0].in_history(b).rev_id
 
2088
        t = b.repository.revision_tree(rev_id)
 
2089
        try:
 
2090
            export(t, dest, format, root)
 
2091
        except errors.NoSuchExportFormat, e:
 
2092
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2093
 
 
2094
 
 
2095
class cmd_cat(Command):
 
2096
    """Write the contents of a file as of a given revision to standard output.
 
2097
 
 
2098
    If no revision is nominated, the last revision is used.
 
2099
 
 
2100
    Note: Take care to redirect standard output when using this command on a
 
2101
    binary file. 
 
2102
    """
 
2103
 
 
2104
    _see_also = ['ls']
 
2105
    takes_options = [
 
2106
        Option('name-from-revision', help='The path name in the old tree.'),
 
2107
        'revision',
 
2108
        ]
 
2109
    takes_args = ['filename']
 
2110
    encoding_type = 'exact'
 
2111
 
 
2112
    @display_command
 
2113
    def run(self, filename, revision=None, name_from_revision=False):
 
2114
        if revision is not None and len(revision) != 1:
 
2115
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2116
                                        " one number")
 
2117
 
 
2118
        tree = None
 
2119
        try:
 
2120
            tree, b, relpath = \
 
2121
                    bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2122
        except errors.NotBranchError:
 
2123
            pass
 
2124
 
 
2125
        if revision is not None and revision[0].get_branch() is not None:
 
2126
            b = Branch.open(revision[0].get_branch())
 
2127
        if tree is None:
 
2128
            tree = b.basis_tree()
 
2129
        if revision is None:
 
2130
            revision_id = b.last_revision()
 
2131
        else:
 
2132
            revision_id = revision[0].in_history(b).rev_id
 
2133
 
 
2134
        cur_file_id = tree.path2id(relpath)
 
2135
        rev_tree = b.repository.revision_tree(revision_id)
 
2136
        old_file_id = rev_tree.path2id(relpath)
 
2137
        
 
2138
        if name_from_revision:
 
2139
            if old_file_id is None:
 
2140
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2141
                                                % (filename, revision_id))
 
2142
            else:
 
2143
                rev_tree.print_file(old_file_id)
 
2144
        elif cur_file_id is not None:
 
2145
            rev_tree.print_file(cur_file_id)
 
2146
        elif old_file_id is not None:
 
2147
            rev_tree.print_file(old_file_id)
 
2148
        else:
 
2149
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2150
                                         (filename, revision_id))
 
2151
 
 
2152
 
 
2153
class cmd_local_time_offset(Command):
 
2154
    """Show the offset in seconds from GMT to local time."""
 
2155
    hidden = True    
 
2156
    @display_command
 
2157
    def run(self):
 
2158
        print osutils.local_time_offset()
 
2159
 
 
2160
 
 
2161
 
 
2162
class cmd_commit(Command):
 
2163
    """Commit changes into a new revision.
 
2164
    
 
2165
    If no arguments are given, the entire tree is committed.
 
2166
 
 
2167
    If selected files are specified, only changes to those files are
 
2168
    committed.  If a directory is specified then the directory and everything 
 
2169
    within it is committed.
 
2170
 
 
2171
    If author of the change is not the same person as the committer, you can
 
2172
    specify the author's name using the --author option. The name should be
 
2173
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2174
 
 
2175
    A selected-file commit may fail in some cases where the committed
 
2176
    tree would be invalid. Consider::
 
2177
 
 
2178
      bzr init foo
 
2179
      mkdir foo/bar
 
2180
      bzr add foo/bar
 
2181
      bzr commit foo -m "committing foo"
 
2182
      bzr mv foo/bar foo/baz
 
2183
      mkdir foo/bar
 
2184
      bzr add foo/bar
 
2185
      bzr commit foo/bar -m "committing bar but not baz"
 
2186
 
 
2187
    In the example above, the last commit will fail by design. This gives
 
2188
    the user the opportunity to decide whether they want to commit the
 
2189
    rename at the same time, separately first, or not at all. (As a general
 
2190
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2191
 
 
2192
    Note: A selected-file commit after a merge is not yet supported.
 
2193
    """
 
2194
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2195
 
 
2196
    # TODO: Strict commit that fails if there are deleted files.
 
2197
    #       (what does "deleted files" mean ??)
 
2198
 
 
2199
    # TODO: Give better message for -s, --summary, used by tla people
 
2200
 
 
2201
    # XXX: verbose currently does nothing
 
2202
 
 
2203
    _see_also = ['bugs', 'uncommit']
 
2204
    takes_args = ['selected*']
 
2205
    takes_options = [
 
2206
            Option('message', type=unicode,
 
2207
                   short_name='m',
 
2208
                   help="Description of the new revision."),
 
2209
            'verbose',
 
2210
             Option('unchanged',
 
2211
                    help='Commit even if nothing has changed.'),
 
2212
             Option('file', type=str,
 
2213
                    short_name='F',
 
2214
                    argname='msgfile',
 
2215
                    help='Take commit message from this file.'),
 
2216
             Option('strict',
 
2217
                    help="Refuse to commit if there are unknown "
 
2218
                    "files in the working tree."),
 
2219
             ListOption('fixes', type=str,
 
2220
                    help="Mark a bug as being fixed by this revision."),
 
2221
             Option('author', type=str,
 
2222
                    help="Set the author's name, if it's different "
 
2223
                         "from the committer."),
 
2224
             Option('local',
 
2225
                    help="Perform a local commit in a bound "
 
2226
                         "branch.  Local commits are not pushed to "
 
2227
                         "the master branch until a normal commit "
 
2228
                         "is performed."
 
2229
                    ),
 
2230
              Option('show-diff',
 
2231
                     help='When no message is supplied, show the diff along'
 
2232
                     ' with the status summary in the message editor.'),
 
2233
             ]
 
2234
    aliases = ['ci', 'checkin']
 
2235
 
 
2236
    def _get_bug_fix_properties(self, fixes, branch):
 
2237
        properties = []
 
2238
        # Configure the properties for bug fixing attributes.
 
2239
        for fixed_bug in fixes:
 
2240
            tokens = fixed_bug.split(':')
 
2241
            if len(tokens) != 2:
 
2242
                raise errors.BzrCommandError(
 
2243
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2244
                    "Commit refused." % fixed_bug)
 
2245
            tag, bug_id = tokens
 
2246
            try:
 
2247
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
2248
            except errors.UnknownBugTrackerAbbreviation:
 
2249
                raise errors.BzrCommandError(
 
2250
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2251
            except errors.MalformedBugIdentifier:
 
2252
                raise errors.BzrCommandError(
 
2253
                    "Invalid bug identifier for %s. Commit refused."
 
2254
                    % fixed_bug)
 
2255
            properties.append('%s fixed' % bug_url)
 
2256
        return '\n'.join(properties)
 
2257
 
 
2258
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2259
            unchanged=False, strict=False, local=False, fixes=None,
 
2260
            author=None, show_diff=False):
 
2261
        from bzrlib.errors import (
 
2262
            PointlessCommit,
 
2263
            ConflictsInTree,
 
2264
            StrictCommitFailed
 
2265
        )
 
2266
        from bzrlib.msgeditor import (
 
2267
            edit_commit_message_encoded,
 
2268
            make_commit_message_template_encoded
 
2269
        )
 
2270
 
 
2271
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2272
        # slightly problematic to run this cross-platform.
 
2273
 
 
2274
        # TODO: do more checks that the commit will succeed before 
 
2275
        # spending the user's valuable time typing a commit message.
 
2276
 
 
2277
        properties = {}
 
2278
 
 
2279
        tree, selected_list = tree_files(selected_list)
 
2280
        if selected_list == ['']:
 
2281
            # workaround - commit of root of tree should be exactly the same
 
2282
            # as just default commit in that tree, and succeed even though
 
2283
            # selected-file merge commit is not done yet
 
2284
            selected_list = []
 
2285
 
 
2286
        if fixes is None:
 
2287
            fixes = []
 
2288
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
2289
        if bug_property:
 
2290
            properties['bugs'] = bug_property
 
2291
 
 
2292
        if local and not tree.branch.get_bound_location():
 
2293
            raise errors.LocalRequiresBoundBranch()
 
2294
 
 
2295
        def get_message(commit_obj):
 
2296
            """Callback to get commit message"""
 
2297
            my_message = message
 
2298
            if my_message is None and not file:
 
2299
                t = make_commit_message_template_encoded(tree,
 
2300
                        selected_list, diff=show_diff,
 
2301
                        output_encoding=bzrlib.user_encoding)
 
2302
                my_message = edit_commit_message_encoded(t)
 
2303
                if my_message is None:
 
2304
                    raise errors.BzrCommandError("please specify a commit"
 
2305
                        " message with either --message or --file")
 
2306
            elif my_message and file:
 
2307
                raise errors.BzrCommandError(
 
2308
                    "please specify either --message or --file")
 
2309
            if file:
 
2310
                my_message = codecs.open(file, 'rt', 
 
2311
                                         bzrlib.user_encoding).read()
 
2312
            if my_message == "":
 
2313
                raise errors.BzrCommandError("empty commit message specified")
 
2314
            return my_message
 
2315
 
 
2316
        try:
 
2317
            tree.commit(message_callback=get_message,
 
2318
                        specific_files=selected_list,
 
2319
                        allow_pointless=unchanged, strict=strict, local=local,
 
2320
                        reporter=None, verbose=verbose, revprops=properties,
 
2321
                        author=author)
 
2322
        except PointlessCommit:
 
2323
            # FIXME: This should really happen before the file is read in;
 
2324
            # perhaps prepare the commit; get the message; then actually commit
 
2325
            raise errors.BzrCommandError("no changes to commit."
 
2326
                              " use --unchanged to commit anyhow")
 
2327
        except ConflictsInTree:
 
2328
            raise errors.BzrCommandError('Conflicts detected in working '
 
2329
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2330
                ' resolve.')
 
2331
        except StrictCommitFailed:
 
2332
            raise errors.BzrCommandError("Commit refused because there are"
 
2333
                              " unknown files in the working tree.")
 
2334
        except errors.BoundBranchOutOfDate, e:
 
2335
            raise errors.BzrCommandError(str(e) + "\n"
 
2336
            'To commit to master branch, run update and then commit.\n'
 
2337
            'You can also pass --local to commit to continue working '
 
2338
            'disconnected.')
 
2339
 
 
2340
 
 
2341
class cmd_check(Command):
 
2342
    """Validate consistency of branch history.
 
2343
 
 
2344
    This command checks various invariants about the branch storage to
 
2345
    detect data corruption or bzr bugs.
 
2346
 
 
2347
    Output fields:
 
2348
 
 
2349
        revisions: This is just the number of revisions checked.  It doesn't
 
2350
            indicate a problem.
 
2351
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2352
            doesn't indicate a problem.
 
2353
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2354
            are not properly referenced by the revision ancestry.  This is a
 
2355
            subtle problem that Bazaar can work around.
 
2356
        unique file texts: This is the total number of unique file contents
 
2357
            seen in the checked revisions.  It does not indicate a problem.
 
2358
        repeated file texts: This is the total number of repeated texts seen
 
2359
            in the checked revisions.  Texts can be repeated when their file
 
2360
            entries are modified, but the file contents are not.  It does not
 
2361
            indicate a problem.
 
2362
    """
 
2363
 
 
2364
    _see_also = ['reconcile']
 
2365
    takes_args = ['branch?']
 
2366
    takes_options = ['verbose']
 
2367
 
 
2368
    def run(self, branch=None, verbose=False):
 
2369
        from bzrlib.check import check
 
2370
        if branch is None:
 
2371
            branch = Branch.open_containing('.')[0]
 
2372
        else:
 
2373
            branch = Branch.open(branch)
 
2374
        check(branch, verbose)
 
2375
 
 
2376
 
 
2377
class cmd_upgrade(Command):
 
2378
    """Upgrade branch storage to current format.
 
2379
 
 
2380
    The check command or bzr developers may sometimes advise you to run
 
2381
    this command. When the default format has changed you may also be warned
 
2382
    during other operations to upgrade.
 
2383
    """
 
2384
 
 
2385
    _see_also = ['check']
 
2386
    takes_args = ['url?']
 
2387
    takes_options = [
 
2388
                    RegistryOption('format',
 
2389
                        help='Upgrade to a specific format.  See "bzr help'
 
2390
                             ' formats" for details.',
 
2391
                        registry=bzrdir.format_registry,
 
2392
                        converter=bzrdir.format_registry.make_bzrdir,
 
2393
                        value_switches=True, title='Branch format'),
 
2394
                    ]
 
2395
 
 
2396
    def run(self, url='.', format=None):
 
2397
        from bzrlib.upgrade import upgrade
 
2398
        if format is None:
 
2399
            format = bzrdir.format_registry.make_bzrdir('default')
 
2400
        upgrade(url, format)
 
2401
 
 
2402
 
 
2403
class cmd_whoami(Command):
 
2404
    """Show or set bzr user id.
 
2405
    
 
2406
    :Examples:
 
2407
        Show the email of the current user::
 
2408
 
 
2409
            bzr whoami --email
 
2410
 
 
2411
        Set the current user::
 
2412
 
 
2413
            bzr whoami 'Frank Chu <fchu@example.com>'
 
2414
    """
 
2415
    takes_options = [ Option('email',
 
2416
                             help='Display email address only.'),
 
2417
                      Option('branch',
 
2418
                             help='Set identity for the current branch instead of '
 
2419
                                  'globally.'),
 
2420
                    ]
 
2421
    takes_args = ['name?']
 
2422
    encoding_type = 'replace'
 
2423
    
 
2424
    @display_command
 
2425
    def run(self, email=False, branch=False, name=None):
 
2426
        if name is None:
 
2427
            # use branch if we're inside one; otherwise global config
 
2428
            try:
 
2429
                c = Branch.open_containing('.')[0].get_config()
 
2430
            except errors.NotBranchError:
 
2431
                c = config.GlobalConfig()
 
2432
            if email:
 
2433
                self.outf.write(c.user_email() + '\n')
 
2434
            else:
 
2435
                self.outf.write(c.username() + '\n')
 
2436
            return
 
2437
 
 
2438
        # display a warning if an email address isn't included in the given name.
 
2439
        try:
 
2440
            config.extract_email_address(name)
 
2441
        except errors.NoEmailInUsername, e:
 
2442
            warning('"%s" does not seem to contain an email address.  '
 
2443
                    'This is allowed, but not recommended.', name)
 
2444
        
 
2445
        # use global config unless --branch given
 
2446
        if branch:
 
2447
            c = Branch.open_containing('.')[0].get_config()
 
2448
        else:
 
2449
            c = config.GlobalConfig()
 
2450
        c.set_user_option('email', name)
 
2451
 
 
2452
 
 
2453
class cmd_nick(Command):
 
2454
    """Print or set the branch nickname.  
 
2455
 
 
2456
    If unset, the tree root directory name is used as the nickname
 
2457
    To print the current nickname, execute with no argument.  
 
2458
    """
 
2459
 
 
2460
    _see_also = ['info']
 
2461
    takes_args = ['nickname?']
 
2462
    def run(self, nickname=None):
 
2463
        branch = Branch.open_containing(u'.')[0]
 
2464
        if nickname is None:
 
2465
            self.printme(branch)
 
2466
        else:
 
2467
            branch.nick = nickname
 
2468
 
 
2469
    @display_command
 
2470
    def printme(self, branch):
 
2471
        print branch.nick
 
2472
 
 
2473
 
 
2474
class cmd_selftest(Command):
 
2475
    """Run internal test suite.
 
2476
    
 
2477
    If arguments are given, they are regular expressions that say which tests
 
2478
    should run.  Tests matching any expression are run, and other tests are
 
2479
    not run.
 
2480
 
 
2481
    Alternatively if --first is given, matching tests are run first and then
 
2482
    all other tests are run.  This is useful if you have been working in a
 
2483
    particular area, but want to make sure nothing else was broken.
 
2484
 
 
2485
    If --exclude is given, tests that match that regular expression are
 
2486
    excluded, regardless of whether they match --first or not.
 
2487
 
 
2488
    To help catch accidential dependencies between tests, the --randomize
 
2489
    option is useful. In most cases, the argument used is the word 'now'.
 
2490
    Note that the seed used for the random number generator is displayed
 
2491
    when this option is used. The seed can be explicitly passed as the
 
2492
    argument to this option if required. This enables reproduction of the
 
2493
    actual ordering used if and when an order sensitive problem is encountered.
 
2494
 
 
2495
    If --list-only is given, the tests that would be run are listed. This is
 
2496
    useful when combined with --first, --exclude and/or --randomize to
 
2497
    understand their impact. The test harness reports "Listed nn tests in ..."
 
2498
    instead of "Ran nn tests in ..." when list mode is enabled.
 
2499
 
 
2500
    If the global option '--no-plugins' is given, plugins are not loaded
 
2501
    before running the selftests.  This has two effects: features provided or
 
2502
    modified by plugins will not be tested, and tests provided by plugins will
 
2503
    not be run.
 
2504
 
 
2505
    Tests that need working space on disk use a common temporary directory, 
 
2506
    typically inside $TMPDIR or /tmp.
 
2507
 
 
2508
    :Examples:
 
2509
        Run only tests relating to 'ignore'::
 
2510
 
 
2511
            bzr selftest ignore
 
2512
 
 
2513
        Disable plugins and list tests as they're run::
 
2514
 
 
2515
            bzr --no-plugins selftest -v
 
2516
    """
 
2517
    # NB: this is used from the class without creating an instance, which is
 
2518
    # why it does not have a self parameter.
 
2519
    def get_transport_type(typestring):
 
2520
        """Parse and return a transport specifier."""
 
2521
        if typestring == "sftp":
 
2522
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2523
            return SFTPAbsoluteServer
 
2524
        if typestring == "memory":
 
2525
            from bzrlib.transport.memory import MemoryServer
 
2526
            return MemoryServer
 
2527
        if typestring == "fakenfs":
 
2528
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2529
            return FakeNFSServer
 
2530
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2531
            (typestring)
 
2532
        raise errors.BzrCommandError(msg)
 
2533
 
 
2534
    hidden = True
 
2535
    takes_args = ['testspecs*']
 
2536
    takes_options = ['verbose',
 
2537
                     Option('one',
 
2538
                             help='Stop when one test fails.',
 
2539
                             short_name='1',
 
2540
                             ),
 
2541
                     Option('transport',
 
2542
                            help='Use a different transport by default '
 
2543
                                 'throughout the test suite.',
 
2544
                            type=get_transport_type),
 
2545
                     Option('benchmark',
 
2546
                            help='Run the benchmarks rather than selftests.'),
 
2547
                     Option('lsprof-timed',
 
2548
                            help='Generate lsprof output for benchmarked'
 
2549
                                 ' sections of code.'),
 
2550
                     Option('cache-dir', type=str,
 
2551
                            help='Cache intermediate benchmark output in this '
 
2552
                                 'directory.'),
 
2553
                     Option('first',
 
2554
                            help='Run all tests, but run specified tests first.',
 
2555
                            short_name='f',
 
2556
                            ),
 
2557
                     Option('list-only',
 
2558
                            help='List the tests instead of running them.'),
 
2559
                     Option('randomize', type=str, argname="SEED",
 
2560
                            help='Randomize the order of tests using the given'
 
2561
                                 ' seed or "now" for the current time.'),
 
2562
                     Option('exclude', type=str, argname="PATTERN",
 
2563
                            short_name='x',
 
2564
                            help='Exclude tests that match this regular'
 
2565
                                 ' expression.'),
 
2566
                     Option('strict', help='Fail on missing dependencies or '
 
2567
                            'known failures.'),
 
2568
                     ]
 
2569
    encoding_type = 'replace'
 
2570
 
 
2571
    def run(self, testspecs_list=None, verbose=False, one=False,
 
2572
            transport=None, benchmark=None,
 
2573
            lsprof_timed=None, cache_dir=None,
 
2574
            first=False, list_only=False,
 
2575
            randomize=None, exclude=None, strict=False):
 
2576
        import bzrlib.ui
 
2577
        from bzrlib.tests import selftest
 
2578
        import bzrlib.benchmarks as benchmarks
 
2579
        from bzrlib.benchmarks import tree_creator
 
2580
 
 
2581
        if cache_dir is not None:
 
2582
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2583
        if not list_only:
 
2584
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2585
            print '   %s (%s python%s)' % (
 
2586
                    bzrlib.__path__[0],
 
2587
                    bzrlib.version_string,
 
2588
                    '.'.join(map(str, sys.version_info)),
 
2589
                    )
 
2590
        print
 
2591
        if testspecs_list is not None:
 
2592
            pattern = '|'.join(testspecs_list)
 
2593
        else:
 
2594
            pattern = ".*"
 
2595
        if benchmark:
 
2596
            test_suite_factory = benchmarks.test_suite
 
2597
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
2598
            verbose = not is_quiet()
 
2599
            # TODO: should possibly lock the history file...
 
2600
            benchfile = open(".perf_history", "at", buffering=1)
 
2601
        else:
 
2602
            test_suite_factory = None
 
2603
            benchfile = None
 
2604
        try:
 
2605
            result = selftest(verbose=verbose,
 
2606
                              pattern=pattern,
 
2607
                              stop_on_failure=one,
 
2608
                              transport=transport,
 
2609
                              test_suite_factory=test_suite_factory,
 
2610
                              lsprof_timed=lsprof_timed,
 
2611
                              bench_history=benchfile,
 
2612
                              matching_tests_first=first,
 
2613
                              list_only=list_only,
 
2614
                              random_seed=randomize,
 
2615
                              exclude_pattern=exclude,
 
2616
                              strict=strict,
 
2617
                              )
 
2618
        finally:
 
2619
            if benchfile is not None:
 
2620
                benchfile.close()
 
2621
        if result:
 
2622
            info('tests passed')
 
2623
        else:
 
2624
            info('tests failed')
 
2625
        return int(not result)
 
2626
 
 
2627
 
 
2628
class cmd_version(Command):
 
2629
    """Show version of bzr."""
 
2630
 
 
2631
    encoding_type = 'replace'
 
2632
 
 
2633
    @display_command
 
2634
    def run(self):
 
2635
        from bzrlib.version import show_version
 
2636
        show_version(to_file=self.outf)
 
2637
 
 
2638
 
 
2639
class cmd_rocks(Command):
 
2640
    """Statement of optimism."""
 
2641
 
 
2642
    hidden = True
 
2643
 
 
2644
    @display_command
 
2645
    def run(self):
 
2646
        print "It sure does!"
 
2647
 
 
2648
 
 
2649
class cmd_find_merge_base(Command):
 
2650
    """Find and print a base revision for merging two branches."""
 
2651
    # TODO: Options to specify revisions on either side, as if
 
2652
    #       merging only part of the history.
 
2653
    takes_args = ['branch', 'other']
 
2654
    hidden = True
 
2655
    
 
2656
    @display_command
 
2657
    def run(self, branch, other):
 
2658
        from bzrlib.revision import ensure_null
 
2659
        
 
2660
        branch1 = Branch.open_containing(branch)[0]
 
2661
        branch2 = Branch.open_containing(other)[0]
 
2662
 
 
2663
        last1 = ensure_null(branch1.last_revision())
 
2664
        last2 = ensure_null(branch2.last_revision())
 
2665
 
 
2666
        graph = branch1.repository.get_graph(branch2.repository)
 
2667
        base_rev_id = graph.find_unique_lca(last1, last2)
 
2668
 
 
2669
        print 'merge base is revision %s' % base_rev_id
 
2670
 
 
2671
 
 
2672
class cmd_merge(Command):
 
2673
    """Perform a three-way merge.
 
2674
    
 
2675
    The branch is the branch you will merge from.  By default, it will merge
 
2676
    the latest revision.  If you specify a revision, that revision will be
 
2677
    merged.  If you specify two revisions, the first will be used as a BASE,
 
2678
    and the second one as OTHER.  Revision numbers are always relative to the
 
2679
    specified branch.
 
2680
 
 
2681
    By default, bzr will try to merge in all new work from the other
 
2682
    branch, automatically determining an appropriate base.  If this
 
2683
    fails, you may need to give an explicit base.
 
2684
    
 
2685
    Merge will do its best to combine the changes in two branches, but there
 
2686
    are some kinds of problems only a human can fix.  When it encounters those,
 
2687
    it will mark a conflict.  A conflict means that you need to fix something,
 
2688
    before you should commit.
 
2689
 
 
2690
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2691
 
 
2692
    If there is no default branch set, the first merge will set it. After
 
2693
    that, you can omit the branch to use the default.  To change the
 
2694
    default, use --remember. The value will only be saved if the remote
 
2695
    location can be accessed.
 
2696
 
 
2697
    The results of the merge are placed into the destination working
 
2698
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2699
    committed to record the result of the merge.
 
2700
    
 
2701
    merge refuses to run if there are any uncommitted changes, unless
 
2702
    --force is given.
 
2703
 
 
2704
    :Examples:
 
2705
        To merge the latest revision from bzr.dev::
 
2706
 
 
2707
            bzr merge ../bzr.dev
 
2708
 
 
2709
        To merge changes up to and including revision 82 from bzr.dev::
 
2710
 
 
2711
            bzr merge -r 82 ../bzr.dev
 
2712
 
 
2713
        To merge the changes introduced by 82, without previous changes::
 
2714
 
 
2715
            bzr merge -r 81..82 ../bzr.dev
 
2716
    """
 
2717
 
 
2718
    _see_also = ['update', 'remerge', 'status-flags']
 
2719
    takes_args = ['branch?']
 
2720
    takes_options = [
 
2721
        'change',
 
2722
        'revision',
 
2723
        Option('force',
 
2724
               help='Merge even if the destination tree has uncommitted changes.'),
 
2725
        'merge-type',
 
2726
        'reprocess',
 
2727
        'remember',
 
2728
        Option('show-base', help="Show base revision text in "
 
2729
               "conflicts."),
 
2730
        Option('uncommitted', help='Apply uncommitted changes'
 
2731
               ' from a working copy, instead of branch changes.'),
 
2732
        Option('pull', help='If the destination is already'
 
2733
                ' completely merged into the source, pull from the'
 
2734
                ' source rather than merging.  When this happens,'
 
2735
                ' you do not need to commit the result.'),
 
2736
        Option('directory',
 
2737
               help='Branch to merge into, '
 
2738
                    'rather than the one containing the working directory.',
 
2739
               short_name='d',
 
2740
               type=unicode,
 
2741
               ),
 
2742
    ]
 
2743
 
 
2744
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
2745
            show_base=False, reprocess=False, remember=False,
 
2746
            uncommitted=False, pull=False,
 
2747
            directory=None,
 
2748
            ):
 
2749
        # This is actually a branch (or merge-directive) *location*.
 
2750
        location = branch
 
2751
        del branch
 
2752
 
 
2753
        if merge_type is None:
 
2754
            merge_type = _mod_merge.Merge3Merger
 
2755
 
 
2756
        if directory is None: directory = u'.'
 
2757
        possible_transports = []
 
2758
        merger = None
 
2759
        allow_pending = True
 
2760
        verified = 'inapplicable'
 
2761
        tree = WorkingTree.open_containing(directory)[0]
 
2762
        change_reporter = delta._ChangeReporter(
 
2763
            unversioned_filter=tree.is_ignored)
 
2764
        cleanups = []
 
2765
        try:
 
2766
            pb = ui.ui_factory.nested_progress_bar()
 
2767
            cleanups.append(pb.finished)
 
2768
            tree.lock_write()
 
2769
            cleanups.append(tree.unlock)
 
2770
            if location is not None:
 
2771
                mergeable, other_transport = _get_mergeable_helper(location)
 
2772
                if mergeable:
 
2773
                    if uncommitted:
 
2774
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2775
                            ' with bundles or merge directives.')
 
2776
 
 
2777
                    if revision is not None:
 
2778
                        raise errors.BzrCommandError(
 
2779
                            'Cannot use -r with merge directives or bundles')
 
2780
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2781
                       mergeable, pb)
 
2782
                possible_transports.append(other_transport)
 
2783
 
 
2784
            if merger is None and uncommitted:
 
2785
                if revision is not None and len(revision) > 0:
 
2786
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2787
                        ' --revision at the same time.')
 
2788
                location = self._select_branch_location(tree, location)[0]
 
2789
                other_tree, other_path = WorkingTree.open_containing(location)
 
2790
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2791
                    pb)
 
2792
                allow_pending = False
 
2793
 
 
2794
            if merger is None:
 
2795
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2796
                    location, revision, remember, possible_transports, pb)
 
2797
 
 
2798
            merger.merge_type = merge_type
 
2799
            merger.reprocess = reprocess
 
2800
            merger.show_base = show_base
 
2801
            merger.change_reporter = change_reporter
 
2802
            self.sanity_check_merger(merger)
 
2803
            if (merger.base_rev_id == merger.other_rev_id and
 
2804
                merger.other_rev_id != None):
 
2805
                note('Nothing to do.')
 
2806
                return 0
 
2807
            if pull:
 
2808
                if merger.interesting_files is not None:
 
2809
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2810
                if (merger.base_rev_id == tree.last_revision()):
 
2811
                    result = tree.pull(merger.other_branch, False,
 
2812
                                       merger.other_rev_id)
 
2813
                    result.report(self.outf)
 
2814
                    return 0
 
2815
            merger.check_basis(not force)
 
2816
            conflict_count = merger.do_merge()
 
2817
            if allow_pending:
 
2818
                merger.set_pending()
 
2819
            if verified == 'failed':
 
2820
                warning('Preview patch does not match changes')
 
2821
            if conflict_count != 0:
 
2822
                return 1
 
2823
            else:
 
2824
                return 0
 
2825
        finally:
 
2826
            for cleanup in reversed(cleanups):
 
2827
                cleanup()
 
2828
 
 
2829
    def sanity_check_merger(self, merger):
 
2830
        if (merger.show_base and
 
2831
            not merger.merge_type is _mod_merge.Merge3Merger):
 
2832
            raise errors.BzrCommandError("Show-base is not supported for this"
 
2833
                                         " merge type. %s" % merger.merge_type)
 
2834
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
2835
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
2836
                                         " for merge type %s." %
 
2837
                                         merger.merge_type)
 
2838
        if merger.reprocess and merger.show_base:
 
2839
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
2840
                                         " show base.")
 
2841
 
 
2842
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
2843
                                possible_transports, pb):
 
2844
        """Produce a merger from a location, assuming it refers to a branch."""
 
2845
        from bzrlib.tag import _merge_tags_if_possible
 
2846
        assert revision is None or len(revision) < 3
 
2847
        # find the branch locations
 
2848
        other_loc, location = self._select_branch_location(tree, location,
 
2849
            revision, -1)
 
2850
        if revision is not None and len(revision) == 2:
 
2851
            base_loc, location = self._select_branch_location(tree, location,
 
2852
                                                              revision, 0)
 
2853
        else:
 
2854
            base_loc = other_loc
 
2855
        # Open the branches
 
2856
        other_branch, other_path = Branch.open_containing(other_loc,
 
2857
            possible_transports)
 
2858
        if base_loc == other_loc:
 
2859
            base_branch = other_branch
 
2860
        else:
 
2861
            base_branch, base_path = Branch.open_containing(base_loc,
 
2862
                possible_transports)
 
2863
        # Find the revision ids
 
2864
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
2865
            other_revision_id = _mod_revision.ensure_null(
 
2866
                other_branch.last_revision())
 
2867
        else:
 
2868
            other_revision_id = \
 
2869
                _mod_revision.ensure_null(
 
2870
                    revision[-1].in_history(other_branch).rev_id)
 
2871
        if (revision is not None and len(revision) == 2
 
2872
            and revision[0] is not None):
 
2873
            base_revision_id = \
 
2874
                _mod_revision.ensure_null(
 
2875
                    revision[0].in_history(base_branch).rev_id)
 
2876
        else:
 
2877
            base_revision_id = None
 
2878
        # Remember where we merge from
 
2879
        if ((tree.branch.get_parent() is None or remember) and
 
2880
            other_branch is not None):
 
2881
            tree.branch.set_parent(other_branch.base)
 
2882
        _merge_tags_if_possible(other_branch, tree.branch)
 
2883
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
2884
            other_revision_id, base_revision_id, other_branch, base_branch)
 
2885
        if other_path != '':
 
2886
            allow_pending = False
 
2887
            merger.interesting_files = [other_path]
 
2888
        else:
 
2889
            allow_pending = True
 
2890
        return merger, allow_pending
 
2891
 
 
2892
    def _select_branch_location(self, tree, location, revision=None,
 
2893
                                index=None):
 
2894
        """Select a branch location, according to possible inputs.
 
2895
 
 
2896
        If provided, branches from ``revision`` are preferred.  (Both
 
2897
        ``revision`` and ``index`` must be supplied.)
 
2898
 
 
2899
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
2900
        ``parent`` location is used, and a note is printed.
 
2901
 
 
2902
        :param tree: The working tree to select a branch for merging into
 
2903
        :param location: The location entered by the user
 
2904
        :param revision: The revision parameter to the command
 
2905
        :param index: The index to use for the revision parameter.  Negative
 
2906
            indices are permitted.
 
2907
        :return: (selected_location, default_location).  The default location
 
2908
            will be the user-entered location, if any, or else the remembered
 
2909
            location.
 
2910
        """
 
2911
        if (revision is not None and index is not None
 
2912
            and revision[index] is not None):
 
2913
            branch = revision[index].get_branch()
 
2914
            if branch is not None:
 
2915
                return branch, location
 
2916
        location = self._get_remembered_parent(tree, location, 'Merging from')
 
2917
        return location, location
 
2918
 
 
2919
    # TODO: move up to common parent; this isn't merge-specific anymore. 
 
2920
    def _get_remembered_parent(self, tree, supplied_location, verb_string):
 
2921
        """Use tree.branch's parent if none was supplied.
 
2922
 
 
2923
        Report if the remembered location was used.
 
2924
        """
 
2925
        if supplied_location is not None:
 
2926
            return supplied_location
 
2927
        stored_location = tree.branch.get_parent()
 
2928
        mutter("%s", stored_location)
 
2929
        if stored_location is None:
 
2930
            raise errors.BzrCommandError("No location specified or remembered")
 
2931
        display_url = urlutils.unescape_for_display(stored_location,
 
2932
            self.outf.encoding)
 
2933
        self.outf.write("%s remembered location %s\n" % (verb_string,
 
2934
            display_url))
 
2935
        return stored_location
 
2936
 
 
2937
 
 
2938
class cmd_remerge(Command):
 
2939
    """Redo a merge.
 
2940
 
 
2941
    Use this if you want to try a different merge technique while resolving
 
2942
    conflicts.  Some merge techniques are better than others, and remerge 
 
2943
    lets you try different ones on different files.
 
2944
 
 
2945
    The options for remerge have the same meaning and defaults as the ones for
 
2946
    merge.  The difference is that remerge can (only) be run when there is a
 
2947
    pending merge, and it lets you specify particular files.
 
2948
 
 
2949
    :Examples:
 
2950
        Re-do the merge of all conflicted files, and show the base text in
 
2951
        conflict regions, in addition to the usual THIS and OTHER texts::
 
2952
      
 
2953
            bzr remerge --show-base
 
2954
 
 
2955
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
2956
        additional processing to reduce the size of conflict regions::
 
2957
      
 
2958
            bzr remerge --merge-type weave --reprocess foobar
 
2959
    """
 
2960
    takes_args = ['file*']
 
2961
    takes_options = [
 
2962
            'merge-type',
 
2963
            'reprocess',
 
2964
            Option('show-base',
 
2965
                   help="Show base revision text in conflicts."),
 
2966
            ]
 
2967
 
 
2968
    def run(self, file_list=None, merge_type=None, show_base=False,
 
2969
            reprocess=False):
 
2970
        if merge_type is None:
 
2971
            merge_type = _mod_merge.Merge3Merger
 
2972
        tree, file_list = tree_files(file_list)
 
2973
        tree.lock_write()
 
2974
        try:
 
2975
            parents = tree.get_parent_ids()
 
2976
            if len(parents) != 2:
 
2977
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
2978
                                             " merges.  Not cherrypicking or"
 
2979
                                             " multi-merges.")
 
2980
            repository = tree.branch.repository
 
2981
            graph = repository.get_graph()
 
2982
            base_revision = graph.find_unique_lca(parents[0], parents[1])
 
2983
            base_tree = repository.revision_tree(base_revision)
 
2984
            other_tree = repository.revision_tree(parents[1])
 
2985
            interesting_ids = None
 
2986
            new_conflicts = []
 
2987
            conflicts = tree.conflicts()
 
2988
            if file_list is not None:
 
2989
                interesting_ids = set()
 
2990
                for filename in file_list:
 
2991
                    file_id = tree.path2id(filename)
 
2992
                    if file_id is None:
 
2993
                        raise errors.NotVersionedError(filename)
 
2994
                    interesting_ids.add(file_id)
 
2995
                    if tree.kind(file_id) != "directory":
 
2996
                        continue
 
2997
                    
 
2998
                    for name, ie in tree.inventory.iter_entries(file_id):
 
2999
                        interesting_ids.add(ie.file_id)
 
3000
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3001
            else:
 
3002
                # Remerge only supports resolving contents conflicts
 
3003
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3004
                restore_files = [c.path for c in conflicts
 
3005
                                 if c.typestring in allowed_conflicts]
 
3006
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3007
            tree.set_conflicts(ConflictList(new_conflicts))
 
3008
            if file_list is not None:
 
3009
                restore_files = file_list
 
3010
            for filename in restore_files:
 
3011
                try:
 
3012
                    restore(tree.abspath(filename))
 
3013
                except errors.NotConflicted:
 
3014
                    pass
 
3015
            # Disable pending merges, because the file texts we are remerging
 
3016
            # have not had those merges performed.  If we use the wrong parents
 
3017
            # list, we imply that the working tree text has seen and rejected
 
3018
            # all the changes from the other tree, when in fact those changes
 
3019
            # have not yet been seen.
 
3020
            tree.set_parent_ids(parents[:1])
 
3021
            try:
 
3022
                conflicts = _mod_merge.merge_inner(
 
3023
                                          tree.branch, other_tree, base_tree,
 
3024
                                          this_tree=tree,
 
3025
                                          interesting_ids=interesting_ids,
 
3026
                                          other_rev_id=parents[1],
 
3027
                                          merge_type=merge_type,
 
3028
                                          show_base=show_base,
 
3029
                                          reprocess=reprocess)
 
3030
            finally:
 
3031
                tree.set_parent_ids(parents)
 
3032
        finally:
 
3033
            tree.unlock()
 
3034
        if conflicts > 0:
 
3035
            return 1
 
3036
        else:
 
3037
            return 0
 
3038
 
 
3039
 
 
3040
class cmd_revert(Command):
 
3041
    """Revert files to a previous revision.
 
3042
 
 
3043
    Giving a list of files will revert only those files.  Otherwise, all files
 
3044
    will be reverted.  If the revision is not specified with '--revision', the
 
3045
    last committed revision is used.
 
3046
 
 
3047
    To remove only some changes, without reverting to a prior version, use
 
3048
    merge instead.  For example, "merge . --r-2..-3" will remove the changes
 
3049
    introduced by -2, without affecting the changes introduced by -1.  Or
 
3050
    to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3051
    
 
3052
    By default, any files that have been manually changed will be backed up
 
3053
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3054
    '.~#~' appended to their name, where # is a number.
 
3055
 
 
3056
    When you provide files, you can use their current pathname or the pathname
 
3057
    from the target revision.  So you can use revert to "undelete" a file by
 
3058
    name.  If you name a directory, all the contents of that directory will be
 
3059
    reverted.
 
3060
 
 
3061
    Any files that have been newly added since that revision will be deleted,
 
3062
    with a backup kept if appropriate.  Directories containing unknown files
 
3063
    will not be deleted.
 
3064
 
 
3065
    The working tree contains a list of pending merged revisions, which will
 
3066
    be included as parents in the next commit.  Normally, revert clears that
 
3067
    list as well as reverting the files.  If any files, are specified, revert
 
3068
    leaves the pending merge list alnone and reverts only the files.  Use "bzr
 
3069
    revert ." in the tree root to revert all files but keep the merge record,
 
3070
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3071
    reverting any files.
 
3072
    """
 
3073
 
 
3074
    _see_also = ['cat', 'export']
 
3075
    takes_options = [
 
3076
        'revision',
 
3077
        Option('no-backup', "Do not save backups of reverted files."),
 
3078
        Option('forget-merges',
 
3079
               'Remove pending merge marker, without changing any files.'),
 
3080
        ]
 
3081
    takes_args = ['file*']
 
3082
 
 
3083
    def run(self, revision=None, no_backup=False, file_list=None,
 
3084
            forget_merges=None):
 
3085
        tree, file_list = tree_files(file_list)
 
3086
        if forget_merges:
 
3087
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3088
        else:
 
3089
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3090
 
 
3091
    @staticmethod
 
3092
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3093
        if revision is None:
 
3094
            rev_id = tree.last_revision()
 
3095
        elif len(revision) != 1:
 
3096
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3097
        else:
 
3098
            rev_id = revision[0].in_history(tree.branch).rev_id
 
3099
        pb = ui.ui_factory.nested_progress_bar()
 
3100
        try:
 
3101
            tree.revert(file_list,
 
3102
                        tree.branch.repository.revision_tree(rev_id),
 
3103
                        not no_backup, pb, report_changes=True)
 
3104
        finally:
 
3105
            pb.finished()
 
3106
 
 
3107
 
 
3108
class cmd_assert_fail(Command):
 
3109
    """Test reporting of assertion failures"""
 
3110
    # intended just for use in testing
 
3111
 
 
3112
    hidden = True
 
3113
 
 
3114
    def run(self):
 
3115
        raise AssertionError("always fails")
 
3116
 
 
3117
 
 
3118
class cmd_help(Command):
 
3119
    """Show help on a command or other topic.
 
3120
    """
 
3121
 
 
3122
    _see_also = ['topics']
 
3123
    takes_options = [
 
3124
            Option('long', 'Show help on all commands.'),
 
3125
            ]
 
3126
    takes_args = ['topic?']
 
3127
    aliases = ['?', '--help', '-?', '-h']
 
3128
    
 
3129
    @display_command
 
3130
    def run(self, topic=None, long=False):
 
3131
        import bzrlib.help
 
3132
        if topic is None and long:
 
3133
            topic = "commands"
 
3134
        bzrlib.help.help(topic)
 
3135
 
 
3136
 
 
3137
class cmd_shell_complete(Command):
 
3138
    """Show appropriate completions for context.
 
3139
 
 
3140
    For a list of all available commands, say 'bzr shell-complete'.
 
3141
    """
 
3142
    takes_args = ['context?']
 
3143
    aliases = ['s-c']
 
3144
    hidden = True
 
3145
    
 
3146
    @display_command
 
3147
    def run(self, context=None):
 
3148
        import shellcomplete
 
3149
        shellcomplete.shellcomplete(context)
 
3150
 
 
3151
 
 
3152
class cmd_fetch(Command):
 
3153
    """Copy in history from another branch but don't merge it.
 
3154
 
 
3155
    This is an internal method used for pull and merge.
 
3156
    """
 
3157
    hidden = True
 
3158
    takes_args = ['from_branch', 'to_branch']
 
3159
    def run(self, from_branch, to_branch):
 
3160
        from bzrlib.fetch import Fetcher
 
3161
        from_b = Branch.open(from_branch)
 
3162
        to_b = Branch.open(to_branch)
 
3163
        Fetcher(to_b, from_b)
 
3164
 
 
3165
 
 
3166
class cmd_missing(Command):
 
3167
    """Show unmerged/unpulled revisions between two branches.
 
3168
    
 
3169
    OTHER_BRANCH may be local or remote.
 
3170
    """
 
3171
 
 
3172
    _see_also = ['merge', 'pull']
 
3173
    takes_args = ['other_branch?']
 
3174
    takes_options = [
 
3175
            Option('reverse', 'Reverse the order of revisions.'),
 
3176
            Option('mine-only',
 
3177
                   'Display changes in the local branch only.'),
 
3178
            Option('this' , 'Same as --mine-only.'),
 
3179
            Option('theirs-only',
 
3180
                   'Display changes in the remote branch only.'),
 
3181
            Option('other', 'Same as --theirs-only.'),
 
3182
            'log-format',
 
3183
            'show-ids',
 
3184
            'verbose'
 
3185
            ]
 
3186
    encoding_type = 'replace'
 
3187
 
 
3188
    @display_command
 
3189
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3190
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3191
            show_ids=False, verbose=False, this=False, other=False):
 
3192
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3193
 
 
3194
        if this:
 
3195
          mine_only = this
 
3196
        if other:
 
3197
          theirs_only = other
 
3198
 
 
3199
        local_branch = Branch.open_containing(u".")[0]
 
3200
        parent = local_branch.get_parent()
 
3201
        if other_branch is None:
 
3202
            other_branch = parent
 
3203
            if other_branch is None:
 
3204
                raise errors.BzrCommandError("No peer location known"
 
3205
                                             " or specified.")
 
3206
            display_url = urlutils.unescape_for_display(parent,
 
3207
                                                        self.outf.encoding)
 
3208
            self.outf.write("Using last location: " + display_url + "\n")
 
3209
 
 
3210
        remote_branch = Branch.open(other_branch)
 
3211
        if remote_branch.base == local_branch.base:
 
3212
            remote_branch = local_branch
 
3213
        local_branch.lock_read()
 
3214
        try:
 
3215
            remote_branch.lock_read()
 
3216
            try:
 
3217
                local_extra, remote_extra = find_unmerged(local_branch,
 
3218
                                                          remote_branch)
 
3219
                if log_format is None:
 
3220
                    registry = log.log_formatter_registry
 
3221
                    log_format = registry.get_default(local_branch)
 
3222
                lf = log_format(to_file=self.outf,
 
3223
                                show_ids=show_ids,
 
3224
                                show_timezone='original')
 
3225
                if reverse is False:
 
3226
                    local_extra.reverse()
 
3227
                    remote_extra.reverse()
 
3228
                if local_extra and not theirs_only:
 
3229
                    self.outf.write("You have %d extra revision(s):\n" %
 
3230
                                    len(local_extra))
 
3231
                    for revision in iter_log_revisions(local_extra,
 
3232
                                        local_branch.repository,
 
3233
                                        verbose):
 
3234
                        lf.log_revision(revision)
 
3235
                    printed_local = True
 
3236
                else:
 
3237
                    printed_local = False
 
3238
                if remote_extra and not mine_only:
 
3239
                    if printed_local is True:
 
3240
                        self.outf.write("\n\n\n")
 
3241
                    self.outf.write("You are missing %d revision(s):\n" %
 
3242
                                    len(remote_extra))
 
3243
                    for revision in iter_log_revisions(remote_extra,
 
3244
                                        remote_branch.repository,
 
3245
                                        verbose):
 
3246
                        lf.log_revision(revision)
 
3247
                if not remote_extra and not local_extra:
 
3248
                    status_code = 0
 
3249
                    self.outf.write("Branches are up to date.\n")
 
3250
                else:
 
3251
                    status_code = 1
 
3252
            finally:
 
3253
                remote_branch.unlock()
 
3254
        finally:
 
3255
            local_branch.unlock()
 
3256
        if not status_code and parent is None and other_branch is not None:
 
3257
            local_branch.lock_write()
 
3258
            try:
 
3259
                # handle race conditions - a parent might be set while we run.
 
3260
                if local_branch.get_parent() is None:
 
3261
                    local_branch.set_parent(remote_branch.base)
 
3262
            finally:
 
3263
                local_branch.unlock()
 
3264
        return status_code
 
3265
 
 
3266
 
 
3267
class cmd_pack(Command):
 
3268
    """Compress the data within a repository."""
 
3269
 
 
3270
    _see_also = ['repositories']
 
3271
    takes_args = ['branch_or_repo?']
 
3272
 
 
3273
    def run(self, branch_or_repo='.'):
 
3274
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3275
        try:
 
3276
            branch = dir.open_branch()
 
3277
            repository = branch.repository
 
3278
        except errors.NotBranchError:
 
3279
            repository = dir.open_repository()
 
3280
        repository.pack()
 
3281
 
 
3282
 
 
3283
class cmd_plugins(Command):
 
3284
    """List the installed plugins.
 
3285
    
 
3286
    This command displays the list of installed plugins including the
 
3287
    path where each one is located and a short description of each.
 
3288
 
 
3289
    A plugin is an external component for Bazaar that extends the
 
3290
    revision control system, by adding or replacing code in Bazaar.
 
3291
    Plugins can do a variety of things, including overriding commands,
 
3292
    adding new commands, providing additional network transports and
 
3293
    customizing log output.
 
3294
 
 
3295
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3296
    information on plugins including where to find them and how to
 
3297
    install them. Instructions are also provided there on how to
 
3298
    write new plugins using the Python programming language.
 
3299
    """
 
3300
 
 
3301
    @display_command
 
3302
    def run(self):
 
3303
        import bzrlib.plugin
 
3304
        from inspect import getdoc
 
3305
        for name, plugin in bzrlib.plugin.plugins().items():
 
3306
            print plugin.path(), "[%s]" % plugin.__version__
 
3307
            d = getdoc(plugin.module)
 
3308
            if d:
 
3309
                print '\t', d.split('\n')[0]
 
3310
 
 
3311
 
 
3312
class cmd_testament(Command):
 
3313
    """Show testament (signing-form) of a revision."""
 
3314
    takes_options = [
 
3315
            'revision',
 
3316
            Option('long', help='Produce long-format testament.'),
 
3317
            Option('strict',
 
3318
                   help='Produce a strict-format testament.')]
 
3319
    takes_args = ['branch?']
 
3320
    @display_command
 
3321
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3322
        from bzrlib.testament import Testament, StrictTestament
 
3323
        if strict is True:
 
3324
            testament_class = StrictTestament
 
3325
        else:
 
3326
            testament_class = Testament
 
3327
        b = WorkingTree.open_containing(branch)[0].branch
 
3328
        b.lock_read()
 
3329
        try:
 
3330
            if revision is None:
 
3331
                rev_id = b.last_revision()
 
3332
            else:
 
3333
                rev_id = revision[0].in_history(b).rev_id
 
3334
            t = testament_class.from_revision(b.repository, rev_id)
 
3335
            if long:
 
3336
                sys.stdout.writelines(t.as_text_lines())
 
3337
            else:
 
3338
                sys.stdout.write(t.as_short_text())
 
3339
        finally:
 
3340
            b.unlock()
 
3341
 
 
3342
 
 
3343
class cmd_annotate(Command):
 
3344
    """Show the origin of each line in a file.
 
3345
 
 
3346
    This prints out the given file with an annotation on the left side
 
3347
    indicating which revision, author and date introduced the change.
 
3348
 
 
3349
    If the origin is the same for a run of consecutive lines, it is 
 
3350
    shown only at the top, unless the --all option is given.
 
3351
    """
 
3352
    # TODO: annotate directories; showing when each file was last changed
 
3353
    # TODO: if the working copy is modified, show annotations on that 
 
3354
    #       with new uncommitted lines marked
 
3355
    aliases = ['ann', 'blame', 'praise']
 
3356
    takes_args = ['filename']
 
3357
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3358
                     Option('long', help='Show commit date in annotations.'),
 
3359
                     'revision',
 
3360
                     'show-ids',
 
3361
                     ]
 
3362
    encoding_type = 'exact'
 
3363
 
 
3364
    @display_command
 
3365
    def run(self, filename, all=False, long=False, revision=None,
 
3366
            show_ids=False):
 
3367
        from bzrlib.annotate import annotate_file
 
3368
        tree, relpath = WorkingTree.open_containing(filename)
 
3369
        branch = tree.branch
 
3370
        branch.lock_read()
 
3371
        try:
 
3372
            if revision is None:
 
3373
                revision_id = branch.last_revision()
 
3374
            elif len(revision) != 1:
 
3375
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3376
            else:
 
3377
                revision_id = revision[0].in_history(branch).rev_id
 
3378
            file_id = tree.path2id(relpath)
 
3379
            if file_id is None:
 
3380
                raise errors.NotVersionedError(filename)
 
3381
            tree = branch.repository.revision_tree(revision_id)
 
3382
            file_version = tree.inventory[file_id].revision
 
3383
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3384
                          show_ids=show_ids)
 
3385
        finally:
 
3386
            branch.unlock()
 
3387
 
 
3388
 
 
3389
class cmd_re_sign(Command):
 
3390
    """Create a digital signature for an existing revision."""
 
3391
    # TODO be able to replace existing ones.
 
3392
 
 
3393
    hidden = True # is this right ?
 
3394
    takes_args = ['revision_id*']
 
3395
    takes_options = ['revision']
 
3396
    
 
3397
    def run(self, revision_id_list=None, revision=None):
 
3398
        import bzrlib.gpg as gpg
 
3399
        if revision_id_list is not None and revision is not None:
 
3400
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3401
        if revision_id_list is None and revision is None:
 
3402
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3403
        b = WorkingTree.open_containing(u'.')[0].branch
 
3404
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3405
        if revision_id_list is not None:
 
3406
            for revision_id in revision_id_list:
 
3407
                b.repository.sign_revision(revision_id, gpg_strategy)
 
3408
        elif revision is not None:
 
3409
            if len(revision) == 1:
 
3410
                revno, rev_id = revision[0].in_history(b)
 
3411
                b.repository.sign_revision(rev_id, gpg_strategy)
 
3412
            elif len(revision) == 2:
 
3413
                # are they both on rh- if so we can walk between them
 
3414
                # might be nice to have a range helper for arbitrary
 
3415
                # revision paths. hmm.
 
3416
                from_revno, from_revid = revision[0].in_history(b)
 
3417
                to_revno, to_revid = revision[1].in_history(b)
 
3418
                if to_revid is None:
 
3419
                    to_revno = b.revno()
 
3420
                if from_revno is None or to_revno is None:
 
3421
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3422
                for revno in range(from_revno, to_revno + 1):
 
3423
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
3424
                                               gpg_strategy)
 
3425
            else:
 
3426
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3427
 
 
3428
 
 
3429
class cmd_bind(Command):
 
3430
    """Convert the current branch into a checkout of the supplied branch.
 
3431
 
 
3432
    Once converted into a checkout, commits must succeed on the master branch
 
3433
    before they will be applied to the local branch.
 
3434
    """
 
3435
 
 
3436
    _see_also = ['checkouts', 'unbind']
 
3437
    takes_args = ['location?']
 
3438
    takes_options = []
 
3439
 
 
3440
    def run(self, location=None):
 
3441
        b, relpath = Branch.open_containing(u'.')
 
3442
        if location is None:
 
3443
            try:
 
3444
                location = b.get_old_bound_location()
 
3445
            except errors.UpgradeRequired:
 
3446
                raise errors.BzrCommandError('No location supplied.  '
 
3447
                    'This format does not remember old locations.')
 
3448
            else:
 
3449
                if location is None:
 
3450
                    raise errors.BzrCommandError('No location supplied and no '
 
3451
                        'previous location known')
 
3452
        b_other = Branch.open(location)
 
3453
        try:
 
3454
            b.bind(b_other)
 
3455
        except errors.DivergedBranches:
 
3456
            raise errors.BzrCommandError('These branches have diverged.'
 
3457
                                         ' Try merging, and then bind again.')
 
3458
 
 
3459
 
 
3460
class cmd_unbind(Command):
 
3461
    """Convert the current checkout into a regular branch.
 
3462
 
 
3463
    After unbinding, the local branch is considered independent and subsequent
 
3464
    commits will be local only.
 
3465
    """
 
3466
 
 
3467
    _see_also = ['checkouts', 'bind']
 
3468
    takes_args = []
 
3469
    takes_options = []
 
3470
 
 
3471
    def run(self):
 
3472
        b, relpath = Branch.open_containing(u'.')
 
3473
        if not b.unbind():
 
3474
            raise errors.BzrCommandError('Local branch is not bound')
 
3475
 
 
3476
 
 
3477
class cmd_uncommit(Command):
 
3478
    """Remove the last committed revision.
 
3479
 
 
3480
    --verbose will print out what is being removed.
 
3481
    --dry-run will go through all the motions, but not actually
 
3482
    remove anything.
 
3483
 
 
3484
    If --revision is specified, uncommit revisions to leave the branch at the
 
3485
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
3486
    branch at revision 15.
 
3487
 
 
3488
    In the future, uncommit will create a revision bundle, which can then
 
3489
    be re-applied.
 
3490
    """
 
3491
 
 
3492
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3493
    # unreferenced information in 'branch-as-repository' branches.
 
3494
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3495
    # information in shared branches as well.
 
3496
    _see_also = ['commit']
 
3497
    takes_options = ['verbose', 'revision',
 
3498
                    Option('dry-run', help='Don\'t actually make changes.'),
 
3499
                    Option('force', help='Say yes to all questions.')]
 
3500
    takes_args = ['location?']
 
3501
    aliases = []
 
3502
 
 
3503
    def run(self, location=None,
 
3504
            dry_run=False, verbose=False,
 
3505
            revision=None, force=False):
 
3506
        from bzrlib.log import log_formatter, show_log
 
3507
        from bzrlib.uncommit import uncommit
 
3508
 
 
3509
        if location is None:
 
3510
            location = u'.'
 
3511
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3512
        try:
 
3513
            tree = control.open_workingtree()
 
3514
            b = tree.branch
 
3515
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3516
            tree = None
 
3517
            b = control.open_branch()
 
3518
 
 
3519
        rev_id = None
 
3520
        if revision is None:
 
3521
            revno = b.revno()
 
3522
        else:
 
3523
            # 'bzr uncommit -r 10' actually means uncommit
 
3524
            # so that the final tree is at revno 10.
 
3525
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3526
            # the revisions that are supplied.
 
3527
            # So we need to offset it by one
 
3528
            revno = revision[0].in_history(b).revno+1
 
3529
 
 
3530
        if revno <= b.revno():
 
3531
            rev_id = b.get_rev_id(revno)
 
3532
        if rev_id is None:
 
3533
            self.outf.write('No revisions to uncommit.\n')
 
3534
            return 1
 
3535
 
 
3536
        lf = log_formatter('short',
 
3537
                           to_file=self.outf,
 
3538
                           show_timezone='original')
 
3539
 
 
3540
        show_log(b,
 
3541
                 lf,
 
3542
                 verbose=False,
 
3543
                 direction='forward',
 
3544
                 start_revision=revno,
 
3545
                 end_revision=b.revno())
 
3546
 
 
3547
        if dry_run:
 
3548
            print 'Dry-run, pretending to remove the above revisions.'
 
3549
            if not force:
 
3550
                val = raw_input('Press <enter> to continue')
 
3551
        else:
 
3552
            print 'The above revision(s) will be removed.'
 
3553
            if not force:
 
3554
                val = raw_input('Are you sure [y/N]? ')
 
3555
                if val.lower() not in ('y', 'yes'):
 
3556
                    print 'Canceled'
 
3557
                    return 0
 
3558
 
 
3559
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3560
                revno=revno)
 
3561
 
 
3562
 
 
3563
class cmd_break_lock(Command):
 
3564
    """Break a dead lock on a repository, branch or working directory.
 
3565
 
 
3566
    CAUTION: Locks should only be broken when you are sure that the process
 
3567
    holding the lock has been stopped.
 
3568
 
 
3569
    You can get information on what locks are open via the 'bzr info' command.
 
3570
    
 
3571
    :Examples:
 
3572
        bzr break-lock
 
3573
    """
 
3574
    takes_args = ['location?']
 
3575
 
 
3576
    def run(self, location=None, show=False):
 
3577
        if location is None:
 
3578
            location = u'.'
 
3579
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3580
        try:
 
3581
            control.break_lock()
 
3582
        except NotImplementedError:
 
3583
            pass
 
3584
        
 
3585
 
 
3586
class cmd_wait_until_signalled(Command):
 
3587
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3588
 
 
3589
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3590
    """
 
3591
 
 
3592
    hidden = True
 
3593
 
 
3594
    def run(self):
 
3595
        sys.stdout.write("running\n")
 
3596
        sys.stdout.flush()
 
3597
        sys.stdin.readline()
 
3598
 
 
3599
 
 
3600
class cmd_serve(Command):
 
3601
    """Run the bzr server."""
 
3602
 
 
3603
    aliases = ['server']
 
3604
 
 
3605
    takes_options = [
 
3606
        Option('inet',
 
3607
               help='Serve on stdin/out for use from inetd or sshd.'),
 
3608
        Option('port',
 
3609
               help='Listen for connections on nominated port of the form '
 
3610
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
3611
                    'result in a dynamically allocated port.  The default port is '
 
3612
                    '4155.',
 
3613
               type=str),
 
3614
        Option('directory',
 
3615
               help='Serve contents of this directory.',
 
3616
               type=unicode),
 
3617
        Option('allow-writes',
 
3618
               help='By default the server is a readonly server.  Supplying '
 
3619
                    '--allow-writes enables write access to the contents of '
 
3620
                    'the served directory and below.'
 
3621
                ),
 
3622
        ]
 
3623
 
 
3624
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3625
        from bzrlib.smart import medium, server
 
3626
        from bzrlib.transport import get_transport
 
3627
        from bzrlib.transport.chroot import ChrootServer
 
3628
        from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
 
3629
        if directory is None:
 
3630
            directory = os.getcwd()
 
3631
        url = urlutils.local_path_to_url(directory)
 
3632
        if not allow_writes:
 
3633
            url = 'readonly+' + url
 
3634
        chroot_server = ChrootServer(get_transport(url))
 
3635
        chroot_server.setUp()
 
3636
        t = get_transport(chroot_server.get_url())
 
3637
        if inet:
 
3638
            smart_server = medium.SmartServerPipeStreamMedium(
 
3639
                sys.stdin, sys.stdout, t)
 
3640
        else:
 
3641
            host = BZR_DEFAULT_INTERFACE
 
3642
            if port is None:
 
3643
                port = BZR_DEFAULT_PORT
 
3644
            else:
 
3645
                if ':' in port:
 
3646
                    host, port = port.split(':')
 
3647
                port = int(port)
 
3648
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3649
            print 'listening on port: ', smart_server.port
 
3650
            sys.stdout.flush()
 
3651
        # for the duration of this server, no UI output is permitted.
 
3652
        # note that this may cause problems with blackbox tests. This should
 
3653
        # be changed with care though, as we dont want to use bandwidth sending
 
3654
        # progress over stderr to smart server clients!
 
3655
        old_factory = ui.ui_factory
 
3656
        try:
 
3657
            ui.ui_factory = ui.SilentUIFactory()
 
3658
            smart_server.serve()
 
3659
        finally:
 
3660
            ui.ui_factory = old_factory
 
3661
 
 
3662
 
 
3663
class cmd_join(Command):
 
3664
    """Combine a subtree into its containing tree.
 
3665
    
 
3666
    This command is for experimental use only.  It requires the target tree
 
3667
    to be in dirstate-with-subtree format, which cannot be converted into
 
3668
    earlier formats.
 
3669
 
 
3670
    The TREE argument should be an independent tree, inside another tree, but
 
3671
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3672
    running "bzr branch" with the target inside a tree.)
 
3673
 
 
3674
    The result is a combined tree, with the subtree no longer an independant
 
3675
    part.  This is marked as a merge of the subtree into the containing tree,
 
3676
    and all history is preserved.
 
3677
 
 
3678
    If --reference is specified, the subtree retains its independence.  It can
 
3679
    be branched by itself, and can be part of multiple projects at the same
 
3680
    time.  But operations performed in the containing tree, such as commit
 
3681
    and merge, will recurse into the subtree.
 
3682
    """
 
3683
 
 
3684
    _see_also = ['split']
 
3685
    takes_args = ['tree']
 
3686
    takes_options = [
 
3687
            Option('reference', help='Join by reference.'),
 
3688
            ]
 
3689
    hidden = True
 
3690
 
 
3691
    def run(self, tree, reference=False):
 
3692
        sub_tree = WorkingTree.open(tree)
 
3693
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3694
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3695
        repo = containing_tree.branch.repository
 
3696
        if not repo.supports_rich_root():
 
3697
            raise errors.BzrCommandError(
 
3698
                "Can't join trees because %s doesn't support rich root data.\n"
 
3699
                "You can use bzr upgrade on the repository."
 
3700
                % (repo,))
 
3701
        if reference:
 
3702
            try:
 
3703
                containing_tree.add_reference(sub_tree)
 
3704
            except errors.BadReferenceTarget, e:
 
3705
                # XXX: Would be better to just raise a nicely printable
 
3706
                # exception from the real origin.  Also below.  mbp 20070306
 
3707
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3708
                                             (tree, e.reason))
 
3709
        else:
 
3710
            try:
 
3711
                containing_tree.subsume(sub_tree)
 
3712
            except errors.BadSubsumeSource, e:
 
3713
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3714
                                             (tree, e.reason))
 
3715
 
 
3716
 
 
3717
class cmd_split(Command):
 
3718
    """Split a tree into two trees.
 
3719
 
 
3720
    This command is for experimental use only.  It requires the target tree
 
3721
    to be in dirstate-with-subtree format, which cannot be converted into
 
3722
    earlier formats.
 
3723
 
 
3724
    The TREE argument should be a subdirectory of a working tree.  That
 
3725
    subdirectory will be converted into an independent tree, with its own
 
3726
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3727
    If you want that behavior, do "bzr join --reference TREE".
 
3728
    """
 
3729
 
 
3730
    _see_also = ['join']
 
3731
    takes_args = ['tree']
 
3732
 
 
3733
    hidden = True
 
3734
 
 
3735
    def run(self, tree):
 
3736
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3737
        sub_id = containing_tree.path2id(subdir)
 
3738
        if sub_id is None:
 
3739
            raise errors.NotVersionedError(subdir)
 
3740
        try:
 
3741
            containing_tree.extract(sub_id)
 
3742
        except errors.RootNotRich:
 
3743
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3744
 
 
3745
 
 
3746
 
 
3747
class cmd_merge_directive(Command):
 
3748
    """Generate a merge directive for auto-merge tools.
 
3749
 
 
3750
    A directive requests a merge to be performed, and also provides all the
 
3751
    information necessary to do so.  This means it must either include a
 
3752
    revision bundle, or the location of a branch containing the desired
 
3753
    revision.
 
3754
 
 
3755
    A submit branch (the location to merge into) must be supplied the first
 
3756
    time the command is issued.  After it has been supplied once, it will
 
3757
    be remembered as the default.
 
3758
 
 
3759
    A public branch is optional if a revision bundle is supplied, but required
 
3760
    if --diff or --plain is specified.  It will be remembered as the default
 
3761
    after the first use.
 
3762
    """
 
3763
 
 
3764
    takes_args = ['submit_branch?', 'public_branch?']
 
3765
 
 
3766
    hidden = True
 
3767
 
 
3768
    _see_also = ['send']
 
3769
 
 
3770
    takes_options = [
 
3771
        RegistryOption.from_kwargs('patch-type',
 
3772
            'The type of patch to include in the directive.',
 
3773
            title='Patch type',
 
3774
            value_switches=True,
 
3775
            enum_switch=False,
 
3776
            bundle='Bazaar revision bundle (default).',
 
3777
            diff='Normal unified diff.',
 
3778
            plain='No patch, just directive.'),
 
3779
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
3780
        Option('mail-to', type=str,
 
3781
            help='Instead of printing the directive, email to this address.'),
 
3782
        Option('message', type=str, short_name='m',
 
3783
            help='Message to use when committing this merge.')
 
3784
        ]
 
3785
 
 
3786
    encoding_type = 'exact'
 
3787
 
 
3788
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3789
            sign=False, revision=None, mail_to=None, message=None):
 
3790
        from bzrlib.revision import ensure_null, NULL_REVISION
 
3791
        include_patch, include_bundle = {
 
3792
            'plain': (False, False),
 
3793
            'diff': (True, False),
 
3794
            'bundle': (True, True),
 
3795
            }[patch_type]
 
3796
        branch = Branch.open('.')
 
3797
        stored_submit_branch = branch.get_submit_branch()
 
3798
        if submit_branch is None:
 
3799
            submit_branch = stored_submit_branch
 
3800
        else:
 
3801
            if stored_submit_branch is None:
 
3802
                branch.set_submit_branch(submit_branch)
 
3803
        if submit_branch is None:
 
3804
            submit_branch = branch.get_parent()
 
3805
        if submit_branch is None:
 
3806
            raise errors.BzrCommandError('No submit branch specified or known')
 
3807
 
 
3808
        stored_public_branch = branch.get_public_branch()
 
3809
        if public_branch is None:
 
3810
            public_branch = stored_public_branch
 
3811
        elif stored_public_branch is None:
 
3812
            branch.set_public_branch(public_branch)
 
3813
        if not include_bundle and public_branch is None:
 
3814
            raise errors.BzrCommandError('No public branch specified or'
 
3815
                                         ' known')
 
3816
        base_revision_id = None
 
3817
        if revision is not None:
 
3818
            if len(revision) > 2:
 
3819
                raise errors.BzrCommandError('bzr merge-directive takes '
 
3820
                    'at most two one revision identifiers')
 
3821
            revision_id = revision[-1].in_history(branch).rev_id
 
3822
            if len(revision) == 2:
 
3823
                base_revision_id = revision[0].in_history(branch).rev_id
 
3824
                base_revision_id = ensure_null(base_revision_id)
 
3825
        else:
 
3826
            revision_id = branch.last_revision()
 
3827
        revision_id = ensure_null(revision_id)
 
3828
        if revision_id == NULL_REVISION:
 
3829
            raise errors.BzrCommandError('No revisions to bundle.')
 
3830
        directive = merge_directive.MergeDirective2.from_objects(
 
3831
            branch.repository, revision_id, time.time(),
 
3832
            osutils.local_time_offset(), submit_branch,
 
3833
            public_branch=public_branch, include_patch=include_patch,
 
3834
            include_bundle=include_bundle, message=message,
 
3835
            base_revision_id=base_revision_id)
 
3836
        if mail_to is None:
 
3837
            if sign:
 
3838
                self.outf.write(directive.to_signed(branch))
 
3839
            else:
 
3840
                self.outf.writelines(directive.to_lines())
 
3841
        else:
 
3842
            message = directive.to_email(mail_to, branch, sign)
 
3843
            s = SMTPConnection(branch.get_config())
 
3844
            s.send_email(message)
 
3845
 
 
3846
 
 
3847
class cmd_send(Command):
 
3848
    """Mail or create a merge-directive for submiting changes.
 
3849
 
 
3850
    A merge directive provides many things needed for requesting merges:
 
3851
 
 
3852
    * A machine-readable description of the merge to perform
 
3853
 
 
3854
    * An optional patch that is a preview of the changes requested
 
3855
 
 
3856
    * An optional bundle of revision data, so that the changes can be applied
 
3857
      directly from the merge directive, without retrieving data from a
 
3858
      branch.
 
3859
 
 
3860
    If --no-bundle is specified, then public_branch is needed (and must be
 
3861
    up-to-date), so that the receiver can perform the merge using the
 
3862
    public_branch.  The public_branch is always included if known, so that
 
3863
    people can check it later.
 
3864
 
 
3865
    The submit branch defaults to the parent, but can be overridden.  Both
 
3866
    submit branch and public branch will be remembered if supplied.
 
3867
 
 
3868
    If a public_branch is known for the submit_branch, that public submit
 
3869
    branch is used in the merge instructions.  This means that a local mirror
 
3870
    can be used as your actual submit branch, once you have set public_branch
 
3871
    for that mirror.
 
3872
 
 
3873
    Mail is sent using your preferred mail program.  This should be transparent
 
3874
    on Windows (it uses MAPI).  On *nix, it requires the xdg-email utility.  If
 
3875
    the preferred client can't be found (or used), your editor will be used.
 
3876
    
 
3877
    To use a specific mail program, set the mail_client configuration option.
 
3878
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
3879
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
3880
    generic options are "default", "editor", "mapi", and "xdg-email".
 
3881
 
 
3882
    If mail is being sent, a to address is required.  This can be supplied
 
3883
    either on the commandline, or by setting the submit_to configuration
 
3884
    option.
 
3885
 
 
3886
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
3887
    merge directive format 2.  It is significantly faster and smaller than
 
3888
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
3889
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
3890
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
3891
    """
 
3892
 
 
3893
    encoding_type = 'exact'
 
3894
 
 
3895
    _see_also = ['merge']
 
3896
 
 
3897
    takes_args = ['submit_branch?', 'public_branch?']
 
3898
 
 
3899
    takes_options = [
 
3900
        Option('no-bundle',
 
3901
               help='Do not include a bundle in the merge directive.'),
 
3902
        Option('no-patch', help='Do not include a preview patch in the merge'
 
3903
               ' directive.'),
 
3904
        Option('remember',
 
3905
               help='Remember submit and public branch.'),
 
3906
        Option('from',
 
3907
               help='Branch to generate the submission from, '
 
3908
               'rather than the one containing the working directory.',
 
3909
               short_name='f',
 
3910
               type=unicode),
 
3911
        Option('output', short_name='o', help='Write directive to this file.',
 
3912
               type=unicode),
 
3913
        Option('mail-to', help='Mail the request to this address.',
 
3914
               type=unicode),
 
3915
        'revision',
 
3916
        'message',
 
3917
        RegistryOption.from_kwargs('format',
 
3918
        'Use the specified output format.',
 
3919
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
3920
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
3921
        ]
 
3922
 
 
3923
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
3924
            no_patch=False, revision=None, remember=False, output=None,
 
3925
            format='4', mail_to=None, message=None, **kwargs):
 
3926
        return self._run(submit_branch, revision, public_branch, remember,
 
3927
                         format, no_bundle, no_patch, output,
 
3928
                         kwargs.get('from', '.'), mail_to, message)
 
3929
 
 
3930
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
3931
             no_bundle, no_patch, output, from_, mail_to, message):
 
3932
        from bzrlib.revision import NULL_REVISION
 
3933
        if output is None:
 
3934
            outfile = StringIO()
 
3935
        elif output == '-':
 
3936
            outfile = self.outf
 
3937
        else:
 
3938
            outfile = open(output, 'wb')
 
3939
        try:
 
3940
            branch = Branch.open_containing(from_)[0]
 
3941
            if output is None:
 
3942
                config = branch.get_config()
 
3943
                if mail_to is None:
 
3944
                    mail_to = config.get_user_option('submit_to')
 
3945
                if mail_to is None:
 
3946
                    raise errors.BzrCommandError('No mail-to address'
 
3947
                                                 ' specified')
 
3948
                mail_client = config.get_mail_client()
 
3949
            if remember and submit_branch is None:
 
3950
                raise errors.BzrCommandError(
 
3951
                    '--remember requires a branch to be specified.')
 
3952
            stored_submit_branch = branch.get_submit_branch()
 
3953
            remembered_submit_branch = False
 
3954
            if submit_branch is None:
 
3955
                submit_branch = stored_submit_branch
 
3956
                remembered_submit_branch = True
 
3957
            else:
 
3958
                if stored_submit_branch is None or remember:
 
3959
                    branch.set_submit_branch(submit_branch)
 
3960
            if submit_branch is None:
 
3961
                submit_branch = branch.get_parent()
 
3962
                remembered_submit_branch = True
 
3963
            if submit_branch is None:
 
3964
                raise errors.BzrCommandError('No submit branch known or'
 
3965
                                             ' specified')
 
3966
            if remembered_submit_branch:
 
3967
                note('Using saved location: %s', submit_branch)
 
3968
 
 
3969
            stored_public_branch = branch.get_public_branch()
 
3970
            if public_branch is None:
 
3971
                public_branch = stored_public_branch
 
3972
            elif stored_public_branch is None or remember:
 
3973
                branch.set_public_branch(public_branch)
 
3974
            if no_bundle and public_branch is None:
 
3975
                raise errors.BzrCommandError('No public branch specified or'
 
3976
                                             ' known')
 
3977
            base_revision_id = None
 
3978
            revision_id = None
 
3979
            if revision is not None:
 
3980
                if len(revision) > 2:
 
3981
                    raise errors.BzrCommandError('bzr send takes '
 
3982
                        'at most two one revision identifiers')
 
3983
                revision_id = revision[-1].in_history(branch).rev_id
 
3984
                if len(revision) == 2:
 
3985
                    base_revision_id = revision[0].in_history(branch).rev_id
 
3986
            if revision_id is None:
 
3987
                revision_id = branch.last_revision()
 
3988
            if revision_id == NULL_REVISION:
 
3989
                raise errors.BzrCommandError('No revisions to submit.')
 
3990
            if format == '4':
 
3991
                directive = merge_directive.MergeDirective2.from_objects(
 
3992
                    branch.repository, revision_id, time.time(),
 
3993
                    osutils.local_time_offset(), submit_branch,
 
3994
                    public_branch=public_branch, include_patch=not no_patch,
 
3995
                    include_bundle=not no_bundle, message=message,
 
3996
                    base_revision_id=base_revision_id)
 
3997
            elif format == '0.9':
 
3998
                if not no_bundle:
 
3999
                    if not no_patch:
 
4000
                        patch_type = 'bundle'
 
4001
                    else:
 
4002
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4003
                            ' permit bundle with no patch')
 
4004
                else:
 
4005
                    if not no_patch:
 
4006
                        patch_type = 'diff'
 
4007
                    else:
 
4008
                        patch_type = None
 
4009
                directive = merge_directive.MergeDirective.from_objects(
 
4010
                    branch.repository, revision_id, time.time(),
 
4011
                    osutils.local_time_offset(), submit_branch,
 
4012
                    public_branch=public_branch, patch_type=patch_type,
 
4013
                    message=message)
 
4014
 
 
4015
            outfile.writelines(directive.to_lines())
 
4016
            if output is None:
 
4017
                subject = '[MERGE] '
 
4018
                if message is not None:
 
4019
                    subject += message
 
4020
                else:
 
4021
                    revision = branch.repository.get_revision(revision_id)
 
4022
                    subject += revision.get_summary()
 
4023
                mail_client.compose_merge_request(mail_to, subject,
 
4024
                                                  outfile.getvalue())
 
4025
        finally:
 
4026
            if output != '-':
 
4027
                outfile.close()
 
4028
 
 
4029
 
 
4030
class cmd_bundle_revisions(cmd_send):
 
4031
 
 
4032
    """Create a merge-directive for submiting changes.
 
4033
 
 
4034
    A merge directive provides many things needed for requesting merges:
 
4035
 
 
4036
    * A machine-readable description of the merge to perform
 
4037
 
 
4038
    * An optional patch that is a preview of the changes requested
 
4039
 
 
4040
    * An optional bundle of revision data, so that the changes can be applied
 
4041
      directly from the merge directive, without retrieving data from a
 
4042
      branch.
 
4043
 
 
4044
    If --no-bundle is specified, then public_branch is needed (and must be
 
4045
    up-to-date), so that the receiver can perform the merge using the
 
4046
    public_branch.  The public_branch is always included if known, so that
 
4047
    people can check it later.
 
4048
 
 
4049
    The submit branch defaults to the parent, but can be overridden.  Both
 
4050
    submit branch and public branch will be remembered if supplied.
 
4051
 
 
4052
    If a public_branch is known for the submit_branch, that public submit
 
4053
    branch is used in the merge instructions.  This means that a local mirror
 
4054
    can be used as your actual submit branch, once you have set public_branch
 
4055
    for that mirror.
 
4056
 
 
4057
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4058
    merge directive format 2.  It is significantly faster and smaller than
 
4059
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4060
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4061
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4062
    """
 
4063
 
 
4064
    takes_options = [
 
4065
        Option('no-bundle',
 
4066
               help='Do not include a bundle in the merge directive.'),
 
4067
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4068
               ' directive.'),
 
4069
        Option('remember',
 
4070
               help='Remember submit and public branch.'),
 
4071
        Option('from',
 
4072
               help='Branch to generate the submission from, '
 
4073
               'rather than the one containing the working directory.',
 
4074
               short_name='f',
 
4075
               type=unicode),
 
4076
        Option('output', short_name='o', help='Write directive to this file.',
 
4077
               type=unicode),
 
4078
        'revision',
 
4079
        RegistryOption.from_kwargs('format',
 
4080
        'Use the specified output format.',
 
4081
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4082
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4083
        ]
 
4084
    aliases = ['bundle']
 
4085
 
 
4086
    _see_also = ['send', 'merge']
 
4087
 
 
4088
    hidden = True
 
4089
 
 
4090
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4091
            no_patch=False, revision=None, remember=False, output=None,
 
4092
            format='4', **kwargs):
 
4093
        if output is None:
 
4094
            output = '-'
 
4095
        return self._run(submit_branch, revision, public_branch, remember,
 
4096
                         format, no_bundle, no_patch, output,
 
4097
                         kwargs.get('from', '.'), None, None)
 
4098
 
 
4099
 
 
4100
class cmd_tag(Command):
 
4101
    """Create, remove or modify a tag naming a revision.
 
4102
    
 
4103
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4104
    (--revision) option can be given -rtag:X, where X is any previously
 
4105
    created tag.
 
4106
 
 
4107
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4108
    along when you branch, push, pull or merge.
 
4109
 
 
4110
    It is an error to give a tag name that already exists unless you pass 
 
4111
    --force, in which case the tag is moved to point to the new revision.
 
4112
    """
 
4113
 
 
4114
    _see_also = ['commit', 'tags']
 
4115
    takes_args = ['tag_name']
 
4116
    takes_options = [
 
4117
        Option('delete',
 
4118
            help='Delete this tag rather than placing it.',
 
4119
            ),
 
4120
        Option('directory',
 
4121
            help='Branch in which to place the tag.',
 
4122
            short_name='d',
 
4123
            type=unicode,
 
4124
            ),
 
4125
        Option('force',
 
4126
            help='Replace existing tags.',
 
4127
            ),
 
4128
        'revision',
 
4129
        ]
 
4130
 
 
4131
    def run(self, tag_name,
 
4132
            delete=None,
 
4133
            directory='.',
 
4134
            force=None,
 
4135
            revision=None,
 
4136
            ):
 
4137
        branch, relpath = Branch.open_containing(directory)
 
4138
        branch.lock_write()
 
4139
        try:
 
4140
            if delete:
 
4141
                branch.tags.delete_tag(tag_name)
 
4142
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4143
            else:
 
4144
                if revision:
 
4145
                    if len(revision) != 1:
 
4146
                        raise errors.BzrCommandError(
 
4147
                            "Tags can only be placed on a single revision, "
 
4148
                            "not on a range")
 
4149
                    revision_id = revision[0].in_history(branch).rev_id
 
4150
                else:
 
4151
                    revision_id = branch.last_revision()
 
4152
                if (not force) and branch.tags.has_tag(tag_name):
 
4153
                    raise errors.TagAlreadyExists(tag_name)
 
4154
                branch.tags.set_tag(tag_name, revision_id)
 
4155
                self.outf.write('Created tag %s.\n' % tag_name)
 
4156
        finally:
 
4157
            branch.unlock()
 
4158
 
 
4159
 
 
4160
class cmd_tags(Command):
 
4161
    """List tags.
 
4162
 
 
4163
    This tag shows a table of tag names and the revisions they reference.
 
4164
    """
 
4165
 
 
4166
    _see_also = ['tag']
 
4167
    takes_options = [
 
4168
        Option('directory',
 
4169
            help='Branch whose tags should be displayed.',
 
4170
            short_name='d',
 
4171
            type=unicode,
 
4172
            ),
 
4173
    ]
 
4174
 
 
4175
    @display_command
 
4176
    def run(self,
 
4177
            directory='.',
 
4178
            ):
 
4179
        branch, relpath = Branch.open_containing(directory)
 
4180
        for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
 
4181
            self.outf.write('%-20s %s\n' % (tag_name, target))
 
4182
 
 
4183
 
 
4184
class cmd_reconfigure(Command):
 
4185
    """Reconfigure the type of a bzr directory.
 
4186
 
 
4187
    A target configuration must be specified.
 
4188
 
 
4189
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4190
    The order of preference is
 
4191
    1. For a lightweight checkout, the current bound location.
 
4192
    2. For branches that used to be checkouts, the previously-bound location.
 
4193
    3. The push location.
 
4194
    4. The parent location.
 
4195
    If none of these is available, --bind-to must be specified.
 
4196
    """
 
4197
 
 
4198
    takes_args = ['location?']
 
4199
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4200
                     title='Target type',
 
4201
                     help='The type to reconfigure the directory to.',
 
4202
                     value_switches=True, enum_switch=False,
 
4203
                     branch='Reconfigure to a branch.',
 
4204
                     tree='Reconfigure to a tree.',
 
4205
                     checkout='Reconfigure to a checkout.'),
 
4206
                     Option('bind-to', help='Branch to bind checkout to.',
 
4207
                            type=str),
 
4208
                     Option('force',
 
4209
                        help='Perform reconfiguration even if local changes'
 
4210
                        ' will be lost.')
 
4211
                     ]
 
4212
 
 
4213
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4214
        directory = bzrdir.BzrDir.open(location)
 
4215
        if target_type is None:
 
4216
            raise errors.BzrCommandError('No target configuration specified')
 
4217
        elif target_type == 'branch':
 
4218
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
4219
        elif target_type == 'tree':
 
4220
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
4221
        elif target_type == 'checkout':
 
4222
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4223
                                                                  bind_to)
 
4224
        reconfiguration.apply(force)
 
4225
 
 
4226
 
 
4227
def _create_prefix(cur_transport):
 
4228
    needed = [cur_transport]
 
4229
    # Recurse upwards until we can create a directory successfully
 
4230
    while True:
 
4231
        new_transport = cur_transport.clone('..')
 
4232
        if new_transport.base == cur_transport.base:
 
4233
            raise errors.BzrCommandError(
 
4234
                "Failed to create path prefix for %s."
 
4235
                % cur_transport.base)
 
4236
        try:
 
4237
            new_transport.mkdir('.')
 
4238
        except errors.NoSuchFile:
 
4239
            needed.append(new_transport)
 
4240
            cur_transport = new_transport
 
4241
        else:
 
4242
            break
 
4243
    # Now we only need to create child directories
 
4244
    while needed:
 
4245
        cur_transport = needed.pop()
 
4246
        cur_transport.ensure_base()
 
4247
 
 
4248
 
 
4249
def _get_mergeable_helper(location):
 
4250
    """Get a merge directive or bundle if 'location' points to one.
 
4251
 
 
4252
    Try try to identify a bundle and returns its mergeable form. If it's not,
 
4253
    we return the tried transport anyway so that it can reused to access the
 
4254
    branch
 
4255
 
 
4256
    :param location: can point to a bundle or a branch.
 
4257
 
 
4258
    :return: mergeable, transport
 
4259
    """
 
4260
    mergeable = None
 
4261
    url = urlutils.normalize_url(location)
 
4262
    url, filename = urlutils.split(url, exclude_trailing_slash=False)
 
4263
    location_transport = transport.get_transport(url)
 
4264
    if filename:
 
4265
        try:
 
4266
            # There may be redirections but we ignore the intermediate
 
4267
            # and final transports used
 
4268
            read = bundle.read_mergeable_from_transport
 
4269
            mergeable, t = read(location_transport, filename)
 
4270
        except errors.NotABundle:
 
4271
            # Continue on considering this url a Branch but adjust the
 
4272
            # location_transport
 
4273
            location_transport = location_transport.clone(filename)
 
4274
    return mergeable, location_transport
 
4275
 
 
4276
 
 
4277
# these get imported and then picked up by the scan for cmd_*
 
4278
# TODO: Some more consistent way to split command definitions across files;
 
4279
# we do need to load at least some information about them to know of 
 
4280
# aliases.  ideally we would avoid loading the implementation until the
 
4281
# details were needed.
 
4282
from bzrlib.cmd_version_info import cmd_version_info
 
4283
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4284
from bzrlib.bundle.commands import (
 
4285
    cmd_bundle_info,
 
4286
    )
 
4287
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4288
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
 
4289
        cmd_weave_plan_merge, cmd_weave_merge_text