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

release = lockmod.release
65

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

69
command = registrar.command(table)
70
readonly = registrar.command.readonly
71 72 73 74 75 76 77 78 79 80

# common command options

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

297 298 299 300
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
301

302
    rootfm = ui.formatter('annotate', opts)
303 304 305 306
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
307 308 309 310 311
    if ctx.rev() is None:
        def hexfn(node):
            if node is None:
                return None
            else:
312
                return rootfm.hexfunc(node)
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
        if opts.get('changeset'):
            # omit "+" suffix which is appended to node hex
            def formatrev(rev):
                if rev is None:
                    return '%d' % ctx.p1().rev()
                else:
                    return '%d' % rev
        else:
            def formatrev(rev):
                if rev is None:
                    return '%d+' % ctx.p1().rev()
                else:
                    return '%d ' % rev
        def formathex(hex):
            if hex is None:
328
                return '%s+' % rootfm.hexfunc(ctx.p1().node())
329 330 331
            else:
                return '%s ' % hex
    else:
332
        hexfn = rootfm.hexfunc
333
        formatrev = formathex = pycompat.bytestr
334

335 336 337 338 339 340
    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),
341
            ]
342
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
343

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

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

352 353
    ui.pager('annotate')

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

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

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

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

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

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

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

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

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

419
    rootfm.end()
420

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

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

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

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

450
    Valid types are:
451

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

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

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

    Returns 0 on success.
468 469
    '''

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

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

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

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

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

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

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

518
    .. note::
519

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
645 646
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
647 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
        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', '', '')
673
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
674

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

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

709 710 711 712
    .. container:: verbose

      Some examples:

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

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

          hg bisect --skip
          hg bisect --skip 23

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

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

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

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

          hg log -r "bisect(pruned)"

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

          hg log -r "bisect(current)"

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

          hg log -r "bisect(range)"

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

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

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

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

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

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

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

800 801
    state = hbisect.load_state(repo)

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

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

826 827
    displayer = cmdutil.show_changeset(ui, repo, {})

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