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 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,
52
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
53
    scmutil,
54
    server,
Gregory Szorc's avatar
Gregory Szorc committed
55 56
    sshserver,
    streamclone,
57
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
58 59 60 61 62 63
    templatekw,
    ui as uimod,
    util,
)

release = lockmod.release
64

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

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

# common command options

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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

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

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

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

280 281 282 283
    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.
284 285

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

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

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

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

334 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)),
             ('file', ' ', lambda x: x.fctx.path(), str),
             ('line_number', ':', lambda x: x.lineno, str),
340
            ]
341
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
342

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

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

351 352
    ui.pager('annotate')

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

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

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

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

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

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

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

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

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

418
    rootfm.end()
419

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

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

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

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

449
    Valid types are:
450

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

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

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

    Returns 0 on success.
467 468
    '''

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

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

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

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

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

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

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

517
    .. note::
518

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

708 709 710 711
    .. container:: verbose

      Some examples:

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

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

          hg bisect --skip
          hg bisect --skip 23

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

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

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

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

          hg log -r "bisect(pruned)"

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

          hg log -r "bisect(current)"

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

          hg log -r "bisect(range)"

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

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

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

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

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

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

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

799 800
    state = hbisect.load_state(repo)

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

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

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

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