/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: John Arbash Meinel
  • Date: 2009-02-24 19:07:29 UTC
  • mto: This revision was merged to the branch mainline in revision 4041.
  • Revision ID: john@arbash-meinel.com-20090224190729-pvb2vrgwajvw65jz
Local modification to exclude certain system DLLs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
import os
 
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
import codecs
 
24
import cStringIO
 
25
import sys
 
26
import time
 
27
 
 
28
import bzrlib
 
29
from bzrlib import (
 
30
    bugtracker,
 
31
    bundle,
 
32
    btree_index,
 
33
    bzrdir,
 
34
    delta,
 
35
    config,
 
36
    errors,
 
37
    globbing,
 
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, RevisionInfo
 
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 (
 
59
    ListOption,
 
60
    Option,
 
61
    RegistryOption,
 
62
    custom_help,
 
63
    _parse_revision_str,
 
64
    )
 
65
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
 
66
 
 
67
 
 
68
def tree_files(file_list, default_branch=u'.', canonicalize=True):
 
69
    try:
 
70
        return internal_tree_files(file_list, default_branch, canonicalize)
 
71
    except errors.FileInWrongBranch, e:
 
72
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
73
                                     (e.path, file_list[0]))
 
74
 
 
75
 
 
76
def _get_one_revision(command_name, revisions):
 
77
    if revisions is None:
 
78
        return None
 
79
    if len(revisions) != 1:
 
80
        raise errors.BzrCommandError(
 
81
            'bzr %s --revision takes exactly one revision identifier' % (
 
82
                command_name,))
 
83
    return revisions[0]
 
84
 
 
85
 
 
86
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
87
    if branch is None:
 
88
        branch = tree.branch
 
89
    if revisions is None:
 
90
        if tree is not None:
 
91
            rev_tree = tree.basis_tree()
 
92
        else:
 
93
            rev_tree = branch.basis_tree()
 
94
    else:
 
95
        revision = _get_one_revision(command_name, revisions)
 
96
        rev_tree = revision.as_tree(branch)
 
97
    return rev_tree
 
98
 
 
99
 
 
100
# XXX: Bad function name; should possibly also be a class method of
 
101
# WorkingTree rather than a function.
 
102
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True):
 
103
    """Convert command-line paths to a WorkingTree and relative paths.
 
104
 
 
105
    This is typically used for command-line processors that take one or
 
106
    more filenames, and infer the workingtree that contains them.
 
107
 
 
108
    The filenames given are not required to exist.
 
109
 
 
110
    :param file_list: Filenames to convert.  
 
111
 
 
112
    :param default_branch: Fallback tree path to use if file_list is empty or
 
113
        None.
 
114
 
 
115
    :return: workingtree, [relative_paths]
 
116
    """
 
117
    if file_list is None or len(file_list) == 0:
 
118
        return WorkingTree.open_containing(default_branch)[0], file_list
 
119
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
120
    return tree, safe_relpath_files(tree, file_list, canonicalize)
 
121
 
 
122
 
 
123
def safe_relpath_files(tree, file_list, canonicalize=True):
 
124
    """Convert file_list into a list of relpaths in tree.
 
125
 
 
126
    :param tree: A tree to operate on.
 
127
    :param file_list: A list of user provided paths or None.
 
128
    :return: A list of relative paths.
 
129
    :raises errors.PathNotChild: When a provided path is in a different tree
 
130
        than tree.
 
131
    """
 
132
    if file_list is None:
 
133
        return None
 
134
    new_list = []
 
135
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
136
    # doesn't - fix that up here before we enter the loop.
 
137
    if canonicalize:
 
138
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
139
    else:
 
140
        fixer = tree.relpath
 
141
    for filename in file_list:
 
142
        try:
 
143
            new_list.append(fixer(osutils.dereference_path(filename)))
 
144
        except errors.PathNotChild:
 
145
            raise errors.FileInWrongBranch(tree.branch, filename)
 
146
    return new_list
 
147
 
 
148
 
 
149
# TODO: Make sure no commands unconditionally use the working directory as a
 
150
# branch.  If a filename argument is used, the first of them should be used to
 
151
# specify the branch.  (Perhaps this can be factored out into some kind of
 
152
# Argument class, representing a file in a branch, where the first occurrence
 
153
# opens the branch?)
 
154
 
 
155
class cmd_status(Command):
 
156
    """Display status summary.
 
157
 
 
158
    This reports on versioned and unknown files, reporting them
 
159
    grouped by state.  Possible states are:
 
160
 
 
161
    added
 
162
        Versioned in the working copy but not in the previous revision.
 
163
 
 
164
    removed
 
165
        Versioned in the previous revision but removed or deleted
 
166
        in the working copy.
 
167
 
 
168
    renamed
 
169
        Path of this file changed from the previous revision;
 
170
        the text may also have changed.  This includes files whose
 
171
        parent directory was renamed.
 
172
 
 
173
    modified
 
174
        Text has changed since the previous revision.
 
175
 
 
176
    kind changed
 
177
        File kind has been changed (e.g. from file to directory).
 
178
 
 
179
    unknown
 
180
        Not versioned and not matching an ignore pattern.
 
181
 
 
182
    To see ignored files use 'bzr ignored'.  For details on the
 
183
    changes to file texts, use 'bzr diff'.
 
184
    
 
185
    Note that --short or -S gives status flags for each item, similar
 
186
    to Subversion's status command. To get output similar to svn -q,
 
187
    use bzr status -SV.
 
188
 
 
189
    If no arguments are specified, the status of the entire working
 
190
    directory is shown.  Otherwise, only the status of the specified
 
191
    files or directories is reported.  If a directory is given, status
 
192
    is reported for everything inside that directory.
 
193
 
 
194
    Before merges are committed, the pending merge tip revisions are
 
195
    shown. To see all pending merge revisions, use the -v option.
 
196
    To skip the display of pending merge information altogether, use
 
197
    the no-pending option or specify a file/directory.
 
198
 
 
199
    If a revision argument is given, the status is calculated against
 
200
    that revision, or between two revisions if two are provided.
 
201
    """
 
202
    
 
203
    # TODO: --no-recurse, --recurse options
 
204
    
 
205
    takes_args = ['file*']
 
206
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
207
                     Option('short', help='Use short status indicators.',
 
208
                            short_name='S'),
 
209
                     Option('versioned', help='Only show versioned files.',
 
210
                            short_name='V'),
 
211
                     Option('no-pending', help='Don\'t show pending merges.',
 
212
                           ),
 
213
                     ]
 
214
    aliases = ['st', 'stat']
 
215
 
 
216
    encoding_type = 'replace'
 
217
    _see_also = ['diff', 'revert', 'status-flags']
 
218
    
 
219
    @display_command
 
220
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
221
            versioned=False, no_pending=False, verbose=False):
 
222
        from bzrlib.status import show_tree_status
 
223
 
 
224
        if revision and len(revision) > 2:
 
225
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
226
                                         ' one or two revision specifiers')
 
227
 
 
228
        tree, relfile_list = tree_files(file_list)
 
229
        # Avoid asking for specific files when that is not needed.
 
230
        if relfile_list == ['']:
 
231
            relfile_list = None
 
232
            # Don't disable pending merges for full trees other than '.'.
 
233
            if file_list == ['.']:
 
234
                no_pending = True
 
235
        # A specific path within a tree was given.
 
236
        elif relfile_list is not None:
 
237
            no_pending = True
 
238
        show_tree_status(tree, show_ids=show_ids,
 
239
                         specific_files=relfile_list, revision=revision,
 
240
                         to_file=self.outf, short=short, versioned=versioned,
 
241
                         show_pending=(not no_pending), verbose=verbose)
 
242
 
 
243
 
 
244
class cmd_cat_revision(Command):
 
245
    """Write out metadata for a revision.
 
246
    
 
247
    The revision to print can either be specified by a specific
 
248
    revision identifier, or you can use --revision.
 
249
    """
 
250
 
 
251
    hidden = True
 
252
    takes_args = ['revision_id?']
 
253
    takes_options = ['revision']
 
254
    # cat-revision is more for frontends so should be exact
 
255
    encoding = 'strict'
 
256
    
 
257
    @display_command
 
258
    def run(self, revision_id=None, revision=None):
 
259
        if revision_id is not None and revision is not None:
 
260
            raise errors.BzrCommandError('You can only supply one of'
 
261
                                         ' revision_id or --revision')
 
262
        if revision_id is None and revision is None:
 
263
            raise errors.BzrCommandError('You must supply either'
 
264
                                         ' --revision or a revision_id')
 
265
        b = WorkingTree.open_containing(u'.')[0].branch
 
266
 
 
267
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
268
        if revision_id is not None:
 
269
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
270
            try:
 
271
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
272
            except errors.NoSuchRevision:
 
273
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
274
                    revision_id)
 
275
                raise errors.BzrCommandError(msg)
 
276
        elif revision is not None:
 
277
            for rev in revision:
 
278
                if rev is None:
 
279
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
280
                                                 ' revision.')
 
281
                rev_id = rev.as_revision_id(b)
 
282
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
283
 
 
284
 
 
285
class cmd_dump_btree(Command):
 
286
    """Dump the contents of a btree index file to stdout.
 
287
 
 
288
    PATH is a btree index file, it can be any URL. This includes things like
 
289
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
 
290
 
 
291
    By default, the tuples stored in the index file will be displayed. With
 
292
    --raw, we will uncompress the pages, but otherwise display the raw bytes
 
293
    stored in the index.
 
294
    """
 
295
 
 
296
    # TODO: Do we want to dump the internal nodes as well?
 
297
    # TODO: It would be nice to be able to dump the un-parsed information,
 
298
    #       rather than only going through iter_all_entries. However, this is
 
299
    #       good enough for a start
 
300
    hidden = True
 
301
    encoding_type = 'exact'
 
302
    takes_args = ['path']
 
303
    takes_options = [Option('raw', help='Write the uncompressed bytes out,'
 
304
                                        ' rather than the parsed tuples.'),
 
305
                    ]
 
306
 
 
307
    def run(self, path, raw=False):
 
308
        dirname, basename = osutils.split(path)
 
309
        t = transport.get_transport(dirname)
 
310
        if raw:
 
311
            self._dump_raw_bytes(t, basename)
 
312
        else:
 
313
            self._dump_entries(t, basename)
 
314
 
 
315
    def _get_index_and_bytes(self, trans, basename):
 
316
        """Create a BTreeGraphIndex and raw bytes."""
 
317
        bt = btree_index.BTreeGraphIndex(trans, basename, None)
 
318
        bytes = trans.get_bytes(basename)
 
319
        bt._file = cStringIO.StringIO(bytes)
 
320
        bt._size = len(bytes)
 
321
        return bt, bytes
 
322
 
 
323
    def _dump_raw_bytes(self, trans, basename):
 
324
        import zlib
 
325
 
 
326
        # We need to parse at least the root node.
 
327
        # This is because the first page of every row starts with an
 
328
        # uncompressed header.
 
329
        bt, bytes = self._get_index_and_bytes(trans, basename)
 
330
        for page_idx, page_start in enumerate(xrange(0, len(bytes),
 
331
                                                     btree_index._PAGE_SIZE)):
 
332
            page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
 
333
            page_bytes = bytes[page_start:page_end]
 
334
            if page_idx == 0:
 
335
                self.outf.write('Root node:\n')
 
336
                header_end, data = bt._parse_header_from_bytes(page_bytes)
 
337
                self.outf.write(page_bytes[:header_end])
 
338
                page_bytes = data
 
339
            self.outf.write('\nPage %d\n' % (page_idx,))
 
340
            decomp_bytes = zlib.decompress(page_bytes)
 
341
            self.outf.write(decomp_bytes)
 
342
            self.outf.write('\n')
 
343
 
 
344
    def _dump_entries(self, trans, basename):
 
345
        try:
 
346
            st = trans.stat(basename)
 
347
        except errors.TransportNotPossible:
 
348
            # We can't stat, so we'll fake it because we have to do the 'get()'
 
349
            # anyway.
 
350
            bt, _ = self._get_index_and_bytes(trans, basename)
 
351
        else:
 
352
            bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
 
353
        for node in bt.iter_all_entries():
 
354
            # Node is made up of:
 
355
            # (index, key, value, [references])
 
356
            self.outf.write('%s\n' % (node[1:],))
 
357
 
 
358
 
 
359
class cmd_remove_tree(Command):
 
360
    """Remove the working tree from a given branch/checkout.
 
361
 
 
362
    Since a lightweight checkout is little more than a working tree
 
363
    this will refuse to run against one.
 
364
 
 
365
    To re-create the working tree, use "bzr checkout".
 
366
    """
 
367
    _see_also = ['checkout', 'working-trees']
 
368
    takes_args = ['location?']
 
369
    takes_options = [
 
370
        Option('force',
 
371
               help='Remove the working tree even if it has '
 
372
                    'uncommitted changes.'),
 
373
        ]
 
374
 
 
375
    def run(self, location='.', force=False):
 
376
        d = bzrdir.BzrDir.open(location)
 
377
        
 
378
        try:
 
379
            working = d.open_workingtree()
 
380
        except errors.NoWorkingTree:
 
381
            raise errors.BzrCommandError("No working tree to remove")
 
382
        except errors.NotLocalUrl:
 
383
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
384
                                         "remote path")
 
385
        if not force:
 
386
            changes = working.changes_from(working.basis_tree())
 
387
            if changes.has_changed():
 
388
                raise errors.UncommittedChanges(working)
 
389
 
 
390
        working_path = working.bzrdir.root_transport.base
 
391
        branch_path = working.branch.bzrdir.root_transport.base
 
392
        if working_path != branch_path:
 
393
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
394
                                         "a lightweight checkout")
 
395
        
 
396
        d.destroy_workingtree()
 
397
        
 
398
 
 
399
class cmd_revno(Command):
 
400
    """Show current revision number.
 
401
 
 
402
    This is equal to the number of revisions on this branch.
 
403
    """
 
404
 
 
405
    _see_also = ['info']
 
406
    takes_args = ['location?']
 
407
 
 
408
    @display_command
 
409
    def run(self, location=u'.'):
 
410
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
411
        self.outf.write('\n')
 
412
 
 
413
 
 
414
class cmd_revision_info(Command):
 
415
    """Show revision number and revision id for a given revision identifier.
 
416
    """
 
417
    hidden = True
 
418
    takes_args = ['revision_info*']
 
419
    takes_options = [
 
420
        'revision',
 
421
        Option('directory',
 
422
            help='Branch to examine, '
 
423
                 'rather than the one containing the working directory.',
 
424
            short_name='d',
 
425
            type=unicode,
 
426
            ),
 
427
        ]
 
428
 
 
429
    @display_command
 
430
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
431
 
 
432
        revs = []
 
433
        if revision is not None:
 
434
            revs.extend(revision)
 
435
        if revision_info_list is not None:
 
436
            for rev in revision_info_list:
 
437
                revs.append(RevisionSpec.from_string(rev))
 
438
 
 
439
        b = Branch.open_containing(directory)[0]
 
440
 
 
441
        if len(revs) == 0:
 
442
            revs.append(RevisionSpec.from_string('-1'))
 
443
 
 
444
        for rev in revs:
 
445
            revision_id = rev.as_revision_id(b)
 
446
            try:
 
447
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
448
            except errors.NoSuchRevision:
 
449
                dotted_map = b.get_revision_id_to_revno_map()
 
450
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
451
            print '%s %s' % (revno, revision_id)
 
452
 
 
453
    
 
454
class cmd_add(Command):
 
455
    """Add specified files or directories.
 
456
 
 
457
    In non-recursive mode, all the named items are added, regardless
 
458
    of whether they were previously ignored.  A warning is given if
 
459
    any of the named files are already versioned.
 
460
 
 
461
    In recursive mode (the default), files are treated the same way
 
462
    but the behaviour for directories is different.  Directories that
 
463
    are already versioned do not give a warning.  All directories,
 
464
    whether already versioned or not, are searched for files or
 
465
    subdirectories that are neither versioned or ignored, and these
 
466
    are added.  This search proceeds recursively into versioned
 
467
    directories.  If no names are given '.' is assumed.
 
468
 
 
469
    Therefore simply saying 'bzr add' will version all files that
 
470
    are currently unknown.
 
471
 
 
472
    Adding a file whose parent directory is not versioned will
 
473
    implicitly add the parent, and so on up to the root. This means
 
474
    you should never need to explicitly add a directory, they'll just
 
475
    get added when you add a file in the directory.
 
476
 
 
477
    --dry-run will show which files would be added, but not actually 
 
478
    add them.
 
479
 
 
480
    --file-ids-from will try to use the file ids from the supplied path.
 
481
    It looks up ids trying to find a matching parent directory with the
 
482
    same filename, and then by pure path. This option is rarely needed
 
483
    but can be useful when adding the same logical file into two
 
484
    branches that will be merged later (without showing the two different
 
485
    adds as a conflict). It is also useful when merging another project
 
486
    into a subdirectory of this one.
 
487
    """
 
488
    takes_args = ['file*']
 
489
    takes_options = [
 
490
        Option('no-recurse',
 
491
               help="Don't recursively add the contents of directories."),
 
492
        Option('dry-run',
 
493
               help="Show what would be done, but don't actually do anything."),
 
494
        'verbose',
 
495
        Option('file-ids-from',
 
496
               type=unicode,
 
497
               help='Lookup file ids from this tree.'),
 
498
        ]
 
499
    encoding_type = 'replace'
 
500
    _see_also = ['remove']
 
501
 
 
502
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
503
            file_ids_from=None):
 
504
        import bzrlib.add
 
505
 
 
506
        base_tree = None
 
507
        if file_ids_from is not None:
 
508
            try:
 
509
                base_tree, base_path = WorkingTree.open_containing(
 
510
                                            file_ids_from)
 
511
            except errors.NoWorkingTree:
 
512
                base_branch, base_path = Branch.open_containing(
 
513
                                            file_ids_from)
 
514
                base_tree = base_branch.basis_tree()
 
515
 
 
516
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
517
                          to_file=self.outf, should_print=(not is_quiet()))
 
518
        else:
 
519
            action = bzrlib.add.AddAction(to_file=self.outf,
 
520
                should_print=(not is_quiet()))
 
521
 
 
522
        if base_tree:
 
523
            base_tree.lock_read()
 
524
        try:
 
525
            file_list = self._maybe_expand_globs(file_list)
 
526
            if file_list:
 
527
                tree = WorkingTree.open_containing(file_list[0])[0]
 
528
            else:
 
529
                tree = WorkingTree.open_containing(u'.')[0]
 
530
            added, ignored = tree.smart_add(file_list, not
 
531
                no_recurse, action=action, save=not dry_run)
 
532
        finally:
 
533
            if base_tree is not None:
 
534
                base_tree.unlock()
 
535
        if not is_quiet() and len(added) > 0:
 
536
            self.outf.write('add completed\n')
 
537
        if len(ignored) > 0:
 
538
            if verbose:
 
539
                for glob in sorted(ignored.keys()):
 
540
                    for path in ignored[glob]:
 
541
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
542
                                        % (path, glob))
 
543
            else:
 
544
                match_len = 0
 
545
                for glob, paths in ignored.items():
 
546
                    match_len += len(paths)
 
547
                self.outf.write("ignored %d file(s).\n" % match_len)
 
548
            self.outf.write("If you wish to add some of these files,"
 
549
                            " please add them by name.\n")
 
550
 
 
551
 
 
552
class cmd_mkdir(Command):
 
553
    """Create a new versioned directory.
 
554
 
 
555
    This is equivalent to creating the directory and then adding it.
 
556
    """
 
557
 
 
558
    takes_args = ['dir+']
 
559
    encoding_type = 'replace'
 
560
 
 
561
    def run(self, dir_list):
 
562
        for d in dir_list:
 
563
            os.mkdir(d)
 
564
            wt, dd = WorkingTree.open_containing(d)
 
565
            wt.add([dd])
 
566
            self.outf.write('added %s\n' % d)
 
567
 
 
568
 
 
569
class cmd_relpath(Command):
 
570
    """Show path of a file relative to root"""
 
571
 
 
572
    takes_args = ['filename']
 
573
    hidden = True
 
574
    
 
575
    @display_command
 
576
    def run(self, filename):
 
577
        # TODO: jam 20050106 Can relpath return a munged path if
 
578
        #       sys.stdout encoding cannot represent it?
 
579
        tree, relpath = WorkingTree.open_containing(filename)
 
580
        self.outf.write(relpath)
 
581
        self.outf.write('\n')
 
582
 
 
583
 
 
584
class cmd_inventory(Command):
 
585
    """Show inventory of the current working copy or a revision.
 
586
 
 
587
    It is possible to limit the output to a particular entry
 
588
    type using the --kind option.  For example: --kind file.
 
589
 
 
590
    It is also possible to restrict the list of files to a specific
 
591
    set. For example: bzr inventory --show-ids this/file
 
592
    """
 
593
 
 
594
    hidden = True
 
595
    _see_also = ['ls']
 
596
    takes_options = [
 
597
        'revision',
 
598
        'show-ids',
 
599
        Option('kind',
 
600
               help='List entries of a particular kind: file, directory, symlink.',
 
601
               type=unicode),
 
602
        ]
 
603
    takes_args = ['file*']
 
604
 
 
605
    @display_command
 
606
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
607
        if kind and kind not in ['file', 'directory', 'symlink']:
 
608
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
609
 
 
610
        revision = _get_one_revision('inventory', revision)
 
611
        work_tree, file_list = tree_files(file_list)
 
612
        work_tree.lock_read()
 
613
        try:
 
614
            if revision is not None:
 
615
                tree = revision.as_tree(work_tree.branch)
 
616
 
 
617
                extra_trees = [work_tree]
 
618
                tree.lock_read()
 
619
            else:
 
620
                tree = work_tree
 
621
                extra_trees = []
 
622
 
 
623
            if file_list is not None:
 
624
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
625
                                          require_versioned=True)
 
626
                # find_ids_across_trees may include some paths that don't
 
627
                # exist in 'tree'.
 
628
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
629
                                 for file_id in file_ids if file_id in tree)
 
630
            else:
 
631
                entries = tree.inventory.entries()
 
632
        finally:
 
633
            tree.unlock()
 
634
            if tree is not work_tree:
 
635
                work_tree.unlock()
 
636
 
 
637
        for path, entry in entries:
 
638
            if kind and kind != entry.kind:
 
639
                continue
 
640
            if show_ids:
 
641
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
642
            else:
 
643
                self.outf.write(path)
 
644
                self.outf.write('\n')
 
645
 
 
646
 
 
647
class cmd_mv(Command):
 
648
    """Move or rename a file.
 
649
 
 
650
    :Usage:
 
651
        bzr mv OLDNAME NEWNAME
 
652
 
 
653
        bzr mv SOURCE... DESTINATION
 
654
 
 
655
    If the last argument is a versioned directory, all the other names
 
656
    are moved into it.  Otherwise, there must be exactly two arguments
 
657
    and the file is changed to a new name.
 
658
 
 
659
    If OLDNAME does not exist on the filesystem but is versioned and
 
660
    NEWNAME does exist on the filesystem but is not versioned, mv
 
661
    assumes that the file has been manually moved and only updates
 
662
    its internal inventory to reflect that change.
 
663
    The same is valid when moving many SOURCE files to a DESTINATION.
 
664
 
 
665
    Files cannot be moved between branches.
 
666
    """
 
667
 
 
668
    takes_args = ['names*']
 
669
    takes_options = [Option("after", help="Move only the bzr identifier"
 
670
        " of the file, because the file has already been moved."),
 
671
        ]
 
672
    aliases = ['move', 'rename']
 
673
    encoding_type = 'replace'
 
674
 
 
675
    def run(self, names_list, after=False):
 
676
        if names_list is None:
 
677
            names_list = []
 
678
 
 
679
        if len(names_list) < 2:
 
680
            raise errors.BzrCommandError("missing file argument")
 
681
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
682
        tree.lock_write()
 
683
        try:
 
684
            self._run(tree, names_list, rel_names, after)
 
685
        finally:
 
686
            tree.unlock()
 
687
 
 
688
    def _run(self, tree, names_list, rel_names, after):
 
689
        into_existing = osutils.isdir(names_list[-1])
 
690
        if into_existing and len(names_list) == 2:
 
691
            # special cases:
 
692
            # a. case-insensitive filesystem and change case of dir
 
693
            # b. move directory after the fact (if the source used to be
 
694
            #    a directory, but now doesn't exist in the working tree
 
695
            #    and the target is an existing directory, just rename it)
 
696
            if (not tree.case_sensitive
 
697
                and rel_names[0].lower() == rel_names[1].lower()):
 
698
                into_existing = False
 
699
            else:
 
700
                inv = tree.inventory
 
701
                # 'fix' the case of a potential 'from'
 
702
                from_id = tree.path2id(
 
703
                            tree.get_canonical_inventory_path(rel_names[0]))
 
704
                if (not osutils.lexists(names_list[0]) and
 
705
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
706
                    into_existing = False
 
707
        # move/rename
 
708
        if into_existing:
 
709
            # move into existing directory
 
710
            # All entries reference existing inventory items, so fix them up
 
711
            # for cicp file-systems.
 
712
            rel_names = tree.get_canonical_inventory_paths(rel_names)
 
713
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
714
                self.outf.write("%s => %s\n" % pair)
 
715
        else:
 
716
            if len(names_list) != 2:
 
717
                raise errors.BzrCommandError('to mv multiple files the'
 
718
                                             ' destination must be a versioned'
 
719
                                             ' directory')
 
720
 
 
721
            # for cicp file-systems: the src references an existing inventory
 
722
            # item:
 
723
            src = tree.get_canonical_inventory_path(rel_names[0])
 
724
            # Find the canonical version of the destination:  In all cases, the
 
725
            # parent of the target must be in the inventory, so we fetch the
 
726
            # canonical version from there (we do not always *use* the
 
727
            # canonicalized tail portion - we may be attempting to rename the
 
728
            # case of the tail)
 
729
            canon_dest = tree.get_canonical_inventory_path(rel_names[1])
 
730
            dest_parent = osutils.dirname(canon_dest)
 
731
            spec_tail = osutils.basename(rel_names[1])
 
732
            # For a CICP file-system, we need to avoid creating 2 inventory
 
733
            # entries that differ only by case.  So regardless of the case
 
734
            # we *want* to use (ie, specified by the user or the file-system),
 
735
            # we must always choose to use the case of any existing inventory
 
736
            # items.  The only exception to this is when we are attempting a
 
737
            # case-only rename (ie, canonical versions of src and dest are
 
738
            # the same)
 
739
            dest_id = tree.path2id(canon_dest)
 
740
            if dest_id is None or tree.path2id(src) == dest_id:
 
741
                # No existing item we care about, so work out what case we
 
742
                # are actually going to use.
 
743
                if after:
 
744
                    # If 'after' is specified, the tail must refer to a file on disk.
 
745
                    if dest_parent:
 
746
                        dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
 
747
                    else:
 
748
                        # pathjoin with an empty tail adds a slash, which breaks
 
749
                        # relpath :(
 
750
                        dest_parent_fq = tree.basedir
 
751
    
 
752
                    dest_tail = osutils.canonical_relpath(
 
753
                                    dest_parent_fq,
 
754
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
 
755
                else:
 
756
                    # not 'after', so case as specified is used
 
757
                    dest_tail = spec_tail
 
758
            else:
 
759
                # Use the existing item so 'mv' fails with AlreadyVersioned.
 
760
                dest_tail = os.path.basename(canon_dest)
 
761
            dest = osutils.pathjoin(dest_parent, dest_tail)
 
762
            mutter("attempting to move %s => %s", src, dest)
 
763
            tree.rename_one(src, dest, after=after)
 
764
            self.outf.write("%s => %s\n" % (src, dest))
 
765
 
 
766
 
 
767
class cmd_pull(Command):
 
768
    """Turn this branch into a mirror of another branch.
 
769
 
 
770
    This command only works on branches that have not diverged.  Branches are
 
771
    considered diverged if the destination branch's most recent commit is one
 
772
    that has not been merged (directly or indirectly) into the parent.
 
773
 
 
774
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
775
    from one into the other.  Once one branch has merged, the other should
 
776
    be able to pull it again.
 
777
 
 
778
    If you want to forget your local changes and just update your branch to
 
779
    match the remote one, use pull --overwrite.
 
780
 
 
781
    If there is no default location set, the first pull will set it.  After
 
782
    that, you can omit the location to use the default.  To change the
 
783
    default, use --remember. The value will only be saved if the remote
 
784
    location can be accessed.
 
785
 
 
786
    Note: The location can be specified either in the form of a branch,
 
787
    or in the form of a path to a file containing a merge directive generated
 
788
    with bzr send.
 
789
    """
 
790
 
 
791
    _see_also = ['push', 'update', 'status-flags']
 
792
    takes_options = ['remember', 'overwrite', 'revision',
 
793
        custom_help('verbose',
 
794
            help='Show logs of pulled revisions.'),
 
795
        Option('directory',
 
796
            help='Branch to pull into, '
 
797
                 'rather than the one containing the working directory.',
 
798
            short_name='d',
 
799
            type=unicode,
 
800
            ),
 
801
        ]
 
802
    takes_args = ['location?']
 
803
    encoding_type = 'replace'
 
804
 
 
805
    def run(self, location=None, remember=False, overwrite=False,
 
806
            revision=None, verbose=False,
 
807
            directory=None):
 
808
        # FIXME: too much stuff is in the command class
 
809
        revision_id = None
 
810
        mergeable = None
 
811
        if directory is None:
 
812
            directory = u'.'
 
813
        try:
 
814
            tree_to = WorkingTree.open_containing(directory)[0]
 
815
            branch_to = tree_to.branch
 
816
        except errors.NoWorkingTree:
 
817
            tree_to = None
 
818
            branch_to = Branch.open_containing(directory)[0]
 
819
 
 
820
        possible_transports = []
 
821
        if location is not None:
 
822
            try:
 
823
                mergeable = bundle.read_mergeable_from_url(location,
 
824
                    possible_transports=possible_transports)
 
825
            except errors.NotABundle:
 
826
                mergeable = None
 
827
 
 
828
        stored_loc = branch_to.get_parent()
 
829
        if location is None:
 
830
            if stored_loc is None:
 
831
                raise errors.BzrCommandError("No pull location known or"
 
832
                                             " specified.")
 
833
            else:
 
834
                display_url = urlutils.unescape_for_display(stored_loc,
 
835
                        self.outf.encoding)
 
836
                if not is_quiet():
 
837
                    self.outf.write("Using saved parent location: %s\n" % display_url)
 
838
                location = stored_loc
 
839
 
 
840
        revision = _get_one_revision('pull', revision)
 
841
        if mergeable is not None:
 
842
            if revision is not None:
 
843
                raise errors.BzrCommandError(
 
844
                    'Cannot use -r with merge directives or bundles')
 
845
            mergeable.install_revisions(branch_to.repository)
 
846
            base_revision_id, revision_id, verified = \
 
847
                mergeable.get_merge_request(branch_to.repository)
 
848
            branch_from = branch_to
 
849
        else:
 
850
            branch_from = Branch.open(location,
 
851
                possible_transports=possible_transports)
 
852
 
 
853
            if branch_to.get_parent() is None or remember:
 
854
                branch_to.set_parent(branch_from.base)
 
855
 
 
856
        if revision is not None:
 
857
            revision_id = revision.as_revision_id(branch_from)
 
858
 
 
859
        branch_to.lock_write()
 
860
        try:
 
861
            if tree_to is not None:
 
862
                change_reporter = delta._ChangeReporter(
 
863
                    unversioned_filter=tree_to.is_ignored)
 
864
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
865
                                      change_reporter,
 
866
                                      possible_transports=possible_transports)
 
867
            else:
 
868
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
869
 
 
870
            result.report(self.outf)
 
871
            if verbose and result.old_revid != result.new_revid:
 
872
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
873
                                       result.old_revid)
 
874
        finally:
 
875
            branch_to.unlock()
 
876
 
 
877
 
 
878
class cmd_push(Command):
 
879
    """Update a mirror of this branch.
 
880
    
 
881
    The target branch will not have its working tree populated because this
 
882
    is both expensive, and is not supported on remote file systems.
 
883
    
 
884
    Some smart servers or protocols *may* put the working tree in place in
 
885
    the future.
 
886
 
 
887
    This command only works on branches that have not diverged.  Branches are
 
888
    considered diverged if the destination branch's most recent commit is one
 
889
    that has not been merged (directly or indirectly) by the source branch.
 
890
 
 
891
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
892
    the other branch completely, discarding its unmerged changes.
 
893
    
 
894
    If you want to ensure you have the different changes in the other branch,
 
895
    do a merge (see bzr help merge) from the other branch, and commit that.
 
896
    After that you will be able to do a push without '--overwrite'.
 
897
 
 
898
    If there is no default push location set, the first push will set it.
 
899
    After that, you can omit the location to use the default.  To change the
 
900
    default, use --remember. The value will only be saved if the remote
 
901
    location can be accessed.
 
902
    """
 
903
 
 
904
    _see_also = ['pull', 'update', 'working-trees']
 
905
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
906
        Option('create-prefix',
 
907
               help='Create the path leading up to the branch '
 
908
                    'if it does not already exist.'),
 
909
        Option('directory',
 
910
            help='Branch to push from, '
 
911
                 'rather than the one containing the working directory.',
 
912
            short_name='d',
 
913
            type=unicode,
 
914
            ),
 
915
        Option('use-existing-dir',
 
916
               help='By default push will fail if the target'
 
917
                    ' directory exists, but does not already'
 
918
                    ' have a control directory.  This flag will'
 
919
                    ' allow push to proceed.'),
 
920
        Option('stacked',
 
921
            help='Create a stacked branch that references the public location '
 
922
                'of the parent branch.'),
 
923
        Option('stacked-on',
 
924
            help='Create a stacked branch that refers to another branch '
 
925
                'for the commit history. Only the work not present in the '
 
926
                'referenced branch is included in the branch created.',
 
927
            type=unicode),
 
928
        ]
 
929
    takes_args = ['location?']
 
930
    encoding_type = 'replace'
 
931
 
 
932
    def run(self, location=None, remember=False, overwrite=False,
 
933
        create_prefix=False, verbose=False, revision=None,
 
934
        use_existing_dir=False, directory=None, stacked_on=None,
 
935
        stacked=False):
 
936
        from bzrlib.push import _show_push_branch
 
937
 
 
938
        # Get the source branch and revision_id
 
939
        if directory is None:
 
940
            directory = '.'
 
941
        br_from = Branch.open_containing(directory)[0]
 
942
        revision = _get_one_revision('push', revision)
 
943
        if revision is not None:
 
944
            revision_id = revision.in_history(br_from).rev_id
 
945
        else:
 
946
            revision_id = br_from.last_revision()
 
947
 
 
948
        # Get the stacked_on branch, if any
 
949
        if stacked_on is not None:
 
950
            stacked_on = urlutils.normalize_url(stacked_on)
 
951
        elif stacked:
 
952
            parent_url = br_from.get_parent()
 
953
            if parent_url:
 
954
                parent = Branch.open(parent_url)
 
955
                stacked_on = parent.get_public_branch()
 
956
                if not stacked_on:
 
957
                    # I considered excluding non-http url's here, thus forcing
 
958
                    # 'public' branches only, but that only works for some
 
959
                    # users, so it's best to just depend on the user spotting an
 
960
                    # error by the feedback given to them. RBC 20080227.
 
961
                    stacked_on = parent_url
 
962
            if not stacked_on:
 
963
                raise errors.BzrCommandError(
 
964
                    "Could not determine branch to refer to.")
 
965
 
 
966
        # Get the destination location
 
967
        if location is None:
 
968
            stored_loc = br_from.get_push_location()
 
969
            if stored_loc is None:
 
970
                raise errors.BzrCommandError(
 
971
                    "No push location known or specified.")
 
972
            else:
 
973
                display_url = urlutils.unescape_for_display(stored_loc,
 
974
                        self.outf.encoding)
 
975
                self.outf.write("Using saved push location: %s\n" % display_url)
 
976
                location = stored_loc
 
977
 
 
978
        _show_push_branch(br_from, revision_id, location, self.outf,
 
979
            verbose=verbose, overwrite=overwrite, remember=remember,
 
980
            stacked_on=stacked_on, create_prefix=create_prefix,
 
981
            use_existing_dir=use_existing_dir)
 
982
 
 
983
 
 
984
class cmd_branch(Command):
 
985
    """Create a new copy of a branch.
 
986
 
 
987
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
988
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
989
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
990
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
991
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
992
    create ./foo-bar.
 
993
 
 
994
    To retrieve the branch as of a particular revision, supply the --revision
 
995
    parameter, as in "branch foo/bar -r 5".
 
996
    """
 
997
 
 
998
    _see_also = ['checkout']
 
999
    takes_args = ['from_location', 'to_location?']
 
1000
    takes_options = ['revision', Option('hardlink',
 
1001
        help='Hard-link working tree files where possible.'),
 
1002
        Option('stacked',
 
1003
            help='Create a stacked branch referring to the source branch. '
 
1004
                'The new branch will depend on the availability of the source '
 
1005
                'branch for all operations.'),
 
1006
        Option('standalone',
 
1007
               help='Do not use a shared repository, even if available.'),
 
1008
        ]
 
1009
    aliases = ['get', 'clone']
 
1010
 
 
1011
    def run(self, from_location, to_location=None, revision=None,
 
1012
            hardlink=False, stacked=False, standalone=False):
 
1013
        from bzrlib.tag import _merge_tags_if_possible
 
1014
 
 
1015
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
1016
            from_location)
 
1017
        revision = _get_one_revision('branch', revision)
 
1018
        br_from.lock_read()
 
1019
        try:
 
1020
            if revision is not None:
 
1021
                revision_id = revision.as_revision_id(br_from)
 
1022
            else:
 
1023
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1024
                # None or perhaps NULL_REVISION to mean copy nothing
 
1025
                # RBC 20060209
 
1026
                revision_id = br_from.last_revision()
 
1027
            if to_location is None:
 
1028
                to_location = urlutils.derive_to_location(from_location)
 
1029
            to_transport = transport.get_transport(to_location)
 
1030
            try:
 
1031
                to_transport.mkdir('.')
 
1032
            except errors.FileExists:
 
1033
                raise errors.BzrCommandError('Target directory "%s" already'
 
1034
                                             ' exists.' % to_location)
 
1035
            except errors.NoSuchFile:
 
1036
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1037
                                             % to_location)
 
1038
            try:
 
1039
                # preserve whatever source format we have.
 
1040
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1041
                                            possible_transports=[to_transport],
 
1042
                                            accelerator_tree=accelerator_tree,
 
1043
                                            hardlink=hardlink, stacked=stacked,
 
1044
                                            force_new_repo=standalone,
 
1045
                                            source_branch=br_from)
 
1046
                branch = dir.open_branch()
 
1047
            except errors.NoSuchRevision:
 
1048
                to_transport.delete_tree('.')
 
1049
                msg = "The branch %s has no revision %s." % (from_location,
 
1050
                    revision)
 
1051
                raise errors.BzrCommandError(msg)
 
1052
            _merge_tags_if_possible(br_from, branch)
 
1053
            # If the source branch is stacked, the new branch may
 
1054
            # be stacked whether we asked for that explicitly or not.
 
1055
            # We therefore need a try/except here and not just 'if stacked:'
 
1056
            try:
 
1057
                note('Created new stacked branch referring to %s.' %
 
1058
                    branch.get_stacked_on_url())
 
1059
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1060
                errors.UnstackableRepositoryFormat), e:
 
1061
                note('Branched %d revision(s).' % branch.revno())
 
1062
        finally:
 
1063
            br_from.unlock()
 
1064
 
 
1065
 
 
1066
class cmd_checkout(Command):
 
1067
    """Create a new checkout of an existing branch.
 
1068
 
 
1069
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
1070
    the branch found in '.'. This is useful if you have removed the working tree
 
1071
    or if it was never created - i.e. if you pushed the branch to its current
 
1072
    location using SFTP.
 
1073
    
 
1074
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
1075
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
1076
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1077
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
1078
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
1079
    create ./foo-bar.
 
1080
 
 
1081
    To retrieve the branch as of a particular revision, supply the --revision
 
1082
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
1083
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
1084
    code.)
 
1085
    """
 
1086
 
 
1087
    _see_also = ['checkouts', 'branch']
 
1088
    takes_args = ['branch_location?', 'to_location?']
 
1089
    takes_options = ['revision',
 
1090
                     Option('lightweight',
 
1091
                            help="Perform a lightweight checkout.  Lightweight "
 
1092
                                 "checkouts depend on access to the branch for "
 
1093
                                 "every operation.  Normal checkouts can perform "
 
1094
                                 "common operations like diff and status without "
 
1095
                                 "such access, and also support local commits."
 
1096
                            ),
 
1097
                     Option('files-from', type=str,
 
1098
                            help="Get file contents from this tree."),
 
1099
                     Option('hardlink',
 
1100
                            help='Hard-link working tree files where possible.'
 
1101
                            ),
 
1102
                     ]
 
1103
    aliases = ['co']
 
1104
 
 
1105
    def run(self, branch_location=None, to_location=None, revision=None,
 
1106
            lightweight=False, files_from=None, hardlink=False):
 
1107
        if branch_location is None:
 
1108
            branch_location = osutils.getcwd()
 
1109
            to_location = branch_location
 
1110
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
1111
            branch_location)
 
1112
        revision = _get_one_revision('checkout', revision)
 
1113
        if files_from is not None:
 
1114
            accelerator_tree = WorkingTree.open(files_from)
 
1115
        if revision is not None:
 
1116
            revision_id = revision.as_revision_id(source)
 
1117
        else:
 
1118
            revision_id = None
 
1119
        if to_location is None:
 
1120
            to_location = urlutils.derive_to_location(branch_location)
 
1121
        # if the source and to_location are the same, 
 
1122
        # and there is no working tree,
 
1123
        # then reconstitute a branch
 
1124
        if (osutils.abspath(to_location) ==
 
1125
            osutils.abspath(branch_location)):
 
1126
            try:
 
1127
                source.bzrdir.open_workingtree()
 
1128
            except errors.NoWorkingTree:
 
1129
                source.bzrdir.create_workingtree(revision_id)
 
1130
                return
 
1131
        source.create_checkout(to_location, revision_id, lightweight,
 
1132
                               accelerator_tree, hardlink)
 
1133
 
 
1134
 
 
1135
class cmd_renames(Command):
 
1136
    """Show list of renamed files.
 
1137
    """
 
1138
    # TODO: Option to show renames between two historical versions.
 
1139
 
 
1140
    # TODO: Only show renames under dir, rather than in the whole branch.
 
1141
    _see_also = ['status']
 
1142
    takes_args = ['dir?']
 
1143
 
 
1144
    @display_command
 
1145
    def run(self, dir=u'.'):
 
1146
        tree = WorkingTree.open_containing(dir)[0]
 
1147
        tree.lock_read()
 
1148
        try:
 
1149
            new_inv = tree.inventory
 
1150
            old_tree = tree.basis_tree()
 
1151
            old_tree.lock_read()
 
1152
            try:
 
1153
                old_inv = old_tree.inventory
 
1154
                renames = []
 
1155
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1156
                for f, paths, c, v, p, n, k, e in iterator:
 
1157
                    if paths[0] == paths[1]:
 
1158
                        continue
 
1159
                    if None in (paths):
 
1160
                        continue
 
1161
                    renames.append(paths)
 
1162
                renames.sort()
 
1163
                for old_name, new_name in renames:
 
1164
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1165
            finally:
 
1166
                old_tree.unlock()
 
1167
        finally:
 
1168
            tree.unlock()
 
1169
 
 
1170
 
 
1171
class cmd_update(Command):
 
1172
    """Update a tree to have the latest code committed to its branch.
 
1173
    
 
1174
    This will perform a merge into the working tree, and may generate
 
1175
    conflicts. If you have any local changes, you will still 
 
1176
    need to commit them after the update for the update to be complete.
 
1177
    
 
1178
    If you want to discard your local changes, you can just do a 
 
1179
    'bzr revert' instead of 'bzr commit' after the update.
 
1180
    """
 
1181
 
 
1182
    _see_also = ['pull', 'working-trees', 'status-flags']
 
1183
    takes_args = ['dir?']
 
1184
    aliases = ['up']
 
1185
 
 
1186
    def run(self, dir='.'):
 
1187
        tree = WorkingTree.open_containing(dir)[0]
 
1188
        possible_transports = []
 
1189
        master = tree.branch.get_master_branch(
 
1190
            possible_transports=possible_transports)
 
1191
        if master is not None:
 
1192
            tree.lock_write()
 
1193
        else:
 
1194
            tree.lock_tree_write()
 
1195
        try:
 
1196
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1197
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1198
            if last_rev == _mod_revision.ensure_null(
 
1199
                tree.branch.last_revision()):
 
1200
                # may be up to date, check master too.
 
1201
                if master is None or last_rev == _mod_revision.ensure_null(
 
1202
                    master.last_revision()):
 
1203
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1204
                    note("Tree is up to date at revision %d." % (revno,))
 
1205
                    return 0
 
1206
            conflicts = tree.update(
 
1207
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1208
                possible_transports=possible_transports)
 
1209
            revno = tree.branch.revision_id_to_revno(
 
1210
                _mod_revision.ensure_null(tree.last_revision()))
 
1211
            note('Updated to revision %d.' % (revno,))
 
1212
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1213
                note('Your local commits will now show as pending merges with '
 
1214
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1215
            if conflicts != 0:
 
1216
                return 1
 
1217
            else:
 
1218
                return 0
 
1219
        finally:
 
1220
            tree.unlock()
 
1221
 
 
1222
 
 
1223
class cmd_info(Command):
 
1224
    """Show information about a working tree, branch or repository.
 
1225
 
 
1226
    This command will show all known locations and formats associated to the
 
1227
    tree, branch or repository.  Statistical information is included with
 
1228
    each report.
 
1229
 
 
1230
    Branches and working trees will also report any missing revisions.
 
1231
    """
 
1232
    _see_also = ['revno', 'working-trees', 'repositories']
 
1233
    takes_args = ['location?']
 
1234
    takes_options = ['verbose']
 
1235
    encoding_type = 'replace'
 
1236
 
 
1237
    @display_command
 
1238
    def run(self, location=None, verbose=False):
 
1239
        if verbose:
 
1240
            noise_level = 2
 
1241
        else:
 
1242
            noise_level = 0
 
1243
        from bzrlib.info import show_bzrdir_info
 
1244
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1245
                         verbose=noise_level, outfile=self.outf)
 
1246
 
 
1247
 
 
1248
class cmd_remove(Command):
 
1249
    """Remove files or directories.
 
1250
 
 
1251
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1252
    them if they can easily be recovered using revert. If no options or
 
1253
    parameters are given bzr will scan for files that are being tracked by bzr
 
1254
    but missing in your tree and stop tracking them for you.
 
1255
    """
 
1256
    takes_args = ['file*']
 
1257
    takes_options = ['verbose',
 
1258
        Option('new', help='Only remove files that have never been committed.'),
 
1259
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1260
            'The file deletion mode to be used.',
 
1261
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1262
            safe='Only delete files if they can be'
 
1263
                 ' safely recovered (default).',
 
1264
            keep="Don't delete any files.",
 
1265
            force='Delete all the specified files, even if they can not be '
 
1266
                'recovered and even if they are non-empty directories.')]
 
1267
    aliases = ['rm', 'del']
 
1268
    encoding_type = 'replace'
 
1269
 
 
1270
    def run(self, file_list, verbose=False, new=False,
 
1271
        file_deletion_strategy='safe'):
 
1272
        tree, file_list = tree_files(file_list)
 
1273
 
 
1274
        if file_list is not None:
 
1275
            file_list = [f for f in file_list]
 
1276
 
 
1277
        tree.lock_write()
 
1278
        try:
 
1279
            # Heuristics should probably all move into tree.remove_smart or
 
1280
            # some such?
 
1281
            if new:
 
1282
                added = tree.changes_from(tree.basis_tree(),
 
1283
                    specific_files=file_list).added
 
1284
                file_list = sorted([f[0] for f in added], reverse=True)
 
1285
                if len(file_list) == 0:
 
1286
                    raise errors.BzrCommandError('No matching files.')
 
1287
            elif file_list is None:
 
1288
                # missing files show up in iter_changes(basis) as
 
1289
                # versioned-with-no-kind.
 
1290
                missing = []
 
1291
                for change in tree.iter_changes(tree.basis_tree()):
 
1292
                    # Find paths in the working tree that have no kind:
 
1293
                    if change[1][1] is not None and change[6][1] is None:
 
1294
                        missing.append(change[1][1])
 
1295
                file_list = sorted(missing, reverse=True)
 
1296
                file_deletion_strategy = 'keep'
 
1297
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1298
                keep_files=file_deletion_strategy=='keep',
 
1299
                force=file_deletion_strategy=='force')
 
1300
        finally:
 
1301
            tree.unlock()
 
1302
 
 
1303
 
 
1304
class cmd_file_id(Command):
 
1305
    """Print file_id of a particular file or directory.
 
1306
 
 
1307
    The file_id is assigned when the file is first added and remains the
 
1308
    same through all revisions where the file exists, even when it is
 
1309
    moved or renamed.
 
1310
    """
 
1311
 
 
1312
    hidden = True
 
1313
    _see_also = ['inventory', 'ls']
 
1314
    takes_args = ['filename']
 
1315
 
 
1316
    @display_command
 
1317
    def run(self, filename):
 
1318
        tree, relpath = WorkingTree.open_containing(filename)
 
1319
        i = tree.path2id(relpath)
 
1320
        if i is None:
 
1321
            raise errors.NotVersionedError(filename)
 
1322
        else:
 
1323
            self.outf.write(i + '\n')
 
1324
 
 
1325
 
 
1326
class cmd_file_path(Command):
 
1327
    """Print path of file_ids to a file or directory.
 
1328
 
 
1329
    This prints one line for each directory down to the target,
 
1330
    starting at the branch root.
 
1331
    """
 
1332
 
 
1333
    hidden = True
 
1334
    takes_args = ['filename']
 
1335
 
 
1336
    @display_command
 
1337
    def run(self, filename):
 
1338
        tree, relpath = WorkingTree.open_containing(filename)
 
1339
        fid = tree.path2id(relpath)
 
1340
        if fid is None:
 
1341
            raise errors.NotVersionedError(filename)
 
1342
        segments = osutils.splitpath(relpath)
 
1343
        for pos in range(1, len(segments) + 1):
 
1344
            path = osutils.joinpath(segments[:pos])
 
1345
            self.outf.write("%s\n" % tree.path2id(path))
 
1346
 
 
1347
 
 
1348
class cmd_reconcile(Command):
 
1349
    """Reconcile bzr metadata in a branch.
 
1350
 
 
1351
    This can correct data mismatches that may have been caused by
 
1352
    previous ghost operations or bzr upgrades. You should only
 
1353
    need to run this command if 'bzr check' or a bzr developer 
 
1354
    advises you to run it.
 
1355
 
 
1356
    If a second branch is provided, cross-branch reconciliation is
 
1357
    also attempted, which will check that data like the tree root
 
1358
    id which was not present in very early bzr versions is represented
 
1359
    correctly in both branches.
 
1360
 
 
1361
    At the same time it is run it may recompress data resulting in 
 
1362
    a potential saving in disk space or performance gain.
 
1363
 
 
1364
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1365
    """
 
1366
 
 
1367
    _see_also = ['check']
 
1368
    takes_args = ['branch?']
 
1369
 
 
1370
    def run(self, branch="."):
 
1371
        from bzrlib.reconcile import reconcile
 
1372
        dir = bzrdir.BzrDir.open(branch)
 
1373
        reconcile(dir)
 
1374
 
 
1375
 
 
1376
class cmd_revision_history(Command):
 
1377
    """Display the list of revision ids on a branch."""
 
1378
 
 
1379
    _see_also = ['log']
 
1380
    takes_args = ['location?']
 
1381
 
 
1382
    hidden = True
 
1383
 
 
1384
    @display_command
 
1385
    def run(self, location="."):
 
1386
        branch = Branch.open_containing(location)[0]
 
1387
        for revid in branch.revision_history():
 
1388
            self.outf.write(revid)
 
1389
            self.outf.write('\n')
 
1390
 
 
1391
 
 
1392
class cmd_ancestry(Command):
 
1393
    """List all revisions merged into this branch."""
 
1394
 
 
1395
    _see_also = ['log', 'revision-history']
 
1396
    takes_args = ['location?']
 
1397
 
 
1398
    hidden = True
 
1399
 
 
1400
    @display_command
 
1401
    def run(self, location="."):
 
1402
        try:
 
1403
            wt = WorkingTree.open_containing(location)[0]
 
1404
        except errors.NoWorkingTree:
 
1405
            b = Branch.open(location)
 
1406
            last_revision = b.last_revision()
 
1407
        else:
 
1408
            b = wt.branch
 
1409
            last_revision = wt.last_revision()
 
1410
 
 
1411
        revision_ids = b.repository.get_ancestry(last_revision)
 
1412
        revision_ids.pop(0)
 
1413
        for revision_id in revision_ids:
 
1414
            self.outf.write(revision_id + '\n')
 
1415
 
 
1416
 
 
1417
class cmd_init(Command):
 
1418
    """Make a directory into a versioned branch.
 
1419
 
 
1420
    Use this to create an empty branch, or before importing an
 
1421
    existing project.
 
1422
 
 
1423
    If there is a repository in a parent directory of the location, then 
 
1424
    the history of the branch will be stored in the repository.  Otherwise
 
1425
    init creates a standalone branch which carries its own history
 
1426
    in the .bzr directory.
 
1427
 
 
1428
    If there is already a branch at the location but it has no working tree,
 
1429
    the tree can be populated with 'bzr checkout'.
 
1430
 
 
1431
    Recipe for importing a tree of files::
 
1432
 
 
1433
        cd ~/project
 
1434
        bzr init
 
1435
        bzr add .
 
1436
        bzr status
 
1437
        bzr commit -m "imported project"
 
1438
    """
 
1439
 
 
1440
    _see_also = ['init-repository', 'branch', 'checkout']
 
1441
    takes_args = ['location?']
 
1442
    takes_options = [
 
1443
        Option('create-prefix',
 
1444
               help='Create the path leading up to the branch '
 
1445
                    'if it does not already exist.'),
 
1446
         RegistryOption('format',
 
1447
                help='Specify a format for this branch. '
 
1448
                'See "help formats".',
 
1449
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1450
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1451
                value_switches=True,
 
1452
                title="Branch Format",
 
1453
                ),
 
1454
         Option('append-revisions-only',
 
1455
                help='Never change revnos or the existing log.'
 
1456
                '  Append revisions to it only.')
 
1457
         ]
 
1458
    def run(self, location=None, format=None, append_revisions_only=False,
 
1459
            create_prefix=False):
 
1460
        if format is None:
 
1461
            format = bzrdir.format_registry.make_bzrdir('default')
 
1462
        if location is None:
 
1463
            location = u'.'
 
1464
 
 
1465
        to_transport = transport.get_transport(location)
 
1466
 
 
1467
        # The path has to exist to initialize a
 
1468
        # branch inside of it.
 
1469
        # Just using os.mkdir, since I don't
 
1470
        # believe that we want to create a bunch of
 
1471
        # locations if the user supplies an extended path
 
1472
        try:
 
1473
            to_transport.ensure_base()
 
1474
        except errors.NoSuchFile:
 
1475
            if not create_prefix:
 
1476
                raise errors.BzrCommandError("Parent directory of %s"
 
1477
                    " does not exist."
 
1478
                    "\nYou may supply --create-prefix to create all"
 
1479
                    " leading parent directories."
 
1480
                    % location)
 
1481
            _create_prefix(to_transport)
 
1482
 
 
1483
        try:
 
1484
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1485
        except errors.NotBranchError:
 
1486
            # really a NotBzrDir error...
 
1487
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1488
            branch = create_branch(to_transport.base, format=format,
 
1489
                                   possible_transports=[to_transport])
 
1490
            a_bzrdir = branch.bzrdir
 
1491
        else:
 
1492
            from bzrlib.transport.local import LocalTransport
 
1493
            if a_bzrdir.has_branch():
 
1494
                if (isinstance(to_transport, LocalTransport)
 
1495
                    and not a_bzrdir.has_workingtree()):
 
1496
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
1497
                raise errors.AlreadyBranchError(location)
 
1498
            branch = a_bzrdir.create_branch()
 
1499
            a_bzrdir.create_workingtree()
 
1500
        if append_revisions_only:
 
1501
            try:
 
1502
                branch.set_append_revisions_only(True)
 
1503
            except errors.UpgradeRequired:
 
1504
                raise errors.BzrCommandError('This branch format cannot be set'
 
1505
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1506
        if not is_quiet():
 
1507
            from bzrlib.info import describe_layout, describe_format
 
1508
            try:
 
1509
                tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
 
1510
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1511
                tree = None
 
1512
            repository = branch.repository
 
1513
            layout = describe_layout(repository, branch, tree).lower()
 
1514
            format = describe_format(a_bzrdir, repository, branch, tree)
 
1515
            self.outf.write("Created a %s (format: %s)\n" % (layout, format))
 
1516
            if repository.is_shared():
 
1517
                #XXX: maybe this can be refactored into transport.path_or_url()
 
1518
                url = repository.bzrdir.root_transport.external_url()
 
1519
                try:
 
1520
                    url = urlutils.local_path_from_url(url)
 
1521
                except errors.InvalidURL:
 
1522
                    pass
 
1523
                self.outf.write("Using shared repository: %s\n" % url)
 
1524
 
 
1525
 
 
1526
class cmd_init_repository(Command):
 
1527
    """Create a shared repository to hold branches.
 
1528
 
 
1529
    New branches created under the repository directory will store their
 
1530
    revisions in the repository, not in the branch directory.
 
1531
 
 
1532
    If the --no-trees option is used then the branches in the repository
 
1533
    will not have working trees by default.
 
1534
 
 
1535
    :Examples:
 
1536
        Create a shared repositories holding just branches::
 
1537
 
 
1538
            bzr init-repo --no-trees repo
 
1539
            bzr init repo/trunk
 
1540
 
 
1541
        Make a lightweight checkout elsewhere::
 
1542
 
 
1543
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1544
            cd trunk-checkout
 
1545
            (add files here)
 
1546
    """
 
1547
 
 
1548
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
1549
    takes_args = ["location"]
 
1550
    takes_options = [RegistryOption('format',
 
1551
                            help='Specify a format for this repository. See'
 
1552
                                 ' "bzr help formats" for details.',
 
1553
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1554
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1555
                            value_switches=True, title='Repository format'),
 
1556
                     Option('no-trees',
 
1557
                             help='Branches in the repository will default to'
 
1558
                                  ' not having a working tree.'),
 
1559
                    ]
 
1560
    aliases = ["init-repo"]
 
1561
 
 
1562
    def run(self, location, format=None, no_trees=False):
 
1563
        if format is None:
 
1564
            format = bzrdir.format_registry.make_bzrdir('default')
 
1565
 
 
1566
        if location is None:
 
1567
            location = '.'
 
1568
 
 
1569
        to_transport = transport.get_transport(location)
 
1570
        to_transport.ensure_base()
 
1571
 
 
1572
        newdir = format.initialize_on_transport(to_transport)
 
1573
        repo = newdir.create_repository(shared=True)
 
1574
        repo.set_make_working_trees(not no_trees)
 
1575
        if not is_quiet():
 
1576
            from bzrlib.info import show_bzrdir_info
 
1577
            show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
 
1578
 
 
1579
 
 
1580
class cmd_diff(Command):
 
1581
    """Show differences in the working tree, between revisions or branches.
 
1582
    
 
1583
    If no arguments are given, all changes for the current tree are listed.
 
1584
    If files are given, only the changes in those files are listed.
 
1585
    Remote and multiple branches can be compared by using the --old and
 
1586
    --new options. If not provided, the default for both is derived from
 
1587
    the first argument, if any, or the current tree if no arguments are
 
1588
    given.
 
1589
 
 
1590
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1591
    produces patches suitable for "patch -p1".
 
1592
 
 
1593
    :Exit values:
 
1594
        1 - changed
 
1595
        2 - unrepresentable changes
 
1596
        3 - error
 
1597
        0 - no change
 
1598
 
 
1599
    :Examples:
 
1600
        Shows the difference in the working tree versus the last commit::
 
1601
 
 
1602
            bzr diff
 
1603
 
 
1604
        Difference between the working tree and revision 1::
 
1605
 
 
1606
            bzr diff -r1
 
1607
 
 
1608
        Difference between revision 2 and revision 1::
 
1609
 
 
1610
            bzr diff -r1..2
 
1611
 
 
1612
        Difference between revision 2 and revision 1 for branch xxx::
 
1613
 
 
1614
            bzr diff -r1..2 xxx
 
1615
 
 
1616
        Show just the differences for file NEWS::
 
1617
 
 
1618
            bzr diff NEWS
 
1619
 
 
1620
        Show the differences in working tree xxx for file NEWS::
 
1621
 
 
1622
            bzr diff xxx/NEWS
 
1623
 
 
1624
        Show the differences from branch xxx to this working tree:
 
1625
 
 
1626
            bzr diff --old xxx
 
1627
 
 
1628
        Show the differences between two branches for file NEWS::
 
1629
 
 
1630
            bzr diff --old xxx --new yyy NEWS
 
1631
 
 
1632
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1633
 
 
1634
            bzr diff --prefix old/:new/
 
1635
    """
 
1636
    _see_also = ['status']
 
1637
    takes_args = ['file*']
 
1638
    takes_options = [
 
1639
        Option('diff-options', type=str,
 
1640
               help='Pass these options to the external diff program.'),
 
1641
        Option('prefix', type=str,
 
1642
               short_name='p',
 
1643
               help='Set prefixes added to old and new filenames, as '
 
1644
                    'two values separated by a colon. (eg "old/:new/").'),
 
1645
        Option('old',
 
1646
            help='Branch/tree to compare from.',
 
1647
            type=unicode,
 
1648
            ),
 
1649
        Option('new',
 
1650
            help='Branch/tree to compare to.',
 
1651
            type=unicode,
 
1652
            ),
 
1653
        'revision',
 
1654
        'change',
 
1655
        Option('using',
 
1656
            help='Use this command to compare files.',
 
1657
            type=unicode,
 
1658
            ),
 
1659
        ]
 
1660
    aliases = ['di', 'dif']
 
1661
    encoding_type = 'exact'
 
1662
 
 
1663
    @display_command
 
1664
    def run(self, revision=None, file_list=None, diff_options=None,
 
1665
            prefix=None, old=None, new=None, using=None):
 
1666
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1667
 
 
1668
        if (prefix is None) or (prefix == '0'):
 
1669
            # diff -p0 format
 
1670
            old_label = ''
 
1671
            new_label = ''
 
1672
        elif prefix == '1':
 
1673
            old_label = 'old/'
 
1674
            new_label = 'new/'
 
1675
        elif ':' in prefix:
 
1676
            old_label, new_label = prefix.split(":")
 
1677
        else:
 
1678
            raise errors.BzrCommandError(
 
1679
                '--prefix expects two values separated by a colon'
 
1680
                ' (eg "old/:new/")')
 
1681
 
 
1682
        if revision and len(revision) > 2:
 
1683
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1684
                                         ' one or two revision specifiers')
 
1685
 
 
1686
        old_tree, new_tree, specific_files, extra_trees = \
 
1687
                _get_trees_to_diff(file_list, revision, old, new)
 
1688
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
1689
                               specific_files=specific_files,
 
1690
                               external_diff_options=diff_options,
 
1691
                               old_label=old_label, new_label=new_label,
 
1692
                               extra_trees=extra_trees, using=using)
 
1693
 
 
1694
 
 
1695
class cmd_deleted(Command):
 
1696
    """List files deleted in the working tree.
 
1697
    """
 
1698
    # TODO: Show files deleted since a previous revision, or
 
1699
    # between two revisions.
 
1700
    # TODO: Much more efficient way to do this: read in new
 
1701
    # directories with readdir, rather than stating each one.  Same
 
1702
    # level of effort but possibly much less IO.  (Or possibly not,
 
1703
    # if the directories are very large...)
 
1704
    _see_also = ['status', 'ls']
 
1705
    takes_options = ['show-ids']
 
1706
 
 
1707
    @display_command
 
1708
    def run(self, show_ids=False):
 
1709
        tree = WorkingTree.open_containing(u'.')[0]
 
1710
        tree.lock_read()
 
1711
        try:
 
1712
            old = tree.basis_tree()
 
1713
            old.lock_read()
 
1714
            try:
 
1715
                for path, ie in old.inventory.iter_entries():
 
1716
                    if not tree.has_id(ie.file_id):
 
1717
                        self.outf.write(path)
 
1718
                        if show_ids:
 
1719
                            self.outf.write(' ')
 
1720
                            self.outf.write(ie.file_id)
 
1721
                        self.outf.write('\n')
 
1722
            finally:
 
1723
                old.unlock()
 
1724
        finally:
 
1725
            tree.unlock()
 
1726
 
 
1727
 
 
1728
class cmd_modified(Command):
 
1729
    """List files modified in working tree.
 
1730
    """
 
1731
 
 
1732
    hidden = True
 
1733
    _see_also = ['status', 'ls']
 
1734
    takes_options = [
 
1735
            Option('null',
 
1736
                   help='Write an ascii NUL (\\0) separator '
 
1737
                   'between files rather than a newline.')
 
1738
            ]
 
1739
 
 
1740
    @display_command
 
1741
    def run(self, null=False):
 
1742
        tree = WorkingTree.open_containing(u'.')[0]
 
1743
        td = tree.changes_from(tree.basis_tree())
 
1744
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1745
            if null:
 
1746
                self.outf.write(path + '\0')
 
1747
            else:
 
1748
                self.outf.write(osutils.quotefn(path) + '\n')
 
1749
 
 
1750
 
 
1751
class cmd_added(Command):
 
1752
    """List files added in working tree.
 
1753
    """
 
1754
 
 
1755
    hidden = True
 
1756
    _see_also = ['status', 'ls']
 
1757
    takes_options = [
 
1758
            Option('null',
 
1759
                   help='Write an ascii NUL (\\0) separator '
 
1760
                   'between files rather than a newline.')
 
1761
            ]
 
1762
 
 
1763
    @display_command
 
1764
    def run(self, null=False):
 
1765
        wt = WorkingTree.open_containing(u'.')[0]
 
1766
        wt.lock_read()
 
1767
        try:
 
1768
            basis = wt.basis_tree()
 
1769
            basis.lock_read()
 
1770
            try:
 
1771
                basis_inv = basis.inventory
 
1772
                inv = wt.inventory
 
1773
                for file_id in inv:
 
1774
                    if file_id in basis_inv:
 
1775
                        continue
 
1776
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1777
                        continue
 
1778
                    path = inv.id2path(file_id)
 
1779
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1780
                        continue
 
1781
                    if null:
 
1782
                        self.outf.write(path + '\0')
 
1783
                    else:
 
1784
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1785
            finally:
 
1786
                basis.unlock()
 
1787
        finally:
 
1788
            wt.unlock()
 
1789
 
 
1790
 
 
1791
class cmd_root(Command):
 
1792
    """Show the tree root directory.
 
1793
 
 
1794
    The root is the nearest enclosing directory with a .bzr control
 
1795
    directory."""
 
1796
 
 
1797
    takes_args = ['filename?']
 
1798
    @display_command
 
1799
    def run(self, filename=None):
 
1800
        """Print the branch root."""
 
1801
        tree = WorkingTree.open_containing(filename)[0]
 
1802
        self.outf.write(tree.basedir + '\n')
 
1803
 
 
1804
 
 
1805
def _parse_limit(limitstring):
 
1806
    try:
 
1807
        return int(limitstring)
 
1808
    except ValueError:
 
1809
        msg = "The limit argument must be an integer."
 
1810
        raise errors.BzrCommandError(msg)
 
1811
 
 
1812
 
 
1813
def _parse_levels(s):
 
1814
    try:
 
1815
        return int(s)
 
1816
    except ValueError:
 
1817
        msg = "The levels argument must be an integer."
 
1818
        raise errors.BzrCommandError(msg)
 
1819
 
 
1820
 
 
1821
class cmd_log(Command):
 
1822
    """Show historical log for a branch or subset of a branch.
 
1823
 
 
1824
    log is bzr's default tool for exploring the history of a branch.
 
1825
    The branch to use is taken from the first parameter. If no parameters
 
1826
    are given, the branch containing the working directory is logged.
 
1827
    Here are some simple examples::
 
1828
 
 
1829
      bzr log                       log the current branch
 
1830
      bzr log foo.py                log a file in its branch
 
1831
      bzr log http://server/branch  log a branch on a server
 
1832
 
 
1833
    The filtering, ordering and information shown for each revision can
 
1834
    be controlled as explained below. By default, all revisions are
 
1835
    shown sorted (topologically) so that newer revisions appear before
 
1836
    older ones and descendants always appear before ancestors. If displayed,
 
1837
    merged revisions are shown indented under the revision in which they
 
1838
    were merged.
 
1839
 
 
1840
    :Output control:
 
1841
 
 
1842
      The log format controls how information about each revision is
 
1843
      displayed. The standard log formats are called ``long``, ``short``
 
1844
      and ``line``. The default is long. See ``bzr help log-formats``
 
1845
      for more details on log formats.
 
1846
 
 
1847
      The following options can be used to control what information is
 
1848
      displayed::
 
1849
  
 
1850
        -l N        display a maximum of N revisions
 
1851
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
 
1852
        -v          display a status summary (delta) for each revision
 
1853
        -p          display a diff (patch) for each revision
 
1854
        --show-ids  display revision-ids (and file-ids), not just revnos
 
1855
  
 
1856
      Note that the default number of levels to display is a function of the
 
1857
      log format. If the -n option is not used, ``short`` and ``line`` show
 
1858
      just the top level (mainline) while ``long`` shows all levels of merged
 
1859
      revisions.
 
1860
  
 
1861
      Status summaries are shown using status flags like A, M, etc. To see
 
1862
      the changes explained using words like ``added`` and ``modified``
 
1863
      instead, use the -vv option.
 
1864
  
 
1865
    :Ordering control:
 
1866
  
 
1867
      To display revisions from oldest to newest, use the --forward option.
 
1868
      In most cases, using this option will have little impact on the total
 
1869
      time taken to produce a log, though --forward does not incrementally
 
1870
      display revisions like --reverse does when it can.
 
1871
  
 
1872
    :Revision filtering:
 
1873
  
 
1874
      The -r option can be used to specify what revision or range of revisions
 
1875
      to filter against. The various forms are shown below::
 
1876
  
 
1877
        -rX      display revision X
 
1878
        -rX..    display revision X and later
 
1879
        -r..Y    display up to and including revision Y
 
1880
        -rX..Y   display from X to Y inclusive
 
1881
  
 
1882
      See ``bzr help revisionspec`` for details on how to specify X and Y.
 
1883
      Some common examples are given below::
 
1884
  
 
1885
        -r-1                show just the tip
 
1886
        -r-10..             show the last 10 mainline revisions
 
1887
        -rsubmit:..         show what's new on this branch
 
1888
        -rancestor:path..   show changes since the common ancestor of this
 
1889
                            branch and the one at location path
 
1890
        -rdate:yesterday..  show changes since yesterday
 
1891
  
 
1892
      When logging a range of revisions using -rX..Y, log starts at
 
1893
      revision Y and searches back in history through the primary
 
1894
      ("left-hand") parents until it finds X. When logging just the
 
1895
      top level (using -n1), an error is reported if X is not found
 
1896
      along the way. If multi-level logging is used (-n0), X may be
 
1897
      a nested merge revision and the log will be truncated accordingly.
 
1898
 
 
1899
    :Path filtering:
 
1900
  
 
1901
      If a parameter is given and it's not a branch, the log will be filtered
 
1902
      to show only those revisions that changed the nominated file or
 
1903
      directory.
 
1904
  
 
1905
      Filenames are interpreted within their historical context. To log a
 
1906
      deleted file, specify a revision range so that the file existed at
 
1907
      the end or start of the range.
 
1908
  
 
1909
      Historical context is also important when interpreting pathnames of
 
1910
      renamed files/directories. Consider the following example:
 
1911
  
 
1912
      * revision 1: add tutorial.txt
 
1913
      * revision 2: modify tutorial.txt
 
1914
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
 
1915
  
 
1916
      In this case:
 
1917
  
 
1918
      * ``bzr log guide.txt`` will log the file added in revision 1
 
1919
  
 
1920
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
 
1921
  
 
1922
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
 
1923
        the original file in revision 2.
 
1924
  
 
1925
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
 
1926
        was no file called guide.txt in revision 2.
 
1927
  
 
1928
      Renames are always followed by log. By design, there is no need to
 
1929
      explicitly ask for this (and no way to stop logging a file back
 
1930
      until it was last renamed).
 
1931
  
 
1932
      Note: If the path is a directory, only revisions that directly changed
 
1933
      that directory object are currently shown. This is considered a bug.
 
1934
      (Support for filtering against multiple files and for files within a
 
1935
      directory is under development.)
 
1936
  
 
1937
    :Other filtering:
 
1938
  
 
1939
      The --message option can be used for finding revisions that match a
 
1940
      regular expression in a commit message.
 
1941
  
 
1942
    :Tips & tricks:
 
1943
  
 
1944
      GUI tools and IDEs are often better at exploring history than command
 
1945
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
1946
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
1947
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
1948
  
 
1949
      Web interfaces are often better at exploring history than command line
 
1950
      tools, particularly for branches on servers. You may prefer Loggerhead
 
1951
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
1952
  
 
1953
      You may find it useful to add the aliases below to ``bazaar.conf``::
 
1954
  
 
1955
        [ALIASES]
 
1956
        tip = log -r-1 -n1
 
1957
        top = log -r-10.. --short --forward
 
1958
        show = log -v -p -n1 --long
 
1959
  
 
1960
      ``bzr tip`` will then show the latest revision while ``bzr top``
 
1961
      will show the last 10 mainline revisions. To see the details of a
 
1962
      particular revision X,  ``bzr show -rX``.
 
1963
  
 
1964
      As many GUI tools and Web interfaces do, you may prefer viewing
 
1965
      history collapsed initially. If you are interested in looking deeper
 
1966
      into a particular merge X, use ``bzr log -n0 -rX``. If you like
 
1967
      working this way, you may wish to either:
 
1968
  
 
1969
      * change your default log format to short (or line)
 
1970
      * add this alias: log = log -n1
 
1971
  
 
1972
      ``bzr log -v`` on a branch with lots of history is currently
 
1973
      very slow. A fix for this issue is currently under development.
 
1974
      With or without that fix, it is recommended that a revision range
 
1975
      be given when using the -v option.
 
1976
  
 
1977
      bzr has a generic full-text matching plugin, bzr-search, that can be
 
1978
      used to find revisions matching user names, commit messages, etc.
 
1979
      Among other features, this plugin can find all revisions containing
 
1980
      a list of words but not others.
 
1981
  
 
1982
      When exploring non-mainline history on large projects with deep
 
1983
      history, the performance of log can be greatly improved by installing
 
1984
      the revnocache plugin. This plugin buffers historical information
 
1985
      trading disk space for faster speed.
 
1986
    """
 
1987
    takes_args = ['location?']
 
1988
    _see_also = ['log-formats', 'revisionspec']
 
1989
    takes_options = [
 
1990
            Option('forward',
 
1991
                   help='Show from oldest to newest.'),
 
1992
            'timezone',
 
1993
            custom_help('verbose',
 
1994
                   help='Show files changed in each revision.'),
 
1995
            'show-ids',
 
1996
            'revision',
 
1997
            Option('change',
 
1998
                   type=bzrlib.option._parse_revision_str,
 
1999
                   short_name='c',
 
2000
                   help='Show just the specified revision.'
 
2001
                   ' See also "help revisionspec".'),
 
2002
            'log-format',
 
2003
            Option('levels',
 
2004
                   short_name='n',
 
2005
                   help='Number of levels to display - 0 for all, 1 for flat.',
 
2006
                   argname='N',
 
2007
                   type=_parse_levels),
 
2008
            Option('message',
 
2009
                   short_name='m',
 
2010
                   help='Show revisions whose message matches this '
 
2011
                        'regular expression.',
 
2012
                   type=str),
 
2013
            Option('limit',
 
2014
                   short_name='l',
 
2015
                   help='Limit the output to the first N revisions.',
 
2016
                   argname='N',
 
2017
                   type=_parse_limit),
 
2018
            Option('show-diff',
 
2019
                   short_name='p',
 
2020
                   help='Show changes made in each revision as a patch.'),
 
2021
            ]
 
2022
    encoding_type = 'replace'
 
2023
 
 
2024
    @display_command
 
2025
    def run(self, location=None, timezone='original',
 
2026
            verbose=False,
 
2027
            show_ids=False,
 
2028
            forward=False,
 
2029
            revision=None,
 
2030
            change=None,
 
2031
            log_format=None,
 
2032
            levels=None,
 
2033
            message=None,
 
2034
            limit=None,
 
2035
            show_diff=False):
 
2036
        from bzrlib.log import show_log, _get_fileid_to_log
 
2037
        direction = (forward and 'forward') or 'reverse'
 
2038
 
 
2039
        if change is not None:
 
2040
            if len(change) > 1:
 
2041
                raise errors.RangeInChangeOption()
 
2042
            if revision is not None:
 
2043
                raise errors.BzrCommandError(
 
2044
                    '--revision and --change are mutually exclusive')
 
2045
            else:
 
2046
                revision = change
 
2047
 
 
2048
        # log everything
 
2049
        file_id = None
 
2050
        if location:
 
2051
            # find the file id to log:
 
2052
 
 
2053
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2054
                location)
 
2055
            if fp != '':
 
2056
                file_id = _get_fileid_to_log(revision, tree, b, fp)
 
2057
                if file_id is None:
 
2058
                    raise errors.BzrCommandError(
 
2059
                        "Path unknown at end or start of revision range: %s" %
 
2060
                        location)
 
2061
        else:
 
2062
            # local dir only
 
2063
            # FIXME ? log the current subdir only RBC 20060203 
 
2064
            if revision is not None \
 
2065
                    and len(revision) > 0 and revision[0].get_branch():
 
2066
                location = revision[0].get_branch()
 
2067
            else:
 
2068
                location = '.'
 
2069
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2070
            b = dir.open_branch()
 
2071
 
 
2072
        b.lock_read()
 
2073
        try:
 
2074
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2075
            if log_format is None:
 
2076
                log_format = log.log_formatter_registry.get_default(b)
 
2077
 
 
2078
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2079
                            show_timezone=timezone,
 
2080
                            delta_format=get_verbosity_level(),
 
2081
                            levels=levels)
 
2082
 
 
2083
            show_log(b,
 
2084
                     lf,
 
2085
                     file_id,
 
2086
                     verbose=verbose,
 
2087
                     direction=direction,
 
2088
                     start_revision=rev1,
 
2089
                     end_revision=rev2,
 
2090
                     search=message,
 
2091
                     limit=limit,
 
2092
                     show_diff=show_diff)
 
2093
        finally:
 
2094
            b.unlock()
 
2095
 
 
2096
 
 
2097
def _get_revision_range(revisionspec_list, branch, command_name):
 
2098
    """Take the input of a revision option and turn it into a revision range.
 
2099
 
 
2100
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2101
    of the desired revisons. It does some user input validations.
 
2102
    """
 
2103
    if revisionspec_list is None:
 
2104
        rev1 = None
 
2105
        rev2 = None
 
2106
    elif len(revisionspec_list) == 1:
 
2107
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2108
    elif len(revisionspec_list) == 2:
 
2109
        start_spec = revisionspec_list[0]
 
2110
        end_spec = revisionspec_list[1]
 
2111
        if end_spec.get_branch() != start_spec.get_branch():
 
2112
            # b is taken from revision[0].get_branch(), and
 
2113
            # show_log will use its revision_history. Having
 
2114
            # different branches will lead to weird behaviors.
 
2115
            raise errors.BzrCommandError(
 
2116
                "bzr %s doesn't accept two revisions in different"
 
2117
                " branches." % command_name)
 
2118
        rev1 = start_spec.in_history(branch)
 
2119
        # Avoid loading all of history when we know a missing
 
2120
        # end of range means the last revision ...
 
2121
        if end_spec.spec is None:
 
2122
            last_revno, last_revision_id = branch.last_revision_info()
 
2123
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2124
        else:
 
2125
            rev2 = end_spec.in_history(branch)
 
2126
    else:
 
2127
        raise errors.BzrCommandError(
 
2128
            'bzr %s --revision takes one or two values.' % command_name)
 
2129
    return rev1, rev2
 
2130
 
 
2131
 
 
2132
def _revision_range_to_revid_range(revision_range):
 
2133
    rev_id1 = None
 
2134
    rev_id2 = None
 
2135
    if revision_range[0] is not None:
 
2136
        rev_id1 = revision_range[0].rev_id
 
2137
    if revision_range[1] is not None:
 
2138
        rev_id2 = revision_range[1].rev_id
 
2139
    return rev_id1, rev_id2
 
2140
 
 
2141
def get_log_format(long=False, short=False, line=False, default='long'):
 
2142
    log_format = default
 
2143
    if long:
 
2144
        log_format = 'long'
 
2145
    if short:
 
2146
        log_format = 'short'
 
2147
    if line:
 
2148
        log_format = 'line'
 
2149
    return log_format
 
2150
 
 
2151
 
 
2152
class cmd_touching_revisions(Command):
 
2153
    """Return revision-ids which affected a particular file.
 
2154
 
 
2155
    A more user-friendly interface is "bzr log FILE".
 
2156
    """
 
2157
 
 
2158
    hidden = True
 
2159
    takes_args = ["filename"]
 
2160
 
 
2161
    @display_command
 
2162
    def run(self, filename):
 
2163
        tree, relpath = WorkingTree.open_containing(filename)
 
2164
        b = tree.branch
 
2165
        file_id = tree.path2id(relpath)
 
2166
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2167
            self.outf.write("%6d %s\n" % (revno, what))
 
2168
 
 
2169
 
 
2170
class cmd_ls(Command):
 
2171
    """List files in a tree.
 
2172
    """
 
2173
 
 
2174
    _see_also = ['status', 'cat']
 
2175
    takes_args = ['path?']
 
2176
    # TODO: Take a revision or remote path and list that tree instead.
 
2177
    takes_options = [
 
2178
            'verbose',
 
2179
            'revision',
 
2180
            Option('non-recursive',
 
2181
                   help='Don\'t recurse into subdirectories.'),
 
2182
            Option('from-root',
 
2183
                   help='Print paths relative to the root of the branch.'),
 
2184
            Option('unknown', help='Print unknown files.'),
 
2185
            Option('versioned', help='Print versioned files.',
 
2186
                   short_name='V'),
 
2187
            Option('ignored', help='Print ignored files.'),
 
2188
            Option('null',
 
2189
                   help='Write an ascii NUL (\\0) separator '
 
2190
                   'between files rather than a newline.'),
 
2191
            Option('kind',
 
2192
                   help='List entries of a particular kind: file, directory, symlink.',
 
2193
                   type=unicode),
 
2194
            'show-ids',
 
2195
            ]
 
2196
    @display_command
 
2197
    def run(self, revision=None, verbose=False,
 
2198
            non_recursive=False, from_root=False,
 
2199
            unknown=False, versioned=False, ignored=False,
 
2200
            null=False, kind=None, show_ids=False, path=None):
 
2201
 
 
2202
        if kind and kind not in ('file', 'directory', 'symlink'):
 
2203
            raise errors.BzrCommandError('invalid kind specified')
 
2204
 
 
2205
        if verbose and null:
 
2206
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
2207
        all = not (unknown or versioned or ignored)
 
2208
 
 
2209
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
2210
 
 
2211
        if path is None:
 
2212
            fs_path = '.'
 
2213
            prefix = ''
 
2214
        else:
 
2215
            if from_root:
 
2216
                raise errors.BzrCommandError('cannot specify both --from-root'
 
2217
                                             ' and PATH')
 
2218
            fs_path = path
 
2219
            prefix = path
 
2220
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2221
            fs_path)
 
2222
        if from_root:
 
2223
            relpath = u''
 
2224
        elif relpath:
 
2225
            relpath += '/'
 
2226
        if revision is not None or tree is None:
 
2227
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
2228
 
 
2229
        tree.lock_read()
 
2230
        try:
 
2231
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2232
                if fp.startswith(relpath):
 
2233
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
2234
                    if non_recursive and '/' in fp:
 
2235
                        continue
 
2236
                    if not all and not selection[fc]:
 
2237
                        continue
 
2238
                    if kind is not None and fkind != kind:
 
2239
                        continue
 
2240
                    kindch = entry.kind_character()
 
2241
                    outstring = fp + kindch
 
2242
                    if verbose:
 
2243
                        outstring = '%-8s %s' % (fc, outstring)
 
2244
                        if show_ids and fid is not None:
 
2245
                            outstring = "%-50s %s" % (outstring, fid)
 
2246
                        self.outf.write(outstring + '\n')
 
2247
                    elif null:
 
2248
                        self.outf.write(fp + '\0')
 
2249
                        if show_ids:
 
2250
                            if fid is not None:
 
2251
                                self.outf.write(fid)
 
2252
                            self.outf.write('\0')
 
2253
                        self.outf.flush()
 
2254
                    else:
 
2255
                        if fid is not None:
 
2256
                            my_id = fid
 
2257
                        else:
 
2258
                            my_id = ''
 
2259
                        if show_ids:
 
2260
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2261
                        else:
 
2262
                            self.outf.write(outstring + '\n')
 
2263
        finally:
 
2264
            tree.unlock()
 
2265
 
 
2266
 
 
2267
class cmd_unknowns(Command):
 
2268
    """List unknown files.
 
2269
    """
 
2270
 
 
2271
    hidden = True
 
2272
    _see_also = ['ls']
 
2273
 
 
2274
    @display_command
 
2275
    def run(self):
 
2276
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2277
            self.outf.write(osutils.quotefn(f) + '\n')
 
2278
 
 
2279
 
 
2280
class cmd_ignore(Command):
 
2281
    """Ignore specified files or patterns.
 
2282
 
 
2283
    See ``bzr help patterns`` for details on the syntax of patterns.
 
2284
 
 
2285
    To remove patterns from the ignore list, edit the .bzrignore file.
 
2286
    After adding, editing or deleting that file either indirectly by
 
2287
    using this command or directly by using an editor, be sure to commit
 
2288
    it.
 
2289
 
 
2290
    Note: ignore patterns containing shell wildcards must be quoted from 
 
2291
    the shell on Unix.
 
2292
 
 
2293
    :Examples:
 
2294
        Ignore the top level Makefile::
 
2295
 
 
2296
            bzr ignore ./Makefile
 
2297
 
 
2298
        Ignore class files in all directories::
 
2299
 
 
2300
            bzr ignore "*.class"
 
2301
 
 
2302
        Ignore .o files under the lib directory::
 
2303
 
 
2304
            bzr ignore "lib/**/*.o"
 
2305
 
 
2306
        Ignore .o files under the lib directory::
 
2307
 
 
2308
            bzr ignore "RE:lib/.*\.o"
 
2309
 
 
2310
        Ignore everything but the "debian" toplevel directory::
 
2311
 
 
2312
            bzr ignore "RE:(?!debian/).*"
 
2313
    """
 
2314
 
 
2315
    _see_also = ['status', 'ignored', 'patterns']
 
2316
    takes_args = ['name_pattern*']
 
2317
    takes_options = [
 
2318
        Option('old-default-rules',
 
2319
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2320
        ]
 
2321
    
 
2322
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2323
        from bzrlib import ignores
 
2324
        if old_default_rules is not None:
 
2325
            # dump the rules and exit
 
2326
            for pattern in ignores.OLD_DEFAULTS:
 
2327
                print pattern
 
2328
            return
 
2329
        if not name_pattern_list:
 
2330
            raise errors.BzrCommandError("ignore requires at least one "
 
2331
                                  "NAME_PATTERN or --old-default-rules")
 
2332
        name_pattern_list = [globbing.normalize_pattern(p) 
 
2333
                             for p in name_pattern_list]
 
2334
        for name_pattern in name_pattern_list:
 
2335
            if (name_pattern[0] == '/' or 
 
2336
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
2337
                raise errors.BzrCommandError(
 
2338
                    "NAME_PATTERN should not be an absolute path")
 
2339
        tree, relpath = WorkingTree.open_containing(u'.')
 
2340
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
2341
        ignored = globbing.Globster(name_pattern_list)
 
2342
        matches = []
 
2343
        tree.lock_read()
 
2344
        for entry in tree.list_files():
 
2345
            id = entry[3]
 
2346
            if id is not None:
 
2347
                filename = entry[0]
 
2348
                if ignored.match(filename):
 
2349
                    matches.append(filename.encode('utf-8'))
 
2350
        tree.unlock()
 
2351
        if len(matches) > 0:
 
2352
            print "Warning: the following files are version controlled and" \
 
2353
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
2354
 
 
2355
 
 
2356
class cmd_ignored(Command):
 
2357
    """List ignored files and the patterns that matched them.
 
2358
 
 
2359
    List all the ignored files and the ignore pattern that caused the file to
 
2360
    be ignored.
 
2361
 
 
2362
    Alternatively, to list just the files::
 
2363
 
 
2364
        bzr ls --ignored
 
2365
    """
 
2366
 
 
2367
    encoding_type = 'replace'
 
2368
    _see_also = ['ignore', 'ls']
 
2369
 
 
2370
    @display_command
 
2371
    def run(self):
 
2372
        tree = WorkingTree.open_containing(u'.')[0]
 
2373
        tree.lock_read()
 
2374
        try:
 
2375
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2376
                if file_class != 'I':
 
2377
                    continue
 
2378
                ## XXX: Slightly inefficient since this was already calculated
 
2379
                pat = tree.is_ignored(path)
 
2380
                self.outf.write('%-50s %s\n' % (path, pat))
 
2381
        finally:
 
2382
            tree.unlock()
 
2383
 
 
2384
 
 
2385
class cmd_lookup_revision(Command):
 
2386
    """Lookup the revision-id from a revision-number
 
2387
 
 
2388
    :Examples:
 
2389
        bzr lookup-revision 33
 
2390
    """
 
2391
    hidden = True
 
2392
    takes_args = ['revno']
 
2393
    
 
2394
    @display_command
 
2395
    def run(self, revno):
 
2396
        try:
 
2397
            revno = int(revno)
 
2398
        except ValueError:
 
2399
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2400
 
 
2401
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2402
 
 
2403
 
 
2404
class cmd_export(Command):
 
2405
    """Export current or past revision to a destination directory or archive.
 
2406
 
 
2407
    If no revision is specified this exports the last committed revision.
 
2408
 
 
2409
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2410
    given, try to find the format with the extension. If no extension
 
2411
    is found exports to a directory (equivalent to --format=dir).
 
2412
 
 
2413
    If root is supplied, it will be used as the root directory inside
 
2414
    container formats (tar, zip, etc). If it is not supplied it will default
 
2415
    to the exported filename. The root option has no effect for 'dir' format.
 
2416
 
 
2417
    If branch is omitted then the branch containing the current working
 
2418
    directory will be used.
 
2419
 
 
2420
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2421
 
 
2422
      =================       =========================
 
2423
      Supported formats       Autodetected by extension
 
2424
      =================       =========================
 
2425
         dir                         (none)
 
2426
         tar                          .tar
 
2427
         tbz2                    .tar.bz2, .tbz2
 
2428
         tgz                      .tar.gz, .tgz
 
2429
         zip                          .zip
 
2430
      =================       =========================
 
2431
    """
 
2432
    takes_args = ['dest', 'branch_or_subdir?']
 
2433
    takes_options = [
 
2434
        Option('format',
 
2435
               help="Type of file to export to.",
 
2436
               type=unicode),
 
2437
        'revision',
 
2438
        Option('root',
 
2439
               type=str,
 
2440
               help="Name of the root directory inside the exported file."),
 
2441
        ]
 
2442
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2443
        root=None):
 
2444
        from bzrlib.export import export
 
2445
 
 
2446
        if branch_or_subdir is None:
 
2447
            tree = WorkingTree.open_containing(u'.')[0]
 
2448
            b = tree.branch
 
2449
            subdir = None
 
2450
        else:
 
2451
            b, subdir = Branch.open_containing(branch_or_subdir)
 
2452
            tree = None
 
2453
 
 
2454
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
 
2455
        try:
 
2456
            export(rev_tree, dest, format, root, subdir)
 
2457
        except errors.NoSuchExportFormat, e:
 
2458
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2459
 
 
2460
 
 
2461
class cmd_cat(Command):
 
2462
    """Write the contents of a file as of a given revision to standard output.
 
2463
 
 
2464
    If no revision is nominated, the last revision is used.
 
2465
 
 
2466
    Note: Take care to redirect standard output when using this command on a
 
2467
    binary file. 
 
2468
    """
 
2469
 
 
2470
    _see_also = ['ls']
 
2471
    takes_options = [
 
2472
        Option('name-from-revision', help='The path name in the old tree.'),
 
2473
        'revision',
 
2474
        ]
 
2475
    takes_args = ['filename']
 
2476
    encoding_type = 'exact'
 
2477
 
 
2478
    @display_command
 
2479
    def run(self, filename, revision=None, name_from_revision=False):
 
2480
        if revision is not None and len(revision) != 1:
 
2481
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2482
                                         " one revision specifier")
 
2483
        tree, branch, relpath = \
 
2484
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2485
        branch.lock_read()
 
2486
        try:
 
2487
            return self._run(tree, branch, relpath, filename, revision,
 
2488
                             name_from_revision)
 
2489
        finally:
 
2490
            branch.unlock()
 
2491
 
 
2492
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2493
        if tree is None:
 
2494
            tree = b.basis_tree()
 
2495
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2496
 
 
2497
        cur_file_id = tree.path2id(relpath)
 
2498
        old_file_id = rev_tree.path2id(relpath)
 
2499
 
 
2500
        if name_from_revision:
 
2501
            if old_file_id is None:
 
2502
                raise errors.BzrCommandError(
 
2503
                    "%r is not present in revision %s" % (
 
2504
                        filename, rev_tree.get_revision_id()))
 
2505
            else:
 
2506
                content = rev_tree.get_file_text(old_file_id)
 
2507
        elif cur_file_id is not None:
 
2508
            content = rev_tree.get_file_text(cur_file_id)
 
2509
        elif old_file_id is not None:
 
2510
            content = rev_tree.get_file_text(old_file_id)
 
2511
        else:
 
2512
            raise errors.BzrCommandError(
 
2513
                "%r is not present in revision %s" % (
 
2514
                    filename, rev_tree.get_revision_id()))
 
2515
        self.outf.write(content)
 
2516
 
 
2517
 
 
2518
class cmd_local_time_offset(Command):
 
2519
    """Show the offset in seconds from GMT to local time."""
 
2520
    hidden = True    
 
2521
    @display_command
 
2522
    def run(self):
 
2523
        print osutils.local_time_offset()
 
2524
 
 
2525
 
 
2526
 
 
2527
class cmd_commit(Command):
 
2528
    """Commit changes into a new revision.
 
2529
    
 
2530
    If no arguments are given, the entire tree is committed.
 
2531
 
 
2532
    If selected files are specified, only changes to those files are
 
2533
    committed.  If a directory is specified then the directory and everything 
 
2534
    within it is committed.
 
2535
 
 
2536
    When excludes are given, they take precedence over selected files.
 
2537
    For example, too commit only changes within foo, but not changes within
 
2538
    foo/bar::
 
2539
 
 
2540
      bzr commit foo -x foo/bar
 
2541
 
 
2542
    If author of the change is not the same person as the committer, you can
 
2543
    specify the author's name using the --author option. The name should be
 
2544
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2545
 
 
2546
    A selected-file commit may fail in some cases where the committed
 
2547
    tree would be invalid. Consider::
 
2548
 
 
2549
      bzr init foo
 
2550
      mkdir foo/bar
 
2551
      bzr add foo/bar
 
2552
      bzr commit foo -m "committing foo"
 
2553
      bzr mv foo/bar foo/baz
 
2554
      mkdir foo/bar
 
2555
      bzr add foo/bar
 
2556
      bzr commit foo/bar -m "committing bar but not baz"
 
2557
 
 
2558
    In the example above, the last commit will fail by design. This gives
 
2559
    the user the opportunity to decide whether they want to commit the
 
2560
    rename at the same time, separately first, or not at all. (As a general
 
2561
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2562
 
 
2563
    Note: A selected-file commit after a merge is not yet supported.
 
2564
    """
 
2565
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2566
 
 
2567
    # TODO: Strict commit that fails if there are deleted files.
 
2568
    #       (what does "deleted files" mean ??)
 
2569
 
 
2570
    # TODO: Give better message for -s, --summary, used by tla people
 
2571
 
 
2572
    # XXX: verbose currently does nothing
 
2573
 
 
2574
    _see_also = ['bugs', 'uncommit']
 
2575
    takes_args = ['selected*']
 
2576
    takes_options = [
 
2577
            ListOption('exclude', type=str, short_name='x',
 
2578
                help="Do not consider changes made to a given path."),
 
2579
            Option('message', type=unicode,
 
2580
                   short_name='m',
 
2581
                   help="Description of the new revision."),
 
2582
            'verbose',
 
2583
             Option('unchanged',
 
2584
                    help='Commit even if nothing has changed.'),
 
2585
             Option('file', type=str,
 
2586
                    short_name='F',
 
2587
                    argname='msgfile',
 
2588
                    help='Take commit message from this file.'),
 
2589
             Option('strict',
 
2590
                    help="Refuse to commit if there are unknown "
 
2591
                    "files in the working tree."),
 
2592
             ListOption('fixes', type=str,
 
2593
                    help="Mark a bug as being fixed by this revision."),
 
2594
             Option('author', type=unicode,
 
2595
                    help="Set the author's name, if it's different "
 
2596
                         "from the committer."),
 
2597
             Option('local',
 
2598
                    help="Perform a local commit in a bound "
 
2599
                         "branch.  Local commits are not pushed to "
 
2600
                         "the master branch until a normal commit "
 
2601
                         "is performed."
 
2602
                    ),
 
2603
              Option('show-diff',
 
2604
                     help='When no message is supplied, show the diff along'
 
2605
                     ' with the status summary in the message editor.'),
 
2606
             ]
 
2607
    aliases = ['ci', 'checkin']
 
2608
 
 
2609
    def _get_bug_fix_properties(self, fixes, branch):
 
2610
        properties = []
 
2611
        # Configure the properties for bug fixing attributes.
 
2612
        for fixed_bug in fixes:
 
2613
            tokens = fixed_bug.split(':')
 
2614
            if len(tokens) != 2:
 
2615
                raise errors.BzrCommandError(
 
2616
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2617
                    "Commit refused." % fixed_bug)
 
2618
            tag, bug_id = tokens
 
2619
            try:
 
2620
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
2621
            except errors.UnknownBugTrackerAbbreviation:
 
2622
                raise errors.BzrCommandError(
 
2623
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2624
            except errors.MalformedBugIdentifier:
 
2625
                raise errors.BzrCommandError(
 
2626
                    "Invalid bug identifier for %s. Commit refused."
 
2627
                    % fixed_bug)
 
2628
            properties.append('%s fixed' % bug_url)
 
2629
        return '\n'.join(properties)
 
2630
 
 
2631
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2632
            unchanged=False, strict=False, local=False, fixes=None,
 
2633
            author=None, show_diff=False, exclude=None):
 
2634
        from bzrlib.errors import (
 
2635
            PointlessCommit,
 
2636
            ConflictsInTree,
 
2637
            StrictCommitFailed
 
2638
        )
 
2639
        from bzrlib.msgeditor import (
 
2640
            edit_commit_message_encoded,
 
2641
            generate_commit_message_template,
 
2642
            make_commit_message_template_encoded
 
2643
        )
 
2644
 
 
2645
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2646
        # slightly problematic to run this cross-platform.
 
2647
 
 
2648
        # TODO: do more checks that the commit will succeed before 
 
2649
        # spending the user's valuable time typing a commit message.
 
2650
 
 
2651
        properties = {}
 
2652
 
 
2653
        tree, selected_list = tree_files(selected_list)
 
2654
        if selected_list == ['']:
 
2655
            # workaround - commit of root of tree should be exactly the same
 
2656
            # as just default commit in that tree, and succeed even though
 
2657
            # selected-file merge commit is not done yet
 
2658
            selected_list = []
 
2659
 
 
2660
        if fixes is None:
 
2661
            fixes = []
 
2662
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
2663
        if bug_property:
 
2664
            properties['bugs'] = bug_property
 
2665
 
 
2666
        if local and not tree.branch.get_bound_location():
 
2667
            raise errors.LocalRequiresBoundBranch()
 
2668
 
 
2669
        def get_message(commit_obj):
 
2670
            """Callback to get commit message"""
 
2671
            my_message = message
 
2672
            if my_message is None and not file:
 
2673
                t = make_commit_message_template_encoded(tree,
 
2674
                        selected_list, diff=show_diff,
 
2675
                        output_encoding=osutils.get_user_encoding())
 
2676
                start_message = generate_commit_message_template(commit_obj)
 
2677
                my_message = edit_commit_message_encoded(t, 
 
2678
                    start_message=start_message)
 
2679
                if my_message is None:
 
2680
                    raise errors.BzrCommandError("please specify a commit"
 
2681
                        " message with either --message or --file")
 
2682
            elif my_message and file:
 
2683
                raise errors.BzrCommandError(
 
2684
                    "please specify either --message or --file")
 
2685
            if file:
 
2686
                my_message = codecs.open(file, 'rt',
 
2687
                                         osutils.get_user_encoding()).read()
 
2688
            if my_message == "":
 
2689
                raise errors.BzrCommandError("empty commit message specified")
 
2690
            return my_message
 
2691
 
 
2692
        try:
 
2693
            tree.commit(message_callback=get_message,
 
2694
                        specific_files=selected_list,
 
2695
                        allow_pointless=unchanged, strict=strict, local=local,
 
2696
                        reporter=None, verbose=verbose, revprops=properties,
 
2697
                        author=author,
 
2698
                        exclude=safe_relpath_files(tree, exclude))
 
2699
        except PointlessCommit:
 
2700
            # FIXME: This should really happen before the file is read in;
 
2701
            # perhaps prepare the commit; get the message; then actually commit
 
2702
            raise errors.BzrCommandError("no changes to commit."
 
2703
                              " use --unchanged to commit anyhow")
 
2704
        except ConflictsInTree:
 
2705
            raise errors.BzrCommandError('Conflicts detected in working '
 
2706
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2707
                ' resolve.')
 
2708
        except StrictCommitFailed:
 
2709
            raise errors.BzrCommandError("Commit refused because there are"
 
2710
                              " unknown files in the working tree.")
 
2711
        except errors.BoundBranchOutOfDate, e:
 
2712
            raise errors.BzrCommandError(str(e) + "\n"
 
2713
            'To commit to master branch, run update and then commit.\n'
 
2714
            'You can also pass --local to commit to continue working '
 
2715
            'disconnected.')
 
2716
 
 
2717
 
 
2718
class cmd_check(Command):
 
2719
    """Validate working tree structure, branch consistency and repository history.
 
2720
 
 
2721
    This command checks various invariants about branch and repository storage
 
2722
    to detect data corruption or bzr bugs.
 
2723
 
 
2724
    The working tree and branch checks will only give output if a problem is
 
2725
    detected. The output fields of the repository check are:
 
2726
 
 
2727
        revisions: This is just the number of revisions checked.  It doesn't
 
2728
            indicate a problem.
 
2729
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2730
            doesn't indicate a problem.
 
2731
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2732
            are not properly referenced by the revision ancestry.  This is a
 
2733
            subtle problem that Bazaar can work around.
 
2734
        unique file texts: This is the total number of unique file contents
 
2735
            seen in the checked revisions.  It does not indicate a problem.
 
2736
        repeated file texts: This is the total number of repeated texts seen
 
2737
            in the checked revisions.  Texts can be repeated when their file
 
2738
            entries are modified, but the file contents are not.  It does not
 
2739
            indicate a problem.
 
2740
 
 
2741
    If no restrictions are specified, all Bazaar data that is found at the given
 
2742
    location will be checked.
 
2743
 
 
2744
    :Examples:
 
2745
 
 
2746
        Check the tree and branch at 'foo'::
 
2747
 
 
2748
            bzr check --tree --branch foo
 
2749
 
 
2750
        Check only the repository at 'bar'::
 
2751
 
 
2752
            bzr check --repo bar
 
2753
 
 
2754
        Check everything at 'baz'::
 
2755
 
 
2756
            bzr check baz
 
2757
    """
 
2758
 
 
2759
    _see_also = ['reconcile']
 
2760
    takes_args = ['path?']
 
2761
    takes_options = ['verbose',
 
2762
                     Option('branch', help="Check the branch related to the"
 
2763
                                           " current directory."),
 
2764
                     Option('repo', help="Check the repository related to the"
 
2765
                                         " current directory."),
 
2766
                     Option('tree', help="Check the working tree related to"
 
2767
                                         " the current directory.")]
 
2768
 
 
2769
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
2770
            tree=False):
 
2771
        from bzrlib.check import check_dwim
 
2772
        if path is None:
 
2773
            path = '.'
 
2774
        if not branch and not repo and not tree:
 
2775
            branch = repo = tree = True
 
2776
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
2777
 
 
2778
 
 
2779
class cmd_upgrade(Command):
 
2780
    """Upgrade branch storage to current format.
 
2781
 
 
2782
    The check command or bzr developers may sometimes advise you to run
 
2783
    this command. When the default format has changed you may also be warned
 
2784
    during other operations to upgrade.
 
2785
    """
 
2786
 
 
2787
    _see_also = ['check']
 
2788
    takes_args = ['url?']
 
2789
    takes_options = [
 
2790
                    RegistryOption('format',
 
2791
                        help='Upgrade to a specific format.  See "bzr help'
 
2792
                             ' formats" for details.',
 
2793
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
2794
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2795
                        value_switches=True, title='Branch format'),
 
2796
                    ]
 
2797
 
 
2798
    def run(self, url='.', format=None):
 
2799
        from bzrlib.upgrade import upgrade
 
2800
        if format is None:
 
2801
            format = bzrdir.format_registry.make_bzrdir('default')
 
2802
        upgrade(url, format)
 
2803
 
 
2804
 
 
2805
class cmd_whoami(Command):
 
2806
    """Show or set bzr user id.
 
2807
    
 
2808
    :Examples:
 
2809
        Show the email of the current user::
 
2810
 
 
2811
            bzr whoami --email
 
2812
 
 
2813
        Set the current user::
 
2814
 
 
2815
            bzr whoami "Frank Chu <fchu@example.com>"
 
2816
    """
 
2817
    takes_options = [ Option('email',
 
2818
                             help='Display email address only.'),
 
2819
                      Option('branch',
 
2820
                             help='Set identity for the current branch instead of '
 
2821
                                  'globally.'),
 
2822
                    ]
 
2823
    takes_args = ['name?']
 
2824
    encoding_type = 'replace'
 
2825
    
 
2826
    @display_command
 
2827
    def run(self, email=False, branch=False, name=None):
 
2828
        if name is None:
 
2829
            # use branch if we're inside one; otherwise global config
 
2830
            try:
 
2831
                c = Branch.open_containing('.')[0].get_config()
 
2832
            except errors.NotBranchError:
 
2833
                c = config.GlobalConfig()
 
2834
            if email:
 
2835
                self.outf.write(c.user_email() + '\n')
 
2836
            else:
 
2837
                self.outf.write(c.username() + '\n')
 
2838
            return
 
2839
 
 
2840
        # display a warning if an email address isn't included in the given name.
 
2841
        try:
 
2842
            config.extract_email_address(name)
 
2843
        except errors.NoEmailInUsername, e:
 
2844
            warning('"%s" does not seem to contain an email address.  '
 
2845
                    'This is allowed, but not recommended.', name)
 
2846
        
 
2847
        # use global config unless --branch given
 
2848
        if branch:
 
2849
            c = Branch.open_containing('.')[0].get_config()
 
2850
        else:
 
2851
            c = config.GlobalConfig()
 
2852
        c.set_user_option('email', name)
 
2853
 
 
2854
 
 
2855
class cmd_nick(Command):
 
2856
    """Print or set the branch nickname.
 
2857
 
 
2858
    If unset, the tree root directory name is used as the nickname.
 
2859
    To print the current nickname, execute with no argument.
 
2860
 
 
2861
    Bound branches use the nickname of its master branch unless it is set
 
2862
    locally.
 
2863
    """
 
2864
 
 
2865
    _see_also = ['info']
 
2866
    takes_args = ['nickname?']
 
2867
    def run(self, nickname=None):
 
2868
        branch = Branch.open_containing(u'.')[0]
 
2869
        if nickname is None:
 
2870
            self.printme(branch)
 
2871
        else:
 
2872
            branch.nick = nickname
 
2873
 
 
2874
    @display_command
 
2875
    def printme(self, branch):
 
2876
        print branch.nick
 
2877
 
 
2878
 
 
2879
class cmd_alias(Command):
 
2880
    """Set/unset and display aliases.
 
2881
 
 
2882
    :Examples:
 
2883
        Show the current aliases::
 
2884
 
 
2885
            bzr alias
 
2886
 
 
2887
        Show the alias specified for 'll'::
 
2888
 
 
2889
            bzr alias ll
 
2890
 
 
2891
        Set an alias for 'll'::
 
2892
 
 
2893
            bzr alias ll="log --line -r-10..-1"
 
2894
 
 
2895
        To remove an alias for 'll'::
 
2896
 
 
2897
            bzr alias --remove ll
 
2898
 
 
2899
    """
 
2900
    takes_args = ['name?']
 
2901
    takes_options = [
 
2902
        Option('remove', help='Remove the alias.'),
 
2903
        ]
 
2904
 
 
2905
    def run(self, name=None, remove=False):
 
2906
        if remove:
 
2907
            self.remove_alias(name)
 
2908
        elif name is None:
 
2909
            self.print_aliases()
 
2910
        else:
 
2911
            equal_pos = name.find('=')
 
2912
            if equal_pos == -1:
 
2913
                self.print_alias(name)
 
2914
            else:
 
2915
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
2916
 
 
2917
    def remove_alias(self, alias_name):
 
2918
        if alias_name is None:
 
2919
            raise errors.BzrCommandError(
 
2920
                'bzr alias --remove expects an alias to remove.')
 
2921
        # If alias is not found, print something like:
 
2922
        # unalias: foo: not found
 
2923
        c = config.GlobalConfig()
 
2924
        c.unset_alias(alias_name)
 
2925
 
 
2926
    @display_command
 
2927
    def print_aliases(self):
 
2928
        """Print out the defined aliases in a similar format to bash."""
 
2929
        aliases = config.GlobalConfig().get_aliases()
 
2930
        for key, value in sorted(aliases.iteritems()):
 
2931
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
2932
 
 
2933
    @display_command
 
2934
    def print_alias(self, alias_name):
 
2935
        from bzrlib.commands import get_alias
 
2936
        alias = get_alias(alias_name)
 
2937
        if alias is None:
 
2938
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
2939
        else:
 
2940
            self.outf.write(
 
2941
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
2942
 
 
2943
    def set_alias(self, alias_name, alias_command):
 
2944
        """Save the alias in the global config."""
 
2945
        c = config.GlobalConfig()
 
2946
        c.set_alias(alias_name, alias_command)
 
2947
 
 
2948
 
 
2949
class cmd_selftest(Command):
 
2950
    """Run internal test suite.
 
2951
    
 
2952
    If arguments are given, they are regular expressions that say which tests
 
2953
    should run.  Tests matching any expression are run, and other tests are
 
2954
    not run.
 
2955
 
 
2956
    Alternatively if --first is given, matching tests are run first and then
 
2957
    all other tests are run.  This is useful if you have been working in a
 
2958
    particular area, but want to make sure nothing else was broken.
 
2959
 
 
2960
    If --exclude is given, tests that match that regular expression are
 
2961
    excluded, regardless of whether they match --first or not.
 
2962
 
 
2963
    To help catch accidential dependencies between tests, the --randomize
 
2964
    option is useful. In most cases, the argument used is the word 'now'.
 
2965
    Note that the seed used for the random number generator is displayed
 
2966
    when this option is used. The seed can be explicitly passed as the
 
2967
    argument to this option if required. This enables reproduction of the
 
2968
    actual ordering used if and when an order sensitive problem is encountered.
 
2969
 
 
2970
    If --list-only is given, the tests that would be run are listed. This is
 
2971
    useful when combined with --first, --exclude and/or --randomize to
 
2972
    understand their impact. The test harness reports "Listed nn tests in ..."
 
2973
    instead of "Ran nn tests in ..." when list mode is enabled.
 
2974
 
 
2975
    If the global option '--no-plugins' is given, plugins are not loaded
 
2976
    before running the selftests.  This has two effects: features provided or
 
2977
    modified by plugins will not be tested, and tests provided by plugins will
 
2978
    not be run.
 
2979
 
 
2980
    Tests that need working space on disk use a common temporary directory, 
 
2981
    typically inside $TMPDIR or /tmp.
 
2982
 
 
2983
    :Examples:
 
2984
        Run only tests relating to 'ignore'::
 
2985
 
 
2986
            bzr selftest ignore
 
2987
 
 
2988
        Disable plugins and list tests as they're run::
 
2989
 
 
2990
            bzr --no-plugins selftest -v
 
2991
    """
 
2992
    # NB: this is used from the class without creating an instance, which is
 
2993
    # why it does not have a self parameter.
 
2994
    def get_transport_type(typestring):
 
2995
        """Parse and return a transport specifier."""
 
2996
        if typestring == "sftp":
 
2997
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2998
            return SFTPAbsoluteServer
 
2999
        if typestring == "memory":
 
3000
            from bzrlib.transport.memory import MemoryServer
 
3001
            return MemoryServer
 
3002
        if typestring == "fakenfs":
 
3003
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3004
            return FakeNFSServer
 
3005
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
3006
            (typestring)
 
3007
        raise errors.BzrCommandError(msg)
 
3008
 
 
3009
    hidden = True
 
3010
    takes_args = ['testspecs*']
 
3011
    takes_options = ['verbose',
 
3012
                     Option('one',
 
3013
                             help='Stop when one test fails.',
 
3014
                             short_name='1',
 
3015
                             ),
 
3016
                     Option('transport',
 
3017
                            help='Use a different transport by default '
 
3018
                                 'throughout the test suite.',
 
3019
                            type=get_transport_type),
 
3020
                     Option('benchmark',
 
3021
                            help='Run the benchmarks rather than selftests.'),
 
3022
                     Option('lsprof-timed',
 
3023
                            help='Generate lsprof output for benchmarked'
 
3024
                                 ' sections of code.'),
 
3025
                     Option('cache-dir', type=str,
 
3026
                            help='Cache intermediate benchmark output in this '
 
3027
                                 'directory.'),
 
3028
                     Option('first',
 
3029
                            help='Run all tests, but run specified tests first.',
 
3030
                            short_name='f',
 
3031
                            ),
 
3032
                     Option('list-only',
 
3033
                            help='List the tests instead of running them.'),
 
3034
                     Option('randomize', type=str, argname="SEED",
 
3035
                            help='Randomize the order of tests using the given'
 
3036
                                 ' seed or "now" for the current time.'),
 
3037
                     Option('exclude', type=str, argname="PATTERN",
 
3038
                            short_name='x',
 
3039
                            help='Exclude tests that match this regular'
 
3040
                                 ' expression.'),
 
3041
                     Option('strict', help='Fail on missing dependencies or '
 
3042
                            'known failures.'),
 
3043
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
3044
                            help='Load a test id list from a text file.'),
 
3045
                     ListOption('debugflag', type=str, short_name='E',
 
3046
                                help='Turn on a selftest debug flag.'),
 
3047
                     ListOption('starting-with', type=str, argname='TESTID',
 
3048
                                param_name='starting_with', short_name='s',
 
3049
                                help=
 
3050
                                'Load only the tests starting with TESTID.'),
 
3051
                     ]
 
3052
    encoding_type = 'replace'
 
3053
 
 
3054
    def run(self, testspecs_list=None, verbose=False, one=False,
 
3055
            transport=None, benchmark=None,
 
3056
            lsprof_timed=None, cache_dir=None,
 
3057
            first=False, list_only=False,
 
3058
            randomize=None, exclude=None, strict=False,
 
3059
            load_list=None, debugflag=None, starting_with=None):
 
3060
        from bzrlib.tests import selftest
 
3061
        import bzrlib.benchmarks as benchmarks
 
3062
        from bzrlib.benchmarks import tree_creator
 
3063
 
 
3064
        # Make deprecation warnings visible, unless -Werror is set
 
3065
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3066
 
 
3067
        if cache_dir is not None:
 
3068
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3069
        if not list_only:
 
3070
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
3071
            print '   %s (%s python%s)' % (
 
3072
                    bzrlib.__path__[0],
 
3073
                    bzrlib.version_string,
 
3074
                    bzrlib._format_version_tuple(sys.version_info),
 
3075
                    )
 
3076
        print
 
3077
        if testspecs_list is not None:
 
3078
            pattern = '|'.join(testspecs_list)
 
3079
        else:
 
3080
            pattern = ".*"
 
3081
        if benchmark:
 
3082
            test_suite_factory = benchmarks.test_suite
 
3083
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3084
            verbose = not is_quiet()
 
3085
            # TODO: should possibly lock the history file...
 
3086
            benchfile = open(".perf_history", "at", buffering=1)
 
3087
        else:
 
3088
            test_suite_factory = None
 
3089
            benchfile = None
 
3090
        try:
 
3091
            result = selftest(verbose=verbose,
 
3092
                              pattern=pattern,
 
3093
                              stop_on_failure=one,
 
3094
                              transport=transport,
 
3095
                              test_suite_factory=test_suite_factory,
 
3096
                              lsprof_timed=lsprof_timed,
 
3097
                              bench_history=benchfile,
 
3098
                              matching_tests_first=first,
 
3099
                              list_only=list_only,
 
3100
                              random_seed=randomize,
 
3101
                              exclude_pattern=exclude,
 
3102
                              strict=strict,
 
3103
                              load_list=load_list,
 
3104
                              debug_flags=debugflag,
 
3105
                              starting_with=starting_with,
 
3106
                              )
 
3107
        finally:
 
3108
            if benchfile is not None:
 
3109
                benchfile.close()
 
3110
        if result:
 
3111
            note('tests passed')
 
3112
        else:
 
3113
            note('tests failed')
 
3114
        return int(not result)
 
3115
 
 
3116
 
 
3117
class cmd_version(Command):
 
3118
    """Show version of bzr."""
 
3119
 
 
3120
    encoding_type = 'replace'
 
3121
    takes_options = [
 
3122
        Option("short", help="Print just the version number."),
 
3123
        ]
 
3124
 
 
3125
    @display_command
 
3126
    def run(self, short=False):
 
3127
        from bzrlib.version import show_version
 
3128
        if short:
 
3129
            self.outf.write(bzrlib.version_string + '\n')
 
3130
        else:
 
3131
            show_version(to_file=self.outf)
 
3132
 
 
3133
 
 
3134
class cmd_rocks(Command):
 
3135
    """Statement of optimism."""
 
3136
 
 
3137
    hidden = True
 
3138
 
 
3139
    @display_command
 
3140
    def run(self):
 
3141
        print "It sure does!"
 
3142
 
 
3143
 
 
3144
class cmd_find_merge_base(Command):
 
3145
    """Find and print a base revision for merging two branches."""
 
3146
    # TODO: Options to specify revisions on either side, as if
 
3147
    #       merging only part of the history.
 
3148
    takes_args = ['branch', 'other']
 
3149
    hidden = True
 
3150
    
 
3151
    @display_command
 
3152
    def run(self, branch, other):
 
3153
        from bzrlib.revision import ensure_null
 
3154
        
 
3155
        branch1 = Branch.open_containing(branch)[0]
 
3156
        branch2 = Branch.open_containing(other)[0]
 
3157
        branch1.lock_read()
 
3158
        try:
 
3159
            branch2.lock_read()
 
3160
            try:
 
3161
                last1 = ensure_null(branch1.last_revision())
 
3162
                last2 = ensure_null(branch2.last_revision())
 
3163
 
 
3164
                graph = branch1.repository.get_graph(branch2.repository)
 
3165
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3166
 
 
3167
                print 'merge base is revision %s' % base_rev_id
 
3168
            finally:
 
3169
                branch2.unlock()
 
3170
        finally:
 
3171
            branch1.unlock()
 
3172
 
 
3173
 
 
3174
class cmd_merge(Command):
 
3175
    """Perform a three-way merge.
 
3176
    
 
3177
    The source of the merge can be specified either in the form of a branch,
 
3178
    or in the form of a path to a file containing a merge directive generated
 
3179
    with bzr send. If neither is specified, the default is the upstream branch
 
3180
    or the branch most recently merged using --remember.
 
3181
 
 
3182
    When merging a branch, by default the tip will be merged. To pick a different
 
3183
    revision, pass --revision. If you specify two values, the first will be used as
 
3184
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3185
    available revisions, like this is commonly referred to as "cherrypicking".
 
3186
 
 
3187
    Revision numbers are always relative to the branch being merged.
 
3188
 
 
3189
    By default, bzr will try to merge in all new work from the other
 
3190
    branch, automatically determining an appropriate base.  If this
 
3191
    fails, you may need to give an explicit base.
 
3192
    
 
3193
    Merge will do its best to combine the changes in two branches, but there
 
3194
    are some kinds of problems only a human can fix.  When it encounters those,
 
3195
    it will mark a conflict.  A conflict means that you need to fix something,
 
3196
    before you should commit.
 
3197
 
 
3198
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
3199
 
 
3200
    If there is no default branch set, the first merge will set it. After
 
3201
    that, you can omit the branch to use the default.  To change the
 
3202
    default, use --remember. The value will only be saved if the remote
 
3203
    location can be accessed.
 
3204
 
 
3205
    The results of the merge are placed into the destination working
 
3206
    directory, where they can be reviewed (with bzr diff), tested, and then
 
3207
    committed to record the result of the merge.
 
3208
    
 
3209
    merge refuses to run if there are any uncommitted changes, unless
 
3210
    --force is given.
 
3211
 
 
3212
    :Examples:
 
3213
        To merge the latest revision from bzr.dev::
 
3214
 
 
3215
            bzr merge ../bzr.dev
 
3216
 
 
3217
        To merge changes up to and including revision 82 from bzr.dev::
 
3218
 
 
3219
            bzr merge -r 82 ../bzr.dev
 
3220
 
 
3221
        To merge the changes introduced by 82, without previous changes::
 
3222
 
 
3223
            bzr merge -r 81..82 ../bzr.dev
 
3224
 
 
3225
        To apply a merge directive contained in in /tmp/merge:
 
3226
 
 
3227
            bzr merge /tmp/merge
 
3228
    """
 
3229
 
 
3230
    encoding_type = 'exact'
 
3231
    _see_also = ['update', 'remerge', 'status-flags']
 
3232
    takes_args = ['location?']
 
3233
    takes_options = [
 
3234
        'change',
 
3235
        'revision',
 
3236
        Option('force',
 
3237
               help='Merge even if the destination tree has uncommitted changes.'),
 
3238
        'merge-type',
 
3239
        'reprocess',
 
3240
        'remember',
 
3241
        Option('show-base', help="Show base revision text in "
 
3242
               "conflicts."),
 
3243
        Option('uncommitted', help='Apply uncommitted changes'
 
3244
               ' from a working copy, instead of branch changes.'),
 
3245
        Option('pull', help='If the destination is already'
 
3246
                ' completely merged into the source, pull from the'
 
3247
                ' source rather than merging.  When this happens,'
 
3248
                ' you do not need to commit the result.'),
 
3249
        Option('directory',
 
3250
               help='Branch to merge into, '
 
3251
                    'rather than the one containing the working directory.',
 
3252
               short_name='d',
 
3253
               type=unicode,
 
3254
               ),
 
3255
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3256
    ]
 
3257
 
 
3258
    def run(self, location=None, revision=None, force=False,
 
3259
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3260
            uncommitted=False, pull=False,
 
3261
            directory=None,
 
3262
            preview=False,
 
3263
            ):
 
3264
        if merge_type is None:
 
3265
            merge_type = _mod_merge.Merge3Merger
 
3266
 
 
3267
        if directory is None: directory = u'.'
 
3268
        possible_transports = []
 
3269
        merger = None
 
3270
        allow_pending = True
 
3271
        verified = 'inapplicable'
 
3272
        tree = WorkingTree.open_containing(directory)[0]
 
3273
        change_reporter = delta._ChangeReporter(
 
3274
            unversioned_filter=tree.is_ignored)
 
3275
        cleanups = []
 
3276
        try:
 
3277
            pb = ui.ui_factory.nested_progress_bar()
 
3278
            cleanups.append(pb.finished)
 
3279
            tree.lock_write()
 
3280
            cleanups.append(tree.unlock)
 
3281
            if location is not None:
 
3282
                try:
 
3283
                    mergeable = bundle.read_mergeable_from_url(location,
 
3284
                        possible_transports=possible_transports)
 
3285
                except errors.NotABundle:
 
3286
                    mergeable = None
 
3287
                else:
 
3288
                    if uncommitted:
 
3289
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3290
                            ' with bundles or merge directives.')
 
3291
 
 
3292
                    if revision is not None:
 
3293
                        raise errors.BzrCommandError(
 
3294
                            'Cannot use -r with merge directives or bundles')
 
3295
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3296
                       mergeable, pb)
 
3297
 
 
3298
            if merger is None and uncommitted:
 
3299
                if revision is not None and len(revision) > 0:
 
3300
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3301
                        ' --revision at the same time.')
 
3302
                location = self._select_branch_location(tree, location)[0]
 
3303
                other_tree, other_path = WorkingTree.open_containing(location)
 
3304
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3305
                    pb)
 
3306
                allow_pending = False
 
3307
                if other_path != '':
 
3308
                    merger.interesting_files = [other_path]
 
3309
 
 
3310
            if merger is None:
 
3311
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3312
                    location, revision, remember, possible_transports, pb)
 
3313
 
 
3314
            merger.merge_type = merge_type
 
3315
            merger.reprocess = reprocess
 
3316
            merger.show_base = show_base
 
3317
            self.sanity_check_merger(merger)
 
3318
            if (merger.base_rev_id == merger.other_rev_id and
 
3319
                merger.other_rev_id is not None):
 
3320
                note('Nothing to do.')
 
3321
                return 0
 
3322
            if pull:
 
3323
                if merger.interesting_files is not None:
 
3324
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3325
                if (merger.base_rev_id == tree.last_revision()):
 
3326
                    result = tree.pull(merger.other_branch, False,
 
3327
                                       merger.other_rev_id)
 
3328
                    result.report(self.outf)
 
3329
                    return 0
 
3330
            merger.check_basis(not force)
 
3331
            if preview:
 
3332
                return self._do_preview(merger)
 
3333
            else:
 
3334
                return self._do_merge(merger, change_reporter, allow_pending,
 
3335
                                      verified)
 
3336
        finally:
 
3337
            for cleanup in reversed(cleanups):
 
3338
                cleanup()
 
3339
 
 
3340
    def _do_preview(self, merger):
 
3341
        from bzrlib.diff import show_diff_trees
 
3342
        tree_merger = merger.make_merger()
 
3343
        tt = tree_merger.make_preview_transform()
 
3344
        try:
 
3345
            result_tree = tt.get_preview_tree()
 
3346
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3347
                            old_label='', new_label='')
 
3348
        finally:
 
3349
            tt.finalize()
 
3350
 
 
3351
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
3352
        merger.change_reporter = change_reporter
 
3353
        conflict_count = merger.do_merge()
 
3354
        if allow_pending:
 
3355
            merger.set_pending()
 
3356
        if verified == 'failed':
 
3357
            warning('Preview patch does not match changes')
 
3358
        if conflict_count != 0:
 
3359
            return 1
 
3360
        else:
 
3361
            return 0
 
3362
 
 
3363
    def sanity_check_merger(self, merger):
 
3364
        if (merger.show_base and
 
3365
            not merger.merge_type is _mod_merge.Merge3Merger):
 
3366
            raise errors.BzrCommandError("Show-base is not supported for this"
 
3367
                                         " merge type. %s" % merger.merge_type)
 
3368
        if merger.reprocess is None:
 
3369
            if merger.show_base:
 
3370
                merger.reprocess = False
 
3371
            else:
 
3372
                # Use reprocess if the merger supports it
 
3373
                merger.reprocess = merger.merge_type.supports_reprocess
 
3374
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
3375
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
3376
                                         " for merge type %s." %
 
3377
                                         merger.merge_type)
 
3378
        if merger.reprocess and merger.show_base:
 
3379
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
3380
                                         " show base.")
 
3381
 
 
3382
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
3383
                                possible_transports, pb):
 
3384
        """Produce a merger from a location, assuming it refers to a branch."""
 
3385
        from bzrlib.tag import _merge_tags_if_possible
 
3386
        # find the branch locations
 
3387
        other_loc, user_location = self._select_branch_location(tree, location,
 
3388
            revision, -1)
 
3389
        if revision is not None and len(revision) == 2:
 
3390
            base_loc, _unused = self._select_branch_location(tree,
 
3391
                location, revision, 0)
 
3392
        else:
 
3393
            base_loc = other_loc
 
3394
        # Open the branches
 
3395
        other_branch, other_path = Branch.open_containing(other_loc,
 
3396
            possible_transports)
 
3397
        if base_loc == other_loc:
 
3398
            base_branch = other_branch
 
3399
        else:
 
3400
            base_branch, base_path = Branch.open_containing(base_loc,
 
3401
                possible_transports)
 
3402
        # Find the revision ids
 
3403
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3404
            other_revision_id = _mod_revision.ensure_null(
 
3405
                other_branch.last_revision())
 
3406
        else:
 
3407
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3408
        if (revision is not None and len(revision) == 2
 
3409
            and revision[0] is not None):
 
3410
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3411
        else:
 
3412
            base_revision_id = None
 
3413
        # Remember where we merge from
 
3414
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3415
             user_location is not None):
 
3416
            tree.branch.set_submit_branch(other_branch.base)
 
3417
        _merge_tags_if_possible(other_branch, tree.branch)
 
3418
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3419
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3420
        if other_path != '':
 
3421
            allow_pending = False
 
3422
            merger.interesting_files = [other_path]
 
3423
        else:
 
3424
            allow_pending = True
 
3425
        return merger, allow_pending
 
3426
 
 
3427
    def _select_branch_location(self, tree, user_location, revision=None,
 
3428
                                index=None):
 
3429
        """Select a branch location, according to possible inputs.
 
3430
 
 
3431
        If provided, branches from ``revision`` are preferred.  (Both
 
3432
        ``revision`` and ``index`` must be supplied.)
 
3433
 
 
3434
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3435
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3436
 
 
3437
        :param tree: The working tree to select a branch for merging into
 
3438
        :param location: The location entered by the user
 
3439
        :param revision: The revision parameter to the command
 
3440
        :param index: The index to use for the revision parameter.  Negative
 
3441
            indices are permitted.
 
3442
        :return: (selected_location, user_location).  The default location
 
3443
            will be the user-entered location.
 
3444
        """
 
3445
        if (revision is not None and index is not None
 
3446
            and revision[index] is not None):
 
3447
            branch = revision[index].get_branch()
 
3448
            if branch is not None:
 
3449
                return branch, branch
 
3450
        if user_location is None:
 
3451
            location = self._get_remembered(tree, 'Merging from')
 
3452
        else:
 
3453
            location = user_location
 
3454
        return location, user_location
 
3455
 
 
3456
    def _get_remembered(self, tree, verb_string):
 
3457
        """Use tree.branch's parent if none was supplied.
 
3458
 
 
3459
        Report if the remembered location was used.
 
3460
        """
 
3461
        stored_location = tree.branch.get_submit_branch()
 
3462
        stored_location_type = "submit"
 
3463
        if stored_location is None:
 
3464
            stored_location = tree.branch.get_parent()
 
3465
            stored_location_type = "parent"
 
3466
        mutter("%s", stored_location)
 
3467
        if stored_location is None:
 
3468
            raise errors.BzrCommandError("No location specified or remembered")
 
3469
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3470
        note(u"%s remembered %s location %s", verb_string,
 
3471
                stored_location_type, display_url)
 
3472
        return stored_location
 
3473
 
 
3474
 
 
3475
class cmd_remerge(Command):
 
3476
    """Redo a merge.
 
3477
 
 
3478
    Use this if you want to try a different merge technique while resolving
 
3479
    conflicts.  Some merge techniques are better than others, and remerge 
 
3480
    lets you try different ones on different files.
 
3481
 
 
3482
    The options for remerge have the same meaning and defaults as the ones for
 
3483
    merge.  The difference is that remerge can (only) be run when there is a
 
3484
    pending merge, and it lets you specify particular files.
 
3485
 
 
3486
    :Examples:
 
3487
        Re-do the merge of all conflicted files, and show the base text in
 
3488
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3489
      
 
3490
            bzr remerge --show-base
 
3491
 
 
3492
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3493
        additional processing to reduce the size of conflict regions::
 
3494
      
 
3495
            bzr remerge --merge-type weave --reprocess foobar
 
3496
    """
 
3497
    takes_args = ['file*']
 
3498
    takes_options = [
 
3499
            'merge-type',
 
3500
            'reprocess',
 
3501
            Option('show-base',
 
3502
                   help="Show base revision text in conflicts."),
 
3503
            ]
 
3504
 
 
3505
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3506
            reprocess=False):
 
3507
        if merge_type is None:
 
3508
            merge_type = _mod_merge.Merge3Merger
 
3509
        tree, file_list = tree_files(file_list)
 
3510
        tree.lock_write()
 
3511
        try:
 
3512
            parents = tree.get_parent_ids()
 
3513
            if len(parents) != 2:
 
3514
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3515
                                             " merges.  Not cherrypicking or"
 
3516
                                             " multi-merges.")
 
3517
            repository = tree.branch.repository
 
3518
            interesting_ids = None
 
3519
            new_conflicts = []
 
3520
            conflicts = tree.conflicts()
 
3521
            if file_list is not None:
 
3522
                interesting_ids = set()
 
3523
                for filename in file_list:
 
3524
                    file_id = tree.path2id(filename)
 
3525
                    if file_id is None:
 
3526
                        raise errors.NotVersionedError(filename)
 
3527
                    interesting_ids.add(file_id)
 
3528
                    if tree.kind(file_id) != "directory":
 
3529
                        continue
 
3530
                    
 
3531
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3532
                        interesting_ids.add(ie.file_id)
 
3533
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3534
            else:
 
3535
                # Remerge only supports resolving contents conflicts
 
3536
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3537
                restore_files = [c.path for c in conflicts
 
3538
                                 if c.typestring in allowed_conflicts]
 
3539
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3540
            tree.set_conflicts(ConflictList(new_conflicts))
 
3541
            if file_list is not None:
 
3542
                restore_files = file_list
 
3543
            for filename in restore_files:
 
3544
                try:
 
3545
                    restore(tree.abspath(filename))
 
3546
                except errors.NotConflicted:
 
3547
                    pass
 
3548
            # Disable pending merges, because the file texts we are remerging
 
3549
            # have not had those merges performed.  If we use the wrong parents
 
3550
            # list, we imply that the working tree text has seen and rejected
 
3551
            # all the changes from the other tree, when in fact those changes
 
3552
            # have not yet been seen.
 
3553
            pb = ui.ui_factory.nested_progress_bar()
 
3554
            tree.set_parent_ids(parents[:1])
 
3555
            try:
 
3556
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3557
                                                             tree, parents[1])
 
3558
                merger.interesting_ids = interesting_ids
 
3559
                merger.merge_type = merge_type
 
3560
                merger.show_base = show_base
 
3561
                merger.reprocess = reprocess
 
3562
                conflicts = merger.do_merge()
 
3563
            finally:
 
3564
                tree.set_parent_ids(parents)
 
3565
                pb.finished()
 
3566
        finally:
 
3567
            tree.unlock()
 
3568
        if conflicts > 0:
 
3569
            return 1
 
3570
        else:
 
3571
            return 0
 
3572
 
 
3573
 
 
3574
class cmd_revert(Command):
 
3575
    """Revert files to a previous revision.
 
3576
 
 
3577
    Giving a list of files will revert only those files.  Otherwise, all files
 
3578
    will be reverted.  If the revision is not specified with '--revision', the
 
3579
    last committed revision is used.
 
3580
 
 
3581
    To remove only some changes, without reverting to a prior version, use
 
3582
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3583
    changes introduced by -2, without affecting the changes introduced by -1.
 
3584
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3585
    
 
3586
    By default, any files that have been manually changed will be backed up
 
3587
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3588
    '.~#~' appended to their name, where # is a number.
 
3589
 
 
3590
    When you provide files, you can use their current pathname or the pathname
 
3591
    from the target revision.  So you can use revert to "undelete" a file by
 
3592
    name.  If you name a directory, all the contents of that directory will be
 
3593
    reverted.
 
3594
 
 
3595
    Any files that have been newly added since that revision will be deleted,
 
3596
    with a backup kept if appropriate.  Directories containing unknown files
 
3597
    will not be deleted.
 
3598
 
 
3599
    The working tree contains a list of pending merged revisions, which will
 
3600
    be included as parents in the next commit.  Normally, revert clears that
 
3601
    list as well as reverting the files.  If any files are specified, revert
 
3602
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3603
    revert ." in the tree root to revert all files but keep the merge record,
 
3604
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3605
    reverting any files.
 
3606
    """
 
3607
 
 
3608
    _see_also = ['cat', 'export']
 
3609
    takes_options = [
 
3610
        'revision',
 
3611
        Option('no-backup', "Do not save backups of reverted files."),
 
3612
        Option('forget-merges',
 
3613
               'Remove pending merge marker, without changing any files.'),
 
3614
        ]
 
3615
    takes_args = ['file*']
 
3616
 
 
3617
    def run(self, revision=None, no_backup=False, file_list=None,
 
3618
            forget_merges=None):
 
3619
        tree, file_list = tree_files(file_list)
 
3620
        tree.lock_write()
 
3621
        try:
 
3622
            if forget_merges:
 
3623
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3624
            else:
 
3625
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3626
        finally:
 
3627
            tree.unlock()
 
3628
 
 
3629
    @staticmethod
 
3630
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3631
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
3632
        pb = ui.ui_factory.nested_progress_bar()
 
3633
        try:
 
3634
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3635
                report_changes=True)
 
3636
        finally:
 
3637
            pb.finished()
 
3638
 
 
3639
 
 
3640
class cmd_assert_fail(Command):
 
3641
    """Test reporting of assertion failures"""
 
3642
    # intended just for use in testing
 
3643
 
 
3644
    hidden = True
 
3645
 
 
3646
    def run(self):
 
3647
        raise AssertionError("always fails")
 
3648
 
 
3649
 
 
3650
class cmd_help(Command):
 
3651
    """Show help on a command or other topic.
 
3652
    """
 
3653
 
 
3654
    _see_also = ['topics']
 
3655
    takes_options = [
 
3656
            Option('long', 'Show help on all commands.'),
 
3657
            ]
 
3658
    takes_args = ['topic?']
 
3659
    aliases = ['?', '--help', '-?', '-h']
 
3660
    
 
3661
    @display_command
 
3662
    def run(self, topic=None, long=False):
 
3663
        import bzrlib.help
 
3664
        if topic is None and long:
 
3665
            topic = "commands"
 
3666
        bzrlib.help.help(topic)
 
3667
 
 
3668
 
 
3669
class cmd_shell_complete(Command):
 
3670
    """Show appropriate completions for context.
 
3671
 
 
3672
    For a list of all available commands, say 'bzr shell-complete'.
 
3673
    """
 
3674
    takes_args = ['context?']
 
3675
    aliases = ['s-c']
 
3676
    hidden = True
 
3677
    
 
3678
    @display_command
 
3679
    def run(self, context=None):
 
3680
        import shellcomplete
 
3681
        shellcomplete.shellcomplete(context)
 
3682
 
 
3683
 
 
3684
class cmd_missing(Command):
 
3685
    """Show unmerged/unpulled revisions between two branches.
 
3686
 
 
3687
    OTHER_BRANCH may be local or remote.
 
3688
 
 
3689
    To filter on a range of revirions, you can use the command -r begin..end
 
3690
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
3691
    also valid.
 
3692
 
 
3693
    :Examples:
 
3694
 
 
3695
        Determine the missing revisions between this and the branch at the
 
3696
        remembered pull location::
 
3697
 
 
3698
            bzr missing
 
3699
 
 
3700
        Determine the missing revisions between this and another branch::
 
3701
 
 
3702
            bzr missing http://server/branch
 
3703
 
 
3704
        Determine the missing revisions up to a specific revision on the other
 
3705
        branch::
 
3706
 
 
3707
            bzr missing -r ..-10
 
3708
 
 
3709
        Determine the missing revisions up to a specific revision on this
 
3710
        branch::
 
3711
 
 
3712
            bzr missing --my-revision ..-10
 
3713
    """
 
3714
 
 
3715
    _see_also = ['merge', 'pull']
 
3716
    takes_args = ['other_branch?']
 
3717
    takes_options = [
 
3718
        Option('reverse', 'Reverse the order of revisions.'),
 
3719
        Option('mine-only',
 
3720
               'Display changes in the local branch only.'),
 
3721
        Option('this' , 'Same as --mine-only.'),
 
3722
        Option('theirs-only',
 
3723
               'Display changes in the remote branch only.'),
 
3724
        Option('other', 'Same as --theirs-only.'),
 
3725
        'log-format',
 
3726
        'show-ids',
 
3727
        'verbose',
 
3728
        custom_help('revision',
 
3729
             help='Filter on other branch revisions (inclusive). '
 
3730
                'See "help revisionspec" for details.'),
 
3731
        Option('my-revision',
 
3732
            type=_parse_revision_str,
 
3733
            help='Filter on local branch revisions (inclusive). '
 
3734
                'See "help revisionspec" for details.'),
 
3735
        Option('include-merges', 'Show merged revisions.'),
 
3736
        ]
 
3737
    encoding_type = 'replace'
 
3738
 
 
3739
    @display_command
 
3740
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3741
            theirs_only=False,
 
3742
            log_format=None, long=False, short=False, line=False,
 
3743
            show_ids=False, verbose=False, this=False, other=False,
 
3744
            include_merges=False, revision=None, my_revision=None):
 
3745
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3746
        def message(s):
 
3747
            if not is_quiet():
 
3748
                self.outf.write(s)
 
3749
 
 
3750
        if this:
 
3751
            mine_only = this
 
3752
        if other:
 
3753
            theirs_only = other
 
3754
        # TODO: We should probably check that we don't have mine-only and
 
3755
        #       theirs-only set, but it gets complicated because we also have
 
3756
        #       this and other which could be used.
 
3757
        restrict = 'all'
 
3758
        if mine_only:
 
3759
            restrict = 'local'
 
3760
        elif theirs_only:
 
3761
            restrict = 'remote'
 
3762
 
 
3763
        local_branch = Branch.open_containing(u".")[0]
 
3764
        parent = local_branch.get_parent()
 
3765
        if other_branch is None:
 
3766
            other_branch = parent
 
3767
            if other_branch is None:
 
3768
                raise errors.BzrCommandError("No peer location known"
 
3769
                                             " or specified.")
 
3770
            display_url = urlutils.unescape_for_display(parent,
 
3771
                                                        self.outf.encoding)
 
3772
            message("Using saved parent location: "
 
3773
                    + display_url + "\n")
 
3774
 
 
3775
        remote_branch = Branch.open(other_branch)
 
3776
        if remote_branch.base == local_branch.base:
 
3777
            remote_branch = local_branch
 
3778
 
 
3779
        local_revid_range = _revision_range_to_revid_range(
 
3780
            _get_revision_range(my_revision, local_branch,
 
3781
                self.name()))
 
3782
 
 
3783
        remote_revid_range = _revision_range_to_revid_range(
 
3784
            _get_revision_range(revision,
 
3785
                remote_branch, self.name()))
 
3786
 
 
3787
        local_branch.lock_read()
 
3788
        try:
 
3789
            remote_branch.lock_read()
 
3790
            try:
 
3791
                local_extra, remote_extra = find_unmerged(
 
3792
                    local_branch, remote_branch, restrict,
 
3793
                    backward=not reverse,
 
3794
                    include_merges=include_merges,
 
3795
                    local_revid_range=local_revid_range,
 
3796
                    remote_revid_range=remote_revid_range)
 
3797
 
 
3798
                if log_format is None:
 
3799
                    registry = log.log_formatter_registry
 
3800
                    log_format = registry.get_default(local_branch)
 
3801
                lf = log_format(to_file=self.outf,
 
3802
                                show_ids=show_ids,
 
3803
                                show_timezone='original')
 
3804
 
 
3805
                status_code = 0
 
3806
                if local_extra and not theirs_only:
 
3807
                    message("You have %d extra revision(s):\n" %
 
3808
                        len(local_extra))
 
3809
                    for revision in iter_log_revisions(local_extra,
 
3810
                                        local_branch.repository,
 
3811
                                        verbose):
 
3812
                        lf.log_revision(revision)
 
3813
                    printed_local = True
 
3814
                    status_code = 1
 
3815
                else:
 
3816
                    printed_local = False
 
3817
 
 
3818
                if remote_extra and not mine_only:
 
3819
                    if printed_local is True:
 
3820
                        message("\n\n\n")
 
3821
                    message("You are missing %d revision(s):\n" %
 
3822
                        len(remote_extra))
 
3823
                    for revision in iter_log_revisions(remote_extra,
 
3824
                                        remote_branch.repository,
 
3825
                                        verbose):
 
3826
                        lf.log_revision(revision)
 
3827
                    status_code = 1
 
3828
 
 
3829
                if mine_only and not local_extra:
 
3830
                    # We checked local, and found nothing extra
 
3831
                    message('This branch is up to date.\n')
 
3832
                elif theirs_only and not remote_extra:
 
3833
                    # We checked remote, and found nothing extra
 
3834
                    message('Other branch is up to date.\n')
 
3835
                elif not (mine_only or theirs_only or local_extra or
 
3836
                          remote_extra):
 
3837
                    # We checked both branches, and neither one had extra
 
3838
                    # revisions
 
3839
                    message("Branches are up to date.\n")
 
3840
            finally:
 
3841
                remote_branch.unlock()
 
3842
        finally:
 
3843
            local_branch.unlock()
 
3844
        if not status_code and parent is None and other_branch is not None:
 
3845
            local_branch.lock_write()
 
3846
            try:
 
3847
                # handle race conditions - a parent might be set while we run.
 
3848
                if local_branch.get_parent() is None:
 
3849
                    local_branch.set_parent(remote_branch.base)
 
3850
            finally:
 
3851
                local_branch.unlock()
 
3852
        return status_code
 
3853
 
 
3854
 
 
3855
class cmd_pack(Command):
 
3856
    """Compress the data within a repository."""
 
3857
 
 
3858
    _see_also = ['repositories']
 
3859
    takes_args = ['branch_or_repo?']
 
3860
 
 
3861
    def run(self, branch_or_repo='.'):
 
3862
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3863
        try:
 
3864
            branch = dir.open_branch()
 
3865
            repository = branch.repository
 
3866
        except errors.NotBranchError:
 
3867
            repository = dir.open_repository()
 
3868
        repository.pack()
 
3869
 
 
3870
 
 
3871
class cmd_plugins(Command):
 
3872
    """List the installed plugins.
 
3873
    
 
3874
    This command displays the list of installed plugins including
 
3875
    version of plugin and a short description of each.
 
3876
 
 
3877
    --verbose shows the path where each plugin is located.
 
3878
 
 
3879
    A plugin is an external component for Bazaar that extends the
 
3880
    revision control system, by adding or replacing code in Bazaar.
 
3881
    Plugins can do a variety of things, including overriding commands,
 
3882
    adding new commands, providing additional network transports and
 
3883
    customizing log output.
 
3884
 
 
3885
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3886
    information on plugins including where to find them and how to
 
3887
    install them. Instructions are also provided there on how to
 
3888
    write new plugins using the Python programming language.
 
3889
    """
 
3890
    takes_options = ['verbose']
 
3891
 
 
3892
    @display_command
 
3893
    def run(self, verbose=False):
 
3894
        import bzrlib.plugin
 
3895
        from inspect import getdoc
 
3896
        result = []
 
3897
        for name, plugin in bzrlib.plugin.plugins().items():
 
3898
            version = plugin.__version__
 
3899
            if version == 'unknown':
 
3900
                version = ''
 
3901
            name_ver = '%s %s' % (name, version)
 
3902
            d = getdoc(plugin.module)
 
3903
            if d:
 
3904
                doc = d.split('\n')[0]
 
3905
            else:
 
3906
                doc = '(no description)'
 
3907
            result.append((name_ver, doc, plugin.path()))
 
3908
        for name_ver, doc, path in sorted(result):
 
3909
            print name_ver
 
3910
            print '   ', doc
 
3911
            if verbose:
 
3912
                print '   ', path
 
3913
            print
 
3914
 
 
3915
 
 
3916
class cmd_testament(Command):
 
3917
    """Show testament (signing-form) of a revision."""
 
3918
    takes_options = [
 
3919
            'revision',
 
3920
            Option('long', help='Produce long-format testament.'),
 
3921
            Option('strict',
 
3922
                   help='Produce a strict-format testament.')]
 
3923
    takes_args = ['branch?']
 
3924
    @display_command
 
3925
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3926
        from bzrlib.testament import Testament, StrictTestament
 
3927
        if strict is True:
 
3928
            testament_class = StrictTestament
 
3929
        else:
 
3930
            testament_class = Testament
 
3931
        if branch == '.':
 
3932
            b = Branch.open_containing(branch)[0]
 
3933
        else:
 
3934
            b = Branch.open(branch)
 
3935
        b.lock_read()
 
3936
        try:
 
3937
            if revision is None:
 
3938
                rev_id = b.last_revision()
 
3939
            else:
 
3940
                rev_id = revision[0].as_revision_id(b)
 
3941
            t = testament_class.from_revision(b.repository, rev_id)
 
3942
            if long:
 
3943
                sys.stdout.writelines(t.as_text_lines())
 
3944
            else:
 
3945
                sys.stdout.write(t.as_short_text())
 
3946
        finally:
 
3947
            b.unlock()
 
3948
 
 
3949
 
 
3950
class cmd_annotate(Command):
 
3951
    """Show the origin of each line in a file.
 
3952
 
 
3953
    This prints out the given file with an annotation on the left side
 
3954
    indicating which revision, author and date introduced the change.
 
3955
 
 
3956
    If the origin is the same for a run of consecutive lines, it is 
 
3957
    shown only at the top, unless the --all option is given.
 
3958
    """
 
3959
    # TODO: annotate directories; showing when each file was last changed
 
3960
    # TODO: if the working copy is modified, show annotations on that 
 
3961
    #       with new uncommitted lines marked
 
3962
    aliases = ['ann', 'blame', 'praise']
 
3963
    takes_args = ['filename']
 
3964
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3965
                     Option('long', help='Show commit date in annotations.'),
 
3966
                     'revision',
 
3967
                     'show-ids',
 
3968
                     ]
 
3969
    encoding_type = 'exact'
 
3970
 
 
3971
    @display_command
 
3972
    def run(self, filename, all=False, long=False, revision=None,
 
3973
            show_ids=False):
 
3974
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
3975
        wt, branch, relpath = \
 
3976
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3977
        if wt is not None:
 
3978
            wt.lock_read()
 
3979
        else:
 
3980
            branch.lock_read()
 
3981
        try:
 
3982
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
3983
            if wt is not None:
 
3984
                file_id = wt.path2id(relpath)
 
3985
            else:
 
3986
                file_id = tree.path2id(relpath)
 
3987
            if file_id is None:
 
3988
                raise errors.NotVersionedError(filename)
 
3989
            file_version = tree.inventory[file_id].revision
 
3990
            if wt is not None and revision is None:
 
3991
                # If there is a tree and we're not annotating historical
 
3992
                # versions, annotate the working tree's content.
 
3993
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
3994
                    show_ids=show_ids)
 
3995
            else:
 
3996
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3997
                              show_ids=show_ids)
 
3998
        finally:
 
3999
            if wt is not None:
 
4000
                wt.unlock()
 
4001
            else:
 
4002
                branch.unlock()
 
4003
 
 
4004
 
 
4005
class cmd_re_sign(Command):
 
4006
    """Create a digital signature for an existing revision."""
 
4007
    # TODO be able to replace existing ones.
 
4008
 
 
4009
    hidden = True # is this right ?
 
4010
    takes_args = ['revision_id*']
 
4011
    takes_options = ['revision']
 
4012
    
 
4013
    def run(self, revision_id_list=None, revision=None):
 
4014
        if revision_id_list is not None and revision is not None:
 
4015
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
4016
        if revision_id_list is None and revision is None:
 
4017
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
4018
        b = WorkingTree.open_containing(u'.')[0].branch
 
4019
        b.lock_write()
 
4020
        try:
 
4021
            return self._run(b, revision_id_list, revision)
 
4022
        finally:
 
4023
            b.unlock()
 
4024
 
 
4025
    def _run(self, b, revision_id_list, revision):
 
4026
        import bzrlib.gpg as gpg
 
4027
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
4028
        if revision_id_list is not None:
 
4029
            b.repository.start_write_group()
 
4030
            try:
 
4031
                for revision_id in revision_id_list:
 
4032
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
4033
            except:
 
4034
                b.repository.abort_write_group()
 
4035
                raise
 
4036
            else:
 
4037
                b.repository.commit_write_group()
 
4038
        elif revision is not None:
 
4039
            if len(revision) == 1:
 
4040
                revno, rev_id = revision[0].in_history(b)
 
4041
                b.repository.start_write_group()
 
4042
                try:
 
4043
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
4044
                except:
 
4045
                    b.repository.abort_write_group()
 
4046
                    raise
 
4047
                else:
 
4048
                    b.repository.commit_write_group()
 
4049
            elif len(revision) == 2:
 
4050
                # are they both on rh- if so we can walk between them
 
4051
                # might be nice to have a range helper for arbitrary
 
4052
                # revision paths. hmm.
 
4053
                from_revno, from_revid = revision[0].in_history(b)
 
4054
                to_revno, to_revid = revision[1].in_history(b)
 
4055
                if to_revid is None:
 
4056
                    to_revno = b.revno()
 
4057
                if from_revno is None or to_revno is None:
 
4058
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
4059
                b.repository.start_write_group()
 
4060
                try:
 
4061
                    for revno in range(from_revno, to_revno + 1):
 
4062
                        b.repository.sign_revision(b.get_rev_id(revno),
 
4063
                                                   gpg_strategy)
 
4064
                except:
 
4065
                    b.repository.abort_write_group()
 
4066
                    raise
 
4067
                else:
 
4068
                    b.repository.commit_write_group()
 
4069
            else:
 
4070
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
4071
 
 
4072
 
 
4073
class cmd_bind(Command):
 
4074
    """Convert the current branch into a checkout of the supplied branch.
 
4075
 
 
4076
    Once converted into a checkout, commits must succeed on the master branch
 
4077
    before they will be applied to the local branch.
 
4078
 
 
4079
    Bound branches use the nickname of its master branch unless it is set
 
4080
    locally, in which case binding will update the the local nickname to be
 
4081
    that of the master.
 
4082
    """
 
4083
 
 
4084
    _see_also = ['checkouts', 'unbind']
 
4085
    takes_args = ['location?']
 
4086
    takes_options = []
 
4087
 
 
4088
    def run(self, location=None):
 
4089
        b, relpath = Branch.open_containing(u'.')
 
4090
        if location is None:
 
4091
            try:
 
4092
                location = b.get_old_bound_location()
 
4093
            except errors.UpgradeRequired:
 
4094
                raise errors.BzrCommandError('No location supplied.  '
 
4095
                    'This format does not remember old locations.')
 
4096
            else:
 
4097
                if location is None:
 
4098
                    raise errors.BzrCommandError('No location supplied and no '
 
4099
                        'previous location known')
 
4100
        b_other = Branch.open(location)
 
4101
        try:
 
4102
            b.bind(b_other)
 
4103
        except errors.DivergedBranches:
 
4104
            raise errors.BzrCommandError('These branches have diverged.'
 
4105
                                         ' Try merging, and then bind again.')
 
4106
        if b.get_config().has_explicit_nickname():
 
4107
            b.nick = b_other.nick
 
4108
 
 
4109
 
 
4110
class cmd_unbind(Command):
 
4111
    """Convert the current checkout into a regular branch.
 
4112
 
 
4113
    After unbinding, the local branch is considered independent and subsequent
 
4114
    commits will be local only.
 
4115
    """
 
4116
 
 
4117
    _see_also = ['checkouts', 'bind']
 
4118
    takes_args = []
 
4119
    takes_options = []
 
4120
 
 
4121
    def run(self):
 
4122
        b, relpath = Branch.open_containing(u'.')
 
4123
        if not b.unbind():
 
4124
            raise errors.BzrCommandError('Local branch is not bound')
 
4125
 
 
4126
 
 
4127
class cmd_uncommit(Command):
 
4128
    """Remove the last committed revision.
 
4129
 
 
4130
    --verbose will print out what is being removed.
 
4131
    --dry-run will go through all the motions, but not actually
 
4132
    remove anything.
 
4133
 
 
4134
    If --revision is specified, uncommit revisions to leave the branch at the
 
4135
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
4136
    branch at revision 15.
 
4137
 
 
4138
    Uncommit leaves the working tree ready for a new commit.  The only change
 
4139
    it may make is to restore any pending merges that were present before
 
4140
    the commit.
 
4141
    """
 
4142
 
 
4143
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
4144
    # unreferenced information in 'branch-as-repository' branches.
 
4145
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
4146
    # information in shared branches as well.
 
4147
    _see_also = ['commit']
 
4148
    takes_options = ['verbose', 'revision',
 
4149
                    Option('dry-run', help='Don\'t actually make changes.'),
 
4150
                    Option('force', help='Say yes to all questions.'),
 
4151
                    Option('local',
 
4152
                           help="Only remove the commits from the local branch"
 
4153
                                " when in a checkout."
 
4154
                           ),
 
4155
                    ]
 
4156
    takes_args = ['location?']
 
4157
    aliases = []
 
4158
    encoding_type = 'replace'
 
4159
 
 
4160
    def run(self, location=None,
 
4161
            dry_run=False, verbose=False,
 
4162
            revision=None, force=False, local=False):
 
4163
        if location is None:
 
4164
            location = u'.'
 
4165
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4166
        try:
 
4167
            tree = control.open_workingtree()
 
4168
            b = tree.branch
 
4169
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
4170
            tree = None
 
4171
            b = control.open_branch()
 
4172
 
 
4173
        if tree is not None:
 
4174
            tree.lock_write()
 
4175
        else:
 
4176
            b.lock_write()
 
4177
        try:
 
4178
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4179
                             local=local)
 
4180
        finally:
 
4181
            if tree is not None:
 
4182
                tree.unlock()
 
4183
            else:
 
4184
                b.unlock()
 
4185
 
 
4186
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
4187
        from bzrlib.log import log_formatter, show_log
 
4188
        from bzrlib.uncommit import uncommit
 
4189
 
 
4190
        last_revno, last_rev_id = b.last_revision_info()
 
4191
 
 
4192
        rev_id = None
 
4193
        if revision is None:
 
4194
            revno = last_revno
 
4195
            rev_id = last_rev_id
 
4196
        else:
 
4197
            # 'bzr uncommit -r 10' actually means uncommit
 
4198
            # so that the final tree is at revno 10.
 
4199
            # but bzrlib.uncommit.uncommit() actually uncommits
 
4200
            # the revisions that are supplied.
 
4201
            # So we need to offset it by one
 
4202
            revno = revision[0].in_history(b).revno + 1
 
4203
            if revno <= last_revno:
 
4204
                rev_id = b.get_rev_id(revno)
 
4205
 
 
4206
        if rev_id is None or _mod_revision.is_null(rev_id):
 
4207
            self.outf.write('No revisions to uncommit.\n')
 
4208
            return 1
 
4209
 
 
4210
        lf = log_formatter('short',
 
4211
                           to_file=self.outf,
 
4212
                           show_timezone='original')
 
4213
 
 
4214
        show_log(b,
 
4215
                 lf,
 
4216
                 verbose=False,
 
4217
                 direction='forward',
 
4218
                 start_revision=revno,
 
4219
                 end_revision=last_revno)
 
4220
 
 
4221
        if dry_run:
 
4222
            print 'Dry-run, pretending to remove the above revisions.'
 
4223
            if not force:
 
4224
                val = raw_input('Press <enter> to continue')
 
4225
        else:
 
4226
            print 'The above revision(s) will be removed.'
 
4227
            if not force:
 
4228
                val = raw_input('Are you sure [y/N]? ')
 
4229
                if val.lower() not in ('y', 'yes'):
 
4230
                    print 'Canceled'
 
4231
                    return 0
 
4232
 
 
4233
        mutter('Uncommitting from {%s} to {%s}',
 
4234
               last_rev_id, rev_id)
 
4235
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
4236
                 revno=revno, local=local)
 
4237
        note('You can restore the old tip by running:\n'
 
4238
             '  bzr pull . -r revid:%s', last_rev_id)
 
4239
 
 
4240
 
 
4241
class cmd_break_lock(Command):
 
4242
    """Break a dead lock on a repository, branch or working directory.
 
4243
 
 
4244
    CAUTION: Locks should only be broken when you are sure that the process
 
4245
    holding the lock has been stopped.
 
4246
 
 
4247
    You can get information on what locks are open via the 'bzr info' command.
 
4248
    
 
4249
    :Examples:
 
4250
        bzr break-lock
 
4251
    """
 
4252
    takes_args = ['location?']
 
4253
 
 
4254
    def run(self, location=None, show=False):
 
4255
        if location is None:
 
4256
            location = u'.'
 
4257
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4258
        try:
 
4259
            control.break_lock()
 
4260
        except NotImplementedError:
 
4261
            pass
 
4262
        
 
4263
 
 
4264
class cmd_wait_until_signalled(Command):
 
4265
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4266
 
 
4267
    This just prints a line to signal when it is ready, then blocks on stdin.
 
4268
    """
 
4269
 
 
4270
    hidden = True
 
4271
 
 
4272
    def run(self):
 
4273
        sys.stdout.write("running\n")
 
4274
        sys.stdout.flush()
 
4275
        sys.stdin.readline()
 
4276
 
 
4277
 
 
4278
class cmd_serve(Command):
 
4279
    """Run the bzr server."""
 
4280
 
 
4281
    aliases = ['server']
 
4282
 
 
4283
    takes_options = [
 
4284
        Option('inet',
 
4285
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4286
        Option('port',
 
4287
               help='Listen for connections on nominated port of the form '
 
4288
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
4289
                    'result in a dynamically allocated port.  The default port is '
 
4290
                    '4155.',
 
4291
               type=str),
 
4292
        Option('directory',
 
4293
               help='Serve contents of this directory.',
 
4294
               type=unicode),
 
4295
        Option('allow-writes',
 
4296
               help='By default the server is a readonly server.  Supplying '
 
4297
                    '--allow-writes enables write access to the contents of '
 
4298
                    'the served directory and below.'
 
4299
                ),
 
4300
        ]
 
4301
 
 
4302
    def run_smart_server(self, smart_server):
 
4303
        """Run 'smart_server' forever, with no UI output at all."""
 
4304
        # For the duration of this server, no UI output is permitted. note
 
4305
        # that this may cause problems with blackbox tests. This should be
 
4306
        # changed with care though, as we dont want to use bandwidth sending
 
4307
        # progress over stderr to smart server clients!
 
4308
        from bzrlib import lockdir
 
4309
        old_factory = ui.ui_factory
 
4310
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4311
        try:
 
4312
            ui.ui_factory = ui.SilentUIFactory()
 
4313
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4314
            smart_server.serve()
 
4315
        finally:
 
4316
            ui.ui_factory = old_factory
 
4317
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4318
 
 
4319
    def get_host_and_port(self, port):
 
4320
        """Return the host and port to run the smart server on.
 
4321
 
 
4322
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4323
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4324
 
 
4325
        If 'port' has a colon in it, the string before the colon will be
 
4326
        interpreted as the host.
 
4327
 
 
4328
        :param port: A string of the port to run the server on.
 
4329
        :return: A tuple of (host, port), where 'host' is a host name or IP,
 
4330
            and port is an integer TCP/IP port.
 
4331
        """
 
4332
        from bzrlib.smart import medium
 
4333
        host = medium.BZR_DEFAULT_INTERFACE
 
4334
        if port is None:
 
4335
            port = medium.BZR_DEFAULT_PORT
 
4336
        else:
 
4337
            if ':' in port:
 
4338
                host, port = port.split(':')
 
4339
            port = int(port)
 
4340
        return host, port
 
4341
 
 
4342
    def get_smart_server(self, transport, inet, port):
 
4343
        """Construct a smart server.
 
4344
 
 
4345
        :param transport: The base transport from which branches will be
 
4346
            served.
 
4347
        :param inet: If True, serve over stdin and stdout. Used for running
 
4348
            from inet.
 
4349
        :param port: The port to listen on. By default, it's `
 
4350
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4351
            information.
 
4352
        :return: A smart server.
 
4353
        """
 
4354
        from bzrlib.smart import medium, server
 
4355
        if inet:
 
4356
            smart_server = medium.SmartServerPipeStreamMedium(
 
4357
                sys.stdin, sys.stdout, transport)
 
4358
        else:
 
4359
            host, port = self.get_host_and_port(port)
 
4360
            smart_server = server.SmartTCPServer(
 
4361
                transport, host=host, port=port)
 
4362
            note('listening on port: %s' % smart_server.port)
 
4363
        return smart_server
 
4364
 
 
4365
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4366
        from bzrlib.transport import get_transport
 
4367
        from bzrlib.transport.chroot import ChrootServer
 
4368
        if directory is None:
 
4369
            directory = os.getcwd()
 
4370
        url = urlutils.local_path_to_url(directory)
 
4371
        if not allow_writes:
 
4372
            url = 'readonly+' + url
 
4373
        chroot_server = ChrootServer(get_transport(url))
 
4374
        chroot_server.setUp()
 
4375
        t = get_transport(chroot_server.get_url())
 
4376
        smart_server = self.get_smart_server(t, inet, port)
 
4377
        self.run_smart_server(smart_server)
 
4378
 
 
4379
 
 
4380
class cmd_join(Command):
 
4381
    """Combine a subtree into its containing tree.
 
4382
    
 
4383
    This command is for experimental use only.  It requires the target tree
 
4384
    to be in dirstate-with-subtree format, which cannot be converted into
 
4385
    earlier formats.
 
4386
 
 
4387
    The TREE argument should be an independent tree, inside another tree, but
 
4388
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
4389
    running "bzr branch" with the target inside a tree.)
 
4390
 
 
4391
    The result is a combined tree, with the subtree no longer an independant
 
4392
    part.  This is marked as a merge of the subtree into the containing tree,
 
4393
    and all history is preserved.
 
4394
 
 
4395
    If --reference is specified, the subtree retains its independence.  It can
 
4396
    be branched by itself, and can be part of multiple projects at the same
 
4397
    time.  But operations performed in the containing tree, such as commit
 
4398
    and merge, will recurse into the subtree.
 
4399
    """
 
4400
 
 
4401
    _see_also = ['split']
 
4402
    takes_args = ['tree']
 
4403
    takes_options = [
 
4404
            Option('reference', help='Join by reference.'),
 
4405
            ]
 
4406
    hidden = True
 
4407
 
 
4408
    def run(self, tree, reference=False):
 
4409
        sub_tree = WorkingTree.open(tree)
 
4410
        parent_dir = osutils.dirname(sub_tree.basedir)
 
4411
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
4412
        repo = containing_tree.branch.repository
 
4413
        if not repo.supports_rich_root():
 
4414
            raise errors.BzrCommandError(
 
4415
                "Can't join trees because %s doesn't support rich root data.\n"
 
4416
                "You can use bzr upgrade on the repository."
 
4417
                % (repo,))
 
4418
        if reference:
 
4419
            try:
 
4420
                containing_tree.add_reference(sub_tree)
 
4421
            except errors.BadReferenceTarget, e:
 
4422
                # XXX: Would be better to just raise a nicely printable
 
4423
                # exception from the real origin.  Also below.  mbp 20070306
 
4424
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4425
                                             (tree, e.reason))
 
4426
        else:
 
4427
            try:
 
4428
                containing_tree.subsume(sub_tree)
 
4429
            except errors.BadSubsumeSource, e:
 
4430
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
4431
                                             (tree, e.reason))
 
4432
 
 
4433
 
 
4434
class cmd_split(Command):
 
4435
    """Split a subdirectory of a tree into a separate tree.
 
4436
 
 
4437
    This command will produce a target tree in a format that supports
 
4438
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
4439
    converted into earlier formats like 'dirstate-tags'.
 
4440
 
 
4441
    The TREE argument should be a subdirectory of a working tree.  That
 
4442
    subdirectory will be converted into an independent tree, with its own
 
4443
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
4444
    """
 
4445
 
 
4446
    # join is not un-hidden yet
 
4447
    #_see_also = ['join']
 
4448
    takes_args = ['tree']
 
4449
 
 
4450
    def run(self, tree):
 
4451
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
4452
        sub_id = containing_tree.path2id(subdir)
 
4453
        if sub_id is None:
 
4454
            raise errors.NotVersionedError(subdir)
 
4455
        try:
 
4456
            containing_tree.extract(sub_id)
 
4457
        except errors.RootNotRich:
 
4458
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
4459
 
 
4460
 
 
4461
class cmd_merge_directive(Command):
 
4462
    """Generate a merge directive for auto-merge tools.
 
4463
 
 
4464
    A directive requests a merge to be performed, and also provides all the
 
4465
    information necessary to do so.  This means it must either include a
 
4466
    revision bundle, or the location of a branch containing the desired
 
4467
    revision.
 
4468
 
 
4469
    A submit branch (the location to merge into) must be supplied the first
 
4470
    time the command is issued.  After it has been supplied once, it will
 
4471
    be remembered as the default.
 
4472
 
 
4473
    A public branch is optional if a revision bundle is supplied, but required
 
4474
    if --diff or --plain is specified.  It will be remembered as the default
 
4475
    after the first use.
 
4476
    """
 
4477
 
 
4478
    takes_args = ['submit_branch?', 'public_branch?']
 
4479
 
 
4480
    hidden = True
 
4481
 
 
4482
    _see_also = ['send']
 
4483
 
 
4484
    takes_options = [
 
4485
        RegistryOption.from_kwargs('patch-type',
 
4486
            'The type of patch to include in the directive.',
 
4487
            title='Patch type',
 
4488
            value_switches=True,
 
4489
            enum_switch=False,
 
4490
            bundle='Bazaar revision bundle (default).',
 
4491
            diff='Normal unified diff.',
 
4492
            plain='No patch, just directive.'),
 
4493
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
4494
        Option('mail-to', type=str,
 
4495
            help='Instead of printing the directive, email to this address.'),
 
4496
        Option('message', type=str, short_name='m',
 
4497
            help='Message to use when committing this merge.')
 
4498
        ]
 
4499
 
 
4500
    encoding_type = 'exact'
 
4501
 
 
4502
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4503
            sign=False, revision=None, mail_to=None, message=None):
 
4504
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4505
        include_patch, include_bundle = {
 
4506
            'plain': (False, False),
 
4507
            'diff': (True, False),
 
4508
            'bundle': (True, True),
 
4509
            }[patch_type]
 
4510
        branch = Branch.open('.')
 
4511
        stored_submit_branch = branch.get_submit_branch()
 
4512
        if submit_branch is None:
 
4513
            submit_branch = stored_submit_branch
 
4514
        else:
 
4515
            if stored_submit_branch is None:
 
4516
                branch.set_submit_branch(submit_branch)
 
4517
        if submit_branch is None:
 
4518
            submit_branch = branch.get_parent()
 
4519
        if submit_branch is None:
 
4520
            raise errors.BzrCommandError('No submit branch specified or known')
 
4521
 
 
4522
        stored_public_branch = branch.get_public_branch()
 
4523
        if public_branch is None:
 
4524
            public_branch = stored_public_branch
 
4525
        elif stored_public_branch is None:
 
4526
            branch.set_public_branch(public_branch)
 
4527
        if not include_bundle and public_branch is None:
 
4528
            raise errors.BzrCommandError('No public branch specified or'
 
4529
                                         ' known')
 
4530
        base_revision_id = None
 
4531
        if revision is not None:
 
4532
            if len(revision) > 2:
 
4533
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4534
                    'at most two one revision identifiers')
 
4535
            revision_id = revision[-1].as_revision_id(branch)
 
4536
            if len(revision) == 2:
 
4537
                base_revision_id = revision[0].as_revision_id(branch)
 
4538
        else:
 
4539
            revision_id = branch.last_revision()
 
4540
        revision_id = ensure_null(revision_id)
 
4541
        if revision_id == NULL_REVISION:
 
4542
            raise errors.BzrCommandError('No revisions to bundle.')
 
4543
        directive = merge_directive.MergeDirective2.from_objects(
 
4544
            branch.repository, revision_id, time.time(),
 
4545
            osutils.local_time_offset(), submit_branch,
 
4546
            public_branch=public_branch, include_patch=include_patch,
 
4547
            include_bundle=include_bundle, message=message,
 
4548
            base_revision_id=base_revision_id)
 
4549
        if mail_to is None:
 
4550
            if sign:
 
4551
                self.outf.write(directive.to_signed(branch))
 
4552
            else:
 
4553
                self.outf.writelines(directive.to_lines())
 
4554
        else:
 
4555
            message = directive.to_email(mail_to, branch, sign)
 
4556
            s = SMTPConnection(branch.get_config())
 
4557
            s.send_email(message)
 
4558
 
 
4559
 
 
4560
class cmd_send(Command):
 
4561
    """Mail or create a merge-directive for submitting changes.
 
4562
 
 
4563
    A merge directive provides many things needed for requesting merges:
 
4564
 
 
4565
    * A machine-readable description of the merge to perform
 
4566
 
 
4567
    * An optional patch that is a preview of the changes requested
 
4568
 
 
4569
    * An optional bundle of revision data, so that the changes can be applied
 
4570
      directly from the merge directive, without retrieving data from a
 
4571
      branch.
 
4572
 
 
4573
    If --no-bundle is specified, then public_branch is needed (and must be
 
4574
    up-to-date), so that the receiver can perform the merge using the
 
4575
    public_branch.  The public_branch is always included if known, so that
 
4576
    people can check it later.
 
4577
 
 
4578
    The submit branch defaults to the parent, but can be overridden.  Both
 
4579
    submit branch and public branch will be remembered if supplied.
 
4580
 
 
4581
    If a public_branch is known for the submit_branch, that public submit
 
4582
    branch is used in the merge instructions.  This means that a local mirror
 
4583
    can be used as your actual submit branch, once you have set public_branch
 
4584
    for that mirror.
 
4585
 
 
4586
    Mail is sent using your preferred mail program.  This should be transparent
 
4587
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4588
    If the preferred client can't be found (or used), your editor will be used.
 
4589
    
 
4590
    To use a specific mail program, set the mail_client configuration option.
 
4591
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4592
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4593
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4594
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
4595
 
 
4596
    If mail is being sent, a to address is required.  This can be supplied
 
4597
    either on the commandline, by setting the submit_to configuration
 
4598
    option in the branch itself or the child_submit_to configuration option 
 
4599
    in the submit branch.
 
4600
 
 
4601
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4602
    merge directive format 2.  It is significantly faster and smaller than
 
4603
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4604
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4605
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4606
    
 
4607
    Merge directives are applied using the merge command or the pull command.
 
4608
    """
 
4609
 
 
4610
    encoding_type = 'exact'
 
4611
 
 
4612
    _see_also = ['merge', 'pull']
 
4613
 
 
4614
    takes_args = ['submit_branch?', 'public_branch?']
 
4615
 
 
4616
    takes_options = [
 
4617
        Option('no-bundle',
 
4618
               help='Do not include a bundle in the merge directive.'),
 
4619
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4620
               ' directive.'),
 
4621
        Option('remember',
 
4622
               help='Remember submit and public branch.'),
 
4623
        Option('from',
 
4624
               help='Branch to generate the submission from, '
 
4625
               'rather than the one containing the working directory.',
 
4626
               short_name='f',
 
4627
               type=unicode),
 
4628
        Option('output', short_name='o',
 
4629
               help='Write merge directive to this file; '
 
4630
                    'use - for stdout.',
 
4631
               type=unicode),
 
4632
        Option('mail-to', help='Mail the request to this address.',
 
4633
               type=unicode),
 
4634
        'revision',
 
4635
        'message',
 
4636
        RegistryOption.from_kwargs('format',
 
4637
        'Use the specified output format.',
 
4638
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4639
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4640
        ]
 
4641
 
 
4642
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4643
            no_patch=False, revision=None, remember=False, output=None,
 
4644
            format='4', mail_to=None, message=None, **kwargs):
 
4645
        return self._run(submit_branch, revision, public_branch, remember,
 
4646
                         format, no_bundle, no_patch, output,
 
4647
                         kwargs.get('from', '.'), mail_to, message)
 
4648
 
 
4649
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4650
             no_bundle, no_patch, output, from_, mail_to, message):
 
4651
        from bzrlib.revision import NULL_REVISION
 
4652
        branch = Branch.open_containing(from_)[0]
 
4653
        if output is None:
 
4654
            outfile = cStringIO.StringIO()
 
4655
        elif output == '-':
 
4656
            outfile = self.outf
 
4657
        else:
 
4658
            outfile = open(output, 'wb')
 
4659
        # we may need to write data into branch's repository to calculate
 
4660
        # the data to send.
 
4661
        branch.lock_write()
 
4662
        try:
 
4663
            if output is None:
 
4664
                config = branch.get_config()
 
4665
                if mail_to is None:
 
4666
                    mail_to = config.get_user_option('submit_to')
 
4667
                mail_client = config.get_mail_client()
 
4668
            if remember and submit_branch is None:
 
4669
                raise errors.BzrCommandError(
 
4670
                    '--remember requires a branch to be specified.')
 
4671
            stored_submit_branch = branch.get_submit_branch()
 
4672
            remembered_submit_branch = None
 
4673
            if submit_branch is None:
 
4674
                submit_branch = stored_submit_branch
 
4675
                remembered_submit_branch = "submit"
 
4676
            else:
 
4677
                if stored_submit_branch is None or remember:
 
4678
                    branch.set_submit_branch(submit_branch)
 
4679
            if submit_branch is None:
 
4680
                submit_branch = branch.get_parent()
 
4681
                remembered_submit_branch = "parent"
 
4682
            if submit_branch is None:
 
4683
                raise errors.BzrCommandError('No submit branch known or'
 
4684
                                             ' specified')
 
4685
            if remembered_submit_branch is not None:
 
4686
                note('Using saved %s location "%s" to determine what '
 
4687
                        'changes to submit.', remembered_submit_branch,
 
4688
                        submit_branch)
 
4689
 
 
4690
            if mail_to is None:
 
4691
                submit_config = Branch.open(submit_branch).get_config()
 
4692
                mail_to = submit_config.get_user_option("child_submit_to")
 
4693
 
 
4694
            stored_public_branch = branch.get_public_branch()
 
4695
            if public_branch is None:
 
4696
                public_branch = stored_public_branch
 
4697
            elif stored_public_branch is None or remember:
 
4698
                branch.set_public_branch(public_branch)
 
4699
            if no_bundle and public_branch is None:
 
4700
                raise errors.BzrCommandError('No public branch specified or'
 
4701
                                             ' known')
 
4702
            base_revision_id = None
 
4703
            revision_id = None
 
4704
            if revision is not None:
 
4705
                if len(revision) > 2:
 
4706
                    raise errors.BzrCommandError('bzr send takes '
 
4707
                        'at most two one revision identifiers')
 
4708
                revision_id = revision[-1].as_revision_id(branch)
 
4709
                if len(revision) == 2:
 
4710
                    base_revision_id = revision[0].as_revision_id(branch)
 
4711
            if revision_id is None:
 
4712
                revision_id = branch.last_revision()
 
4713
            if revision_id == NULL_REVISION:
 
4714
                raise errors.BzrCommandError('No revisions to submit.')
 
4715
            if format == '4':
 
4716
                directive = merge_directive.MergeDirective2.from_objects(
 
4717
                    branch.repository, revision_id, time.time(),
 
4718
                    osutils.local_time_offset(), submit_branch,
 
4719
                    public_branch=public_branch, include_patch=not no_patch,
 
4720
                    include_bundle=not no_bundle, message=message,
 
4721
                    base_revision_id=base_revision_id)
 
4722
            elif format == '0.9':
 
4723
                if not no_bundle:
 
4724
                    if not no_patch:
 
4725
                        patch_type = 'bundle'
 
4726
                    else:
 
4727
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4728
                            ' permit bundle with no patch')
 
4729
                else:
 
4730
                    if not no_patch:
 
4731
                        patch_type = 'diff'
 
4732
                    else:
 
4733
                        patch_type = None
 
4734
                directive = merge_directive.MergeDirective.from_objects(
 
4735
                    branch.repository, revision_id, time.time(),
 
4736
                    osutils.local_time_offset(), submit_branch,
 
4737
                    public_branch=public_branch, patch_type=patch_type,
 
4738
                    message=message)
 
4739
 
 
4740
            outfile.writelines(directive.to_lines())
 
4741
            if output is None:
 
4742
                subject = '[MERGE] '
 
4743
                if message is not None:
 
4744
                    subject += message
 
4745
                else:
 
4746
                    revision = branch.repository.get_revision(revision_id)
 
4747
                    subject += revision.get_summary()
 
4748
                basename = directive.get_disk_name(branch)
 
4749
                mail_client.compose_merge_request(mail_to, subject,
 
4750
                                                  outfile.getvalue(), basename)
 
4751
        finally:
 
4752
            if output != '-':
 
4753
                outfile.close()
 
4754
            branch.unlock()
 
4755
 
 
4756
 
 
4757
class cmd_bundle_revisions(cmd_send):
 
4758
 
 
4759
    """Create a merge-directive for submitting changes.
 
4760
 
 
4761
    A merge directive provides many things needed for requesting merges:
 
4762
 
 
4763
    * A machine-readable description of the merge to perform
 
4764
 
 
4765
    * An optional patch that is a preview of the changes requested
 
4766
 
 
4767
    * An optional bundle of revision data, so that the changes can be applied
 
4768
      directly from the merge directive, without retrieving data from a
 
4769
      branch.
 
4770
 
 
4771
    If --no-bundle is specified, then public_branch is needed (and must be
 
4772
    up-to-date), so that the receiver can perform the merge using the
 
4773
    public_branch.  The public_branch is always included if known, so that
 
4774
    people can check it later.
 
4775
 
 
4776
    The submit branch defaults to the parent, but can be overridden.  Both
 
4777
    submit branch and public branch will be remembered if supplied.
 
4778
 
 
4779
    If a public_branch is known for the submit_branch, that public submit
 
4780
    branch is used in the merge instructions.  This means that a local mirror
 
4781
    can be used as your actual submit branch, once you have set public_branch
 
4782
    for that mirror.
 
4783
 
 
4784
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4785
    merge directive format 2.  It is significantly faster and smaller than
 
4786
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4787
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4788
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4789
    """
 
4790
 
 
4791
    takes_options = [
 
4792
        Option('no-bundle',
 
4793
               help='Do not include a bundle in the merge directive.'),
 
4794
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4795
               ' directive.'),
 
4796
        Option('remember',
 
4797
               help='Remember submit and public branch.'),
 
4798
        Option('from',
 
4799
               help='Branch to generate the submission from, '
 
4800
               'rather than the one containing the working directory.',
 
4801
               short_name='f',
 
4802
               type=unicode),
 
4803
        Option('output', short_name='o', help='Write directive to this file.',
 
4804
               type=unicode),
 
4805
        'revision',
 
4806
        RegistryOption.from_kwargs('format',
 
4807
        'Use the specified output format.',
 
4808
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4809
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4810
        ]
 
4811
    aliases = ['bundle']
 
4812
 
 
4813
    _see_also = ['send', 'merge']
 
4814
 
 
4815
    hidden = True
 
4816
 
 
4817
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4818
            no_patch=False, revision=None, remember=False, output=None,
 
4819
            format='4', **kwargs):
 
4820
        if output is None:
 
4821
            output = '-'
 
4822
        return self._run(submit_branch, revision, public_branch, remember,
 
4823
                         format, no_bundle, no_patch, output,
 
4824
                         kwargs.get('from', '.'), None, None)
 
4825
 
 
4826
 
 
4827
class cmd_tag(Command):
 
4828
    """Create, remove or modify a tag naming a revision.
 
4829
    
 
4830
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4831
    (--revision) option can be given -rtag:X, where X is any previously
 
4832
    created tag.
 
4833
 
 
4834
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4835
    along when you branch, push, pull or merge.
 
4836
 
 
4837
    It is an error to give a tag name that already exists unless you pass 
 
4838
    --force, in which case the tag is moved to point to the new revision.
 
4839
 
 
4840
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
4841
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
4842
    """
 
4843
 
 
4844
    _see_also = ['commit', 'tags']
 
4845
    takes_args = ['tag_name']
 
4846
    takes_options = [
 
4847
        Option('delete',
 
4848
            help='Delete this tag rather than placing it.',
 
4849
            ),
 
4850
        Option('directory',
 
4851
            help='Branch in which to place the tag.',
 
4852
            short_name='d',
 
4853
            type=unicode,
 
4854
            ),
 
4855
        Option('force',
 
4856
            help='Replace existing tags.',
 
4857
            ),
 
4858
        'revision',
 
4859
        ]
 
4860
 
 
4861
    def run(self, tag_name,
 
4862
            delete=None,
 
4863
            directory='.',
 
4864
            force=None,
 
4865
            revision=None,
 
4866
            ):
 
4867
        branch, relpath = Branch.open_containing(directory)
 
4868
        branch.lock_write()
 
4869
        try:
 
4870
            if delete:
 
4871
                branch.tags.delete_tag(tag_name)
 
4872
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4873
            else:
 
4874
                if revision:
 
4875
                    if len(revision) != 1:
 
4876
                        raise errors.BzrCommandError(
 
4877
                            "Tags can only be placed on a single revision, "
 
4878
                            "not on a range")
 
4879
                    revision_id = revision[0].as_revision_id(branch)
 
4880
                else:
 
4881
                    revision_id = branch.last_revision()
 
4882
                if (not force) and branch.tags.has_tag(tag_name):
 
4883
                    raise errors.TagAlreadyExists(tag_name)
 
4884
                branch.tags.set_tag(tag_name, revision_id)
 
4885
                self.outf.write('Created tag %s.\n' % tag_name)
 
4886
        finally:
 
4887
            branch.unlock()
 
4888
 
 
4889
 
 
4890
class cmd_tags(Command):
 
4891
    """List tags.
 
4892
 
 
4893
    This command shows a table of tag names and the revisions they reference.
 
4894
    """
 
4895
 
 
4896
    _see_also = ['tag']
 
4897
    takes_options = [
 
4898
        Option('directory',
 
4899
            help='Branch whose tags should be displayed.',
 
4900
            short_name='d',
 
4901
            type=unicode,
 
4902
            ),
 
4903
        RegistryOption.from_kwargs('sort',
 
4904
            'Sort tags by different criteria.', title='Sorting',
 
4905
            alpha='Sort tags lexicographically (default).',
 
4906
            time='Sort tags chronologically.',
 
4907
            ),
 
4908
        'show-ids',
 
4909
        'revision',
 
4910
    ]
 
4911
 
 
4912
    @display_command
 
4913
    def run(self,
 
4914
            directory='.',
 
4915
            sort='alpha',
 
4916
            show_ids=False,
 
4917
            revision=None,
 
4918
            ):
 
4919
        branch, relpath = Branch.open_containing(directory)
 
4920
 
 
4921
        tags = branch.tags.get_tag_dict().items()
 
4922
        if not tags:
 
4923
            return
 
4924
 
 
4925
        if revision:
 
4926
            branch.lock_read()
 
4927
            try:
 
4928
                graph = branch.repository.get_graph()
 
4929
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
4930
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
4931
                # only show revisions between revid1 and revid2 (inclusive)
 
4932
                tags = [(tag, revid) for tag, revid in tags if
 
4933
                    graph.is_between(revid, revid1, revid2)]
 
4934
            finally:
 
4935
                branch.unlock()
 
4936
        if sort == 'alpha':
 
4937
            tags.sort()
 
4938
        elif sort == 'time':
 
4939
            timestamps = {}
 
4940
            for tag, revid in tags:
 
4941
                try:
 
4942
                    revobj = branch.repository.get_revision(revid)
 
4943
                except errors.NoSuchRevision:
 
4944
                    timestamp = sys.maxint # place them at the end
 
4945
                else:
 
4946
                    timestamp = revobj.timestamp
 
4947
                timestamps[revid] = timestamp
 
4948
            tags.sort(key=lambda x: timestamps[x[1]])
 
4949
        if not show_ids:
 
4950
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
4951
            revno_map = branch.get_revision_id_to_revno_map()
 
4952
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4953
                        for tag, revid in tags ]
 
4954
        for tag, revspec in tags:
 
4955
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
4956
 
 
4957
 
 
4958
class cmd_reconfigure(Command):
 
4959
    """Reconfigure the type of a bzr directory.
 
4960
 
 
4961
    A target configuration must be specified.
 
4962
 
 
4963
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4964
    The order of preference is
 
4965
    1. For a lightweight checkout, the current bound location.
 
4966
    2. For branches that used to be checkouts, the previously-bound location.
 
4967
    3. The push location.
 
4968
    4. The parent location.
 
4969
    If none of these is available, --bind-to must be specified.
 
4970
    """
 
4971
 
 
4972
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
4973
    takes_args = ['location?']
 
4974
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4975
                     title='Target type',
 
4976
                     help='The type to reconfigure the directory to.',
 
4977
                     value_switches=True, enum_switch=False,
 
4978
                     branch='Reconfigure to be an unbound branch '
 
4979
                        'with no working tree.',
 
4980
                     tree='Reconfigure to be an unbound branch '
 
4981
                        'with a working tree.',
 
4982
                     checkout='Reconfigure to be a bound branch '
 
4983
                        'with a working tree.',
 
4984
                     lightweight_checkout='Reconfigure to be a lightweight'
 
4985
                     ' checkout (with no local history).',
 
4986
                     standalone='Reconfigure to be a standalone branch '
 
4987
                        '(i.e. stop using shared repository).',
 
4988
                     use_shared='Reconfigure to use a shared repository.'),
 
4989
                     Option('bind-to', help='Branch to bind checkout to.',
 
4990
                            type=str),
 
4991
                     Option('force',
 
4992
                        help='Perform reconfiguration even if local changes'
 
4993
                        ' will be lost.')
 
4994
                     ]
 
4995
 
 
4996
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4997
        directory = bzrdir.BzrDir.open(location)
 
4998
        if target_type is None:
 
4999
            raise errors.BzrCommandError('No target configuration specified')
 
5000
        elif target_type == 'branch':
 
5001
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
5002
        elif target_type == 'tree':
 
5003
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
5004
        elif target_type == 'checkout':
 
5005
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
5006
                                                                  bind_to)
 
5007
        elif target_type == 'lightweight-checkout':
 
5008
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
5009
                directory, bind_to)
 
5010
        elif target_type == 'use-shared':
 
5011
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
5012
        elif target_type == 'standalone':
 
5013
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
5014
        reconfiguration.apply(force)
 
5015
 
 
5016
 
 
5017
class cmd_switch(Command):
 
5018
    """Set the branch of a checkout and update.
 
5019
    
 
5020
    For lightweight checkouts, this changes the branch being referenced.
 
5021
    For heavyweight checkouts, this checks that there are no local commits
 
5022
    versus the current bound branch, then it makes the local branch a mirror
 
5023
    of the new location and binds to it.
 
5024
 
 
5025
    In both cases, the working tree is updated and uncommitted changes
 
5026
    are merged. The user can commit or revert these as they desire.
 
5027
 
 
5028
    Pending merges need to be committed or reverted before using switch.
 
5029
 
 
5030
    The path to the branch to switch to can be specified relative to the parent
 
5031
    directory of the current branch. For example, if you are currently in a
 
5032
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
5033
    /path/to/newbranch.
 
5034
 
 
5035
    Bound branches use the nickname of its master branch unless it is set
 
5036
    locally, in which case switching will update the the local nickname to be
 
5037
    that of the master.
 
5038
    """
 
5039
 
 
5040
    takes_args = ['to_location']
 
5041
    takes_options = [Option('force',
 
5042
                        help='Switch even if local commits will be lost.')
 
5043
                     ]
 
5044
 
 
5045
    def run(self, to_location, force=False):
 
5046
        from bzrlib import switch
 
5047
        tree_location = '.'
 
5048
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5049
        branch = control_dir.open_branch()
 
5050
        try:
 
5051
            to_branch = Branch.open(to_location)
 
5052
        except errors.NotBranchError:
 
5053
            this_branch = control_dir.open_branch()
 
5054
            # This may be a heavy checkout, where we want the master branch
 
5055
            this_url = this_branch.get_bound_location()
 
5056
            # If not, use a local sibling
 
5057
            if this_url is None:
 
5058
                this_url = this_branch.base
 
5059
            to_branch = Branch.open(
 
5060
                urlutils.join(this_url, '..', to_location))
 
5061
        switch.switch(control_dir, to_branch, force)
 
5062
        if branch.get_config().has_explicit_nickname():
 
5063
            branch = control_dir.open_branch() #get the new branch!
 
5064
            branch.nick = to_branch.nick
 
5065
        note('Switched to branch: %s',
 
5066
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
5067
 
 
5068
 
 
5069
class cmd_hooks(Command):
 
5070
    """Show a branch's currently registered hooks.
 
5071
    """
 
5072
 
 
5073
    hidden = True
 
5074
    takes_args = ['path?']
 
5075
 
 
5076
    def run(self, path=None):
 
5077
        if path is None:
 
5078
            path = '.'
 
5079
        branch_hooks = Branch.open(path).hooks
 
5080
        for hook_type in branch_hooks:
 
5081
            hooks = branch_hooks[hook_type]
 
5082
            self.outf.write("%s:\n" % (hook_type,))
 
5083
            if hooks:
 
5084
                for hook in hooks:
 
5085
                    self.outf.write("  %s\n" %
 
5086
                                    (branch_hooks.get_hook_name(hook),))
 
5087
            else:
 
5088
                self.outf.write("  <no hooks installed>\n")
 
5089
 
 
5090
 
 
5091
class cmd_shelve(Command):
 
5092
    """Temporarily set aside some changes from the current tree.
 
5093
 
 
5094
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
5095
    ie. out of the way, until a later time when you can bring them back from
 
5096
    the shelf with the 'unshelve' command.
 
5097
 
 
5098
    If shelve --list is specified, previously-shelved changes are listed.
 
5099
 
 
5100
    Shelve is intended to help separate several sets of changes that have
 
5101
    been inappropriately mingled.  If you just want to get rid of all changes
 
5102
    and you don't need to restore them later, use revert.  If you want to
 
5103
    shelve all text changes at once, use shelve --all.
 
5104
 
 
5105
    If filenames are specified, only the changes to those files will be
 
5106
    shelved. Other files will be left untouched.
 
5107
 
 
5108
    If a revision is specified, changes since that revision will be shelved.
 
5109
 
 
5110
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
5111
    restore the most recently shelved changes.
 
5112
    """
 
5113
 
 
5114
    takes_args = ['file*']
 
5115
 
 
5116
    takes_options = [
 
5117
        'revision',
 
5118
        Option('all', help='Shelve all changes.'),
 
5119
        'message',
 
5120
        RegistryOption('writer', 'Method to use for writing diffs.',
 
5121
                       bzrlib.option.diff_writer_registry,
 
5122
                       value_switches=True, enum_switch=False),
 
5123
 
 
5124
        Option('list', help='List shelved changes.'),
 
5125
    ]
 
5126
    _see_also = ['unshelve']
 
5127
 
 
5128
    def run(self, revision=None, all=False, file_list=None, message=None,
 
5129
            writer=None, list=False):
 
5130
        if list:
 
5131
            return self.run_for_list()
 
5132
        from bzrlib.shelf_ui import Shelver
 
5133
        if writer is None:
 
5134
            writer = bzrlib.option.diff_writer_registry.get()
 
5135
        try:
 
5136
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5137
                              message).run()
 
5138
        except errors.UserAbort:
 
5139
            return 0
 
5140
 
 
5141
    def run_for_list(self):
 
5142
        tree = WorkingTree.open_containing('.')[0]
 
5143
        tree.lock_read()
 
5144
        try:
 
5145
            manager = tree.get_shelf_manager()
 
5146
            shelves = manager.active_shelves()
 
5147
            if len(shelves) == 0:
 
5148
                note('No shelved changes.')
 
5149
                return 0
 
5150
            for shelf_id in reversed(shelves):
 
5151
                message = manager.get_metadata(shelf_id).get('message')
 
5152
                if message is None:
 
5153
                    message = '<no message>'
 
5154
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5155
            return 1
 
5156
        finally:
 
5157
            tree.unlock()
 
5158
 
 
5159
 
 
5160
class cmd_unshelve(Command):
 
5161
    """Restore shelved changes.
 
5162
 
 
5163
    By default, the most recently shelved changes are restored. However if you
 
5164
    specify a patch by name those changes will be restored instead.  This
 
5165
    works best when the changes don't depend on each other.
 
5166
    """
 
5167
 
 
5168
    takes_args = ['shelf_id?']
 
5169
    takes_options = [
 
5170
        RegistryOption.from_kwargs(
 
5171
            'action', help="The action to perform.",
 
5172
            enum_switch=False, value_switches=True,
 
5173
            apply="Apply changes and remove from the shelf.",
 
5174
            dry_run="Show changes, but do not apply or remove them.",
 
5175
            delete_only="Delete changes without applying them."
 
5176
        )
 
5177
    ]
 
5178
    _see_also = ['shelve']
 
5179
 
 
5180
    def run(self, shelf_id=None, action='apply'):
 
5181
        from bzrlib.shelf_ui import Unshelver
 
5182
        Unshelver.from_args(shelf_id, action).run()
 
5183
 
 
5184
 
 
5185
def _create_prefix(cur_transport):
 
5186
    needed = [cur_transport]
 
5187
    # Recurse upwards until we can create a directory successfully
 
5188
    while True:
 
5189
        new_transport = cur_transport.clone('..')
 
5190
        if new_transport.base == cur_transport.base:
 
5191
            raise errors.BzrCommandError(
 
5192
                "Failed to create path prefix for %s."
 
5193
                % cur_transport.base)
 
5194
        try:
 
5195
            new_transport.mkdir('.')
 
5196
        except errors.NoSuchFile:
 
5197
            needed.append(new_transport)
 
5198
            cur_transport = new_transport
 
5199
        else:
 
5200
            break
 
5201
    # Now we only need to create child directories
 
5202
    while needed:
 
5203
        cur_transport = needed.pop()
 
5204
        cur_transport.ensure_base()
 
5205
 
 
5206
 
 
5207
# these get imported and then picked up by the scan for cmd_*
 
5208
# TODO: Some more consistent way to split command definitions across files;
 
5209
# we do need to load at least some information about them to know of 
 
5210
# aliases.  ideally we would avoid loading the implementation until the
 
5211
# details were needed.
 
5212
from bzrlib.cmd_version_info import cmd_version_info
 
5213
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5214
from bzrlib.bundle.commands import (
 
5215
    cmd_bundle_info,
 
5216
    )
 
5217
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5218
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5219
        cmd_weave_plan_merge, cmd_weave_merge_text