commands.py 228 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

8
from node import hex, bin, nullid, nullrev, short
9
from lock import release
10
from i18n import _
11
import os, re, difflib, time, tempfile, errno, shlex
12
import sys, socket
13
import hg, scmutil, util, revlog, copies, error, bookmarks
14
import patch, help, encoding, templatekw, discovery
15
import archival, changegroup, cmdutil, hbisect
16
import sshserver, hgweb, commandserver
17
import extensions
18
from hgweb import server as hgweb_server
19
import merge as mergemod
20
import minirst, revset, fileset
21
import dagparser, context, simplemerge, graphmod, copies
22 23
import random
import setdiscovery, treediscovery, dagutil, pvec, localrepo
24
import phases, obsolete, exchange, bundle2
25
import ui as uimod
26

27 28 29 30
table = {}

command = cmdutil.command(table)

31 32 33
# Space delimited list of commands that don't require local repositories.
# This should be populated by passing norepo=True into the @command decorator.
norepo = ''
34 35 36 37
# Space delimited list of commands that optionally require local repositories.
# This should be populated by passing optionalrepo=True into the @command
# decorator.
optionalrepo = ''
38 39 40 41 42
# Space delimited list of commands that will examine arguments looking for
# a repository. This should be populated by passing inferrepo=True into the
# @command decorator.
inferrepo = ''

43 44 45 46 47 48 49 50 51
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
52
     _('do not prompt, automatically pick the first choice for all prompts')),
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
    ('', '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')),
69
    ('', 'hidden', False, _('consider hidden changesets')),
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
]

dryrunopts = [('n', 'dry-run', None,
               _('do not perform actions, just print output'))]

remoteopts = [
    ('e', 'ssh', '',
     _('specify ssh command to use'), _('CMD')),
    ('', 'remotecmd', '',
     _('specify hg command to run on the remote side'), _('CMD')),
    ('', 'insecure', None,
     _('do not verify server certificate (ignoring web.cacerts config)')),
]

walkopts = [
    ('I', 'include', [],
     _('include names matching the given patterns'), _('PATTERN')),
    ('X', 'exclude', [],
     _('exclude names matching the given patterns'), _('PATTERN')),
]

commitopts = [
    ('m', 'message', '',
     _('use text as commit message'), _('TEXT')),
    ('l', 'logfile', '',
     _('read commit message from file'), _('FILE')),
]

commitopts2 = [
    ('d', 'date', '',
     _('record the specified date as commit date'), _('DATE')),
    ('u', 'user', '',
     _('record the specified user as committer'), _('USER')),
]

105 106 107 108 109 110
# hidden for now
formatteropts = [
    ('T', 'template', '',
     _('display with template (DEPRECATED)'), _('TEMPLATE')),
]

111 112
templateopts = [
    ('', 'style', '',
113
     _('display using template map file (DEPRECATED)'), _('STYLE')),
114
    ('T', 'template', '',
115 116 117 118 119 120 121 122 123 124
     _('display with template'), _('TEMPLATE')),
]

logopts = [
    ('p', 'patch', None, _('show patch')),
    ('g', 'git', None, _('use git extended diff format')),
    ('l', 'limit', '',
     _('limit number of changes displayed'), _('NUM')),
    ('M', 'no-merges', None, _('do not show merges')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
125
    ('G', 'graph', None, _("show the revision DAG")),
126 127 128 129 130 131 132 133
] + templateopts

diffopts = [
    ('a', 'text', None, _('treat all files as text')),
    ('g', 'git', None, _('use git extended diff format')),
    ('', 'nodates', None, _('omit dates from diff headers'))
]

134
diffwsopts = [
135 136 137 138 139 140
    ('w', 'ignore-all-space', None,
     _('ignore white space when comparing lines')),
    ('b', 'ignore-space-change', None,
     _('ignore changes in the amount of white space')),
    ('B', 'ignore-blank-lines', None,
     _('ignore changes whose lines are all blank')),
141 142 143
    ]

diffopts2 = [
144
    ('', 'noprefix', None, _('omit a/ and b/ prefixes from filenames')),
145 146 147
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
148 149 150 151 152
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
]

153 154 155 156
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

157 158 159 160 161 162 163 164 165 166
similarityopts = [
    ('s', 'similarity', '',
     _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))
]

subrepoopts = [
    ('S', 'subrepos', None,
     _('recurse into subrepositories'))
]

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

169 170
@command('^add',
    walkopts + subrepoopts + dryrunopts,
171 172
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
173
def add(ui, repo, *pats, **opts):
174 175
    """add the specified files on the next commit

176 177
    Schedule files to be version controlled and added to the
    repository.
178

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

182
    If no names are given, add all files to the repository.
183 184 185 186

    .. container:: verbose

       An example showing how new (unknown) files are added
Martin Geisler's avatar
Martin Geisler committed
187
       automatically by :hg:`add`::
188 189 190 191 192 193 194 195

         $ ls
         foo.c
         $ hg status
         ? foo.c
         $ hg add
         adding foo.c
         $ hg status
196
         A foo.c
197 198

    Returns 0 if all files are successfully added.
199 200
    """

201
    m = scmutil.match(repo[None], pats, opts)
202
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
203
    return rejected and 1 or 0
204

205
@command('addremove',
206
    similarityopts + subrepoopts + walkopts + dryrunopts,
207 208
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
209
def addremove(ui, repo, *pats, **opts):
210
    """add all new files, delete all missing files
211

212 213
    Add all new files and remove all missing files from the
    repository.
214

215
    New files are ignored if they match any of the patterns in
216
    ``.hgignore``. As with add, these changes take effect at the next
217
    commit.
218

219
    Use the -s/--similarity option to detect renamed files. This
220
    option takes a percentage between 0 (disabled) and 100 (files must
221 222 223
    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
224
    can be expensive. After using this option, :hg:`status -C` can be
225 226 227
    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.
228 229

    Returns 0 if all files are successfully added.
230
    """
231
    try:
232
        sim = float(opts.get('similarity') or 100)
233 234
    except ValueError:
        raise util.Abort(_('similarity must be a number'))
235 236
    if sim < 0 or sim > 100:
        raise util.Abort(_('similarity must be between 0 and 100'))
237
    matcher = scmutil.match(repo[None], pats, opts)
238
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
239

240 241 242 243 244 245 246 247 248 249 250 251
@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')),
    ('l', 'line-number', None, _('show line number at the first appearance'))
252
    ] + diffwsopts + walkopts + formatteropts,
253 254
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
255
def annotate(ui, repo, *pats, **opts):
256
    """show changeset information by line for each file
257

258 259
    List changes in files, showing the revision id responsible for
    each line
260

261 262
    This command is useful for discovering when a change was made and
    by whom.
263

264 265 266 267
    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.
268 269

    Returns 0 on success.
270
    """
271 272 273
    if not pats:
        raise util.Abort(_('at least one filename or pattern is required'))

274 275 276
    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
277
        opts['file'] = True
278

279
    fm = ui.formatter('annotate', opts)
280
    datefunc = ui.quiet and util.shortdate or util.datestr
281
    hexfn = fm.hexfunc
282

283 284 285 286 287 288
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
             ('number', ' ', lambda x: x[0].rev(), str),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), str),
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
289
            ]
290
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
291

292
    if (not opts.get('user') and not opts.get('changeset')
293
        and not opts.get('date') and not opts.get('file')):
294
        opts['number'] = True
295

296
    linenumber = opts.get('line_number') is not None
297
    if linenumber and (not opts.get('changeset')) and (not opts.get('number')):
298 299
        raise util.Abort(_('at least one of -n/-c is required for -l'))

300 301 302 303 304 305
    if fm:
        def makefunc(get, fmt):
            return get
    else:
        def makefunc(get, fmt):
            return lambda x: fmt(get(x))
306 307
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
308
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
309 310
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
311

312 313 314
    def bad(x, y):
        raise util.Abort("%s: %s" % (x, y))

315
    ctx = scmutil.revsingle(repo, opts.get('rev'))
316
    m = scmutil.match(ctx, pats, opts)
317
    m.bad = bad
318
    follow = not opts.get('no_follow')
319 320
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
321 322
    for abs in ctx.walk(m):
        fctx = ctx[abs]
323
        if not opts.get('text') and util.binary(fctx.data()):
324
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
325 326
            continue

327 328
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
329
        formats = []
330 331
        pieces = []

332
        for f, sep in funcmap:
333 334
            l = [f(n) for n, dummy in lines]
            if l:
335 336 337 338 339 340
                if fm:
                    formats.append(['%s' for x in l])
                else:
                    sizes = [encoding.colwidth(x) for x in l]
                    ml = max(sizes)
                    formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
341
                pieces.append(l)
342

343
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
344 345 346
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
347

348
        if lines and not lines[-1][1].endswith('\n'):
349 350 351
            fm.plain('\n')

    fm.end()
352

353 354 355 356 357 358 359 360
@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'))
361
def archive(ui, repo, dest, **opts):
362
    '''create an unversioned archive of a repository revision
363

364 365
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
366

367 368 369
    The archive type is automatically detected based on file
    extension (or override using -t/--type).

Matt Mackall's avatar
Matt Mackall committed
370 371 372 373 374 375 376 377 378 379 380 381
    .. 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*"

382
    Valid types are:
383

384 385 386 387 388 389
    :``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
390

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

394 395 396 397
    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.
398 399

    Returns 0 on success.
400 401
    '''

402
    ctx = scmutil.revsingle(repo, opts.get('rev'))
403
    if not ctx:
404
        raise util.Abort(_('no working directory: please specify a revision'))
405
    node = ctx.node()
406
    dest = cmdutil.makefilename(repo, dest, node)
407
    if os.path.realpath(dest) == repo.root:
408
        raise util.Abort(_('repository root cannot be destination'))
409

410
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
411
    prefix = opts.get('prefix')
412

413 414 415
    if dest == '-':
        if kind == 'files':
            raise util.Abort(_('cannot archive plain files to stdout'))
416
        dest = cmdutil.makefileobj(repo, dest)
417 418
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
419

420
    prefix = cmdutil.makefilename(repo, prefix, node)
421
    matchfn = scmutil.match(ctx, [], opts)
422
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
423
                     matchfn, prefix, subrepos=opts.get('subrepos'))
424

425 426
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
Mateusz Kwapich's avatar
Mateusz Kwapich committed
427
    ('', 'commit', None, _('commit if no conflicts were encountered')),
428 429
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
430
    ('r', 'rev', '', _('revision to backout'), _('REV')),
431
    ('e', 'edit', False, _('invoke editor on commit messages')),
432
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
433
    _('[OPTION]... [-r] REV'))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
434
def backout(ui, repo, node=None, rev=None, commit=False, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
435 436
    '''reverse effect of earlier changeset

437 438 439
    Prepare a new changeset with the effect of REV undone in the
    current working directory.

440
    If REV is the parent of the working directory, then this new changeset
441 442 443
    is committed automatically. Otherwise, hg needs to merge the
    changes and the merged result is left uncommitted.

444
    .. note::
445

446 447 448
      backout cannot be used to fix either an unwanted or
      incorrect merge.

Matt Mackall's avatar
Matt Mackall committed
449 450 451 452 453 454 455 456 457 458 459
    .. container:: verbose

      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.
460

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

463 464
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
465
    '''
Daniel Holth's avatar
Daniel Holth committed
466 467 468 469 470
    if rev and node:
        raise util.Abort(_("please specify just one revision"))

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

472 473 474
    if not rev:
        raise util.Abort(_("please specify a revision to backout"))

475 476 477 478
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

479
    cmdutil.checkunfinished(repo)
480
    cmdutil.bailifchanged(repo)
481
    node = scmutil.revsingle(repo, rev).node()
482

483
    op1, op2 = repo.dirstate.parents()
484
    if not repo.changelog.isancestor(node, op1):
485
        raise util.Abort(_('cannot backout change that is not an ancestor'))
486

487 488
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
489
        raise util.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
490
    if p2 != nullid:
491
        if not opts.get('parent'):
492
            raise util.Abort(_('cannot backout a merge changeset'))
493 494
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
495
            raise util.Abort(_('%s is not a parent of %s') %
496
                             (short(p), short(node)))
497 498
        parent = p
    else:
499
        if opts.get('parent'):
500 501
            raise util.Abort(_('cannot use --parent on non-merge changeset'))
        parent = p1
502

503
    # the backout should appear on the same branch
504 505 506
    wlock = repo.wlock()
    try:
        branch = repo.dirstate.branch()
507
        bheads = repo.branchheads(branch)
508
        rctx = scmutil.revsingle(repo, hex(parent))
509 510
        if not opts.get('merge') and op1 != node:
            try:
511 512
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
513
                repo.dirstate.beginparentchange()
514 515
                stats = mergemod.update(repo, parent, True, True, False,
                                        node, False)
516
                repo.setparents(op1, op2)
517
                repo.dirstate.endparentchange()
518 519
                hg._showstats(repo, stats)
                if stats[3]:
520 521
                    repo.ui.status(_("use 'hg resolve' to retry unresolved "
                                     "file merges\n"))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
522 523
                    return 1
                elif not commit:
524 525 526
                    msg = _("changeset %s backed out, "
                            "don't forget to commit.\n")
                    ui.status(msg % short(node))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
527
                    return 0
528
            finally:
529
                ui.setconfig('ui', 'forcemerge', '', '')
530 531 532 533 534
        else:
            hg.clean(repo, node, show_stats=False)
            repo.dirstate.setbranch(branch)
            cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

535

536
        def commitfunc(ui, repo, message, match, opts):
537 538
            editform = 'backout'
            e = cmdutil.getcommiteditor(editform=editform, **opts)
539 540 541
            if not message:
                # we don't translate commit messages
                message = "Backed out changeset %s" % short(node)
542
                e = cmdutil.getcommiteditor(edit=True, editform=editform)
543 544 545
            return repo.commit(message, opts.get('user'), opts.get('date'),
                               match, editor=e)
        newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
546 547 548
        if not newnode:
            ui.status(_("nothing changed\n"))
            return 1
549
        cmdutil.commitstatus(repo, newnode, branch, bheads)
550

551 552 553 554 555 556 557 558 559
        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:
560 561
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
562 563
                return hg.merge(repo, hex(repo.changelog.tip()))
            finally:
564
                ui.setconfig('ui', 'forcemerge', '', '')
565 566
    finally:
        wlock.release()
567
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
568

569 570 571 572 573 574 575 576 577
@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]"))
578
def bisect(ui, repo, rev=None, extra=None, command=None,
579 580
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
581 582
    """subdivision search of changesets

583 584 585 586 587 588 589 590 591 592 593 594 595
    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.
596 597 598 599 600 601
    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.
602

603 604 605 606
    .. container:: verbose

      Some examples:

607
      - start a bisection with known bad revision 34, and good revision 12::
608 609 610 611 612 613 614 615 616 617

          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
618
      - mark the current revision, or a known revision, to be skipped (e.g. if
619 620 621 622 623
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

624
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
625

626
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
627

628 629 630 631 632 633 634 635 636 637
      - 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
638
          hg bisect --command "make && make tests"
639 640 641 642 643 644

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

          hg log -r "bisect(pruned)"

645 646 647 648 649
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

650 651 652 653
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

654
      - you can even get a nice graph::
655 656 657

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

658 659
      See :hg:`help revsets` for more about the `bisect()` keyword.

660
    Returns 0 on success.
661
    """
662 663 664 665 666 667 668 669
    def extendbisectrange(nodes, good):
        # bisect is incomplete when it ends on a merge node and
        # one of the parent was not checked.
        parents = repo[nodes[0]].parents()
        if len(parents) > 1:
            side = good and state['bad'] or state['good']
            num = len(set(i.node() for i in parents) & set(side))
            if num == 1:
Yuya Nishihara's avatar
Yuya Nishihara committed
670
                return parents[0].ancestor(parents[1])
671 672
        return None

673 674 675 676
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
677 678 679 680
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
681
            displayer.show(repo[nodes[0]])
682 683 684 685 686
            extendnode = extendbisectrange(nodes, good)
            if extendnode is not None:
                ui.write(_('Not all ancestors of this changeset have been'
                           ' checked.\nUse bisect --extend to continue the '
                           'bisection from\nthe common ancestor, %s.\n')
687
                         % extendnode)
688 689
        else:
            # multiple possible revisions
690 691 692 693 694 695
            if good:
                ui.write(_("Due to skipped revisions, the first "
                        "good revision could be any of:\n"))
            else:
                ui.write(_("Due to skipped revisions, the first "
                        "bad revision could be any of:\n"))
696
            for n in nodes:
697
                displayer.show(repo[n])
698
        displayer.close()
699 700 701 702 703 704 705 706 707 708 709

    def check_state(state, interactive=True):
        if not state['good'] or not state['bad']:
            if (good or bad or skip or reset) and interactive:
                return
            if not state['good']:
                raise util.Abort(_('cannot bisect (no known good revisions)'))
            else:
                raise util.Abort(_('cannot bisect (no known bad revisions)'))
        return True

710 711 712 713 714 715 716 717 718 719
    # 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
720
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
721
        raise util.Abort(_('incompatible arguments'))
722

723 724
    cmdutil.checkunfinished(repo)

725 726 727 728 729 730
    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

731 732 733 734
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
735 736 737 738
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
739 740
                raise util.Abort(_('current bisect revision is unknown - '
                                   'start a new bisect to fix'))
741
        else:
742 743 744
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
                raise util.Abort(_('current bisect revision is a merge'))
745 746 747
        try:
            while changesets:
                # update state
748
                state['current'] = [node]
749
                hbisect.save_state(repo, state)
750
                status = ui.system(command, environ={'HG_NODE': hex(node)})
751 752 753 754 755 756 757 758 759 760 761
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
                    raise util.Abort(_("failed to execute %s") % command)
                elif status < 0:
                    raise util.Abort(_("%s killed") % command)
                else:
                    transition = "bad"
762
                ctx = scmutil.revsingle(repo, rev, node)
763
                rev = None # clear for future iterations
764
                state[transition].append(ctx.node())
765
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
766 767
                check_state(state, interactive=False)
                # bisect
768
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
769
                # update to next check
770 771 772 773
                node = nodes[0]
                if not noupdate:
                    cmdutil.bailifchanged(repo)
                    hg.clean(repo, node, show_stats=False)
774
        finally:
775
            state['current'] = [node]
776
            hbisect.save_state(repo, state)
777
        print_result(nodes, bgood)
778
        return
779 780

    # update state
781 782

    if rev:
783
        nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
784 785 786
    else:
        nodes = [repo.lookup('.')]

787 788
    if good or bad or skip:
        if good:
789
            state['good'] += nodes
790
        elif bad:
791
            state['bad'] += nodes
792
        elif skip:
793
            state['skip'] += nodes
794
        hbisect.save_state(repo, state)
795

796 797
    if not check_state(state):
        return
798 799

    # actually bisect
800
    nodes, changesets, good = hbisect.bisect(repo.changelog, state)
801 802 803 804
    if extend:
        if not changesets:
            extendnode = extendbisectrange(nodes, good)
            if extendnode is not None:
805 806
                ui.write(_("Extending search to changeset %d:%s\n")
                         % (extendnode.rev(), extendnode))
807 808
                state['current'] = [extendnode.node()]
                hbisect.save_state(repo, state)
809 810
                if noupdate:
                    return
811
                cmdutil.bailifchanged(repo)
812 813 814
                return hg.clean(repo, extendnode.node())
        raise util.Abort(_("nothing to extend"))

815
    if changesets == 0:
816
        print_result(nodes, good)
817 818 819
    else:
        assert len(nodes) == 1 # only a single node can be tested next
        node = nodes[0]
820 821 822 823 824
        # compute the approximate number of remaining tests
        tests, size = 0, 2
        while size <= changesets:
            tests, size = tests + 1, size * 2
        rev = repo.changelog.rev(node)
825 826
        ui.write(_("Testing changeset %d:%s "
                   "(%d changesets remaining, ~%d tests)\n")
827
                 % (rev, short(node), changesets, tests))
828 829
        state['current'] = [node]
        hbisect.save_state(repo, state)
830
        if not noupdate:
831
            cmdutil.bailifchanged(repo)