commands.py 260 KB
Newer Older
mpm@selenic.com's avatar
mpm@selenic.com committed
1 2
# commands.py - command processing for mercurial
#
3
# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
mpm@selenic.com's avatar
mpm@selenic.com committed
4
#
5
# This software may be used and distributed according to the terms of the
Matt Mackall's avatar
Matt Mackall committed
6
# GNU General Public License version 2 or any later version.
mpm@selenic.com's avatar
mpm@selenic.com committed
7

Gregory Szorc's avatar
Gregory Szorc committed
8 9 10 11 12 13 14 15 16 17
from __future__ import absolute_import

import difflib
import errno
import operator
import os
import random
import re
import shlex
import socket
18
import string
Gregory Szorc's avatar
Gregory Szorc committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
import sys
import tempfile
import time

from .i18n import _
from .node import (
    bin,
    hex,
    nullhex,
    nullid,
    nullrev,
    short,
)
from . import (
    archival,
    bookmarks,
    bundle2,
    changegroup,
    cmdutil,
    commandserver,
    copies,
    dagparser,
    dagutil,
    destutil,
    discovery,
    encoding,
    error,
    exchange,
    extensions,
    fileset,
49
    formatter,
Gregory Szorc's avatar
Gregory Szorc committed
50 51 52 53 54 55 56 57 58 59 60 61
    graphmod,
    hbisect,
    help,
    hg,
    hgweb,
    localrepo,
    lock as lockmod,
    merge as mergemod,
    minirst,
    obsolete,
    patch,
    phases,
timeless's avatar
timeless committed
62
    policy,
Gregory Szorc's avatar
Gregory Szorc committed
63
    pvec,
64
    pycompat,
Gregory Szorc's avatar
Gregory Szorc committed
65 66 67 68 69 70
    repair,
    revlog,
    revset,
    scmutil,
    setdiscovery,
    sshserver,
71
    sslutil,
Gregory Szorc's avatar
Gregory Szorc committed
72 73
    streamclone,
    templatekw,
74
    templater,
Gregory Szorc's avatar
Gregory Szorc committed
75 76 77 78 79 80
    treediscovery,
    ui as uimod,
    util,
)

release = lockmod.release
81

82 83 84 85
table = {}

command = cmdutil.command(table)

86 87 88 89 90 91
# label constants
# until 3.5, bookmarks.current was the advertised name, not
# bookmarks.active, so we must use both to avoid breaking old
# custom styles
activebookmarklabel = 'bookmarks.active bookmarks.current'

92 93 94 95 96 97 98 99 100
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
101
     _('do not prompt, automatically pick the first choice for all prompts')),
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
    ('', 'config', [],
     _('set/override config option (use \'section.name=value\')'),
     _('CONFIG')),
    ('', 'debug', None, _('enable debugging output')),
    ('', 'debugger', None, _('start debugger')),
    ('', 'encoding', encoding.encoding, _('set the charset encoding'),
     _('ENCODE')),
    ('', 'encodingmode', encoding.encodingmode,
     _('set the charset encoding mode'), _('MODE')),
    ('', 'traceback', None, _('always print a traceback on exception')),
    ('', 'time', None, _('time how long the command takes')),
    ('', 'profile', None, _('print command execution profile')),
    ('', 'version', None, _('output version information and exit')),
    ('h', 'help', None, _('display help and exit')),
118
    ('', 'hidden', False, _('consider hidden changesets')),
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
]

dryrunopts = [('n', 'dry-run', None,
               _('do not perform actions, just print output'))]

remoteopts = [
    ('e', 'ssh', '',
     _('specify ssh command to use'), _('CMD')),
    ('', 'remotecmd', '',
     _('specify hg command to run on the remote side'), _('CMD')),
    ('', 'insecure', None,
     _('do not verify server certificate (ignoring web.cacerts config)')),
]

walkopts = [
    ('I', 'include', [],
     _('include names matching the given patterns'), _('PATTERN')),
    ('X', 'exclude', [],
     _('exclude names matching the given patterns'), _('PATTERN')),
]

commitopts = [
    ('m', 'message', '',
     _('use text as commit message'), _('TEXT')),
    ('l', 'logfile', '',
     _('read commit message from file'), _('FILE')),
]

commitopts2 = [
    ('d', 'date', '',
     _('record the specified date as commit date'), _('DATE')),
    ('u', 'user', '',
     _('record the specified user as committer'), _('USER')),
]

154 155 156
# hidden for now
formatteropts = [
    ('T', 'template', '',
157
     _('display with template (EXPERIMENTAL)'), _('TEMPLATE')),
158 159
]

160 161
templateopts = [
    ('', 'style', '',
162
     _('display using template map file (DEPRECATED)'), _('STYLE')),
163
    ('T', 'template', '',
164 165 166 167 168 169 170 171 172 173
     _('display with template'), _('TEMPLATE')),
]

logopts = [
    ('p', 'patch', None, _('show patch')),
    ('g', 'git', None, _('use git extended diff format')),
    ('l', 'limit', '',
     _('limit number of changes displayed'), _('NUM')),
    ('M', 'no-merges', None, _('do not show merges')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
174
    ('G', 'graph', None, _("show the revision DAG")),
175 176 177 178 179 180 181 182
] + templateopts

diffopts = [
    ('a', 'text', None, _('treat all files as text')),
    ('g', 'git', None, _('use git extended diff format')),
    ('', 'nodates', None, _('omit dates from diff headers'))
]

183
diffwsopts = [
184 185 186 187 188 189
    ('w', 'ignore-all-space', None,
     _('ignore white space when comparing lines')),
    ('b', 'ignore-space-change', None,
     _('ignore changes in the amount of white space')),
    ('B', 'ignore-blank-lines', None,
     _('ignore changes whose lines are all blank')),
190 191 192
    ]

diffopts2 = [
193
    ('', 'noprefix', None, _('omit a/ and b/ prefixes from filenames')),
194 195 196
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
197 198 199
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
200
    ('', 'root', '', _('produce diffs relative to subdirectory'), _('DIR')),
201 202
]

203 204 205 206
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

207 208 209 210 211 212 213 214 215 216
similarityopts = [
    ('s', 'similarity', '',
     _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))
]

subrepoopts = [
    ('S', 'subrepos', None,
     _('recurse into subrepositories'))
]

217 218 219
debugrevlogopts = [
    ('c', 'changelog', False, _('open changelog')),
    ('m', 'manifest', False, _('open manifest')),
220
    ('', 'dir', '', _('open directory manifest')),
221 222
]

mpm@selenic.com's avatar
mpm@selenic.com committed
223
# Commands start here, listed alphabetically
224

225 226
@command('^add',
    walkopts + subrepoopts + dryrunopts,
227 228
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
229
def add(ui, repo, *pats, **opts):
230 231
    """add the specified files on the next commit

232 233
    Schedule files to be version controlled and added to the
    repository.
234

235
    The files will be added to the repository at the next commit. To
236
    undo an add before that, see :hg:`forget`.
237

timeless's avatar
timeless committed
238 239
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
240 241 242

    .. container:: verbose

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
       Examples:

         - New (unknown) files are added
           automatically by :hg:`add`::

             $ ls
             foo.c
             $ hg status
             ? foo.c
             $ hg add
             adding foo.c
             $ hg status
             A foo.c

         - Specific files to be added can be specified::

             $ ls
             bar.c  foo.c
             $ hg status
             ? bar.c
             ? foo.c
             $ hg add bar.c
             $ hg status
             A bar.c
             ? foo.c
268 269

    Returns 0 if all files are successfully added.
270 271
    """

272
    m = scmutil.match(repo[None], pats, opts)
273
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
274
    return rejected and 1 or 0
275

276
@command('addremove',
277
    similarityopts + subrepoopts + walkopts + dryrunopts,
278 279
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
280
def addremove(ui, repo, *pats, **opts):
281
    """add all new files, delete all missing files
282

283 284
    Add all new files and remove all missing files from the
    repository.
285

timeless's avatar
timeless committed
286 287 288
    Unless names are given, new files are ignored if they match any of
    the patterns in ``.hgignore``. As with add, these changes take
    effect at the next commit.
289

290
    Use the -s/--similarity option to detect renamed files. This
291
    option takes a percentage between 0 (disabled) and 100 (files must
292 293 294
    be identical) as its parameter. With a parameter greater than 0,
    this compares every removed file with every added file and records
    those similar enough as renames. Detecting renamed files this way
295
    can be expensive. After using this option, :hg:`status -C` can be
296 297 298
    used to check which files were identified as moved or renamed. If
    not specified, -s/--similarity defaults to 100 and only renames of
    identical files are detected.
299

300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
    .. container:: verbose

       Examples:

         - A number of files (bar.c and foo.c) are new,
           while foobar.c has been removed (without using :hg:`remove`)
           from the repository::

             $ ls
             bar.c foo.c
             $ hg status
             ! foobar.c
             ? bar.c
             ? foo.c
             $ hg addremove
             adding bar.c
             adding foo.c
             removing foobar.c
             $ hg status
             A bar.c
             A foo.c
             R foobar.c

         - A file foobar.c was moved to foo.c without using :hg:`rename`.
           Afterwards, it was edited slightly::

             $ ls
             foo.c
             $ hg status
             ! foobar.c
             ? foo.c
             $ hg addremove --similarity 90
             removing foobar.c
             adding foo.c
             recording removal of foobar.c as rename to foo.c (94% similar)
             $ hg status -C
             A foo.c
               foobar.c
             R foobar.c

340
    Returns 0 if all files are successfully added.
341
    """
342
    try:
343
        sim = float(opts.get('similarity') or 100)
344
    except ValueError:
345
        raise error.Abort(_('similarity must be a number'))
346
    if sim < 0 or sim > 100:
347
        raise error.Abort(_('similarity must be between 0 and 100'))
348
    matcher = scmutil.match(repo[None], pats, opts)
349
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
350

351 352 353 354 355 356 357 358 359 360 361 362
@command('^annotate|blame',
    [('r', 'rev', '', _('annotate the specified revision'), _('REV')),
    ('', 'follow', None,
     _('follow copies/renames and list the filename (DEPRECATED)')),
    ('', 'no-follow', None, _("don't follow copies and renames")),
    ('a', 'text', None, _('treat all files as text')),
    ('u', 'user', None, _('list the author (long with -v)')),
    ('f', 'file', None, _('list the filename')),
    ('d', 'date', None, _('list the date (short with -q)')),
    ('n', 'number', None, _('list the revision number (default)')),
    ('c', 'changeset', None, _('list the changeset')),
    ('l', 'line-number', None, _('show line number at the first appearance'))
363
    ] + diffwsopts + walkopts + formatteropts,
364 365
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
366
def annotate(ui, repo, *pats, **opts):
367
    """show changeset information by line for each file
368

369
    List changes in files, showing the revision id responsible for
370
    each line.
371

372 373
    This command is useful for discovering when a change was made and
    by whom.
374

375 376 377
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

378 379 380 381
    Without the -a/--text option, annotate will avoid processing files
    it detects as binary. With -a, annotate will annotate the file
    anyway, although the results will probably be neither useful
    nor desirable.
382 383

    Returns 0 on success.
384
    """
385
    if not pats:
386
        raise error.Abort(_('at least one filename or pattern is required'))
387

388 389 390
    if opts.get('follow'):
        # --follow is deprecated and now just an alias for -f/--file
        # to mimic the behavior of Mercurial before version 1.5
391
        opts['file'] = True
392

393 394
    ctx = scmutil.revsingle(repo, opts.get('rev'))

395
    fm = ui.formatter('annotate', opts)
396 397 398 399
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
    if ctx.rev() is None:
        def hexfn(node):
            if node is None:
                return None
            else:
                return fm.hexfunc(node)
        if opts.get('changeset'):
            # omit "+" suffix which is appended to node hex
            def formatrev(rev):
                if rev is None:
                    return '%d' % ctx.p1().rev()
                else:
                    return '%d' % rev
        else:
            def formatrev(rev):
                if rev is None:
                    return '%d+' % ctx.p1().rev()
                else:
                    return '%d ' % rev
        def formathex(hex):
            if hex is None:
                return '%s+' % fm.hexfunc(ctx.p1().node())
            else:
                return '%s ' % hex
    else:
        hexfn = fm.hexfunc
        formatrev = formathex = str
427

428
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
429 430
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
431 432 433
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
434
            ]
435
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
436

437
    if (not opts.get('user') and not opts.get('changeset')
438
        and not opts.get('date') and not opts.get('file')):
439
        opts['number'] = True
440

441
    linenumber = opts.get('line_number') is not None
442
    if linenumber and (not opts.get('changeset')) and (not opts.get('number')):
443
        raise error.Abort(_('at least one of -n/-c is required for -l'))
444

445
    if fm.isplain():
446
        def makefunc(get, fmt):
447
            return lambda x: fmt(get(x))
448 449
    else:
        def makefunc(get, fmt):
450
            return get
451 452
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
453
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
454 455
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
456

457
    def bad(x, y):
458
        raise error.Abort("%s: %s" % (x, y))
459

460 461
    m = scmutil.match(ctx, pats, opts, badfn=bad)

462
    follow = not opts.get('no_follow')
463 464
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
465 466
    for abs in ctx.walk(m):
        fctx = ctx[abs]
467
        if not opts.get('text') and util.binary(fctx.data()):
468
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
469 470
            continue

471 472
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
473 474
        if not lines:
            continue
475
        formats = []
476 477
        pieces = []

478
        for f, sep in funcmap:
479
            l = [f(n) for n, dummy in lines]
480
            if fm.isplain():
481 482 483
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
484 485
            else:
                formats.append(['%s' for x in l])
486
            pieces.append(l)
487

488
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
489 490 491
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
492

493
        if not lines[-1][1].endswith('\n'):
494 495 496
            fm.plain('\n')

    fm.end()
497

498 499 500 501 502 503 504 505
@command('archive',
    [('', 'no-decode', None, _('do not pass files through decoders')),
    ('p', 'prefix', '', _('directory prefix for files in archive'),
     _('PREFIX')),
    ('r', 'rev', '', _('revision to distribute'), _('REV')),
    ('t', 'type', '', _('type of distribution to create'), _('TYPE')),
    ] + subrepoopts + walkopts,
    _('[OPTION]... DEST'))
506
def archive(ui, repo, dest, **opts):
507
    '''create an unversioned archive of a repository revision
508

509 510
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
511

512
    The archive type is automatically detected based on file
timeless's avatar
timeless committed
513
    extension (to override, use -t/--type).
514

Matt Mackall's avatar
Matt Mackall committed
515 516 517 518 519 520 521 522 523 524 525 526
    .. container:: verbose

      Examples:

      - create a zip file containing the 1.0 release::

          hg archive -r 1.0 project-1.0.zip

      - create a tarball excluding .hg files::

          hg archive project.tar.gz -X ".hg*"

527
    Valid types are:
528

529 530 531 532 533 534
    :``files``: a directory full of files (default)
    :``tar``:   tar archive, uncompressed
    :``tbz2``:  tar archive, compressed using bzip2
    :``tgz``:   tar archive, compressed using gzip
    :``uzip``:  zip archive, uncompressed
    :``zip``:   zip archive, compressed using deflate
535

536
    The exact name of the destination archive or directory is given
Martin Geisler's avatar
Martin Geisler committed
537
    using a format string; see :hg:`help export` for details.
538

539 540 541 542
    Each member added to an archive file has a directory prefix
    prepended. Use -p/--prefix to specify a format string for the
    prefix. The default is the basename of the archive, with suffixes
    removed.
543 544

    Returns 0 on success.
545 546
    '''

547
    ctx = scmutil.revsingle(repo, opts.get('rev'))
548
    if not ctx:
549
        raise error.Abort(_('no working directory: please specify a revision'))
550
    node = ctx.node()
551
    dest = cmdutil.makefilename(repo, dest, node)
552
    if os.path.realpath(dest) == repo.root:
553
        raise error.Abort(_('repository root cannot be destination'))
554

555
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
556
    prefix = opts.get('prefix')
557

558 559
    if dest == '-':
        if kind == 'files':
560
            raise error.Abort(_('cannot archive plain files to stdout'))
561
        dest = cmdutil.makefileobj(repo, dest)
562 563
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
564

565
    prefix = cmdutil.makefilename(repo, prefix, node)
566
    matchfn = scmutil.match(ctx, [], opts)
567
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
568
                     matchfn, prefix, subrepos=opts.get('subrepos'))
569

570 571
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
572 573 574
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
575 576
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
577
    ('r', 'rev', '', _('revision to backout'), _('REV')),
578
    ('e', 'edit', False, _('invoke editor on commit messages')),
579
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
580
    _('[OPTION]... [-r] REV'))
581
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
582 583
    '''reverse effect of earlier changeset

584
    Prepare a new changeset with the effect of REV undone in the
585 586
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
587

588
    If REV is the parent of the working directory, then this new changeset
589
    is committed automatically (unless --no-commit is specified).
590

591
    .. note::
592

593
       :hg:`backout` cannot be used to fix either an unwanted or
594
       incorrect merge.
595

Matt Mackall's avatar
Matt Mackall committed
596 597
    .. container:: verbose

598 599 600 601 602 603 604 605 606 607 608 609
      Examples:

      - Reverse the effect of the parent of the working directory.
        This backout will be committed immediately::

          hg backout -r .

      - Reverse the effect of previous bad revision 23::

          hg backout -r 23

      - Reverse the effect of previous bad revision 23 and
610
        leave changes uncommitted::
611

612 613
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
614

Matt Mackall's avatar
Matt Mackall committed
615 616 617 618 619 620 621 622 623
      By default, the pending changeset will have one parent,
      maintaining a linear history. With --merge, the pending
      changeset will instead have two parents: the old parent of the
      working directory and a new child of REV that simply undoes REV.

      Before version 1.7, the behavior without --merge was equivalent
      to specifying --merge followed by :hg:`update --clean .` to
      cancel the merge and leave the child of REV as a head to be
      merged separately.
624

Martin Geisler's avatar
Martin Geisler committed
625
    See :hg:`help dates` for a list of formats valid for -d/--date.
626

627 628 629
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

630 631
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
632
    '''
633 634 635 636
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
637
        return _dobackout(ui, repo, node, rev, **opts)
638 639 640
    finally:
        release(lock, wlock)

641 642 643
def _dobackout(ui, repo, node=None, rev=None, **opts):
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
644 645
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
646

Daniel Holth's avatar
Daniel Holth committed
647
    if rev and node:
648
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
649 650 651

    if not rev:
        rev = node
Vadim Gelfer's avatar
Vadim Gelfer committed
652

653
    if not rev:
654
        raise error.Abort(_("please specify a revision to backout"))
655

656 657 658 659
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

660
    cmdutil.checkunfinished(repo)
661
    cmdutil.bailifchanged(repo)
662
    node = scmutil.revsingle(repo, rev).node()
663

664
    op1, op2 = repo.dirstate.parents()
665
    if not repo.changelog.isancestor(node, op1):
666
        raise error.Abort(_('cannot backout change that is not an ancestor'))
667

668 669
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
670
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
671
    if p2 != nullid:
672
        if not opts.get('parent'):
673
            raise error.Abort(_('cannot backout a merge changeset'))
674 675
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
676
            raise error.Abort(_('%s is not a parent of %s') %
677
                             (short(p), short(node)))
678 679
        parent = p
    else:
680
        if opts.get('parent'):
681
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
682
        parent = p1
683

684
    # the backout should appear on the same branch
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
        dsguard = cmdutil.dirstateguard(repo, 'backout')
        try:
            ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                         'backout')
            stats = mergemod.update(repo, parent, True, True, node, False)
            repo.setparents(op1, op2)
            dsguard.close()
            hg._showstats(repo, stats)
            if stats[3]:
                repo.ui.status(_("use 'hg resolve' to retry unresolved "
                                 "file merges\n"))
                return 1
        finally:
            ui.setconfig('ui', 'forcemerge', '', '')
            lockmod.release(dsguard)
    else:
        hg.clean(repo, node, show_stats=False)
        repo.dirstate.setbranch(branch)
        cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

709 710 711 712 713
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
        e = cmdutil.getcommiteditor(editform=editform, **opts)
        if not message:
            # we don't translate commit messages
            message = "Backed out changeset %s" % short(node)
            e = cmdutil.getcommiteditor(edit=True, editform=editform)
        return repo.commit(message, opts.get('user'), opts.get('date'),
                           match, editor=e)
    newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
    if not newnode:
        ui.status(_("nothing changed\n"))
        return 1
    cmdutil.commitstatus(repo, newnode, branch, bheads)

    def nice(node):
        return '%d:%s' % (repo.changelog.rev(node), short(node))
    ui.status(_('changeset %s backs out changeset %s\n') %
              (nice(repo.changelog.tip()), nice(node)))
    if opts.get('merge') and op1 != node:
        hg.clean(repo, op1, show_stats=False)
        ui.status(_('merging with changeset %s\n')
                  % nice(repo.changelog.tip()))
        try:
            ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                         'backout')
            return hg.merge(repo, hex(repo.changelog.tip()))
        finally:
            ui.setconfig('ui', 'forcemerge', '', '')
744
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
745

746 747 748 749 750 751 752 753 754
@command('bisect',
    [('r', 'reset', False, _('reset bisect state')),
    ('g', 'good', False, _('mark changeset good')),
    ('b', 'bad', False, _('mark changeset bad')),
    ('s', 'skip', False, _('skip testing changeset')),
    ('e', 'extend', False, _('extend the bisect range')),
    ('c', 'command', '', _('use command to check changeset state'), _('CMD')),
    ('U', 'noupdate', False, _('do not update to target'))],
    _("[-gbsr] [-U] [-c CMD] [REV]"))
755
def bisect(ui, repo, rev=None, extra=None, command=None,
756 757
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
758 759
    """subdivision search of changesets

760 761 762 763 764 765 766 767 768 769 770 771 772
    This command helps to find changesets which introduce problems. To
    use, mark the earliest changeset you know exhibits the problem as
    bad, then mark the latest changeset which is free from the problem
    as good. Bisect will update your working directory to a revision
    for testing (unless the -U/--noupdate option is specified). Once
    you have performed tests, mark the working directory as good or
    bad, and bisect will either update to another candidate changeset
    or announce that it has found the bad revision.

    As a shortcut, you can also use the revision argument to mark a
    revision as good or bad without checking it out first.

    If you supply a command, it will be used for automatic bisection.
773 774 775 776 777 778
    The environment variable HG_NODE will contain the ID of the
    changeset being tested. The exit status of the command will be
    used to mark revisions as good or bad: status 0 means good, 125
    means to skip the revision, 127 (command not found) will abort the
    bisection, and any other non-zero exit status means the revision
    is bad.
779

780 781 782 783
    .. container:: verbose

      Some examples:

784
      - start a bisection with known bad revision 34, and good revision 12::
785 786 787 788 789 790 791 792 793 794

          hg bisect --bad 34
          hg bisect --good 12

      - advance the current bisection by marking current revision as good or
        bad::

          hg bisect --good
          hg bisect --bad

kiilerix's avatar
kiilerix committed
795
      - mark the current revision, or a known revision, to be skipped (e.g. if
796 797 798 799 800
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

801
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
802

803
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
804

805 806 807 808 809 810 811 812 813 814
      - forget the current bisection::

          hg bisect --reset

      - use 'make && make tests' to automatically find the first broken
        revision::

          hg bisect --reset
          hg bisect --bad 34
          hg bisect --good 12
815
          hg bisect --command "make && make tests"
816 817 818 819 820 821

      - see all changesets whose states are already known in the current
        bisection::

          hg log -r "bisect(pruned)"

822 823 824 825 826
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

827 828 829 830
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

831
      - you can even get a nice graph::
832 833 834

          hg log --graph -r "bisect(range)"

835 836
      See :hg:`help revsets` for more about the `bisect()` keyword.

837
    Returns 0 on success.
838 839 840 841 842 843 844 845 846 847 848
    """
    # backward compatibility
    if rev in "good bad reset init".split():
        ui.warn(_("(use of 'hg bisect <cmd>' is deprecated)\n"))
        cmd, rev, extra = rev, extra, None
        if cmd == "good":
            good = True
        elif cmd == "bad":
            bad = True
        else:
            reset = True
849
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
850
        raise error.Abort(_('incompatible arguments'))
851

852 853
    cmdutil.checkunfinished(repo)

854
    if reset:
855
        hbisect.resetstate(repo)
856 857
        return

858 859
    state = hbisect.load_state(repo)

860 861 862 863 864 865 866 867 868 869 870 871 872
    # update state
    if good or bad or skip:
        if rev:
            nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
        else:
            nodes = [repo.lookup('.')]
        if good:
            state['good'] += nodes
        elif bad:
            state['bad'] += nodes
        elif skip:
            state['skip'] += nodes
        hbisect.save_state(repo, state)
873 874
        if not (state['good'] and state['bad']):
            return
875

876 877 878 879 880 881 882
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

883 884
    displayer = cmdutil.show_changeset(ui, repo, {})

885 886
    if command:
        changesets = 1
887 888 889 890
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
891
                raise error.Abort(_('current bisect revision is unknown - '
892
                                   'start a new bisect to fix'))
893
        else:
894 895
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
896
                raise error.Abort(_('current bisect revision is a merge'))
897 898
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
899 900 901
        try:
            while changesets:
                # update state
902
                state['current'] = [node]
903
                hbisect.save_state(repo, state)
904
                status = ui.system(command, environ={'HG_NODE': hex(node)})
905 906 907 908 909 910
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
911
                    raise error.Abort(_("failed to execute %s") % command)
912
                elif status < 0:
913
                    raise error.Abort(_("%s killed") % command)
914 915
                else:
                    transition = "bad"
916 917
                state[transition].append(node)
                ctx = repo[node]
918
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
919
                hbisect.checkstate(state)
920
                # bisect
921
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
922
                # update to next check
923
                node = nodes[0]
924
                mayupdate(repo, node, show_stats=False)
925
        finally:
926
            state['current'] = [node]