commands.py 254 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
import commandserver
27

28 29 30 31
table = {}

command = cmdutil.command(table)

32 33 34 35 36 37
# 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'

38 39 40 41 42 43 44 45 46
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
47
     _('do not prompt, automatically pick the first choice for all prompts')),
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
    ('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')),
64
    ('', 'hidden', False, _('consider hidden changesets')),
65 66 67 68 69 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
]

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

100 101 102
# hidden for now
formatteropts = [
    ('T', 'template', '',
103
     _('display with template (EXPERIMENTAL)'), _('TEMPLATE')),
104 105
]

106 107
templateopts = [
    ('', 'style', '',
108
     _('display using template map file (DEPRECATED)'), _('STYLE')),
109
    ('T', 'template', '',
110 111 112 113 114 115 116 117 118 119
     _('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')),
120
    ('G', 'graph', None, _("show the revision DAG")),
121 122 123 124 125 126 127 128
] + 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'))
]

129
diffwsopts = [
130 131 132 133 134 135
    ('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')),
136 137 138
    ]

diffopts2 = [
139
    ('', 'noprefix', None, _('omit a/ and b/ prefixes from filenames')),
140 141 142
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
143 144 145
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
146
    ('', 'root', '', _('produce diffs relative to subdirectory'), _('DIR')),
147 148
]

149 150 151 152
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

153 154 155 156 157 158 159 160 161 162
similarityopts = [
    ('s', 'similarity', '',
     _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))
]

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

163 164 165 166 167 168
debugrevlogopts = [
    ('c', 'changelog', False, _('open changelog')),
    ('m', 'manifest', False, _('open manifest')),
    ('', 'dir', False, _('open directory manifest')),
]

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

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

178 179
    Schedule files to be version controlled and added to the
    repository.
180

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

timeless's avatar
timeless committed
184 185
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
186 187 188

    .. container:: verbose

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
       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
214 215

    Returns 0 if all files are successfully added.
216 217
    """

218
    m = scmutil.match(repo[None], pats, opts)
219
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
220
    return rejected and 1 or 0
221

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

229 230
    Add all new files and remove all missing files from the
    repository.
231

timeless's avatar
timeless committed
232 233 234
    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.
235

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

246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
    .. 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

286
    Returns 0 if all files are successfully added.
287
    """
288
    try:
289
        sim = float(opts.get('similarity') or 100)
290
    except ValueError:
291
        raise error.Abort(_('similarity must be a number'))
292
    if sim < 0 or sim > 100:
293
        raise error.Abort(_('similarity must be between 0 and 100'))
294
    matcher = scmutil.match(repo[None], pats, opts)
295
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
296

297 298 299 300 301 302 303 304 305 306 307 308
@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'))
309
    ] + diffwsopts + walkopts + formatteropts,
310 311
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
312
def annotate(ui, repo, *pats, **opts):
313
    """show changeset information by line for each file
314

315
    List changes in files, showing the revision id responsible for
316
    each line.
317

318 319
    This command is useful for discovering when a change was made and
    by whom.
320

321 322 323
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

324 325 326 327
    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.
328 329

    Returns 0 on success.
330
    """
331
    if not pats:
332
        raise error.Abort(_('at least one filename or pattern is required'))
333

334 335 336
    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
337
        opts['file'] = True
338

339 340
    ctx = scmutil.revsingle(repo, opts.get('rev'))

341
    fm = ui.formatter('annotate', opts)
342 343 344 345
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
    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
373

374
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
375 376
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
377 378 379
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
380
            ]
381
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
382

383
    if (not opts.get('user') and not opts.get('changeset')
384
        and not opts.get('date') and not opts.get('file')):
385
        opts['number'] = True
386

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

391 392 393 394 395 396
    if fm:
        def makefunc(get, fmt):
            return get
    else:
        def makefunc(get, fmt):
            return lambda x: fmt(get(x))
397 398
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
399
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
400 401
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
402

403
    def bad(x, y):
404
        raise error.Abort("%s: %s" % (x, y))
405

406 407
    m = scmutil.match(ctx, pats, opts, badfn=bad)

408
    follow = not opts.get('no_follow')
409 410
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
411 412
    for abs in ctx.walk(m):
        fctx = ctx[abs]
413
        if not opts.get('text') and util.binary(fctx.data()):
414
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
415 416
            continue

417 418
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
419
        formats = []
420 421
        pieces = []

422
        for f, sep in funcmap:
423 424
            l = [f(n) for n, dummy in lines]
            if l:
425 426 427 428 429 430
                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])
431
                pieces.append(l)
432

433
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
434 435 436
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
437

438
        if lines and not lines[-1][1].endswith('\n'):
439 440 441
            fm.plain('\n')

    fm.end()
442

443 444 445 446 447 448 449 450
@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'))
451
def archive(ui, repo, dest, **opts):
452
    '''create an unversioned archive of a repository revision
453

454 455
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
456

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

Matt Mackall's avatar
Matt Mackall committed
460 461 462 463 464 465 466 467 468 469 470 471
    .. 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*"

472
    Valid types are:
473

474 475 476 477 478 479
    :``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
480

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

484 485 486 487
    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.
488 489

    Returns 0 on success.
490 491
    '''

492
    ctx = scmutil.revsingle(repo, opts.get('rev'))
493
    if not ctx:
494
        raise error.Abort(_('no working directory: please specify a revision'))
495
    node = ctx.node()
496
    dest = cmdutil.makefilename(repo, dest, node)
497
    if os.path.realpath(dest) == repo.root:
498
        raise error.Abort(_('repository root cannot be destination'))
499

500
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
501
    prefix = opts.get('prefix')
502

503 504
    if dest == '-':
        if kind == 'files':
505
            raise error.Abort(_('cannot archive plain files to stdout'))
506
        dest = cmdutil.makefileobj(repo, dest)
507 508
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
509

510
    prefix = cmdutil.makefilename(repo, prefix, node)
511
    matchfn = scmutil.match(ctx, [], opts)
512
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
513
                     matchfn, prefix, subrepos=opts.get('subrepos'))
514

515 516
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
517 518 519
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
520 521
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
522
    ('r', 'rev', '', _('revision to backout'), _('REV')),
523
    ('e', 'edit', False, _('invoke editor on commit messages')),
524
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
525
    _('[OPTION]... [-r] REV'))
526
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
527 528
    '''reverse effect of earlier changeset

529
    Prepare a new changeset with the effect of REV undone in the
530 531
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
532

533
    If REV is the parent of the working directory, then this new changeset
534
    is committed automatically (unless --no-commit is specified).
535

536
    .. note::
537

538
       :hg:`backout` cannot be used to fix either an unwanted or
539
       incorrect merge.
540

Matt Mackall's avatar
Matt Mackall committed
541 542
    .. container:: verbose

543 544 545 546 547 548 549 550 551 552 553 554
      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
555
        leave changes uncommitted::
556

557 558
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
559

Matt Mackall's avatar
Matt Mackall committed
560 561 562 563 564 565 566 567 568
      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.
569

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

572 573 574
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

575 576
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
577
    '''
578 579 580 581
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
582
        return _dobackout(ui, repo, node, rev, **opts)
583 584 585
    finally:
        release(lock, wlock)

586 587 588
def _dobackout(ui, repo, node=None, rev=None, **opts):
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
589 590
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
591

Daniel Holth's avatar
Daniel Holth committed
592
    if rev and node:
593
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
594 595 596

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

598
    if not rev:
599
        raise error.Abort(_("please specify a revision to backout"))
600

601 602 603 604
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

605
    cmdutil.checkunfinished(repo)
606
    cmdutil.bailifchanged(repo)
607
    node = scmutil.revsingle(repo, rev).node()
608

609
    op1, op2 = repo.dirstate.parents()
610
    if not repo.changelog.isancestor(node, op1):
611
        raise error.Abort(_('cannot backout change that is not an ancestor'))
612

613 614
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
615
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
616
    if p2 != nullid:
617
        if not opts.get('parent'):
618
            raise error.Abort(_('cannot backout a merge changeset'))
619 620
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
621
            raise error.Abort(_('%s is not a parent of %s') %
622
                             (short(p), short(node)))
623 624
        parent = p
    else:
625
        if opts.get('parent'):
626
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
627
        parent = p1
628

629
    # the backout should appear on the same branch
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
        dsguard = cmdutil.dirstateguard(repo, 'backout')
        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())

654 655 656 657 658
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
        e = cmdutil.getcommiteditor(editform=editform, **opts)
        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', '', '')
689
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
690

691 692 693 694 695 696 697 698 699
@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]"))
700
def bisect(ui, repo, rev=None, extra=None, command=None,
701 702
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
703 704
    """subdivision search of changesets

705 706 707 708 709 710 711 712 713 714 715 716 717
    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.
718 719 720 721 722 723
    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.
724

725 726 727 728
    .. container:: verbose

      Some examples:

729
      - start a bisection with known bad revision 34, and good revision 12::
730 731 732 733 734 735 736 737 738 739

          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
740
      - mark the current revision, or a known revision, to be skipped (e.g. if
741 742 743 744 745
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

746
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
747

748
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
749

750 751 752 753 754 755 756 757 758 759
      - 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
760
          hg bisect --command "make && make tests"
761 762 763 764 765 766

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

          hg log -r "bisect(pruned)"

767 768 769 770 771
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

772 773 774 775
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

776
      - you can even get a nice graph::
777 778 779

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

780 781
      See :hg:`help revsets` for more about the `bisect()` keyword.

782
    Returns 0 on success.
783
    """
784 785 786 787 788
    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:
789 790 791 792
            if good:
                side = state['bad']
            else:
                side = state['good']
793 794
            num = len(set(i.node() for i in parents) & set(side))
            if num == 1:
Yuya Nishihara's avatar
Yuya Nishihara committed
795
                return parents[0].ancestor(parents[1])
796 797
        return None

798 799 800 801
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
802 803 804 805
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
806
            displayer.show(repo[nodes[0]])
807 808 809 810 811
            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')
812
                         % extendnode)
813 814
        else:
            # multiple possible revisions
815 816 817 818 819 820
            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"))
821
            for n in nodes:
822
                displayer.show(repo[n])
823
        displayer.close()
824 825 826 827 828 829

    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']:
830
                raise error.Abort(_('cannot bisect (no known good revisions)'))
831
            else:
832
                raise error.Abort(_('cannot bisect (no known bad revisions)'))
833 834
        return True

835 836 837 838 839 840 841 842 843 844
    # 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
845
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
846
        raise error.Abort(_('incompatible arguments'))
847

848 849
    cmdutil.checkunfinished(repo)

850 851 852 853 854 855
    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

856 857 858 859
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
860 861 862 863
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
864
                raise error.Abort(_('current bisect revision is unknown - '
865
                                   'start a new bisect to fix'))
866
        else:
867 868
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
869
                raise error.Abort(_('current bisect revision is a merge'))
870 871 872
        try:
            while changesets:
                # update state
873
                state['current'] = [node]
874
                hbisect.save_state(repo, state)
875
                status = ui.system(command, environ={'HG_NODE': hex(node)})
876 877 878 879 880 881
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
882
                    raise error.Abort(_("failed to execute %s") % command)
883
                elif status < 0:
884
                    raise error.Abort(_("%s killed") % command)
885 886
                else:
                    transition = "bad"
887
                ctx = scmutil.revsingle(repo, rev, node)
888
                rev = None # clear for future iterations
889
                state[transition].append(ctx.node())
890
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
891 892
                check_state(state, interactive=False)
                # bisect
893
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
Benoit Boissinot's avatar