commands.py 197 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
from __future__ import absolute_import

import difflib
import errno
import os
import re
14
import sys
Gregory Szorc's avatar
Gregory Szorc committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

from .i18n import _
from .node import (
    hex,
    nullid,
    nullrev,
    short,
)
from . import (
    archival,
    bookmarks,
    bundle2,
    changegroup,
    cmdutil,
    copies,
30
    debugcommands as debugcommandsmod,
Gregory Szorc's avatar
Gregory Szorc committed
31
    destutil,
32
    dirstateguard,
Gregory Szorc's avatar
Gregory Szorc committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46
    discovery,
    encoding,
    error,
    exchange,
    extensions,
    graphmod,
    hbisect,
    help,
    hg,
    lock as lockmod,
    merge as mergemod,
    obsolete,
    patch,
    phases,
47
    pycompat,
48
    rcutil,
49
    registrar,
50
    revsetlang,
Gregory Szorc's avatar
Gregory Szorc committed
51
    scmutil,
52
    server,
Gregory Szorc's avatar
Gregory Szorc committed
53 54
    sshserver,
    streamclone,
55
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
56 57 58 59 60 61
    templatekw,
    ui as uimod,
    util,
)

release = lockmod.release
62

63
table = {}
64
table.update(debugcommandsmod.command._table)
65

66
command = registrar.command(table)
67

68 69 70 71 72 73
# 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'

74 75 76 77 78 79 80 81 82
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
83
     _('do not prompt, automatically pick the first choice for all prompts')),
84 85
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
86
    ('', 'color', '',
87 88
     # i18n: 'always', 'auto', 'never', and 'debug' are keywords
     # and should not be translated
89
     _("when to colorize (boolean, always, auto, never, or debug)"),
90
     _('TYPE')),
91 92 93 94 95 96 97 98 99 100 101 102 103 104
    ('', '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')),
105
    ('', 'hidden', False, _('consider hidden changesets')),
106 107
    ('', 'pager', 'auto',
     _("when to paginate (boolean, always, auto, or never)"), _('TYPE')),
108 109
]

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
dryrunopts = cmdutil.dryrunopts
remoteopts = cmdutil.remoteopts
walkopts = cmdutil.walkopts
commitopts = cmdutil.commitopts
commitopts2 = cmdutil.commitopts2
formatteropts = cmdutil.formatteropts
templateopts = cmdutil.templateopts
logopts = cmdutil.logopts
diffopts = cmdutil.diffopts
diffwsopts = cmdutil.diffwsopts
diffopts2 = cmdutil.diffopts2
mergetoolopts = cmdutil.mergetoolopts
similarityopts = cmdutil.similarityopts
subrepoopts = cmdutil.subrepoopts
debugrevlogopts = cmdutil.debugrevlogopts
125

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

128 129
@command('^add',
    walkopts + subrepoopts + dryrunopts,
130 131
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
132
def add(ui, repo, *pats, **opts):
133 134
    """add the specified files on the next commit

135 136
    Schedule files to be version controlled and added to the
    repository.
137

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

timeless's avatar
timeless committed
141 142
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
143 144 145

    .. container:: verbose

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
       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
171 172

    Returns 0 if all files are successfully added.
173 174
    """

175
    m = scmutil.match(repo[None], pats, pycompat.byteskwargs(opts))
176
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
177
    return rejected and 1 or 0
178

179
@command('addremove',
180
    similarityopts + subrepoopts + walkopts + dryrunopts,
181 182
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
183
def addremove(ui, repo, *pats, **opts):
184
    """add all new files, delete all missing files
185

186 187
    Add all new files and remove all missing files from the
    repository.
188

timeless's avatar
timeless committed
189 190 191
    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.
192

193
    Use the -s/--similarity option to detect renamed files. This
194
    option takes a percentage between 0 (disabled) and 100 (files must
195 196 197
    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
198
    can be expensive. After using this option, :hg:`status -C` can be
199 200 201
    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.
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
    .. 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

243
    Returns 0 if all files are successfully added.
244
    """
245
    opts = pycompat.byteskwargs(opts)
246
    try:
247
        sim = float(opts.get('similarity') or 100)
248
    except ValueError:
249
        raise error.Abort(_('similarity must be a number'))
250
    if sim < 0 or sim > 100:
251
        raise error.Abort(_('similarity must be between 0 and 100'))
252
    matcher = scmutil.match(repo[None], pats, opts)
253
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
254

255 256 257 258 259 260 261 262 263 264 265
@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')),
266 267
    ('l', 'line-number', None, _('show line number at the first appearance')),
    ('', 'skip', [], _('revision to not display (EXPERIMENTAL)'), _('REV')),
268
    ] + diffwsopts + walkopts + formatteropts,
269 270
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
271
def annotate(ui, repo, *pats, **opts):
272
    """show changeset information by line for each file
273

274
    List changes in files, showing the revision id responsible for
275
    each line.
276

277 278
    This command is useful for discovering when a change was made and
    by whom.
279

280 281 282
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

283 284 285 286
    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.
287 288

    Returns 0 on success.
289
    """
290
    opts = pycompat.byteskwargs(opts)
291
    if not pats:
292
        raise error.Abort(_('at least one filename or pattern is required'))
293

294 295 296
    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
297
        opts['file'] = True
298

299 300
    ctx = scmutil.revsingle(repo, opts.get('rev'))

301
    fm = ui.formatter('annotate', opts)
302 303 304 305
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
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
    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
333

334
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
335 336
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
337 338 339
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
340
            ]
341
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
342

343
    if (not opts.get('user') and not opts.get('changeset')
344
        and not opts.get('date') and not opts.get('file')):
345
        opts['number'] = True
346

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

351 352
    ui.pager('annotate')

353
    if fm.isplain():
354
        def makefunc(get, fmt):
355
            return lambda x: fmt(get(x))
356 357
    else:
        def makefunc(get, fmt):
358
            return get
359 360
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
361
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
362 363
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
364

365
    def bad(x, y):
366
        raise error.Abort("%s: %s" % (x, y))
367

368 369
    m = scmutil.match(ctx, pats, opts, badfn=bad)

370
    follow = not opts.get('no_follow')
371 372
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
373 374 375 376
    skiprevs = opts.get('skip')
    if skiprevs:
        skiprevs = scmutil.revrange(repo, skiprevs)

Matt Mackall's avatar
Matt Mackall committed
377 378
    for abs in ctx.walk(m):
        fctx = ctx[abs]
Jun Wu's avatar
Jun Wu committed
379
        if not opts.get('text') and fctx.isbinary():
380
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
381 382
            continue

383
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
384
                              skiprevs=skiprevs, diffopts=diffopts)
385 386
        if not lines:
            continue
387
        formats = []
388 389
        pieces = []

390
        for f, sep in funcmap:
391
            l = [f(n) for n, dummy in lines]
392
            if fm.isplain():
393 394 395
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
396 397
            else:
                formats.append(['%s' for x in l])
398
            pieces.append(l)
399

400
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
401 402 403
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
404

405
        if not lines[-1][1].endswith('\n'):
406 407 408
            fm.plain('\n')

    fm.end()
409

410 411 412 413 414 415 416 417
@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'))
418
def archive(ui, repo, dest, **opts):
419
    '''create an unversioned archive of a repository revision
420

421 422
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
423

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

Matt Mackall's avatar
Matt Mackall committed
427 428 429 430 431 432 433 434 435 436 437 438
    .. 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*"

439
    Valid types are:
440

441 442 443 444 445 446
    :``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
447

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

451 452 453 454
    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.
455 456

    Returns 0 on success.
457 458
    '''

459
    opts = pycompat.byteskwargs(opts)
460
    ctx = scmutil.revsingle(repo, opts.get('rev'))
461
    if not ctx:
462
        raise error.Abort(_('no working directory: please specify a revision'))
463
    node = ctx.node()
464
    dest = cmdutil.makefilename(repo, dest, node)
465
    if os.path.realpath(dest) == repo.root:
466
        raise error.Abort(_('repository root cannot be destination'))
467

468
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
469
    prefix = opts.get('prefix')
470

471 472
    if dest == '-':
        if kind == 'files':
473
            raise error.Abort(_('cannot archive plain files to stdout'))
474
        dest = cmdutil.makefileobj(repo, dest)
475 476
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
477

478
    prefix = cmdutil.makefilename(repo, prefix, node)
479
    matchfn = scmutil.match(ctx, [], opts)
480
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
481
                     matchfn, prefix, subrepos=opts.get('subrepos'))
482

483 484
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
485 486 487
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
488 489
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
490
    ('r', 'rev', '', _('revision to backout'), _('REV')),
491
    ('e', 'edit', False, _('invoke editor on commit messages')),
492
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
493
    _('[OPTION]... [-r] REV'))
494
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
495 496
    '''reverse effect of earlier changeset

497
    Prepare a new changeset with the effect of REV undone in the
498 499
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
500

501
    If REV is the parent of the working directory, then this new changeset
502
    is committed automatically (unless --no-commit is specified).
503

504
    .. note::
505

506
       :hg:`backout` cannot be used to fix either an unwanted or
507
       incorrect merge.
508

Matt Mackall's avatar
Matt Mackall committed
509 510
    .. container:: verbose

511 512 513 514 515 516 517 518 519 520 521 522
      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
523
        leave changes uncommitted::
524

525 526
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
527

Matt Mackall's avatar
Matt Mackall committed
528 529 530 531 532 533 534 535 536
      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.
537

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

540 541 542
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

543 544
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
545
    '''
546 547 548 549
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
550
        return _dobackout(ui, repo, node, rev, **opts)
551 552 553
    finally:
        release(lock, wlock)

554
def _dobackout(ui, repo, node=None, rev=None, **opts):
555
    opts = pycompat.byteskwargs(opts)
556 557
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
558 559
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
560

Daniel Holth's avatar
Daniel Holth committed
561
    if rev and node:
562
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
563 564 565

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

567
    if not rev:
568
        raise error.Abort(_("please specify a revision to backout"))
569

570 571 572 573
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

574
    cmdutil.checkunfinished(repo)
575
    cmdutil.bailifchanged(repo)
576
    node = scmutil.revsingle(repo, rev).node()
577

578
    op1, op2 = repo.dirstate.parents()
579
    if not repo.changelog.isancestor(node, op1):
580
        raise error.Abort(_('cannot backout change that is not an ancestor'))
581

582 583
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
584
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
585
    if p2 != nullid:
586
        if not opts.get('parent'):
587
            raise error.Abort(_('cannot backout a merge changeset'))
588 589
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
590
            raise error.Abort(_('%s is not a parent of %s') %
591
                             (short(p), short(node)))
592 593
        parent = p
    else:
594
        if opts.get('parent'):
595
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
596
        parent = p1
597

598
    # the backout should appear on the same branch
599 600 601 602
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
603
        dsguard = dirstateguard.dirstateguard(repo, 'backout')
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
        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())

623 624 625 626 627
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
628 629 630

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
631 632
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
        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', '', '')
659
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
660

661 662 663 664 665 666 667 668 669
@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]"))
670
def bisect(ui, repo, rev=None, extra=None, command=None,
671 672
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
673 674
    """subdivision search of changesets

675 676 677 678 679 680 681 682 683 684 685 686 687
    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.
688 689 690 691 692 693
    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.
694

695 696 697 698
    .. container:: verbose

      Some examples:

699
      - start a bisection with known bad revision 34, and good revision 12::
700 701 702 703 704 705 706 707 708 709

          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
710
      - mark the current revision, or a known revision, to be skipped (e.g. if
711 712 713 714 715
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

716
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
717

718
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
719

720 721 722 723 724 725 726 727 728 729
      - 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
730
          hg bisect --command "make && make tests"
731 732 733 734 735 736

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

          hg log -r "bisect(pruned)"

737 738 739 740 741
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

742 743 744 745
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

746
      - you can even get a nice graph::
747 748 749

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

750
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
751

752
    Returns 0 on success.
753 754 755 756 757 758 759 760 761 762 763
    """
    # 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
764
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
765
        raise error.Abort(_('incompatible arguments'))
766 767

    if reset:
768
        hbisect.resetstate(repo)
769 770
        return

771 772
    state = hbisect.load_state(repo)

773 774 775 776 777 778 779 780 781 782 783 784 785
    # 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)
786 787
        if not (state['good'] and state['bad']):
            return
788

789 790 791 792
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
793
        cmdutil.checkunfinished(repo)
794 795 796
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

797 798
    displayer = cmdutil.show_changeset(ui, repo, {})

799 800
    if command:
        changesets = 1
801 802 803 804
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
805
                raise error.Abort(_('current bisect revision is unknown - '
806
                                   'start a new bisect to fix'))
807
        else:
808 809
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
810
                raise error.Abort(_('current bisect revision is a merge'))
811 812
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
813 814 815
        try:
            while changesets:
                # update state
816
                state['current'] = [node]
817
                hbisect.save_state(repo, state)
818 819
                status = ui.system(command, environ={'HG_NODE': hex(node)},
                                   blockedtag='bisect_check')
820 821 822 823 824 825
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
826
                    raise error.Abort(_("failed to execute %s") % command)
827
                elif status < 0:
828
                    raise error.Abort(_("%s killed") % command)
829 830
                else:
                    transition = "bad"
831 832
                state[transition].append(node)
                ctx = repo[node]
833
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
834
                hbisect.checkstate(state)
835
                # bisect
836
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
837
                # update to next check
838
                node = nodes[0]
839
                mayupdate(repo, node, show_stats=False)
840
        finally:
841
            state['current'] = [node]
842
            hbisect.save_state(repo, state)
843
        hbisect.printresult(ui, repo, state, displayer, nodes, bgood)
844
        return
845

846
    hbisect.checkstate(state)
847 848

    # actually bisect
849
    nodes, changesets, good = hbisect.bisect(repo.changelog, state)
850 851
    if extend:
        if not changesets:
852
            extendnode = hbisect.extendrange(repo, state, nodes, good)
853
            if extendnode is not None:
854 855
                ui.write(_("Extending search to changeset %d:%s\n")
                         % (extendnode.rev(), extendnode))
856 857
                state['current'] = [extendnode.node()]
                hbisect.save_state(repo, state)
858
                return mayupdate(repo, extendnode.node())