commands.py 196 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 18 19 20 21 22 23 24 25 26 27 28 29
from __future__ import absolute_import

import difflib
import errno
import os
import re

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

release = lockmod.release
60

61 62
table = {}

63
command = registrar.command(table)
64

65 66 67 68 69 70
# 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'

71 72 73 74 75 76 77 78 79
# common command options

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

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
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
122

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

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

132 133
    Schedule files to be version controlled and added to the
    repository.
134

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

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

    .. container:: verbose

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

    Returns 0 if all files are successfully added.
170 171
    """

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

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

183 184
    Add all new files and remove all missing files from the
    repository.
185

timeless's avatar
timeless committed
186 187 188
    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.
189

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

200 201 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
    .. 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

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

252 253 254 255 256 257 258 259 260 261 262 263
@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'))
264
    ] + diffwsopts + walkopts + formatteropts,
265 266
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
267
def annotate(ui, repo, *pats, **opts):
268
    """show changeset information by line for each file
269

270
    List changes in files, showing the revision id responsible for
271
    each line.
272

273 274
    This command is useful for discovering when a change was made and
    by whom.
275

276 277 278
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

279 280 281 282
    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.
283 284

    Returns 0 on success.
285
    """
286
    opts = pycompat.byteskwargs(opts)
287
    if not pats:
288
        raise error.Abort(_('at least one filename or pattern is required'))
289

290 291 292
    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
293
        opts['file'] = True
294

295 296
    ctx = scmutil.revsingle(repo, opts.get('rev'))

297
    fm = ui.formatter('annotate', opts)
298 299 300 301
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
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
    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
329

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

339
    if (not opts.get('user') and not opts.get('changeset')
340
        and not opts.get('date') and not opts.get('file')):
341
        opts['number'] = True
342

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

347 348
    ui.pager('annotate')

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

361
    def bad(x, y):
362
        raise error.Abort("%s: %s" % (x, y))
363

364 365
    m = scmutil.match(ctx, pats, opts, badfn=bad)

366
    follow = not opts.get('no_follow')
367 368
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
369 370
    for abs in ctx.walk(m):
        fctx = ctx[abs]
Jun Wu's avatar
Jun Wu committed
371
        if not opts.get('text') and fctx.isbinary():
372
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
373 374
            continue

375 376
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
377 378
        if not lines:
            continue
379
        formats = []
380 381
        pieces = []

382
        for f, sep in funcmap:
383
            l = [f(n) for n, dummy in lines]
384
            if fm.isplain():
385 386 387
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
388 389
            else:
                formats.append(['%s' for x in l])
390
            pieces.append(l)
391

392
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
393 394 395
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
396

397
        if not lines[-1][1].endswith('\n'):
398 399 400
            fm.plain('\n')

    fm.end()
401

402 403 404 405 406 407 408 409
@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'))
410
def archive(ui, repo, dest, **opts):
411
    '''create an unversioned archive of a repository revision
412

413 414
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
415

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

Matt Mackall's avatar
Matt Mackall committed
419 420 421 422 423 424 425 426 427 428 429 430
    .. 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*"

431
    Valid types are:
432

433 434 435 436 437 438
    :``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
439

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

443 444 445 446
    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.
447 448

    Returns 0 on success.
449 450
    '''

451
    opts = pycompat.byteskwargs(opts)
452
    ctx = scmutil.revsingle(repo, opts.get('rev'))
453
    if not ctx:
454
        raise error.Abort(_('no working directory: please specify a revision'))
455
    node = ctx.node()
456
    dest = cmdutil.makefilename(repo, dest, node)
457
    if os.path.realpath(dest) == repo.root:
458
        raise error.Abort(_('repository root cannot be destination'))
459

460
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
461
    prefix = opts.get('prefix')
462

463 464
    if dest == '-':
        if kind == 'files':
465
            raise error.Abort(_('cannot archive plain files to stdout'))
466
        dest = cmdutil.makefileobj(repo, dest)
467 468
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
469

470
    prefix = cmdutil.makefilename(repo, prefix, node)
471
    matchfn = scmutil.match(ctx, [], opts)
472
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
473
                     matchfn, prefix, subrepos=opts.get('subrepos'))
474

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

489
    Prepare a new changeset with the effect of REV undone in the
490 491
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
492

493
    If REV is the parent of the working directory, then this new changeset
494
    is committed automatically (unless --no-commit is specified).
495

496
    .. note::
497

498
       :hg:`backout` cannot be used to fix either an unwanted or
499
       incorrect merge.
500

Matt Mackall's avatar
Matt Mackall committed
501 502
    .. container:: verbose

503 504 505 506 507 508 509 510 511 512 513 514
      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
515
        leave changes uncommitted::
516

517 518
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
519

Matt Mackall's avatar
Matt Mackall committed
520 521 522 523 524 525 526 527 528
      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.
529

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

532 533 534
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

535 536
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
537
    '''
538 539 540 541
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
542
        return _dobackout(ui, repo, node, rev, **opts)
543 544 545
    finally:
        release(lock, wlock)

546
def _dobackout(ui, repo, node=None, rev=None, **opts):
547
    opts = pycompat.byteskwargs(opts)
548 549
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
550 551
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
552

Daniel Holth's avatar
Daniel Holth committed
553
    if rev and node:
554
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
555 556 557

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

559
    if not rev:
560
        raise error.Abort(_("please specify a revision to backout"))
561

562 563 564 565
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

566
    cmdutil.checkunfinished(repo)
567
    cmdutil.bailifchanged(repo)
568
    node = scmutil.revsingle(repo, rev).node()
569

570
    op1, op2 = repo.dirstate.parents()
571
    if not repo.changelog.isancestor(node, op1):
572
        raise error.Abort(_('cannot backout change that is not an ancestor'))
573

574 575
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
576
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
577
    if p2 != nullid:
578
        if not opts.get('parent'):
579
            raise error.Abort(_('cannot backout a merge changeset'))
580 581
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
582
            raise error.Abort(_('%s is not a parent of %s') %
583
                             (short(p), short(node)))
584 585
        parent = p
    else:
586
        if opts.get('parent'):
587
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
588
        parent = p1
589

590
    # the backout should appear on the same branch
591 592 593 594
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
595
        dsguard = dirstateguard.dirstateguard(repo, 'backout')
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
        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())

615 616 617 618 619
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
620 621 622

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
623 624
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
        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', '', '')
651
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
652

653 654 655 656 657 658 659 660 661
@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]"))
662
def bisect(ui, repo, rev=None, extra=None, command=None,
663 664
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
665 666
    """subdivision search of changesets

667 668 669 670 671 672 673 674 675 676 677 678 679
    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.
680 681 682 683 684 685
    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.
686

687 688 689 690
    .. container:: verbose

      Some examples:

691
      - start a bisection with known bad revision 34, and good revision 12::
692 693 694 695 696 697 698 699 700 701

          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
702
      - mark the current revision, or a known revision, to be skipped (e.g. if
703 704 705 706 707
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

708
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
709

710
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
711

712 713 714 715 716 717 718 719 720 721
      - 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
722
          hg bisect --command "make && make tests"
723 724 725 726 727 728

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

          hg log -r "bisect(pruned)"

729 730 731 732 733
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

734 735 736 737
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

738
      - you can even get a nice graph::
739 740 741

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

742
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
743

744
    Returns 0 on success.
745 746 747 748 749 750 751 752 753 754 755
    """
    # 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
756
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
757
        raise error.Abort(_('incompatible arguments'))
758 759

    if reset:
760
        hbisect.resetstate(repo)
761 762
        return

763 764
    state = hbisect.load_state(repo)

765 766 767 768 769 770 771 772 773 774 775 776 777
    # 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)
778 779
        if not (state['good'] and state['bad']):
            return
780

781 782 783 784
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
785
        cmdutil.checkunfinished(repo)
786 787 788
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

789 790
    displayer = cmdutil.show_changeset(ui, repo, {})

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

838
    hbisect.checkstate(state)
839 840

    # actually bisect
841
    nodes, changesets, good = hbisect.bisect(repo.changelog, state)
842 843
    if extend:
        if not changesets:
844
            extendnode = hbisect.extendrange(repo, state, nodes, good)
845
            if extendnode is not None:
846 847
                ui.write(_("Extending search to changeset %d:%s\n")
                         % (extendnode.rev(), extendnode))
848 849
                state['current'] = [extendnode.node()]
                hbisect.save_state(repo, state)
850
                return mayupdate(repo, extendnode.node())
851
        raise error.Abort(_("nothing to extend"))
852

853
    if changesets == 0:
854
        hbisect.printresult(ui, repo, state, displayer, nodes, good)
855 856 857
    else:
        assert len(nodes) == 1 # only a single node can be tested next
        node = nodes[0]
858 859 860 861 862
        # compute the approximate number of remaining tests
        tests, size = 0, 2
        while size <= changesets:
            tests, size = tests + 1, size * 2
        rev = repo.changelog.rev(node)
863 864
        ui.write(_