commands.py 200 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
readonly = registrar.command.readonly
69 70 71 72 73 74 75 76 77 78

# common command options

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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

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

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

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

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

279 280 281 282
    Without the -a/--text option, annotate will avoid processing files
    it detects as binary. With -a, annotate will annotate the file
    anyway, although the results will probably be neither useful
    nor desirable.
283 284

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

290 291 292
    if opts.get('follow'):
        # --follow is deprecated and now just an alias for -f/--file
        # to mimic the behavior of Mercurial before version 1.5
293
        opts['file'] = True
294

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

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

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

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

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

347 348
    ui.pager('annotate')

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

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

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

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

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

382
        fm = rootfm.nested('lines')
383
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
384
                              skiprevs=skiprevs, diffopts=diffopts)
385
        if not lines:
386
            fm.end()
387
            continue
388
        formats = []
389 390
        pieces = []

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

401
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
402 403
            fm.startitem()
            fm.write(fields, "".join(f), *p)
404 405 406 407 408
            if l[0].skip:
                fmt = "* %s"
            else:
                fmt = ": %s"
            fm.write('line', fmt, l[1])
409

410
        if not lines[-1][1].endswith('\n'):
411
            fm.plain('\n')
412
        fm.end()
413

414
    rootfm.end()
415

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

427 428
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
429

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

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

445
    Valid types are:
446

447 448 449 450 451 452
    :``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
453

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

457 458 459 460
    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.
461 462

    Returns 0 on success.
463 464
    '''

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

474
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
475
    prefix = opts.get('prefix')
476

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

484
    prefix = cmdutil.makefilename(repo, prefix, node)
485
    match = scmutil.match(ctx, [], opts)
486
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
487
                     match, prefix, subrepos=opts.get('subrepos'))
488

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

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

507
    If REV is the parent of the working directory, then this new changeset
508
    is committed automatically (unless --no-commit is specified).
509

510
    .. note::
511

512
       :hg:`backout` cannot be used to fix either an unwanted or
513
       incorrect merge.
514

Matt Mackall's avatar
Matt Mackall committed
515 516
    .. container:: verbose

517 518 519 520 521 522 523 524 525 526 527 528
      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
529
        leave changes uncommitted::
530

531 532
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
533

Matt Mackall's avatar
Matt Mackall committed
534 535 536 537 538 539 540 541 542
      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.
543

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

546 547 548
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

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

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

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

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

573
    if not rev:
574
        raise error.Abort(_("please specify a revision to backout"))
575

576 577 578 579
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

580
    cmdutil.checkunfinished(repo)
581
    cmdutil.bailifchanged(repo)
582
    node = scmutil.revsingle(repo, rev).node()
583

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

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

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

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

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

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

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

701 702 703 704
    .. container:: verbose

      Some examples:

705
      - start a bisection with known bad revision 34, and good revision 12::
706 707 708 709 710 711 712 713 714 715

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

          hg bisect --skip
          hg bisect --skip 23

722
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
723

724
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
725

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

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

          hg log -r "bisect(pruned)"

743 744 745 746 747
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

748 749 750 751
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

752
      - you can even get a nice graph::
753 754 755

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

756
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
757

758
    Returns 0 on success.
759 760 761 762 763 764 765 766 767 768 769
    """
    # 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
770
    elif extra:
771
        raise error.Abort(_('incompatible arguments'))
772

773 774 775 776 777 778 779 780 781
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

782 783 784 785 786
    enabled = [x for x in incompatibles if incompatibles[x]]

    if len(enabled) > 1:
        raise error.Abort(_('%s and %s are incompatible') %
                          tuple(sorted(enabled)[0:2]))
787

788
    if reset:
789
        hbisect.resetstate(repo)
790 791
        return

792 793
    state = hbisect.load_state(repo)

794 795 796 797 798 799 800 801 802 803 804 805 806
    # 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)
807 808
        if not (state['good'] and state['bad']):
            return
809

810 811 812 813
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
814
        cmdutil.checkunfinished(repo)
815 816 817
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

818 819
    displayer = cmdutil.show_changeset(ui, repo, {})

820 821
    if command:
        changesets = 1
822 823 824 825
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
826
                raise error.Abort(_('current bisect revision is unknown - '
827
                                   'start a new bisect to fix'))
828
        else:
829 830
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
831
                raise error.Abort(_('current bisect revision is a merge'))
832 833
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
834 835 836
        try:
            while changesets:
                # update state
837
                state['current'] = [node]
838
                hbisect.save_state(repo, state)
839 840
                status = ui.system(command, environ={'HG_NODE': hex(node)},
                                   blockedtag='bisect_check')
841 842 843 844 845 846
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
847
                    raise error.Abort(_("failed to execute %s") % command)
848
                elif status < 0:
849
                    raise error.Abort(_("%s killed") % command)
850 851
                else:
                    transition = "bad"
852 853
                state[transition].append(node)
                ctx = repo[node]
854
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
855
                hbisect.checkstate(state)
856
                # bisect
857
                nodes, changesets, bgood = hbisect.bisect(repo, state)
858
                # update to next check
859
                node = nodes[0]
Pierre-Yves David's avatar