/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-08-28 05:00:33 UTC
  • mfrom: (4659 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4660.
  • Revision ID: mbp@sourcefrog.net-20090828050033-blwvnig3gdzbr1iw
merge trunk

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