← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-16 11:10:03 UTC
  • mto: This revision was merged to the branch mainline in revision 6511.
  • Revision ID: v.ladeuil+lp@free.fr-20120316111003-a3fsp7hi8wo86e3a
https://launchpad.net/bugs/956860
Ensures the format registry is not empty when generating docs for sphinx

Show diffs side-by-side

added added

removed removed

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