← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:06:36 UTC
  • mfrom: (3932.2.3 1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113030636-dqx4t8yaaqgdvam5
Merge 1.11rc1

Show diffs side-by-side

added added

removed removed

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