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

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

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

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

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

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

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

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

300
    fm = ui.formatter('annotate', opts)
301 302 303 304
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
    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
332

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

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

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

350 351
    ui.pager('annotate')

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

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

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

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

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

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

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

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

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

    fm.end()
408

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

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

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

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

438
    Valid types are:
439

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

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

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

    Returns 0 on success.
456 457
    '''

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

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

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

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

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

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

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

503
    .. note::
504

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

694 695 696 697
    .. container:: verbose

      Some examples:

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

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

          hg bisect --skip
          hg bisect --skip 23

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

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

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

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

          hg log -r "bisect(pruned)"

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

          hg log -r "bisect(current)"

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

          hg log -r "bisect(range)"

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

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

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

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

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

770 771
    state = hbisect.load_state(repo)

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

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

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

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

845
    hbisect.checkstate(state)
846 847

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