commands.py 261 KB
Newer Older
mpm@selenic.com's avatar
mpm@selenic.com committed
1 2
# commands.py - command processing for mercurial
#
3
# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
mpm@selenic.com's avatar
mpm@selenic.com committed
4
#
5
# This software may be used and distributed according to the terms of the
Matt Mackall's avatar
Matt Mackall committed
6
# GNU General Public License version 2 or any later version.
mpm@selenic.com's avatar
mpm@selenic.com committed
7

Gregory Szorc's avatar
Gregory Szorc committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
from __future__ import absolute_import

import difflib
import errno
import operator
import os
import random
import re
import shlex
import socket
import sys
import tempfile
import time

from .i18n import _
from .node import (
    bin,
    hex,
    nullhex,
    nullid,
    nullrev,
    short,
)
from . import (
    archival,
    bookmarks,
    bundle2,
    changegroup,
    cmdutil,
    commandserver,
    context,
    copies,
    dagparser,
    dagutil,
    destutil,
    discovery,
    encoding,
    error,
    exchange,
    extensions,
    fileset,
49
    formatter,
Gregory Szorc's avatar
Gregory Szorc committed
50 51 52 53 54 55 56 57 58 59 60 61
    graphmod,
    hbisect,
    help,
    hg,
    hgweb,
    localrepo,
    lock as lockmod,
    merge as mergemod,
    minirst,
    obsolete,
    patch,
    phases,
timeless's avatar
timeless committed
62
    policy,
Gregory Szorc's avatar
Gregory Szorc committed
63 64 65 66 67 68 69 70 71 72
    pvec,
    repair,
    revlog,
    revset,
    scmutil,
    setdiscovery,
    simplemerge,
    sshserver,
    streamclone,
    templatekw,
73
    templater,
Gregory Szorc's avatar
Gregory Szorc committed
74 75 76 77 78 79
    treediscovery,
    ui as uimod,
    util,
)

release = lockmod.release
80

81 82 83 84
table = {}

command = cmdutil.command(table)

85 86 87 88 89 90
# 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'

91 92 93 94 95 96 97 98 99
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
100
     _('do not prompt, automatically pick the first choice for all prompts')),
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    ('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')),
117
    ('', 'hidden', False, _('consider hidden changesets')),
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
]

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

153 154 155
# hidden for now
formatteropts = [
    ('T', 'template', '',
156
     _('display with template (EXPERIMENTAL)'), _('TEMPLATE')),
157 158
]

159 160
templateopts = [
    ('', 'style', '',
161
     _('display using template map file (DEPRECATED)'), _('STYLE')),
162
    ('T', 'template', '',
163 164 165 166 167 168 169 170 171 172
     _('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')),
173
    ('G', 'graph', None, _("show the revision DAG")),
174 175 176 177 178 179 180 181
] + 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'))
]

182
diffwsopts = [
183 184 185 186 187 188
    ('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')),
189 190 191
    ]

diffopts2 = [
192
    ('', 'noprefix', None, _('omit a/ and b/ prefixes from filenames')),
193 194 195
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
196 197 198
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
199
    ('', 'root', '', _('produce diffs relative to subdirectory'), _('DIR')),
200 201
]

202 203 204 205
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

206 207 208 209 210 211 212 213 214 215
similarityopts = [
    ('s', 'similarity', '',
     _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))
]

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

216 217 218
debugrevlogopts = [
    ('c', 'changelog', False, _('open changelog')),
    ('m', 'manifest', False, _('open manifest')),
219
    ('', 'dir', '', _('open directory manifest')),
220 221
]

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

224 225
@command('^add',
    walkopts + subrepoopts + dryrunopts,
226 227
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
228
def add(ui, repo, *pats, **opts):
229 230
    """add the specified files on the next commit

231 232
    Schedule files to be version controlled and added to the
    repository.
233

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

timeless's avatar
timeless committed
237 238
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
239 240 241

    .. container:: verbose

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
       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
267 268

    Returns 0 if all files are successfully added.
269 270
    """

271
    m = scmutil.match(repo[None], pats, opts)
272
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
273
    return rejected and 1 or 0
274

275
@command('addremove',
276
    similarityopts + subrepoopts + walkopts + dryrunopts,
277 278
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
279
def addremove(ui, repo, *pats, **opts):
280
    """add all new files, delete all missing files
281

282 283
    Add all new files and remove all missing files from the
    repository.
284

timeless's avatar
timeless committed
285 286 287
    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.
288

289
    Use the -s/--similarity option to detect renamed files. This
290
    option takes a percentage between 0 (disabled) and 100 (files must
291 292 293
    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
294
    can be expensive. After using this option, :hg:`status -C` can be
295 296 297
    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.
298

299 300 301 302 303 304 305 306 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 334 335 336 337 338
    .. 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

339
    Returns 0 if all files are successfully added.
340
    """
341
    try:
342
        sim = float(opts.get('similarity') or 100)
343
    except ValueError:
344
        raise error.Abort(_('similarity must be a number'))
345
    if sim < 0 or sim > 100:
346
        raise error.Abort(_('similarity must be between 0 and 100'))
347
    matcher = scmutil.match(repo[None], pats, opts)
348
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
349

350 351 352 353 354 355 356 357 358 359 360 361
@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'))
362
    ] + diffwsopts + walkopts + formatteropts,
363 364
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
365
def annotate(ui, repo, *pats, **opts):
366
    """show changeset information by line for each file
367

368
    List changes in files, showing the revision id responsible for
369
    each line.
370

371 372
    This command is useful for discovering when a change was made and
    by whom.
373

374 375 376
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

377 378 379 380
    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.
381 382

    Returns 0 on success.
383
    """
384
    if not pats:
385
        raise error.Abort(_('at least one filename or pattern is required'))
386

387 388 389
    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
390
        opts['file'] = True
391

392 393
    ctx = scmutil.revsingle(repo, opts.get('rev'))

394
    fm = ui.formatter('annotate', opts)
395 396 397 398
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
    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
426

427
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
428 429
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
430 431 432
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
433
            ]
434
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
435

436
    if (not opts.get('user') and not opts.get('changeset')
437
        and not opts.get('date') and not opts.get('file')):
438
        opts['number'] = True
439

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

444 445 446 447 448 449
    if fm:
        def makefunc(get, fmt):
            return get
    else:
        def makefunc(get, fmt):
            return lambda x: fmt(get(x))
450 451
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
452
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
453 454
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
455

456
    def bad(x, y):
457
        raise error.Abort("%s: %s" % (x, y))
458

459 460
    m = scmutil.match(ctx, pats, opts, badfn=bad)

461
    follow = not opts.get('no_follow')
462 463
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
464 465
    for abs in ctx.walk(m):
        fctx = ctx[abs]
466
        if not opts.get('text') and util.binary(fctx.data()):
467
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
468 469
            continue

470 471
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
472
        formats = []
473 474
        pieces = []

475
        for f, sep in funcmap:
476 477
            l = [f(n) for n, dummy in lines]
            if l:
478 479 480 481 482 483
                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])
484
                pieces.append(l)
485

486
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
487 488 489
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
490

491
        if lines and not lines[-1][1].endswith('\n'):
492 493 494
            fm.plain('\n')

    fm.end()
495

496 497 498 499 500 501 502 503
@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'))
504
def archive(ui, repo, dest, **opts):
505
    '''create an unversioned archive of a repository revision
506

507 508
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
509

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

Matt Mackall's avatar
Matt Mackall committed
513 514 515 516 517 518 519 520 521 522 523 524
    .. 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*"

525
    Valid types are:
526

527 528 529 530 531 532
    :``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
533

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

537 538 539 540
    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.
541 542

    Returns 0 on success.
543 544
    '''

545
    ctx = scmutil.revsingle(repo, opts.get('rev'))
546
    if not ctx:
547
        raise error.Abort(_('no working directory: please specify a revision'))
548
    node = ctx.node()
549
    dest = cmdutil.makefilename(repo, dest, node)
550
    if os.path.realpath(dest) == repo.root:
551
        raise error.Abort(_('repository root cannot be destination'))
552

553
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
554
    prefix = opts.get('prefix')
555

556 557
    if dest == '-':
        if kind == 'files':
558
            raise error.Abort(_('cannot archive plain files to stdout'))
559
        dest = cmdutil.makefileobj(repo, dest)
560 561
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
562

563
    prefix = cmdutil.makefilename(repo, prefix, node)
564
    matchfn = scmutil.match(ctx, [], opts)
565
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
566
                     matchfn, prefix, subrepos=opts.get('subrepos'))
567

568 569
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
570 571 572
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
573 574
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
575
    ('r', 'rev', '', _('revision to backout'), _('REV')),
576
    ('e', 'edit', False, _('invoke editor on commit messages')),
577
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
578
    _('[OPTION]... [-r] REV'))
579
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
580 581
    '''reverse effect of earlier changeset

582
    Prepare a new changeset with the effect of REV undone in the
583 584
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
585

586
    If REV is the parent of the working directory, then this new changeset
587
    is committed automatically (unless --no-commit is specified).
588

589
    .. note::
590

591
       :hg:`backout` cannot be used to fix either an unwanted or
592
       incorrect merge.
593

Matt Mackall's avatar
Matt Mackall committed
594 595
    .. container:: verbose

596 597 598 599 600 601 602 603 604 605 606 607
      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
608
        leave changes uncommitted::
609

610 611
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
612

Matt Mackall's avatar
Matt Mackall committed
613 614 615 616 617 618 619 620 621
      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.
622

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

625 626 627
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

628 629
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
630
    '''
631 632 633 634
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
635
        return _dobackout(ui, repo, node, rev, **opts)
636 637 638
    finally:
        release(lock, wlock)

639 640 641
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"))
642 643
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
644

Daniel Holth's avatar
Daniel Holth committed
645
    if rev and node:
646
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
647 648 649

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

651
    if not rev:
652
        raise error.Abort(_("please specify a revision to backout"))
653

654 655 656 657
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

658
    cmdutil.checkunfinished(repo)
659
    cmdutil.bailifchanged(repo)
660
    node = scmutil.revsingle(repo, rev).node()
661

662
    op1, op2 = repo.dirstate.parents()
663
    if not repo.changelog.isancestor(node, op1):
664
        raise error.Abort(_('cannot backout change that is not an ancestor'))
665

666 667
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
668
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
669
    if p2 != nullid:
670
        if not opts.get('parent'):
671
            raise error.Abort(_('cannot backout a merge changeset'))
672 673
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
674
            raise error.Abort(_('%s is not a parent of %s') %
675
                             (short(p), short(node)))
676 677
        parent = p
    else:
678
        if opts.get('parent'):
679
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
680
        parent = p1
681

682
    # the backout should appear on the same branch
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
    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())

707 708 709 710 711
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741

    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', '', '')
742
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
743

744 745 746 747 748 749 750 751 752
@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]"))
753
def bisect(ui, repo, rev=None, extra=None, command=None,
754 755
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
756 757
    """subdivision search of changesets

758 759 760 761 762 763 764 765 766 767 768 769 770
    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.
771 772 773 774 775 776
    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.
777

778 779 780 781
    .. container:: verbose

      Some examples:

782
      - start a bisection with known bad revision 34, and good revision 12::
783 784 785 786 787 788 789 790 791 792

          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
793
      - mark the current revision, or a known revision, to be skipped (e.g. if
794 795 796 797 798
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

799
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
800

801
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
802

803 804 805 806 807 808 809 810 811 812
      - 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
813
          hg bisect --command "make && make tests"
814 815 816 817 818 819

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

          hg log -r "bisect(pruned)"

820 821 822 823 824
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

825 826 827 828
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

829
      - you can even get a nice graph::
830 831 832

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

833 834
      See :hg:`help revsets` for more about the `bisect()` keyword.

835
    Returns 0 on success.
836
    """
837 838 839 840 841
    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:
842 843 844 845
            if good:
                side = state['bad']
            else:
                side = state['good']
846 847
            num = len(set(i.node() for i in parents) & set(side))
            if num == 1:
Yuya Nishihara's avatar
Yuya Nishihara committed
848
                return parents[0].ancestor(parents[1])
849 850
        return None

851 852 853 854
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
855 856 857 858
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
859
            displayer.show(repo[nodes[0]])
860 861 862 863 864
            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')
865
                         % extendnode)
866 867
        else:
            # multiple possible revisions
868 869 870 871 872 873
            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"))
874
            for n in nodes:
875
                displayer.show(repo[n])
876
        displayer.close()
877 878 879 880 881 882

    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']:
883
                raise error.Abort(_('cannot bisect (no known good revisions)'))
884
            else:
885
                raise error.Abort(_('cannot bisect (no known bad revisions)'))
886 887
        return True

888 889 890 891 892 893 894 895 896 897
    # 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
898
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
899
        raise error.Abort(_('incompatible arguments'))
900

901 902
    cmdutil.checkunfinished(repo)

903 904 905 906 907 908
    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

909 910 911 912
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
913 914 915 916
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
917
                raise error.Abort(_('current bisect revision is unknown - '
918
                                   'start a new bisect to fix'))
919
        else:
920 921
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
922
                raise error.Abort(_('current bisect revision is a merge'))
923 924 925
        try:
            while changesets:
                # update state
926
                state['current'] = [node]
927
                hbisect.save_state(repo, state)
928
                status = ui.system(command, environ={'HG_NODE': hex(node)})
929 930 931 932 933 934
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
935
                    raise error.Abort(_("failed to execute %s") % command)
936
                elif status < 0:
937
                    raise error.Abort(_("%s killed") % command)
938 939
                else:
                    transition = "bad"
940
                ctx = scmutil.revsingle(repo, rev, node)
941
                rev = None # clear for future iterations
942
                state[transition].append(ctx.node())
943
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
944 945
                check_state(state, interactive=False)
                # bisect