commands.py 243 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, nullhex, 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
Gregory Szorc's avatar
Gregory Szorc committed
16
import sshserver, hgweb
17
import extensions
18
import merge as mergemod
19
import minirst, revset, fileset
20
import dagparser, context, simplemerge, graphmod, copies
21
import random, operator
22
import setdiscovery, treediscovery, dagutil, pvec, localrepo, destutil
23
import phases, obsolete, exchange, bundle2, repair, lock as lockmod
24
import ui as uimod
25
import streamclone
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
# label constants
# until 3.5, bookmarks.current was the advertised name, not
# bookmarks.active, so we must use both to avoid breaking old
# custom styles
activebookmarklabel = 'bookmarks.active bookmarks.current'

49 50 51 52 53 54 55 56 57
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
58
     _('do not prompt, automatically pick the first choice for all prompts')),
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
    ('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')),
75
    ('', 'hidden', False, _('consider hidden changesets')),
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 105 106 107 108 109 110
]

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')),
]

111 112 113
# hidden for now
formatteropts = [
    ('T', 'template', '',
114
     _('display with template (EXPERIMENTAL)'), _('TEMPLATE')),
115 116
]

117 118
templateopts = [
    ('', 'style', '',
119
     _('display using template map file (DEPRECATED)'), _('STYLE')),
120
    ('T', 'template', '',
121 122 123 124 125 126 127 128 129 130
     _('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')),
131
    ('G', 'graph', None, _("show the revision DAG")),
132 133 134 135 136 137 138 139
] + 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'))
]

140
diffwsopts = [
141 142 143 144 145 146
    ('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')),
147 148 149
    ]

diffopts2 = [
150
    ('', 'noprefix', None, _('omit a/ and b/ prefixes from filenames')),
151 152 153
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
154 155 156
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
157
    ('', 'root', '', _('produce diffs relative to subdirectory'), _('DIR')),
158 159
]

160 161 162 163
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

164 165 166 167 168 169 170 171 172 173
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
174
# Commands start here, listed alphabetically
175

176 177
@command('^add',
    walkopts + subrepoopts + dryrunopts,
178 179
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
180
def add(ui, repo, *pats, **opts):
181 182
    """add the specified files on the next commit

183 184
    Schedule files to be version controlled and added to the
    repository.
185

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

189
    If no names are given, add all files to the repository.
190 191 192

    .. container:: verbose

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
       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
218 219

    Returns 0 if all files are successfully added.
220 221
    """

222
    m = scmutil.match(repo[None], pats, opts)
223
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
224
    return rejected and 1 or 0
225

226
@command('addremove',
227
    similarityopts + subrepoopts + walkopts + dryrunopts,
228 229
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
230
def addremove(ui, repo, *pats, **opts):
231
    """add all new files, delete all missing files
232

233 234
    Add all new files and remove all missing files from the
    repository.
235

236
    New files are ignored if they match any of the patterns in
237
    ``.hgignore``. As with add, these changes take effect at the next
238
    commit.
239

240
    Use the -s/--similarity option to detect renamed files. This
241
    option takes a percentage between 0 (disabled) and 100 (files must
242 243 244
    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
245
    can be expensive. After using this option, :hg:`status -C` can be
246 247 248
    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.
249 250

    Returns 0 if all files are successfully added.
251
    """
252
    try:
253
        sim = float(opts.get('similarity') or 100)
254
    except ValueError:
255
        raise error.Abort(_('similarity must be a number'))
256
    if sim < 0 or sim > 100:
257
        raise error.Abort(_('similarity must be between 0 and 100'))
258
    matcher = scmutil.match(repo[None], pats, opts)
259
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
260

261 262 263 264 265 266 267 268 269 270 271 272
@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'))
273
    ] + diffwsopts + walkopts + formatteropts,
274 275
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
276
def annotate(ui, repo, *pats, **opts):
277
    """show changeset information by line for each file
278

279 280
    List changes in files, showing the revision id responsible for
    each line
281

282 283
    This command is useful for discovering when a change was made and
    by whom.
284

285 286 287 288
    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.
289 290

    Returns 0 on success.
291
    """
292
    if not pats:
293
        raise error.Abort(_('at least one filename or pattern is required'))
294

295 296 297
    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
298
        opts['file'] = True
299

300 301
    ctx = scmutil.revsingle(repo, opts.get('rev'))

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

335
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
336 337
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
338 339 340
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], 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 354 355 356 357
    if fm:
        def makefunc(get, fmt):
            return get
    else:
        def makefunc(get, fmt):
            return lambda x: fmt(get(x))
358 359
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
360
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
361 362
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
363

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

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

369
    follow = not opts.get('no_follow')
370 371
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
372 373
    for abs in ctx.walk(m):
        fctx = ctx[abs]
374
        if not opts.get('text') and util.binary(fctx.data()):
375
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
376 377
            continue

378 379
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
380
        formats = []
381 382
        pieces = []

383
        for f, sep in funcmap:
384 385
            l = [f(n) for n, dummy in lines]
            if l:
386 387 388 389 390 391
                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])
392
                pieces.append(l)
393

394
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
395 396 397
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
398

399
        if lines and not lines[-1][1].endswith('\n'):
400 401 402
            fm.plain('\n')

    fm.end()
403

404 405 406 407 408 409 410 411
@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'))
412
def archive(ui, repo, dest, **opts):
413
    '''create an unversioned archive of a repository revision
414

415 416
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
417

418 419 420
    The archive type is automatically detected based on file
    extension (or override using -t/--type).

Matt Mackall's avatar
Matt Mackall committed
421 422 423 424 425 426 427 428 429 430 431 432
    .. 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*"

433
    Valid types are:
434

435 436 437 438 439 440
    :``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
441

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

445 446 447 448
    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.
449 450

    Returns 0 on success.
451 452
    '''

453
    ctx = scmutil.revsingle(repo, opts.get('rev'))
454
    if not ctx:
455
        raise error.Abort(_('no working directory: please specify a revision'))
456
    node = ctx.node()
457
    dest = cmdutil.makefilename(repo, dest, node)
458
    if os.path.realpath(dest) == repo.root:
459
        raise error.Abort(_('repository root cannot be destination'))
460

461
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
462
    prefix = opts.get('prefix')
463

464 465
    if dest == '-':
        if kind == 'files':
466
            raise error.Abort(_('cannot archive plain files to stdout'))
467
        dest = cmdutil.makefileobj(repo, dest)
468 469
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
470

471
    prefix = cmdutil.makefilename(repo, prefix, node)
472
    matchfn = scmutil.match(ctx, [], opts)
473
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
474
                     matchfn, prefix, subrepos=opts.get('subrepos'))
475

476 477
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
Mateusz Kwapich's avatar
Mateusz Kwapich committed
478
    ('', 'commit', None, _('commit if no conflicts were encountered')),
479 480
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
481
    ('r', 'rev', '', _('revision to backout'), _('REV')),
482
    ('e', 'edit', False, _('invoke editor on commit messages')),
483
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
484
    _('[OPTION]... [-r] REV'))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
485
def backout(ui, repo, node=None, rev=None, commit=False, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
486 487
    '''reverse effect of earlier changeset

488 489 490
    Prepare a new changeset with the effect of REV undone in the
    current working directory.

491
    If REV is the parent of the working directory, then this new changeset
492 493 494
    is committed automatically. Otherwise, hg needs to merge the
    changes and the merged result is left uncommitted.

495
    .. note::
496

497 498 499
      backout cannot be used to fix either an unwanted or
      incorrect merge.

Matt Mackall's avatar
Matt Mackall committed
500 501
    .. container:: verbose

502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
      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
          hg commit -m "Backout revision 23"

      - Reverse the effect of previous bad revision 23 and
        commit the backout immediately::

          hg backout -r 23 --commit

Matt Mackall's avatar
Matt Mackall committed
519 520 521 522 523 524 525 526 527
      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.
528

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

531 532 533
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

534 535
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
536
    '''
Daniel Holth's avatar
Daniel Holth committed
537
    if rev and node:
538
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
539 540 541

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

543
    if not rev:
544
        raise error.Abort(_("please specify a revision to backout"))
545

546 547 548 549
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

550
    cmdutil.checkunfinished(repo)
551
    cmdutil.bailifchanged(repo)
552
    node = scmutil.revsingle(repo, rev).node()
553

554
    op1, op2 = repo.dirstate.parents()
555
    if not repo.changelog.isancestor(node, op1):
556
        raise error.Abort(_('cannot backout change that is not an ancestor'))
557

558 559
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
560
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
561
    if p2 != nullid:
562
        if not opts.get('parent'):
563
            raise error.Abort(_('cannot backout a merge changeset'))
564 565
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
566
            raise error.Abort(_('%s is not a parent of %s') %
567
                             (short(p), short(node)))
568 569
        parent = p
    else:
570
        if opts.get('parent'):
571
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
572
        parent = p1
573

574
    # the backout should appear on the same branch
575 576 577
    wlock = repo.wlock()
    try:
        branch = repo.dirstate.branch()
578
        bheads = repo.branchheads(branch)
579
        rctx = scmutil.revsingle(repo, hex(parent))
580
        if not opts.get('merge') and op1 != node:
581
            dsguard = cmdutil.dirstateguard(repo, 'backout')
582
            try:
583 584
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
585 586
                stats = mergemod.update(repo, parent, True, True, False,
                                        node, False)
587
                repo.setparents(op1, op2)
588
                dsguard.close()
589 590
                hg._showstats(repo, stats)
                if stats[3]:
591 592
                    repo.ui.status(_("use 'hg resolve' to retry unresolved "
                                     "file merges\n"))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
593 594
                    return 1
                elif not commit:
595 596 597
                    msg = _("changeset %s backed out, "
                            "don't forget to commit.\n")
                    ui.status(msg % short(node))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
598
                    return 0
599
            finally:
600
                ui.setconfig('ui', 'forcemerge', '', '')
601
                lockmod.release(dsguard)
602 603 604 605 606
        else:
            hg.clean(repo, node, show_stats=False)
            repo.dirstate.setbranch(branch)
            cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

607

608
        def commitfunc(ui, repo, message, match, opts):
609 610
            editform = 'backout'
            e = cmdutil.getcommiteditor(editform=editform, **opts)
611 612 613
            if not message:
                # we don't translate commit messages
                message = "Backed out changeset %s" % short(node)
614
                e = cmdutil.getcommiteditor(edit=True, editform=editform)
615 616 617
            return repo.commit(message, opts.get('user'), opts.get('date'),
                               match, editor=e)
        newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
618 619 620
        if not newnode:
            ui.status(_("nothing changed\n"))
            return 1
621
        cmdutil.commitstatus(repo, newnode, branch, bheads)
622

623 624 625 626 627 628 629 630 631
        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:
632 633
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
634 635
                return hg.merge(repo, hex(repo.changelog.tip()))
            finally:
636
                ui.setconfig('ui', 'forcemerge', '', '')
637 638
    finally:
        wlock.release()
639
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
640

641 642 643 644 645 646 647 648 649
@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]"))
650
def bisect(ui, repo, rev=None, extra=None, command=None,
651 652
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
653 654
    """subdivision search of changesets

655 656 657 658 659 660 661 662 663 664 665 666 667
    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.
668 669 670 671 672 673
    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.
674

675 676 677 678
    .. container:: verbose

      Some examples:

679
      - start a bisection with known bad revision 34, and good revision 12::
680 681 682 683 684 685 686 687 688 689

          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
690
      - mark the current revision, or a known revision, to be skipped (e.g. if
691 692 693 694 695
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

696
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
697

698
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
699

700 701 702 703 704 705 706 707 708 709
      - 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
710
          hg bisect --command "make && make tests"
711 712 713 714 715 716

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

          hg log -r "bisect(pruned)"

717 718 719 720 721
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

722 723 724 725
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

726
      - you can even get a nice graph::
727 728 729

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

730 731
      See :hg:`help revsets` for more about the `bisect()` keyword.

732
    Returns 0 on success.
733
    """
734 735 736 737 738
    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:
739 740 741 742
            if good:
                side = state['bad']
            else:
                side = state['good']
743 744
            num = len(set(i.node() for i in parents) & set(side))
            if num == 1:
Yuya Nishihara's avatar
Yuya Nishihara committed
745
                return parents[0].ancestor(parents[1])
746 747
        return None

748 749 750 751
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
752 753 754 755
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
756
            displayer.show(repo[nodes[0]])
757 758 759 760 761
            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')
762
                         % extendnode)
763 764
        else:
            # multiple possible revisions
765 766 767 768 769 770
            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"))
771
            for n in nodes:
772
                displayer.show(repo[n])
773
        displayer.close()
774 775 776 777 778 779

    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']:
780
                raise error.Abort(_('cannot bisect (no known good revisions)'))
781
            else:
782
                raise error.Abort(_('cannot bisect (no known bad revisions)'))
783 784
        return True

785 786 787 788 789 790 791 792 793 794
    # 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
795
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
796
        raise error.Abort(_('incompatible arguments'))
797

798 799
    cmdutil.checkunfinished(repo)

800 801 802 803 804 805
    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

806 807 808 809
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
810 811 812 813
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
814
                raise error.Abort(_('current bisect revision is unknown - '
815
                                   'start a new bisect to fix'))
816
        else:
817 818
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
819
                raise error.Abort(_('current bisect revision is a merge'))
820 821 822
        try:
            while changesets:
                # update state
823
                state['current'] = [node]
824
                hbisect.save_state(repo, state)
825
                status = ui.system(command, environ={'HG_NODE': hex(node)})
826 827 828 829 830 831
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
832
                    raise error.Abort(_("failed to execute %s") % command)
833
                elif status < 0:
834
                    raise error.Abort(_("%s killed") % command)
835 836
                else:
                    transition = "bad"
837
                ctx = scmutil.revsingle(repo, rev, node)
838
                rev = None # clear for future iterations
839
                state[transition].append(ctx.node())
840
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
841 842
                check_state(state, interactive=False)
                # bisect
843
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
844
                # update to next check