commands.py 195 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
from __future__ import absolute_import

import difflib
import errno
import os
import re

from .i18n import _
from .node import (
    hex,
    nullid,
    nullrev,
    short,
)
from . import (
    archival,
    bookmarks,
    bundle2,
    changegroup,
    cmdutil,
    copies,
    destutil,
30
    dirstateguard,
Gregory Szorc's avatar
Gregory Szorc committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
    discovery,
    encoding,
    error,
    exchange,
    extensions,
    graphmod,
    hbisect,
    help,
    hg,
    lock as lockmod,
    merge as mergemod,
    minirst,
    obsolete,
    patch,
    phases,
46
    pycompat,
Gregory Szorc's avatar
Gregory Szorc committed
47 48
    revset,
    scmutil,
49
    server,
Gregory Szorc's avatar
Gregory Szorc committed
50 51 52 53 54 55 56 57
    sshserver,
    streamclone,
    templatekw,
    ui as uimod,
    util,
)

release = lockmod.release
58

59 60 61 62
table = {}

command = cmdutil.command(table)

63 64 65 66 67 68
# 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'

69 70 71 72 73 74 75 76 77
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
78
     _('do not prompt, automatically pick the first choice for all prompts')),
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
    ('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')),
95
    ('', 'hidden', False, _('consider hidden changesets')),
96 97
    ('', 'pager', 'auto',
     _("when to paginate (boolean, always, auto, or never)"), _('TYPE')),
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
]

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

133 134 135
# hidden for now
formatteropts = [
    ('T', 'template', '',
136
     _('display with template (EXPERIMENTAL)'), _('TEMPLATE')),
137 138
]

139 140
templateopts = [
    ('', 'style', '',
141
     _('display using template map file (DEPRECATED)'), _('STYLE')),
142
    ('T', 'template', '',
143 144 145 146 147 148 149 150 151 152
     _('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')),
153
    ('G', 'graph', None, _("show the revision DAG")),
154 155 156 157 158 159 160 161
] + 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'))
]

162
diffwsopts = [
163 164 165 166 167 168
    ('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')),
169 170 171
    ]

diffopts2 = [
172
    ('', 'noprefix', None, _('omit a/ and b/ prefixes from filenames')),
173 174 175
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
176 177 178
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
179
    ('', 'root', '', _('produce diffs relative to subdirectory'), _('DIR')),
180 181
]

182 183 184 185
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

186 187 188 189 190 191 192 193 194 195
similarityopts = [
    ('s', 'similarity', '',
     _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))
]

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

196 197 198
debugrevlogopts = [
    ('c', 'changelog', False, _('open changelog')),
    ('m', 'manifest', False, _('open manifest')),
199
    ('', 'dir', '', _('open directory manifest')),
200 201
]

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

204 205
@command('^add',
    walkopts + subrepoopts + dryrunopts,
206 207
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
208
def add(ui, repo, *pats, **opts):
209 210
    """add the specified files on the next commit

211 212
    Schedule files to be version controlled and added to the
    repository.
213

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

timeless's avatar
timeless committed
217 218
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
219 220 221

    .. container:: verbose

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
       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
247 248

    Returns 0 if all files are successfully added.
249 250
    """

251
    m = scmutil.match(repo[None], pats, opts)
252
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
253
    return rejected and 1 or 0
254

255
@command('addremove',
256
    similarityopts + subrepoopts + walkopts + dryrunopts,
257 258
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
259
def addremove(ui, repo, *pats, **opts):
260
    """add all new files, delete all missing files
261

262 263
    Add all new files and remove all missing files from the
    repository.
264

timeless's avatar
timeless committed
265 266 267
    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.
268

269
    Use the -s/--similarity option to detect renamed files. This
270
    option takes a percentage between 0 (disabled) and 100 (files must
271 272 273
    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
274
    can be expensive. After using this option, :hg:`status -C` can be
275 276 277
    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.
278

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
    .. 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

319
    Returns 0 if all files are successfully added.
320
    """
321
    try:
322
        sim = float(opts.get('similarity') or 100)
323
    except ValueError:
324
        raise error.Abort(_('similarity must be a number'))
325
    if sim < 0 or sim > 100:
326
        raise error.Abort(_('similarity must be between 0 and 100'))
327
    matcher = scmutil.match(repo[None], pats, opts)
328
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
329

330 331 332 333 334 335 336 337 338 339 340 341
@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'))
342
    ] + diffwsopts + walkopts + formatteropts,
343 344
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
345
def annotate(ui, repo, *pats, **opts):
346
    """show changeset information by line for each file
347

348
    List changes in files, showing the revision id responsible for
349
    each line.
350

351 352
    This command is useful for discovering when a change was made and
    by whom.
353

354 355 356
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

357 358 359 360
    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.
361 362

    Returns 0 on success.
363
    """
364
    ui.pager('annotate')
365
    if not pats:
366
        raise error.Abort(_('at least one filename or pattern is required'))
367

368 369 370
    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
371
        opts['file'] = True
372

373 374
    ctx = scmutil.revsingle(repo, opts.get('rev'))

375
    fm = ui.formatter('annotate', opts)
376 377 378 379
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
    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
407

408
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
409 410
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
411 412 413
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
414
            ]
415
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
416

417
    if (not opts.get('user') and not opts.get('changeset')
418
        and not opts.get('date') and not opts.get('file')):
419
        opts['number'] = True
420

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

425
    if fm.isplain():
426
        def makefunc(get, fmt):
427
            return lambda x: fmt(get(x))
428 429
    else:
        def makefunc(get, fmt):
430
            return get
431 432
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
433
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
434 435
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
436

437
    def bad(x, y):
438
        raise error.Abort("%s: %s" % (x, y))
439

440 441
    m = scmutil.match(ctx, pats, opts, badfn=bad)

442
    follow = not opts.get('no_follow')
443 444
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
445 446
    for abs in ctx.walk(m):
        fctx = ctx[abs]
447
        if not opts.get('text') and util.binary(fctx.data()):
448
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
449 450
            continue

451 452
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
453 454
        if not lines:
            continue
455
        formats = []
456 457
        pieces = []

458
        for f, sep in funcmap:
459
            l = [f(n) for n, dummy in lines]
460
            if fm.isplain():
461 462 463
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
464 465
            else:
                formats.append(['%s' for x in l])
466
            pieces.append(l)
467

468
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
469 470 471
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
472

473
        if not lines[-1][1].endswith('\n'):
474 475 476
            fm.plain('\n')

    fm.end()
477

478 479 480 481 482 483 484 485
@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'))
486
def archive(ui, repo, dest, **opts):
487
    '''create an unversioned archive of a repository revision
488

489 490
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
491

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

Matt Mackall's avatar
Matt Mackall committed
495 496 497 498 499 500 501 502 503 504 505 506
    .. 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*"

507
    Valid types are:
508

509 510 511 512 513 514
    :``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
515

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

519 520 521 522
    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.
523 524

    Returns 0 on success.
525 526
    '''

527
    ctx = scmutil.revsingle(repo, opts.get('rev'))
528
    if not ctx:
529
        raise error.Abort(_('no working directory: please specify a revision'))
530
    node = ctx.node()
531
    dest = cmdutil.makefilename(repo, dest, node)
532
    if os.path.realpath(dest) == repo.root:
533
        raise error.Abort(_('repository root cannot be destination'))
534

535
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
536
    prefix = opts.get('prefix')
537

538 539
    if dest == '-':
        if kind == 'files':
540
            raise error.Abort(_('cannot archive plain files to stdout'))
541
        dest = cmdutil.makefileobj(repo, dest)
542 543
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
544

545
    prefix = cmdutil.makefilename(repo, prefix, node)
546
    matchfn = scmutil.match(ctx, [], opts)
547
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
548
                     matchfn, prefix, subrepos=opts.get('subrepos'))
549

550 551
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
552 553 554
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
555 556
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
557
    ('r', 'rev', '', _('revision to backout'), _('REV')),
558
    ('e', 'edit', False, _('invoke editor on commit messages')),
559
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
560
    _('[OPTION]... [-r] REV'))
561
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
562 563
    '''reverse effect of earlier changeset

564
    Prepare a new changeset with the effect of REV undone in the
565 566
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
567

568
    If REV is the parent of the working directory, then this new changeset
569
    is committed automatically (unless --no-commit is specified).
570

571
    .. note::
572

573
       :hg:`backout` cannot be used to fix either an unwanted or
574
       incorrect merge.
575

Matt Mackall's avatar
Matt Mackall committed
576 577
    .. container:: verbose

578 579 580 581 582 583 584 585 586 587 588 589
      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
590
        leave changes uncommitted::
591

592 593
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
594

Matt Mackall's avatar
Matt Mackall committed
595 596 597 598 599 600 601 602 603
      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.
604

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

607 608 609
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

610 611
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
612
    '''
613 614 615 616
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
617
        return _dobackout(ui, repo, node, rev, **opts)
618 619 620
    finally:
        release(lock, wlock)

621 622 623
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"))
624 625
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
626

Daniel Holth's avatar
Daniel Holth committed
627
    if rev and node:
628
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
629 630 631

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

633
    if not rev:
634
        raise error.Abort(_("please specify a revision to backout"))
635

636 637 638 639
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

640
    cmdutil.checkunfinished(repo)
641
    cmdutil.bailifchanged(repo)
642
    node = scmutil.revsingle(repo, rev).node()
643

644
    op1, op2 = repo.dirstate.parents()
645
    if not repo.changelog.isancestor(node, op1):
646
        raise error.Abort(_('cannot backout change that is not an ancestor'))
647

648 649
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
650
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
651
    if p2 != nullid:
652
        if not opts.get('parent'):
653
            raise error.Abort(_('cannot backout a merge changeset'))
654 655
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
656
            raise error.Abort(_('%s is not a parent of %s') %
657
                             (short(p), short(node)))
658 659
        parent = p
    else:
660
        if opts.get('parent'):
661
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
662
        parent = p1
663

664
    # the backout should appear on the same branch
665 666 667 668
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
669
        dsguard = dirstateguard.dirstateguard(repo, 'backout')
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
        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())

689 690 691 692 693
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723

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

726 727 728 729 730 731 732 733 734
@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]"))
735
def bisect(ui, repo, rev=None, extra=None, command=None,
736 737
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
738 739
    """subdivision search of changesets

740 741 742 743 744 745 746 747 748 749 750 751 752
    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.
753 754 755 756 757 758
    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.
759

760 761 762 763
    .. container:: verbose

      Some examples:

764
      - start a bisection with known bad revision 34, and good revision 12::
765 766 767 768 769 770 771 772 773 774

          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
775
      - mark the current revision, or a known revision, to be skipped (e.g. if
776 777 778 779 780
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

781
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
782

783
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
784

785 786 787 788 789 790 791 792 793 794
      - 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
795
          hg bisect --command "make && make tests"
796 797 798 799 800 801

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

          hg log -r "bisect(pruned)"

802 803 804 805 806
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

807 808 809 810
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

811
      - you can even get a nice graph::
812 813 814

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

815
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
816

817
    Returns 0 on success.
818 819 820 821 822 823 824 825 826 827 828
    """
    # 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
829
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
830
        raise error.Abort(_('incompatible arguments'))
831

832 833
    cmdutil.checkunfinished(repo)

834
    if reset:
835
        hbisect.resetstate(repo)
836 837
        return

838 839
    state = hbisect.load_state(repo)

840 841 842 843 844 845 846 847 848 849 850 851 852
    # update state
    if good or bad or skip:
        if rev:
            nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
        else:
            nodes = [repo.lookup('.')]
        if good:
            state['good'] += nodes
        elif bad:
            state['bad'] += nodes
        elif skip:
            state['skip'] += nodes
        hbisect.save_state(repo, state)
853 854
        if not (state['good'] and state['bad']):
            return
855

856 857 858 859 860 861 862
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

863 864
    displayer = cmdutil.show_changeset(ui, repo, {})

865 866
    if command:
        changesets = 1
867 868 869 870
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
871
                raise error.Abort(_('current bisect revision is unknown - '
872
                                   'start a new bisect to fix'))
873
        else:
874 875
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
876
                raise error.Abort(_('current bisect revision is a merge'))
877 878
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
879 880 881
        try:
            while changesets:
                # update state
882
                state['current'] = [node]
883
                hbisect.save_state(repo, state)
884
                status = ui.system(command, environ={'HG_NODE': hex(node)})
885 886 887 888 889 890
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
891
                    raise error.Abort(_("failed to execute %s") % command)
892
                elif status < 0:
893
                    raise error.Abort(_("%s killed") % command)
894 895
                else:
                    transition = "bad"
896 897
                state[transition].append(node)
                ctx = repo[node]
898
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
899
                hbisect.checkstate(state)
900
                # bisect
901
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
902
                # update to next check
903
                node = nodes[0]
904
                mayupdate(repo, node, show_stats=False)
905
        finally:
906
            state['current'] = [node]
907
            hbisect.save_state(repo, state)
908
        hbisect.printresult(ui, repo, state, displayer, nodes, bgood)
909
        return
910