commands.py 198 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
    discovery,
    encoding,
    error,
    exchange,
    extensions,
Yuya Nishihara's avatar
Yuya Nishihara committed
38
    formatter,
Gregory Szorc's avatar
Gregory Szorc committed
39 40 41 42 43 44 45 46 47
    graphmod,
    hbisect,
    help,
    hg,
    lock as lockmod,
    merge as mergemod,
    obsolete,
    patch,
    phases,
48
    pycompat,
49
    rcutil,
50
    registrar,
51
    revsetlang,
Gregory Szorc's avatar
Gregory Szorc committed
52
    scmutil,
53
    server,
Gregory Szorc's avatar
Gregory Szorc committed
54 55
    sshserver,
    streamclone,
56
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
57 58 59 60 61 62
    templatekw,
    ui as uimod,
    util,
)

release = lockmod.release
63

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

67
command = registrar.command(table)
68

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

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

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

302
    rootfm = ui.formatter('annotate', opts)
303 304 305 306
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
307 308 309 310 311
    if ctx.rev() is None:
        def hexfn(node):
            if node is None:
                return None
            else:
312
                return rootfm.hexfunc(node)
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
        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:
328
                return '%s+' % rootfm.hexfunc(ctx.p1().node())
329 330 331
            else:
                return '%s ' % hex
    else:
332
        hexfn = rootfm.hexfunc
333
        formatrev = formathex = str
334

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

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

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

352 353
    ui.pager('annotate')

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

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

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

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

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

385
        fm = rootfm
386
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
387
                              skiprevs=skiprevs, diffopts=diffopts)
388 389
        if not lines:
            continue
390
        formats = []
391 392
        pieces = []

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

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

408
        if not lines[-1][1].endswith('\n'):
409 410
            fm.plain('\n')

411
    rootfm.end()
412

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

424 425
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
426

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

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

442
    Valid types are:
443

444 445 446 447 448 449
    :``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
450

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

454 455 456 457
    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.
458 459

    Returns 0 on success.
460 461
    '''

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

471
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
472
    prefix = opts.get('prefix')
473

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

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

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

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

504
    If REV is the parent of the working directory, then this new changeset
505
    is committed automatically (unless --no-commit is specified).
506

507
    .. note::
508

509
       :hg:`backout` cannot be used to fix either an unwanted or
510
       incorrect merge.
511

Matt Mackall's avatar
Matt Mackall committed
512 513
    .. container:: verbose

514 515 516 517 518 519 520 521 522 523 524 525
      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
526
        leave changes uncommitted::
527

528 529
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
530

Matt Mackall's avatar
Matt Mackall committed
531 532 533 534 535 536 537 538 539
      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.
540

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

543 544 545
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

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

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

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

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

570
    if not rev:
571
        raise error.Abort(_("please specify a revision to backout"))
572

573 574 575 576
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

577
    cmdutil.checkunfinished(repo)
578
    cmdutil.bailifchanged(repo)
579
    node = scmutil.revsingle(repo, rev).node()
580

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

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

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

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

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

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

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

698 699 700 701
    .. container:: verbose

      Some examples:

702
      - start a bisection with known bad revision 34, and good revision 12::
703 704 705 706 707 708 709 710 711 712

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

          hg bisect --skip
          hg bisect --skip 23

719
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
720

721
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
722

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

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

          hg log -r "bisect(pruned)"

740 741 742 743 744
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

745 746 747 748
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

749
      - you can even get a nice graph::
750 751 752

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

753
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
754

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

    if reset:
771
        hbisect.resetstate(repo)
772 773
        return

774 775
    state = hbisect.load_state(repo)

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

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

800 801
    displayer = cmdutil.show_changeset(ui, repo, {})

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

849
    hbisect.checkstate(state)
850 851

    # actually bisect