← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Gordon Tyler
  • Date: 2009-11-30 00:48:51 UTC
  • mto: (4870.1.1 integration2)
  • mto: This revision was merged to the branch mainline in revision 4836.
  • Revision ID: gordon@doxxx.net-20091130004851-as4nnjedltpogxot
Fixed detection of bzr.exe when display python interpreter version.

Show diffs side-by-side

added added

removed removed

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