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 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
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,
29
    debugcommands as debugcommandsmod,
Gregory Szorc's avatar
Gregory Szorc committed
30
    destutil,
31
    dirstateguard,
Gregory Szorc's avatar
Gregory Szorc committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45
    discovery,
    encoding,
    error,
    exchange,
    extensions,
    graphmod,
    hbisect,
    help,
    hg,
    lock as lockmod,
    merge as mergemod,
    obsolete,
    patch,
    phases,
46
    pycompat,
47
    rcutil,
48
    registrar,
49
    revsetlang,
Gregory Szorc's avatar
Gregory Szorc committed
50
    scmutil,
51
    server,
Gregory Szorc's avatar
Gregory Szorc committed
52 53
    sshserver,
    streamclone,
54
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
55 56 57 58 59 60
    templatekw,
    ui as uimod,
    util,
)

release = lockmod.release
61

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

65
command = registrar.command(table)
66

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

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

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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')),
    ('l', 'line-number', None, _('show line number at the first appearance'))
266
    ] + diffwsopts + walkopts + formatteropts,
267 268
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
269
def annotate(ui, repo, *pats, **opts):
270
    """show changeset information by line for each file
271

272
    List changes in files, showing the revision id responsible for
273
    each line.
274

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

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

281 282 283 284
    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.
285 286

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

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

297 298
    ctx = scmutil.revsingle(repo, opts.get('rev'))

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

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

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

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

349 350
    ui.pager('annotate')

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

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

366 367
    m = scmutil.match(ctx, pats, opts, badfn=bad)

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

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

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

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

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

    fm.end()
403

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

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

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

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

433
    Valid types are:
434

435 436 437 438 439 440
    :``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
441

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

445 446 447 448
    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.
449 450

    Returns 0 on success.
451 452
    '''

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

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

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

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

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

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

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

498
    .. note::
499

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

Matt Mackall's avatar
Matt Mackall committed
503 504
    .. container:: verbose

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

519 520
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
521

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

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

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

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

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

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

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

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

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

568
    cmdutil.checkunfinished(repo)
569
    cmdutil.bailifchanged(repo)
570
    node = scmutil.revsingle(repo, rev).node()
571

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

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

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

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

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

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

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

689 690 691 692
    .. container:: verbose

      Some examples:

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

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

          hg bisect --skip
          hg bisect --skip 23

710
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
711

712
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
713

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

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

          hg log -r "bisect(pruned)"

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

          hg log -r "bisect(current)"

736 737 738 739
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

740
      - you can even get a nice graph::
741 742 743

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

744
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
745

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

    if reset:
762
        hbisect.resetstate(repo)
763 764
        return

765 766
    state = hbisect.load_state(repo)

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

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

791 792
    displayer = cmdutil.show_changeset(ui, repo, {})

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

840
    hbisect.checkstate(state)
841 842

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

855
    if changesets == 0:
856
        hbisect.printresult(ui, repo, state, displayer, nodes, good)
857 858 859