commands.py 202 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
    graphmod,
    hbisect,
    help,
    hg,
    lock as lockmod,
44
    logcmdutil,
Gregory Szorc's avatar
Gregory Szorc committed
45 46
    merge as mergemod,
    obsolete,
47
    obsutil,
Gregory Szorc's avatar
Gregory Szorc committed
48 49
    patch,
    phases,
50
    pycompat,
51
    rcutil,
52
    registrar,
53
    revsetlang,
54
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
55
    scmutil,
56
    server,
Gregory Szorc's avatar
Gregory Szorc committed
57
    streamclone,
58
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
59 60 61
    templatekw,
    ui as uimod,
    util,
62
    wireprotoserver,
Gregory Szorc's avatar
Gregory Szorc committed
63 64 65
)

release = lockmod.release
66

67
table = {}
68
table.update(debugcommandsmod.command._table)
69

70
command = registrar.command(table)
71
readonly = registrar.command.readonly
72 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 300 301
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
302

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

336 337 338 339
    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)),
340 341
             ('file', ' ', lambda x: x.fctx.path(), pycompat.bytestr),
             ('line_number', ':', lambda x: x.lineno, pycompat.bytestr),
342
            ]
343
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
344

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

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

353 354
    ui.pager('annotate')

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

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

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

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

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

388
        fm = rootfm.nested('lines')
389
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
390
                              skiprevs=skiprevs, diffopts=diffopts)
391
        if not lines:
392
            fm.end()
393
            continue
394
        formats = []
395 396
        pieces = []

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

407
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
408 409
            fm.startitem()
            fm.write(fields, "".join(f), *p)
410 411 412 413 414
            if l[0].skip:
                fmt = "* %s"
            else:
                fmt = ": %s"
            fm.write('line', fmt, l[1])
415

416
        if not lines[-1][1].endswith('\n'):
417
            fm.plain('\n')
418
        fm.end()
419

420
    rootfm.end()
421

422 423 424 425 426 427 428 429
@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'))
430
def archive(ui, repo, dest, **opts):
431
    '''create an unversioned archive of a repository revision
432

433 434
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
435

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

Matt Mackall's avatar
Matt Mackall committed
439 440 441 442 443 444 445 446 447 448 449 450
    .. 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*"

451
    Valid types are:
452

453 454 455 456 457 458
    :``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
459

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

463 464 465 466
    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.
467 468

    Returns 0 on success.
469 470
    '''

471
    opts = pycompat.byteskwargs(opts)
472 473 474 475
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
476
    if not ctx:
477
        raise error.Abort(_('no working directory: please specify a revision'))
478
    node = ctx.node()
479
    dest = cmdutil.makefilename(ctx, dest)
480
    if os.path.realpath(dest) == repo.root:
481
        raise error.Abort(_('repository root cannot be destination'))
482

483
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
484
    prefix = opts.get('prefix')
485

486 487
    if dest == '-':
        if kind == 'files':
488
            raise error.Abort(_('cannot archive plain files to stdout'))
489
        dest = cmdutil.makefileobj(repo, dest, node)
490 491
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
492

493
    prefix = cmdutil.makefilename(ctx, prefix)
494
    match = scmutil.match(ctx, [], opts)
495
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
496
                     match, prefix, subrepos=opts.get('subrepos'))
497

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

512
    Prepare a new changeset with the effect of REV undone in the
513 514
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
515

516
    If REV is the parent of the working directory, then this new changeset
517
    is committed automatically (unless --no-commit is specified).
518

519
    .. note::
520

521
       :hg:`backout` cannot be used to fix either an unwanted or
522
       incorrect merge.
523

Matt Mackall's avatar
Matt Mackall committed
524 525
    .. container:: verbose

526 527 528 529 530 531 532 533 534 535 536 537
      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
538
        leave changes uncommitted::
539

540 541
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
542

Matt Mackall's avatar
Matt Mackall committed
543 544 545 546 547 548 549 550 551
      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.
552

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

555 556 557
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

558 559
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
560
    '''
561 562 563 564
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
565
        return _dobackout(ui, repo, node, rev, **opts)
566 567 568
    finally:
        release(lock, wlock)

569
def _dobackout(ui, repo, node=None, rev=None, **opts):
570
    opts = pycompat.byteskwargs(opts)
571 572
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
573 574
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
575

Daniel Holth's avatar
Daniel Holth committed
576
    if rev and node:
577
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
578 579 580

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

582
    if not rev:
583
        raise error.Abort(_("please specify a revision to backout"))
584

585 586 587 588
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

589
    cmdutil.checkunfinished(repo)
590
    cmdutil.bailifchanged(repo)
591
    node = scmutil.revsingle(repo, rev).node()
592

593
    op1, op2 = repo.dirstate.parents()
594
    if not repo.changelog.isancestor(node, op1):
595
        raise error.Abort(_('cannot backout change that is not an ancestor'))
596

597 598
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
599
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
600
    if p2 != nullid:
601
        if not opts.get('parent'):
602
            raise error.Abort(_('cannot backout a merge changeset'))
603 604
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
605
            raise error.Abort(_('%s is not a parent of %s') %
606
                             (short(p), short(node)))
607 608
        parent = p
    else:
609
        if opts.get('parent'):
610
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
611
        parent = p1
612

613
    # the backout should appear on the same branch
614 615 616 617
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
618
        dsguard = dirstateguard.dirstateguard(repo, 'backout')
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
        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())

638 639 640 641 642
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
643 644 645

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
646 647
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
        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', '', '')
674
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
675

676 677 678 679 680 681 682 683 684
@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]"))
685
def bisect(ui, repo, rev=None, extra=None, command=None,
686 687
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
688 689
    """subdivision search of changesets

690 691 692 693 694 695 696 697 698 699 700 701 702
    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.
703 704 705 706 707 708
    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.
709

710 711 712 713
    .. container:: verbose

      Some examples:

714
      - start a bisection with known bad revision 34, and good revision 12::
715 716 717 718 719 720 721 722 723 724

          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
725
      - mark the current revision, or a known revision, to be skipped (e.g. if
726 727 728 729 730
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

731
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
732

733
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
734

735 736 737 738 739 740 741 742 743 744
      - 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
745
          hg bisect --command "make && make tests"
746 747 748 749 750 751

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

          hg log -r "bisect(pruned)"

752 753 754 755 756
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

757 758 759 760
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

761
      - you can even get a nice graph::
762 763 764

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

765
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
766

767
    Returns 0 on success.
768 769 770 771 772 773 774 775 776 777 778
    """
    # 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
779
    elif extra:
780
        raise error.Abort(_('incompatible arguments'))
781

782 783 784 785 786 787 788 789 790
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

791 792 793 794 795
    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]))
796

797
    if reset:
798
        hbisect.resetstate(repo)
799 800
        return

801 802
    state = hbisect.load_state(repo)

803 804 805 806 807 808 809 810 811 812 813 814 815
    # 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)
816 817
        if not (state['good'] and state['bad']):
            return
818

819 820 821 822
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
823
        cmdutil.checkunfinished(repo)
824 825 826
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

827
    displayer = logcmdutil.changesetdisplayer(ui, repo, {})
828

829 830
    if command:
        changesets = 1
831 832 833 834
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
835
                raise error.Abort(_('current bisect revision is unknown - '
836
                                   'start a new bisect to fix'))
837
        else:
838 839
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
840
                raise error.Abort(_('current bisect revision is a merge'))
841 842
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
843 844 845
        try:
            while changesets:
                # update state
846
                state['current'] = [node]
847
                hbisect.save_state(repo, state)
848 849
                status = ui.system(command, environ={'HG_NODE': hex(node)},
                                   blockedtag='bisect_check')
850 851 852 853 854 855
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
856
                    raise error.Abort(_("failed to execute %s") % command)
857
                elif status < 0: