← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2005-09-15 21:35:53 UTC
  • mfrom: (907.1.57)
  • mto: (1393.2.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050915213552-a6c83a5ef1e20897
(broken) Transport work is merged in. Tests do not pass yet.

Show diffs side-by-side

added added

removed removed

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